Client#

class ansys.platform.instancemanagement.Client(channel: Channel, configuration: Configuration | None = None)#

Provides a high-level client object for interacting with the PIM API.

This class exposes the methods of the PIM API.

Methods

Client.close()

Close the connection.

Client.create_instance(product_name[, ...])

Create a remote instance of a product based on its name and optionally its version.

Client.get_instance(name[, timeout])

Get a remote product instance by name.

Client.list_definitions([product_name, ...])

Get the list of supported product definitions.

Client.list_instances([timeout])

List the existing instances.