register_file#

ansys.optislang.core.server_commands.register_file(uid: str | None = None, ident: str | None = None, local_location: Dict | None = None, action: str | None = None, password: str | None = None) str#

Generate JSON string of register_file command.

Parameters:
uid: str, opt

Uid entry.

ident: str, opt

Ident.

local_location: Dict, opt

Dictionary specifying location, e. g. { “split_path”: {“head”: “”, “tail”: “C:/samples_path/result.txt” }, “base_path”: “”, “base_path_mode”: “ABSOLUTE_PATH” }.

action: str, opt

Action, e. g. “Send”

passwordstr, opt

Password.

Returns:
str

JSON string of register_file command.