com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters package

Submodules

com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client module

The com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client module provides classes for configuring the Attestation Service. It attests the state of a remote infrastructure node.

class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The ServiceStatus class provides methods to get the Attestation Service health status. This class was added in vSphere API 7.0.0.0.

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

class Health(string)

Bases: vmware.vapi.bindings.enum.Enum

The ServiceStatus.Health class defines the possible service health states. This enumeration was added in vSphere API 7.0.0.0.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters

string (str) – String value for the Health instance.

ERROR = Health(string='ERROR')

Service is not functioning. This class attribute was added in vSphere API 7.0.0.0.

NONE = Health(string='NONE')

No status available. This class attribute was added in vSphere API 7.0.0.0.

OK = Health(string='OK')

Service is functioning normally. This class attribute was added in vSphere API 7.0.0.0.

WARNING = Health(string='WARNING')

Service is functioning, however there is an issue that requires attention. This class attribute was added in vSphere API 7.0.0.0.

class Info(health=None, details=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The ServiceStatus.Info class contains information that describes the status of the service. This class was added in vSphere API 7.0.0.0.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters
get_task(cluster)

Return the Attestation service health in the given cluster. This method was added in vSphere API 7.0.0.0.

Parameters

cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Return type

class

vmware.vapi.stdlib.client.task.Task

Returns

Task instance

Raise

com.vmware.vapi.std.errors_client.Error For any other error.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If the cluster id is empty.

Raise

com.vmware.vapi.std.errors_client.NotFound If the cluster is not found.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated If the caller is not authenticated.

class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client module

The com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client module provides the interfaces for configuring the Key Provider Service. It encapsulates one or more key servers and exposes Trusted Key Providers.

class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Providers interface provides methods to create, update and delete Key Providers that handoff to key servers. This class was added in vSphere API 7.0.0.0.

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

class CreateSpec(provider=None, master_key_id=None, key_server=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.CreateSpec class contains attributes that describe the desired configuration for a new Key Provider. This class was added in vSphere API 7.0.0.0.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • provider (str) –

    Name of the provider.

    A unique string chosen by the client.. This attribute was added in vSphere API 7.0.0.0. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

  • master_key_id (str) –

    Master key ID created for the provider.

    A unique Key ID.. This attribute was added in vSphere API 7.0.0.0.

  • key_server (Providers.KeyServerCreateSpec) – Key server associated with this Provider. This attribute was added in vSphere API 7.0.0.0.

class Health(string)

Bases: vmware.vapi.bindings.enum.Enum

The Providers.Health class defines the possible health states. This enumeration was added in vSphere API 7.0.0.0.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters

string (str) – String value for the Health instance.

ERROR = Health(string='ERROR')

Not healthy. This class attribute was added in vSphere API 7.0.0.0.

NONE = Health(string='NONE')

No status available. This class attribute was added in vSphere API 7.0.0.0.

OK = Health(string='OK')

Health is normal. This class attribute was added in vSphere API 7.0.0.0.

WARNING = Health(string='WARNING')

Health is normal, however there is an issue that requires attention. This class attribute was added in vSphere API 7.0.0.0.

class Info(master_key_id=None, key_server=None, status=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.Info class contains attributes that describe the current configuration of a provider. This class was added in vSphere API 7.0.0.0.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • master_key_id (str) –

    Master key identifier created for the provider.

    A unique Key identifier.. This attribute was added in vSphere API 7.0.0.0.

  • key_server (Providers.KeyServerInfo) – Key server associated with this provider. This attribute was added in vSphere API 7.0.0.0.

  • status (Providers.Status) – Status of the provider in the cluster. This attribute was added in vSphere API 7.0.0.0.

class KeyServerCreateSpec(type=None, description=None, proxy_server=None, connection_timeout=None, kmip_server=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.KeyServerCreateSpec class contains attributes that describe the desired configuration for the key server. This class was added in vSphere API 7.0.0.0.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • type (Providers.KeyServerCreateSpec.Type) – Type of the key server. This attribute was added in vSphere API 7.0.0.0.

  • description (str or None) – Description of the key server. This attribute was added in vSphere API 7.0.0.0. If None, description will not be added.

  • proxy_server (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress or None) – Proxy server configuration. This attribute was added in vSphere API 7.0.0.0. If None, the key server will not use a proxy server.

  • connection_timeout (long or None) – Connection timeout in seconds. This attribute was added in vSphere API 7.0.0.0. If None, connection timeout will not be set.

  • kmip_server (Providers.KmipServerCreateSpec) – Configuration information for Key Management Interoperability Protocol (KMIP) based key server. This attribute was added in vSphere API 7.0.0.0. This attribute is optional and it is only relevant when the value of type is Providers.KeyServerCreateSpec.Type.KMIP.

class Type(string)

Bases: vmware.vapi.bindings.enum.Enum

The Providers.KeyServerCreateSpec.Type class lists the key server types. This enumeration was added in vSphere API 7.0.0.0.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters

string (str) – String value for the Type instance.

KMIP = Type(string='KMIP')

Key Management Interoperability Protocol (KMIP) based key management server. This class attribute was added in vSphere API 7.0.0.0.

class KeyServerInfo(type=None, description=None, proxy_server=None, connection_timeout=None, kmip_server=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.KeyServerInfo class contains attributes that describe the current configuration of a key server. This class was added in vSphere API 7.0.0.0.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • type (Providers.KeyServerInfo.Type) – Type of the key server. This attribute was added in vSphere API 7.0.0.0.

  • description (str) – Description of the key server. This attribute was added in vSphere API 7.0.0.0.

  • proxy_server (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress or None) –

    Proxy server configuration.

    . This attribute was added in vSphere API 7.0.0.0. If None, proxy server configuration will not be set.

  • connection_timeout (long or None) –

    Connection timeout in seconds.

    . This attribute was added in vSphere API 7.0.0.0. If None, connection timeout will be unset.

  • kmip_server (Providers.KmipServerInfo) – Configuration information for KMIP based key server. This attribute was added in vSphere API 7.0.0.0. This attribute is optional and it is only relevant when the value of type is Providers.KeyServerInfo.Type.KMIP.

class Type(string)

Bases: vmware.vapi.bindings.enum.Enum

The Providers.KeyServerInfo.Type class list the key server types. This enumeration was added in vSphere API 7.0.0.0.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters

string (str) – String value for the Type instance.

KMIP = Type(string='KMIP')

Key Management Interoperability Protocol (KMIP) based key management server. This class attribute was added in vSphere API 7.0.0.0.

class KeyServerUpdateSpec(type=None, description=None, proxy_server=None, connection_timeout=None, kmip_server=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.KeyServerUpdateSpec class contains attributes that describe new configuration for an existing key server. This class was added in vSphere API 7.0.0.0.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • type (Providers.KeyServerUpdateSpec.Type or None) –

    Type of the key server.

    . This attribute was added in vSphere API 7.0.0.0. If None, key server type and configuration information will remain unchanged. In this case all key server configuration information fields (e.g KMIP) should be unset.

  • description (str or None) –

    Description of the key server.

    . This attribute was added in vSphere API 7.0.0.0. If None, description will remain unchanged.

  • proxy_server (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress or None) –

    Proxy server configuration.

    . This attribute was added in vSphere API 7.0.0.0. If None, proxy server configuration will remain unchanged.

  • connection_timeout (long or None) –

    Connection timeout in seconds.

    . This attribute was added in vSphere API 7.0.0.0. If None, connection timeout will remain unchanged.

  • kmip_server (Providers.KmipServerUpdateSpec or None) –

    Configuration information for KMIP based key server.

    . This attribute was added in vSphere API 7.0.0.0. If None, kmip server configuration will remain unchanged.

class Type(string)

Bases: vmware.vapi.bindings.enum.Enum

The Providers.KeyServerUpdateSpec.Type class list the key server types. This enumeration was added in vSphere API 7.0.0.0.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters

string (str) – String value for the Type instance.

KMIP = Type(string='KMIP')

Key Management Interoperability Protocol (KMIP) based key management server. This class attribute was added in vSphere API 7.0.0.0.

class KmipServerCreateSpec(servers=None, username=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.KmipServerCreateSpec class contains attributes that describe Key Management Interoperability Protocol (KMIP) desired key server configuration. This class was added in vSphere API 7.0.0.0.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • servers (list of Providers.Server) –

    List of Key Management Interoperability Protocol (KMIP) compliant key servers.

    Key servers must be configured for active-active replication. If the server port is None, a default value for KMIP’s port will be used.. This attribute was added in vSphere API 7.0.0.0.

  • username (str or None) – Username for authentication. This attribute was added in vSphere API 7.0.0.0. If None, no username will be added.

class KmipServerInfo(servers=None, username=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.KmipServerInfo class contains attributes that describe the current configuration of a KMIP based key server. This class was added in vSphere API 7.0.0.0.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • servers (list of Providers.Server) – List of KMIP compliant key servers. This attribute was added in vSphere API 7.0.0.0.

  • username (str or None) –

    Username for authentication.

    . This attribute was added in vSphere API 7.0.0.0. If None, username will not be set.

class KmipServerUpdateSpec(servers=None, username=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.KmipServerUpdateSpec class contains attributes that describe new configuration for KMIP based key server. This class was added in vSphere API 7.0.0.0.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • servers (list of Providers.Server or None) –

    List of KMIP compliant key servers.

    Key servers must be configured for active-active replication. If the server port is None, a default value for KMIP’s port will be used.

    . This attribute was added in vSphere API 7.0.0.0. If None, server configuration will remain unchanged.

  • username (str or None) –

    Username for authentication.

    . This attribute was added in vSphere API 7.0.0.0. If None, username will remain unchanged.

RESOURCE_TYPE = 'com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider'

Resource type for a Key Provider. This class attribute was added in vSphere API 7.0.0.0.

class Server(name=None, address=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.Server class contains attributes that describe a connection endpoint. This class was added in vSphere API 7.0.0.0.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters
class ServerInfo(health=None, details=None, client_trust_server=None, server_trust_client=None, name=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.ServerInfo class contains attributes that describe the status of a key server. This class was added in vSphere API 7.0.0.0.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • health (Providers.Health) – The connection status health of the server. This attribute was added in vSphere API 7.0.0.0.

  • details (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Details regarding the health of the server connection.

    When the service Providers.Health is not Providers.Health.OK, this attribute will provide an actionable description of the issue.. This attribute was added in vSphere API 7.0.0.0.

  • client_trust_server (bool) – Whether this client trusts the server. This attribute was added in vSphere API 7.0.0.0.

  • server_trust_client (bool) – Whether the server trusts this client. This attribute was added in vSphere API 7.0.0.0.

  • name (str) – Name of the server. This attribute was added in vSphere API 7.0.0.0.

class Status(health=None, details=None, servers=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.Status class contains attributes that describe the status of the Key Provider. This class was added in vSphere API 7.0.0.0.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • health (Providers.Health) – The health of the provider. This attribute was added in vSphere API 7.0.0.0.

  • details (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Details regarding the health of the provider.

    When the service Providers.Health is not Providers.Health.OK, this attribute will provide an actionable description of the issue.. This attribute was added in vSphere API 7.0.0.0.

  • servers (list of Providers.ServerInfo) – Health of the key servers. This attribute was added in vSphere API 7.0.0.0.

class Summary(provider=None, health=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.Summary class contains attributes that summarize a provider. This class was added in vSphere API 7.0.0.0.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • provider (str) –

    Name of the provider.

    A unique string chosen by the client.. This attribute was added in vSphere API 7.0.0.0. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

  • health (Providers.Health) – Health of the provider in the cluster. This attribute was added in vSphere API 7.0.0.0.

class UpdateSpec(master_key_id=None, key_server=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.UpdateSpec class contains attributes that describe the new configuration for an existing provider. This class was added in vSphere API 7.0.0.0.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • master_key_id (str or None) –

    Master key identifier created for the provider.

    A unique Key identifier.

    . This attribute was added in vSphere API 7.0.0.0. If None, masterKeyId will remain unchanged.

  • key_server (Providers.KeyServerUpdateSpec or None) –

    Key server associated with this provider.

    . This attribute was added in vSphere API 7.0.0.0. If None, key server configuration will remain unchanged.

create_task(cluster, spec)

Add a new Key Provider. This method was added in vSphere API 7.0.0.0.

Parameters

  • cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

  • spec (Providers.CreateSpec) – Provider information.

Raise

com.vmware.vapi.std.errors_client.AlreadyExists If the provider already exists.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If the spec is invalid or cluster id is empty.

Raise

com.vmware.vapi.std.errors_client.NotFound If the cluster is not found.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated If the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.Error For any other error.

delete_task(cluster, provider)

Remove a Key Provider. This method was added in vSphere API 7.0.0.0.

Parameters

  • cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

  • provider (str) – Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If the cluster or provider id is empty.

Raise

com.vmware.vapi.std.errors_client.NotFound If the cluster or provider is not found.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated If the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.Error For any other error.

get_task(cluster, provider)

Return information about a Key Provider. This method was added in vSphere API 7.0.0.0.

Parameters

  • cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

  • provider (str) – Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

Return type

class

vmware.vapi.stdlib.client.task.Task

Returns

Task instance

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If the cluster or provider id is empty.

Raise

com.vmware.vapi.std.errors_client.NotFound If the cluster or provider is not found.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated If the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.Error For any other error.

list_task(cluster)

Return a list of summary of Key Providers. This method was added in vSphere API 7.0.0.0.

Parameters

cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Return type

class

vmware.vapi.stdlib.client.task.Task

Returns

Task instance

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If the cluster id is empty.

Raise

com.vmware.vapi.std.errors_client.NotFound If the cluster is not found.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated If the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.Error For any other error.

update_task(cluster, provider, spec)

Update an existing Key Provider. This method was added in vSphere API 7.0.0.0.

Parameters

  • cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

  • provider (str) – Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

  • spec (Providers.UpdateSpec) – Provider information.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If the cluster or provider id is empty, or the spec is invalid.

Raise

com.vmware.vapi.std.errors_client.NotFound If the cluster or provider is not found.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated If the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.Error For any other error.

class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The ServiceStatus class provides methods to get the Key Provider Service health status. This class was added in vSphere API 7.0.0.0.

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

class Health(string)

Bases: vmware.vapi.bindings.enum.Enum

The ServiceStatus.Health class defines the possible service health states. This enumeration was added in vSphere API 7.0.0.0.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters

string (str) – String value for the Health instance.

ERROR = Health(string='ERROR')

Service is not functioning. This class attribute was added in vSphere API 7.0.0.0.

NONE = Health(string='NONE')

No status available. This class attribute was added in vSphere API 7.0.0.0.

OK = Health(string='OK')

Service is functioning normally. This class attribute was added in vSphere API 7.0.0.0.

WARNING = Health(string='WARNING')

Service is functioning, however there is an issue that requires attention. This class attribute was added in vSphere API 7.0.0.0.

class Info(health=None, details=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The ServiceStatus.Info class contains information that describes the status of the service. This class was added in vSphere API 7.0.0.0.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters
get_task(cluster)

Return the Key Provider Service health in the given cluster. This method was added in vSphere API 7.0.0.0.

Parameters

cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Return type

class

vmware.vapi.stdlib.client.task.Task

Returns

Task instance

Raise

com.vmware.vapi.std.errors_client.Error For any other error.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If the cluster id is empty.

Raise

com.vmware.vapi.std.errors_client.NotFound If the cluster is not found.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated If the caller is not authenticated.

class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance