list_definitions

Client.list_definitions(product_name: str | None = None, product_version: str | None = None, timeout: float | None = None) → Sequence[Definition]

Get the list of supported product definitions.

Parameters:

product_namestr, optional

Filter by product name if provided. The default is None.

product_versionstr, optional

Filter by product version if provided. The default is None.

timeoutfloat, optional

Set a timeout in seconds for the request if provided. The default is None.

Returns:

list

List of supported product definitions.

Examples

>>> import ansys.platform.instancemanagement as pypim
>>> client = pypim.connect()
>>> for definition in client.list_definitions(product_name="mapdl"):
>>>     print(f"MAPDL version {definition.version} is available on the server.")
    MAPDL version 221 is available on the server.