com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os package

Submodules

com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client module

The com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client module provides the interfaces for configuring ESX host metadata.

class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages(config)

Bases: VapiInterface

The BaseImages class provides methods to manage trusted instances of ESX software on a cluster level. 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 FilterSpec(version=None, display_name=None, health=None)

Bases: VapiStruct

The BaseImages.FilterSpec class contains the data necessary for identifying a Trust Authority Host in a cluster. 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:

  • version (set of str or None) – Search criteria by ESX base image version numbers. 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 contain identifiers for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage. version if None return all ESX version numbers.

  • display_name (set of str or None) – Search criteria by ESX base image version version numbers. This attribute was added in vSphere API 7.0.0.0. displayName if None return all ESX display version numbers.

  • health (set of BaseImages.Health or None) – Search criteria by health indicator. This attribute was added in vSphere API 7.0.0.0. health if None return all health indicators.

class Health(string)

Bases: Enum

The BaseImages.Health class is indicator for the consistency of the hosts status in the cluster. 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 all hosts in the cluster are in consistent state. 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')

Each host in the cluster is in consistent state with the rest hosts in the cluster. This class attribute was added in vSphere API 7.0.0.0.

WARNING = Health(string='WARNING')

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

class Info(display_name=None, last_attested_time=None, health=None, details=None)

Bases: VapiStruct

The BaseImages.Info class contains information that describes an ESX base image. 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:

  • display_name (str) – A unique ESX version formatted for display. This attribute was added in vSphere API 7.0.0.0.

  • last_attested_time (datetime.datetime or None) – The last time that an attestation completed successfully using this ESX base image. This attribute was added in vSphere API 8.0.1.0. If None, then there is no known last attestation time using this ESX base image.

  • health (BaseImages.Health) – A health indicator which indicates whether each host in the cluster has this version of the ESX base image. This attribute was added in vSphere API 7.0.0.0.

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

    Details regarding the health.

    When the BaseImages.Health is not BaseImages.Health.OK or BaseImages.Health.NONE, this member will provide an actionable description of the issues present.. This attribute was added in vSphere API 7.0.0.0.

RESOURCE_TYPE = 'com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage'

Resource type for ESX base image. This class attribute was added in vSphere API 7.0.0.0.

class Summary(version=None, display_name=None, health=None)

Bases: VapiStruct

The BaseImages.Summary class contains information that summarizes an ESX base image. 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:

  • version (str) – A unique ESX version number. 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.attestation.os.esx.BaseImage. 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.attestation.os.esx.BaseImage.

  • display_name (str) – A unique ESX version formatted for display. This attribute was added in vSphere API 7.0.0.0.

  • health (BaseImages.Health) – A health indicator which indicates whether each host in the cluster has this version of the ESX base image. This attribute was added in vSphere API 7.0.0.0.

delete_task(cluster, version)

Remove a trusted ESX base image of each ESX in the cluster. This method was added in vSphere API 7.0.0.0.

Parameters:

  • cluster (str) – The id of the cluster on which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

  • version (str) – The ESX base image version. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage.

Raise:

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

Raise:

com.vmware.vapi.std.errors_client.InvalidArgument if the version is invalid or the cluster id is empty.

Raise:

com.vmware.vapi.std.errors_client.NotFound if the version or cluster is not found.

Raise:

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

get_task(cluster, version)

Get the trusted ESX base version details. This method was added in vSphere API 7.0.0.0.

Parameters:

  • cluster (str) – The id of the cluster on which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

  • version (str) – The ESX base image version. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage.

Return type:

class:

vmware.vapi.stdlib.client.task.Task

Returns:

Task instance

Raise:

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

Raise:

com.vmware.vapi.std.errors_client.InvalidArgument if the version is invalid or the cluster id is empty.

Raise:

com.vmware.vapi.std.errors_client.NotFound if the version or cluster is not found.

Raise:

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

import_from_imgdb_task(cluster, imgdb)

Import ESX metadata as a new trusted base image to each host in the cluster.

Import a boot_imgdb.tgz file which contains metadata that describes a trusted ESX base image. A boot_imgdb.tgz file can be downloaded from a representative host.. This method was added in vSphere API 7.0.0.0.

Parameters:

  • cluster (str) – The id of the cluster on which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

  • imgdb (str) – ESX metadata on a cluster level.

Return type:

class:

vmware.vapi.stdlib.client.task.Task

Returns:

Task instance

Raise:

com.vmware.vapi.std.errors_client.AlreadyExists if ESX metadata for the same version has already been added.

Raise:

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

Raise:

com.vmware.vapi.std.errors_client.InvalidArgument if the imgdb 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.

list_task(cluster, spec=None)

Return a list of trusted ESX base images. This method was added in vSphere API 7.0.0.0.

Parameters:

  • cluster (str) – The id of the cluster on which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

  • spec (BaseImages.FilterSpec or None) – The search specification. if None return all information.

Return type:

class:

vmware.vapi.stdlib.client.task.Task

Returns:

Task instance

Raise:

com.vmware.vapi.std.errors_client.Error if there is a generic 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.os.esx_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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