Configuration

class ansys.platform.instancemanagement.Configuration(headers: Sequence[Tuple[str, str]], uri: str, access_token: str | None = None, transport: str | None = None, cert_files: CertificateFiles | None = None, certs_dir: str | None = None)

Configuration for the PIM client.

Built from a configuration file (from_file(), either version 1 or version 2) or from programmatic parameters (from_parameters()). The resolved transport is always one of insecure, tls, uds, mtls, or wnua, regardless of how it was built. See Security for the full picture of PyPIM’s transport security model.

Returns:

Configuration: settings to configure the PIM client

Raises:

InvalidConfigurationError: configuration file is not a well formatted json file

InvalidConfigurationError: version is not supported

InvalidConfigurationError: a key is missing in the configuration file

Methods

Configuration.from_environment()	Create a PyPIM configuration based on the environment configuration.
Configuration.from_file(config_path)	Initialize the PyPIM configuration based on the configuration file.
Configuration.from_parameters(uri[, ...])	Build a configuration from programmatic parameters.

Attributes

Configuration.access_token	Access token.
Configuration.cert_files	MTLS client certificate files, or None.
Configuration.certs_dir	MTLS certificates directory, or None.
Configuration.headers	Headers to add to the requests to PIM.
Configuration.tls	Whether the connection to PIM requires encryption with a bearer token.
Configuration.transport	Canonical transport: insecure, tls, uds, mtls, or wnua.
Configuration.uri	Uri of the PIM service.