list_instances#

Client.list_instances(timeout: Optional[float] = None) Sequence[Instance]#

List the existing instances.

Parameters:
timeoutfloat, optional

Maximum time in seconds for the request. The default is None.

Returns:
list

List of instances.

Examples

>>> import ansys.platform.instancemanagement as pypim
>>> client = pypim.connect()
>>> for instance in client.list_instances():
>>>     status = "ready" if instance.ready else "not ready"
>>>     print(f"The instance {instance.name} is {status}.")
    The instance instances/mapdl-221-yAVne0ve is ready