reset

ansys.optislang.core.tcp.server_commands.reset(actor_uid: str | None = None, hid: str | None = None, run_async: bool = False, password: str | None = None) → str

Generate JSON string of reset command.

Parameters:

actor_uid: Optional[str], optional

Actor uid entry. A Hierarchical ID (hid) is required. By default None.

hid: Optional[str], optional

Hid entry. The actor uid is required. By default None.

run_async: bool, optional

Whether to perform the reset as an asynchronous, non-blocking long running operation. If True, the server responds immediately with an operation ID that can be polled or waited on via the get_long_running_operation_status/ wait_for_long_running_operation queries. By default False.

Note

Argument is supported for Ansys optiSLang version >= 27.1 only.

passwordOptional[str], optional

Password, by default None.

Returns:

str

JSON string of reset command.