com.vmware.vcenter.crypto_manager.hosts package¶

Submodules¶

com.vmware.vcenter.crypto_manager.hosts.kms_client module¶

The com.vmware.vcenter.crypto_manager.hosts.kms_client module provides classes for managing key providers.

class com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Providers class provides methods to retrieve providers on a host. This class was added in vSphere API 7.0.2.0.

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

class FilterSpec(providers=None, health=None, types=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.FilterSpec class contains attributes used to filter the results when listing providers. This class was added in vSphere API 7.0.2.0.

Tip

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

Parameters

providers (set of str or None) – Provider identifiers. This attribute was added in vSphere API 7.0.2.0. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: com.vmware.vcenter.crypto_manager.kms.provider. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: com.vmware.vcenter.crypto_manager.kms.provider. If None or empty, the result will not be filtered by provider identifier.
health (set of Providers.Health or None) – Provider health status. This attribute was added in vSphere API 7.0.2.0. If None or empty, the result will not be filtered by provider health status.
types (set of Providers.Type or None) – Provider types. This attribute was added in vSphere API 7.0.2.0. If None or empty, the result will not be filtered by provider type.

class Health(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Providers.Health class contains the health status of a provider. This enumeration was added in vSphere API 7.0.2.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')¶: There is a critical issue that requires attention. This class attribute was added in vSphere API 7.0.2.0.

NONE = Health(string='NONE')¶: No health status is available. This class attribute was added in vSphere API 7.0.2.0.

OK = Health(string='OK')¶: Operating normally. This class attribute was added in vSphere API 7.0.2.0.

WARNING = Health(string='WARNING')¶: Operating normally, but there is an issue that requires attention. This class attribute was added in vSphere API 7.0.2.0.

class Info(health=None, details=None, type=None, native_info=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.Info class contains attributes that describe the details of a provider. This class was added in vSphere API 7.0.2.0.

Tip

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

Parameters

health (Providers.Health) – Health status of the provider. This attribute was added in vSphere API 7.0.2.0.
details (list of com.vmware.vapi.std_client.LocalizableMessage) – Details regarding the health status of the provider. This attribute was added in vSphere API 7.0.2.0.
type (Providers.Type) – Provider type. This attribute was added in vSphere API 7.0.2.0.
native_info (Providers.NativeProviderInfo) – Native provider information. This attribute was added in vSphere API 7.0.2.0. This attribute is optional and it is only relevant when the value of type is Providers.Type.NATIVE.

class NativeProviderInfo(key_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.NativeProviderInfo class contains attributes that describe details of a native provider. This class was added in vSphere API 7.0.2.0.

Tip

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

Parameters: key_id (str) – Key identifier for the provider. This attribute was added in vSphere API 7.0.2.0.

class Summary(provider=None, type=None, health=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

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

Tip

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

Parameters

provider (str) – Identifier of the provider. This attribute was added in vSphere API 7.0.2.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.crypto_manager.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.crypto_manager.kms.provider.
type (Providers.Type) – Provider type. This attribute was added in vSphere API 7.0.2.0.
health (Providers.Health) – Health status of the provider. This attribute was added in vSphere API 7.0.2.0.

class Type(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Providers.Type class contains the types of providers. This enumeration was added in vSphere API 7.0.2.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.

NATIVE = Type(string='NATIVE')¶: Native provider. This class attribute was added in vSphere API 7.0.2.0.

TRUST_AUTHORITY = Type(string='TRUST_AUTHORITY')¶: Trust Authority provider. This class attribute was added in vSphere API 7.0.2.0.

get(host, provider)¶

Get a provider on a host. This method was added in vSphere API 7.0.2.0.

Parameters

host (str) – Host identifier. The parameter must be an identifier for the resource type: HostSystem.
provider (str) – Provider identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.crypto_manager.kms.provider.

Return type

Providers.Info

Returns

Information of the provider.

Raise

com.vmware.vapi.std.errors_client.Error if there is a generic error.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument if the host identifier is empty or the provider identifier is empty.

Raise

com.vmware.vapi.std.errors_client.NotFound if the provider or the host is not found.

Raise

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

Raise

com.vmware.vapi.std.errors_client.Unauthorized if the caller is not authorized.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

The resource HostSystem referenced by the parameter host requires Cryptographer.ReadKeyServersInfo.

list(host, filter_spec=None)¶

List the available providers on a host. This method was added in vSphere API 7.0.2.0.

Parameters

host (str) – Host identifier. The parameter must be an identifier for the resource type: HostSystem.
filter_spec (Providers.FilterSpec or None) – Filter spec. If None, the behavior is equivalent to a Providers.FilterSpec with all attributes None.

Return type

list of Providers.Summary

Returns

Summary of providers.

Raise

com.vmware.vapi.std.errors_client.Error if there is a generic error.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument if the host identifier is empty or the FilterSpec is invalid.

Raise

com.vmware.vapi.std.errors_client.NotFound if the host is not found.

Raise

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

Raise

com.vmware.vapi.std.errors_client.Unauthorized if the caller is not authorized.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

The resource HostSystem referenced by the parameter host requires Cryptographer.ReadKeyServersInfo.

class com.vmware.vcenter.crypto_manager.hosts.kms_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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