com.vmware.esx.settings.clusters.software package¶

Subpackages¶

Submodules¶

com.vmware.esx.settings.clusters.software.drafts_client module¶

The com.vmware.esx.settings.clusters.software.drafts_client module provides classes to manage software drafts for ESX cluster.

class com.vmware.esx.settings.clusters.software.drafts_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.esx.settings.clusters.software.reports_client module¶

The com.vmware.esx.settings.clusters.software.reports_client module provides classes to manage reports pertaining to the desired state software for a cluster of ESXi hosts.

class com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The ApplyImpact class provides methods to get the impact of an apply method on a cluster.

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

class ApplyImpactSpec(hosts=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ApplyImpact.ApplyImpactSpec class contains attributes that describe the specification to be used for getting the impact of an apply method on an ESXi cluster.

Tip

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

Parameters: hosts (set of str or None) – The specific hosts for which an impact is to be generated. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: HostSystem. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: HostSystem. if None or empty impact is generated for all hosts within the cluster.

class ClusterImpact(impact=None, host_impact=None, commit=None, host_info=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ApplyImpact.ClusterImpact class contains attributes that describe the summary of how hosts within a cluster will be impacted during an apply method.

Tip

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

Parameters

impact (list of ApplyImpact.Impact) – Impact of steps performed during the setup and cleanup phase of the apply method.
host_impact (dict of str and list of ApplyImpact.Impact) – Impact summary for each host within the clsuter. When clients pass a value of this class as a parameter, the key in the attribute dict must be an identifier for the resource type: HostSystem. When methods return a value of this class as a return value, the key in the attribute dict will be an identifier for the resource type: HostSystem.
commit (str) – Identifier of the commit on which the impact is generated. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.settings.commit. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.esx.settings.commit.
host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Information of hosts within the cluster. When clients pass a value of this class as a parameter, the key in the attribute dict must be an identifier for the resource type: HostSystem. When methods return a value of this class as a return value, the key in the attribute dict will be an identifier for the resource type: HostSystem.

class Impact(message=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ApplyImpact.Impact class contains attributes that describe what the impact is of a particular step during the apply method.

Tip

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

Parameters: message (com.vmware.vapi.std_client.LocalizableMessage) – Description of the impact.

get(cluster, spec=None)¶

Returns a summary of how hosts within the cluster will be impacted during an apply method. The impact is generated from the compliance information obtained from com.vmware.esx.settings.clusters.software_client.Compliance.get()

Parameters

cluster (str) – The cluster identifier. The parameter must be an identifier for the resource type: ClusterComputeResource.
spec (ApplyImpact.ApplyImpactSpec or None) – Specification for how much information should be returned.

Return type

ApplyImpact.ClusterImpact

Returns

Summary of how hosts will be impacted during an apply method

Raise

com.vmware.vapi.std.errors_client.Error If there is an unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no cluster associated with cluster in the system.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

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

Raise

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

Method execution requires VcIntegrity.lifecycleSoftwareRemediation.Read.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareRemediation.Read.

class com.vmware.esx.settings.clusters.software.reports_client.CheckResult(status=None, scan_time=None, updated_since_last_check=None, v_san_data_only=None, commit=None, base_image_version=None, pci_device_compliance=None, storage_device_compliance=None, notifications=None, note=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The CheckResult class contains information to describe HCL compliance result of a cluster on target software specification.

Tip

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

Parameters

status (ComplianceStatus) – Overall compliance status of Cluster with respective to all hosts in the cluster.
scan_time (datetime.datetime) – HCL Validation check time.
updated_since_last_check (bool) – Flag to indicate if there were any hardware compatibility overrides were performed after the last check method. This attribute was added in vSphere API 7.0.2.1. This attribute is optional because it was added in a newer version than its parent node.
v_san_data_only (bool or None) – HCL Validation Computed only for vSAN Clusters. None to show vSAN in UI
commit (str or None) – Spec Identifier of the desired configuration on which the HCL scan is performed to generate this result, populated by the HCL validation. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.settings.commit. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.esx.settings.commit. This attribute will be None if validation was performed against a draft.
base_image_version (str) – Target base image version E.g., version = BaseImageSpec->Version com.vmware.esx.settings_client.BaseImageSpec.version class
pci_device_compliance (PciDeviceCompliance or None) – Compliance result for the Pci Devices that are present in all hosts of the cluster. This attribute will be None if Pci device compliance was not computed.
storage_device_compliance (StorageDeviceCompliance or None) – Compliance result for storage devices in all the hosts of the cluster. Currently only includes SAS/SATA storage devices. This attribute was added in vSphere API 7.0.2.1. This attribute will be None if storage device compliance was not computed.
notifications (com.vmware.esx.settings_client.Notifications) – Notifications returned by the HCL Validation operation.
note (com.vmware.vapi.std_client.LocalizableMessage) – Localizable disclaimer notice to show on the UI detailing the type of checks are done by the HCL Validaiton. Example : HCL Validation is only done on storage and network controllers.

class com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The ComplianceStatus class contains the possible different status of compliance with respect to target version.

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 ComplianceStatus instance.

COMPATIBLE = ComplianceStatus(string='COMPATIBLE')¶: Target hardware is compliant with VMware Compatibility Guide (VCG)

HCL_DATA_UNAVAILABLE = ComplianceStatus(string='HCL_DATA_UNAVAILABLE')¶: HCL data can not be fetched to validate cluster hardware.

INCOMPATIBLE = ComplianceStatus(string='INCOMPATIBLE')¶: Target hardware is not (recognizably) compliant with VMware Compatibility Guide (VCG)

NO_FIRMWARE_PROVIDER = ComplianceStatus(string='NO_FIRMWARE_PROVIDER')¶: No Firmware HSM present in Software Spec to get Firmware Details com.vmware.esx.settings_client.HardwareSupportPackageInfo class

UNAVAILABLE = ComplianceStatus(string='UNAVAILABLE')¶: Target hardware compliance with VMware Compatibility Guide (VCG) cannot be determined.

class com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The ComplianceStatusDetail class contains the essential status values for compliance with respect to target VMware Compatibility Guide (VCG). This enumeration was added in vSphere API 7.0.2.1.

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 ComplianceStatusDetail instance.

CERTIFIED = ComplianceStatusDetail(string='CERTIFIED')¶: Hardware is specifically certified for target vSphere version according to the VCG/HCL. This class attribute was added in vSphere API 7.0.2.1.

FIRMWARE_VERSION_UNKNOWN = ComplianceStatusDetail(string='FIRMWARE_VERSION_UNKNOWN')¶: No firmware version information is available (for example no Hardware Support Manager, HSM, configured in the cluster’s Software Spec to get Firmware Details com.vmware.esx.settings_client.HardwareSupportPackageInfo class or the system failed to retrieve the current firmware version of a device using the specified HSM. This class attribute was added in vSphere API 7.0.2.1.

HCL_DATA_UNAVAILABLE = ComplianceStatusDetail(string='HCL_DATA_UNAVAILABLE')¶: HCL data can not be fetched to validate cluster hardware. This class attribute was added in vSphere API 7.0.2.1.

HOSTS_UNAVAILABLE = ComplianceStatusDetail(string='HOSTS_UNAVAILABLE')¶: Hosts in cluster are not available to validate cluster hardware. This class attribute was added in vSphere API 7.0.2.1.

MUTED = ComplianceStatusDetail(string='MUTED')¶: When a user requests a non-compliance or HCL compliance unavailable warning to be suppressed. This class attribute was added in vSphere API 7.0.2.1.

NOT_CERTIFIED = ComplianceStatusDetail(string='NOT_CERTIFIED')¶: Hardware is specifically not certified for target vSphere version according to the VCG/HCL. This class attribute was added in vSphere API 7.0.2.1.

UNKNOWN = ComplianceStatusDetail(string='UNKNOWN')¶: When given hardware may be certified for a release but its status can’t be definitively determined due to ambiguity in server model, CPU series, or BIOS version. This class attribute was added in vSphere API 7.0.2.1.

USER_FLAGGED = ComplianceStatusDetail(string='USER_FLAGGED')¶: When a server or device’s HCL compliance status has been overridden by the user to mark the system as non-compliant. This class attribute was added in vSphere API 7.0.2.1.

USER_VERIFIED = ComplianceStatusDetail(string='USER_VERIFIED')¶: When a server or device’s HCL compliance status has been overridden by the user to mark the system as compliant. This class attribute was added in vSphere API 7.0.2.1.

VENDOR_UPDATE = ComplianceStatusDetail(string='VENDOR_UPDATE')¶: When BIOS or firmware has been updated from a certified entry found in the VMware Compatibility Guide (VCG). This class attribute was added in vSphere API 7.0.2.1.

class com.vmware.esx.settings.clusters.software.reports_client.DriverFirmwareVersion(driver_version=None, firmware_version=None, driver_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The DriverFirmwareVersion class contains information about device’s driver and firmware version combination from Hardware Compatibility List or from the target versions from the desired state.

Tip

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

Parameters

driver_version (str) – Driver Version.
firmware_version (str) – Firmware Version. This will be an empty string if the target firmware version cannot be determined.
driver_name (str) – Driver Name.

class com.vmware.esx.settings.clusters.software.reports_client.FirmwareVersionMatchingCriteria(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The FirmwareVersionMatchingCriteria class contains the criteria for firmware version comparison. This enumeration was added in vSphere API 8.0.0.1.

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 FirmwareVersionMatchingCriteria instance.

EXACT = FirmwareVersionMatchingCriteria(string='EXACT')¶

MINIMUM = FirmwareVersionMatchingCriteria(string='MINIMUM')¶

class com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The HardwareCompatibility class provides methods to manage HCL Validation of a software specification of an ESX cluster.

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

class CheckSummary(status=None, scan_time=None, commit=None, base_image_version=None, summary_result=None, notifications=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The HardwareCompatibility.CheckSummary class contains information to describe the HCL compliance summary result of a cluster on target software specification.

Tip

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

Parameters

status (HardwareCompatibility.ComplianceStatus) – Overall compliance status of the cluster with respective to all hosts in the cluster.
scan_time (datetime.datetime) – HCL Validation check time.
commit (str or None) – Spec Identifier of the desired configuration on which the HCL scan is performed to generate this result, populated by the HCL validation. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.settings.commit. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.esx.settings.commit. This attribute will be None if validation was performed against a draft.
base_image_version (str) – Target base image version E.g., version = BaseImageSpec->Version com.vmware.esx.settings_client.BaseImageSpec.version class
summary_result (com.vmware.vapi.std_client.LocalizableMessage) – Over all Compliance result for cluster for the software specification.
notifications (com.vmware.esx.settings_client.Notifications) – Notifications returned by the HCL Validation operation.

class ComplianceStatus(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The HardwareCompatibility.ComplianceStatus class contains the possible different status of compliance with respect to target version.

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 ComplianceStatus instance.

COMPATIBLE = ComplianceStatus(string='COMPATIBLE')¶

Target hardware is compliant with VCG/HCL. This includes (from the ComplianceStatusDetail:

COMPLIANT
VENDOR_UPDATE
USER_OVERRIDE

HCL_DATA_UNAVAILABLE = ComplianceStatus(string='HCL_DATA_UNAVAILABLE')¶: HCL data can not be fetched to validate cluster hardware.

INCOMPATIBLE = ComplianceStatus(string='INCOMPATIBLE')¶

Target hardware is not (recognizably) compliant with VCG/HCL This includes (from the ComplianceStatusDetail):

NONCOMPLIANT
USER_FLAGGED
NONCOMPLIANCE_MUTED

NO_FIRMWARE_PROVIDER = ComplianceStatus(string='NO_FIRMWARE_PROVIDER')¶: No Firmware HSM present in Software Spec to get Firmware Details com.vmware.esx.settings_client.HardwareSupportPackageInfo class

UNAVAILABLE = ComplianceStatus(string='UNAVAILABLE')¶

Target hardware compliance with VCG/HCL cannot be determined This includes (from the ComplianceStatusDetail):

HCL_DATA_UNAVAILABLE
UNAVAILABLE
NO_FIRMWARE_PROVIDER
UNKNOWN

check_task(cluster)¶

Initiates a Cluster HCL Validation check for a given cluster. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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 If there is some other unknown internal error. The accompanying error message will give more details about the failure and any possible resolution(s).

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no cluster associated with cluster in the system.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

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

get(cluster)¶

Returns the HCL validation check summary.

Parameters

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

Return type

HardwareCompatibility.CheckSummary

Returns

CheckSummary HCL validation summary.

Raise

com.vmware.vapi.std.errors_client.Error If there is some other unknown internal error. The accompanying error message will give more details about the failure and any possible resolution(s).

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no cluster associated with cluster in the system.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

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

Raise

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

Method execution requires VcIntegrity.HardwareCompatibility.Read.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.HardwareCompatibility.Read.

class com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The LastApplyResult class provides methods to get the most recent available result of applying the desired software document to all hosts within a cluster.

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

class ApplyResult(status=None, commit=None, host_info=None, host_status=None, successful_hosts=None, failed_hosts=None, skipped_hosts=None, notifications=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LastApplyResult.ApplyResult class contains attributes that describe the result of an apply method.

Tip

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

Parameters

status (LastApplyResult.ApplyStatus) – Specifies the aggregated status of the apply method.
commit (str) – The identifier of the commit used to fetch the desired software document to be applied to all hosts within the cluster. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.settings.commit. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.esx.settings.commit.
host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Information of the hosts in this cluster to which the desired software document specified by the LastApplyResult.ApplyResult.commit should be applied to. When clients pass a value of this class as a parameter, the key in the attribute dict must be an identifier for the resource type: HostSystem. When methods return a value of this class as a return value, the key in the attribute dict will be an identifier for the resource type: HostSystem.
host_status (dict of str and LastApplyResult.ApplyStatus) – Status of the hosts in this cluster to which the desired software document specified by the LastApplyResult.ApplyResult.commit was applied to. Hosts on which the apply method was sucessful are specified by LastApplyResult.ApplyResult.successful_hosts. Hosts on which the apply method failed are specified by LastApplyResult.ApplyResult.failed_hosts. Hosts which were skipped by the apply method are specified by LastApplyResult.ApplyResult.skipped_hosts. When clients pass a value of this class as a parameter, the key in the attribute dict must be an identifier for the resource type: HostSystem. When methods return a value of this class as a return value, the key in the attribute dict will be an identifier for the resource type: HostSystem.
successful_hosts (set of str) – Hosts in this cluster to which the desired software document specified by the LastApplyResult.ApplyResult.commit has been successfully applied to. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: HostSystem. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: HostSystem.
failed_hosts (set of str) – Hosts in this cluster to which the desired software document specified by the LastApplyResult.ApplyResult.commit failed to be applied to. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: HostSystem. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: HostSystem.
skipped_hosts (set of str) – Hosts in this cluster that were skipped by the apply method. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: HostSystem. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: HostSystem.
notifications (com.vmware.esx.settings_client.Notifications or None) – Notifications providing additional information for com.vmware.esx.settings.clusters_client.Software.apply() method. These notifications are mutually exclusive with the notifications in LastApplyResult.ApplyStatus. This attribute was added in vSphere API 7.0.2.1. This attribute is optional because it was added in a newer version than its parent node.

class ApplyStatus(status=None, progress=None, start_time=None, end_time=None, notifications=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LastApplyResult.ApplyStatus class contains attributes that describe the status of an apply method.

Tip

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

Parameters

status (LastApplyResult.ApplyStatus.Status) – The status of the method.
progress (com.vmware.cis.task_client.Progress or None) – Progress of the operation. This attribute was added in vSphere API 7.0.2.1. None for #ApplyStatus of the cluster
start_time (datetime.datetime) – Time when the method started.
end_time (datetime.datetime) – Time when the method completed.
notifications (com.vmware.esx.settings_client.Notifications) – Notifications providing additional information about the status of the method.

class Status(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The LastApplyResult.ApplyStatus.Status class contains the possible different status codes that can be returned while trying to apply the desired software specification to hosts within the cluster.

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 Status instance.

ERROR = Status(string='ERROR')¶: The method encountered an unspecified error.

OK = Status(string='OK')¶: The method completed successfully.

RETRY_PENDING = Status(string='RETRY_PENDING')¶: The method is being scheduled for retry. This class attribute was added in vSphere API 7.0.2.1.

SKIPPED = Status(string='SKIPPED')¶: The method was skipped.

TIMED_OUT = Status(string='TIMED_OUT')¶: The method timed out.

get(cluster)¶

Returns the most recent available result of applying the desired software document to all hosts within the cluster.

Parameters

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

Return type

LastApplyResult.ApplyResult

Returns

Most recent available result of applying the desired software document to all hosts within the cluster.

Raise

com.vmware.vapi.std.errors_client.Error If there is an unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no cluster associated with cluster in the system or if there is no result associated with the cluster cluster

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

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

Raise

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

Method execution requires VcIntegrity.lifecycleSoftwareRemediation.Read.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareRemediation.Read.

class com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The LastCheckResult class provides methods to get the most recent available result of the checks that have been run on a cluster before the application of the desired software document to all hosts within the cluster.

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

class CheckInfo(check=None, name=None, description=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LastCheckResult.CheckInfo class contains attributes that describe a particular check.

Tip

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

Parameters

check (str) – The check identifier.
name (com.vmware.vapi.std_client.LocalizableMessage) – The check name.
description (com.vmware.vapi.std_client.LocalizableMessage) – Human-readable check description.

class CheckResult(status=None, start_time=None, end_time=None, commit=None, host_info=None, entity_results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LastCheckResult.CheckResult class contains attributes that describe aggregated status of all checks performed.

Tip

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

Parameters

status (LastCheckResult.Status) – Aggregated status from all checks performed.
start_time (datetime.datetime) – Time when the operation started.
end_time (datetime.datetime) – Time when the operation completed.
commit (str) – The identifier of the commit on which checks have been run. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.settings.commit. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.esx.settings.commit.
host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Information about the hosts in this cluster for which checks have been requested to be run. When clients pass a value of this class as a parameter, the key in the attribute dict must be an identifier for the resource type: HostSystem. When methods return a value of this class as a return value, the key in the attribute dict will be an identifier for the resource type: HostSystem.
entity_results (list of LastCheckResult.EntityCheckResult) – List of LastCheckResult.EntityCheckResult for all entities for which checks have been run.

class CheckStatus(check=None, status=None, issues=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LastCheckResult.CheckStatus class contains attributes that describe a check result.

Tip

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

Parameters

check (LastCheckResult.CheckInfo) – Information about this check.
status (LastCheckResult.Status) – The status of this check.
issues (list of com.vmware.vapi.std_client.LocalizableMessage) – The issues encountered while running this check.

class EntityCheckResult(type=None, cluster=None, host=None, status=None, check_statuses=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LastCheckResult.EntityCheckResult class contains attributes that describe aggregated status of all checks performed on a specific entity.

Tip

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

Parameters

type (LastCheckResult.EntityCheckResult.EntityType) – The entity type for which these checks are being run.
cluster (str) – If the entity type is CLUSTER then the cluster identifier for which the checks have been run. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: ClusterComputeResource. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: ClusterComputeResource. This attribute is optional and it is only relevant when the value of type is LastCheckResult.EntityCheckResult.EntityType.CLUSTER.
host (str) – If the entity type is HOST then the host identifier for which the checks have been run. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: HostSystem. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: HostSystem. This attribute is optional and it is only relevant when the value of type is LastCheckResult.EntityCheckResult.EntityType.HOST.
status (LastCheckResult.Status) – Aggregated status from all checks performed on this entity.
check_statuses (list of LastCheckResult.CheckStatus) – List of LastCheckResult.CheckStatus for all checks performed.

class EntityType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The LastCheckResult.EntityCheckResult.EntityType class contains the entitites on which checks can be performed.

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 EntityType instance.

CLUSTER = EntityType(string='CLUSTER')¶: Entity type Cluster

HOST = EntityType(string='HOST')¶: Entity type Host

class Status(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The LastCheckResult.Status class defines the status result for a particular check.

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 Status instance.

ERROR = Status(string='ERROR')¶: The check indicates an error.

OK = Status(string='OK')¶: The check indicates a success.

TIMEOUT = Status(string='TIMEOUT')¶: The check did not return in a timely manner.

WARNING = Status(string='WARNING')¶: The check indicates a warning.

get(cluster)¶

Returns the most recent available result of checks run on the cluster before the application of the desired software document to all hosts within the cluster.

Parameters

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

Return type

LastCheckResult.CheckResult

Returns

Most recent result available of the checks run on the cluster.

Raise

com.vmware.vapi.std.errors_client.Error If there is an unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no cluster associated with cluster in the system or if there is no result associated with the cluster cluster

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

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

Raise

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

Method execution requires VcIntegrity.lifecycleSoftwareRemediation.Read.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareRemediation.Read.

class com.vmware.esx.settings.clusters.software.reports_client.PciDevice(display_name=None, driver_name=None, vendor=None, vid=None, did=None, svid=None, ssid=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The PciDevice class contains information about a PCI Device.

Tip

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

Parameters

display_name (str) – Display name of the device.
driver_name (str) – Driver Name of the device.
vendor (str) – Vendor Name of the device.
vid (str) – PCI VID of the device.
did (str) – PCI DID of the device.
svid (str) – PCI SVID of the device.
ssid (str) – PCI SSID of the device.

class com.vmware.esx.settings.clusters.software.reports_client.PciDeviceCompliance(status=None, compatible_devices=None, incompatible_devices=None, incompatible_driver_firmware=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The PciDeviceCompliance class contains information that describe the compliance result of all pci device from all hosts in the clsuter with respect to the component present in the target software specification.

Tip

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

Parameters

status (ComplianceStatus) – Over all Compliance status of PCI Devices in Cluster with respective to all hosts in the cluster.
compatible_devices (list of PciDeviceComplianceInfo) – Compatible Device Compliance result for all devices present on all hosts in the cluster compared with the corresponding component in the software specification. The key is the DeviceName and value is the PciDeviceComplianceInfo object.
incompatible_devices (list of PciDeviceComplianceInfo) – Incompatible Device Compliance result for all devices present on all hosts in the cluster compared with the corresponding component in the software specification. The key is the DeviceName and value is the PciDeviceComplianceInfo object.
incompatible_driver_firmware (list of PciDeviceComplianceInfo) – Incompatible Driver Firmware combination Compliance result for all devices present on hosts in the cluster compared with the corresponding component in the software specification. The key is the DeviceName and value is the PciDeviceComplianceInfo object.

class com.vmware.esx.settings.clusters.software.reports_client.PciDeviceComplianceInfo(status=None, device=None, compatible_versions=None, host_info=None, target=None, validated_features_in_use=None, supported=None, constraints=None, compatibility_guide_link=None, notifications=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The PciDeviceComplianceInfo class contains information that describe the compliance of a pci device with respect to the component present in the target software specification.

Tip

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

Parameters

status (ComplianceStatus) – High-level compliance status of the device.
device (PciDevice) – Pci Device Details
compatible_versions (list of str) – List of vSphere Versions compatible for this device. This field is populated only for device found INCOMPATIBLE
host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Affected List of Host IDs where this device is found. When clients pass a value of this class as a parameter, the key in the attribute dict must be an identifier for the resource type: HostSystem. When methods return a value of this class as a return value, the key in the attribute dict will be an identifier for the resource type: HostSystem.
target (DriverFirmwareVersion) – Driver and Firmware Version from Image Specification.
validated_features_in_use (dict of Service and set of str) – Validated features in use on this device If Service is set but features is empty, device is active for solution Subset of validated features for which we provide certification - for example RDMA, not IPV6 Inclusion in this set of features is independent of the certification status of device. In other words it’s possible a device is configured to use a feature it is not certified. This attribute was added in vSphere API 8.0.0.1. This attribute is optional because it was added in a newer version than its parent node.
supported (list of DriverFirmwareVersion) – List of Supported Driver and Firmware Version combination from Harware Compatibility List.
constraints (list of PciDeviceConstraint) – List of Supported Driver and Firmware Version combination and corresponding supportedFeatures from VMware Compatibility Guide (VCG) listing for the given vSphere version. This attribute was added in vSphere API 8.0.0.1. This attribute is optional because it was added in a newer version than its parent node.
compatibility_guide_link (str or None) – Provides link to the VMware Compatibility Guide for further information on the compatibility. If None there is no VMware Compatibility link available as this is device used by VSAN.
notifications (com.vmware.esx.settings_client.Notifications or None) – Device Specific notifications describing the compliance result. This attribute will be None if there are no notifications

class com.vmware.esx.settings.clusters.software.reports_client.PciDeviceConstraint(firmware_version=None, firmware_version_match=None, driver_name=None, driver_version=None, supported_features=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The PciDeviceConstraint class contain information about PCI device’s hardware compatibility certification including details like driver and/or firmware versions and the set of validated features supported. This class was added in vSphere API 8.0.0.1.

Tip

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

Parameters

firmware_version (str or None) – Certified Firmware Version. This attribute was added in vSphere API 8.0.0.1. This attribute will be None - If there is no firware version specified for the device
firmware_version_match (FirmwareVersionMatchingCriteria or None) – Criteria for matching firmware version. This attribute was added in vSphere API 8.0.0.1. This attribute will be None when firmware version is not set
driver_name (str or None) – Certified Driver Name. This attribute was added in vSphere API 8.0.0.1. This attribute will be None If there is no driver certification for the device
driver_version (str or None) – Certified Driver Version(Exact Matching criteria). This attribute was added in vSphere API 8.0.0.1. This attribute will be None If there is no driver certification for the device.
supported_features (dict of Service and set of str) – Map of solutions and the corresponding features that the device is certified for in the VMware Compatibility Guide If map is empty, device is not certified for any specific solutions like vSAN. If Service is set but features are empty, means device is certified for solution. If Service is set and features is also set, means device is certified for specific features. This attribute was added in vSphere API 8.0.0.1.

class com.vmware.esx.settings.clusters.software.reports_client.Service(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Service class specifies information about vSphere solutions that have solution specific VMware compatibility Guide certification. This enumeration was added in vSphere API 8.0.0.1.

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 Service instance.

VSAN = Service(string='VSAN')¶

class com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceCompatibility(status=None, compatible_versions=None, supported_firmware_versions=None, constraints=None, vcg_product=None, model=None, partner=None, compatibility_guide_link=None, used_for_compliance=None, user_selected=None, notifications=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The StorageDeviceCompatibility class contains information that describe the compliance of a storage device with respect to the component present in the target software specification. This class was added in vSphere API 7.0.2.1.

Tip

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

Parameters

status (ComplianceStatus) – Compliance status of the storage device, when computed based on this VMware Compatibility Guide (VCG) listing. This attribute was added in vSphere API 7.0.2.1.
compatible_versions (list of str or None) – List of vSphere Versions compatible for this storage device. This attribute was added in vSphere API 7.0.2.1. This attribute will be None if the storage device is certified for the target ESXi version.
supported_firmware_versions (list of str or None) – List of minimum firmware versions supported from VMware Compatibility Guide (VCG) listing for the given vSphere version. This attribute was added in vSphere API 7.0.2.1. This attribute will be None if the storage device is not certified for the target ESXi version or the storage device is only certified in combination with specific driver versions, in which case listedDriverFirmwareVersions below will be set.
constraints (list of StorageDeviceConstraint) – List of Supported Firmware Versions and corresponding supported features from VMware Compatibility Guide (VCG) listing for the given vSphere version. This attribute was added in vSphere API 8.0.0.1. This attribute is optional because it was added in a newer version than its parent node.
vcg_product (str) – Identifier of the VMware Compatibility Guide (VCG) listing for the product. This attribute was added in vSphere API 7.0.2.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.settings.vcg_product. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.esx.settings.vcg_product.
model (str) – Model name of the storage device as listed in the VMware Compatibility Guide (VCG) listing. This may not be the same as the StorageDeviceInfo.model. This attribute was added in vSphere API 7.0.2.1.
partner (str) – OEM partner name of the storage device as listed in the VMware Compatibility Guide (VCG) listing. This attribute was added in vSphere API 7.0.2.1.
compatibility_guide_link (str) – Provides link to the VMware Compatibility Guide (VCG) listing for further information on the compatibility. This attribute was added in vSphere API 7.0.2.1.
used_for_compliance (bool) – Flag to indicate whether this VMware compatibility Guide (VCG) listing was used to compute the overall compatibility of the storage device. This attribute was added in vSphere API 7.0.2.1.
user_selected (bool) – Flag to indicate if the user has selected this VMware Compatibility Guide (VCG) listing to be considered to compute the overall compatibility of the storage device. This attribute was added in vSphere API 7.0.2.1.
notifications (com.vmware.esx.settings_client.Notifications or None) – VMware compatibility Guide (VCG) listing specific notifications describing the compliance result. This attribute was added in vSphere API 7.0.2.1. This attribute will be None if there are no notifications

class com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceCompliance(status=None, compatible_devices=None, incompatible_devices=None, unknown_devices=None, notifications=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The StorageDeviceCompliance class contains information that describe the compliance result of all storage devices from all hosts in the cluster with respect to the storage device model and the firmware certification. This class was added in vSphere API 7.0.2.1.

Tip

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

Parameters

status (ComplianceStatus) – Overall compliance status of storage devices in the cluster with respect to all hosts in the cluster. This attribute was added in vSphere API 7.0.2.1.
compatible_devices (list of StorageDeviceComplianceInfo) –
Lists compliance information for storage devices found to be compliant with VMware Compatibility Guide (VCG) during the last check method.

Note that complianceStatus of every device is not necessarily COMPATIBLE due to changes made after this check was run; entries are only rearranged when a new check method is invoked. lastOverrideTime being greater than the scanTime is an indication that there were changes made after the last check method. This attribute was added in vSphere API 7.0.2.1.
incompatible_devices (list of StorageDeviceComplianceInfo) –
Lists compliance information for storage devices found to be non-compliant with VMware Compatibility Guide (VCG) during the last check method.

Note that complianceStatus of every device is not necessarily INCOMPATIBLE due to changes made after this check was run; entries are only rearranged when a new check method is invoked. lastOverrideTime being greater than the scanTime is an indication that there were changes made after the last check method. This attribute was added in vSphere API 7.0.2.1.
unknown_devices (list of StorageDeviceComplianceInfo) –
Lists storage devices whose compliance information could not be computed successfully during the last check method.

Note that complianceStatus of every device is not necessarily UNAVAILABLE due to changes made after this check was run; entries are only rearranged when a new check method is invoked. lastOverrideTime being greater than the scanTime is an indication that there were changes made after the last check method. This attribute was added in vSphere API 7.0.2.1.
notifications (com.vmware.esx.settings_client.Notifications or None) – Storage device compliance specific notifications describing the compliance result. This attribute was added in vSphere API 7.0.2.1. This attribute will be None if there are no notifications

class com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceComplianceInfo(storage_device_info=None, device_count=None, status=None, detail=None, host_info=None, firmware_version=None, validated_features_in_use=None, driver_name=None, driver_version=None, matches=None, used_by_vsan=None, notifications=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The StorageDeviceComplianceInfo class contains attributes that describe the compliance information of a storage device. This class was added in vSphere API 7.0.2.1.

Tip

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

Parameters

storage_device_info (StorageDeviceInfo) – Information of the storage device. This attribute was added in vSphere API 7.0.2.1.
device_count (long) – Indicate the number of actual physical storage devices represented by this info. This attribute was added in vSphere API 8.0.0.1. This attribute is optional because it was added in a newer version than its parent node.
status (ComplianceStatus) – Compliance status of the storage device. When there are multiple possible VMware Compatibility Guide (VCG) matches for the storage device, the compliance status would be set to ComplianceStatus.UNAVAILABLE Each match found would be listed under StorageDeviceComplianceInfo.matches with the corresponding compliance status of the storage device if compared against the constraints specified in the match. This attribute was added in vSphere API 7.0.2.1.
detail (ComplianceStatusDetail) – Detailed compliance status of the storage device. This attribute was added in vSphere API 7.0.2.1.
host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Affected List of Host IDs where this device is found. This attribute was added in vSphere API 7.0.2.1. When clients pass a value of this class as a parameter, the key in the attribute dict must be an identifier for the resource type: HostSystem. When methods return a value of this class as a return value, the key in the attribute dict will be an identifier for the resource type: HostSystem.
firmware_version (str or None) – Firmware version on the storage device. This attribute was added in vSphere API 7.0.2.1. This attribute will be None if the firmware version on the storage device is unknown or cannot be determined.
validated_features_in_use (dict of Service and set of str) – Validated Features in use on the storage device If Service is set but features is empty, device is active for solution Subset of validated features for which we provide certification - for example RDMA, not IPV6 Inclusion in this set of features is independent of the certification status of device. In other words it’s possible a device is configured to use a feature it is not certified. This attribute was added in vSphere API 8.0.0.1. This attribute is optional because it was added in a newer version than its parent node.
driver_name (str or None) – Driver name on the storage device. This attribute was added in vSphere API 8.0.0.1. This attribute will be None if there is no driver associated with the device.
driver_version (str or None) – Driver Version on the storage device. This attribute was added in vSphere API 8.0.0.1. This attribute will be None if there is no driver associated with the device.
matches (list of StorageDeviceCompatibility) –
Provides information about possible compatibility matches for the given storage device.

There could be multiple possible matches available in the compatibility data.. This attribute was added in vSphere API 7.0.2.1.
used_by_vsan (bool) – Indicates if the storage device is in use by vSAN. When this flag is set to true, the hardware compatibility is computed against vSAN HCL constraints. This attribute was added in vSphere API 7.0.2.1.
notifications (com.vmware.esx.settings_client.Notifications or None) – Device Specific notifications describing the compliance result. This attribute was added in vSphere API 7.0.2.1. This attribute will be None if there are no notifications

class com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceConstraint(firmware_version=None, firmware_version_match=None, driver_name=None, driver_version=None, supported_features=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The StorageHclConstraint class contains information about Storage device’s hardware compatibility certification including details like driver and/or firmware versions and the set of validated features supported. This class was added in vSphere API 8.0.0.1.

Tip

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

Parameters

firmware_version (str or None) – Certified Firmware Version. This attribute was added in vSphere API 8.0.0.1. This attribute will be None- If there is no firware version specified for the device
firmware_version_match (FirmwareVersionMatchingCriteria or None) – Criteria for matching firmware version. This attribute was added in vSphere API 8.0.0.1. This attribute will be None when firmware version is not set
driver_name (str or None) – Certified Driver Name. This attribute was added in vSphere API 8.0.0.1. This attribute will be None If there is no driver certification for the device
driver_version (str or None) – Certified Driver Version. This attribute was added in vSphere API 8.0.0.1. This attribute will be None If there is no driver certification for the device
supported_features (dict of Service and set of str) – Map of solutions and the corresponding features that the device is certified for in the VMware Compatibility Guide If map is empty, device is not certified for any specific solutions like vSAN If Service is set but features are empty, means device is certified for solution. If Service is set and features is also set, means device is certified for specific features. This attribute was added in vSphere API 8.0.0.1. This attribute is optional because it was added in a newer version than its parent node.

class com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceInfo(model=None, vendor=None, part_number=None, capacity=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The StorageDeviceInfo class contains attributes describing a storage device. This class was added in vSphere API 7.0.2.1.

Tip

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

Parameters

model (str) – Storage device model. This attribute was added in vSphere API 7.0.2.1.
vendor (str) – Storage device vendor. This attribute was added in vSphere API 7.0.2.1.
part_number (str or None) – Hardware part number of the storage device. This attribute was added in vSphere API 7.0.2.1. This attribute will be unest if part number information is not available for the storage device.
capacity (long) – Capacity of the storage device in bytes. This attribute was added in vSphere API 7.0.2.1.

class com.vmware.esx.settings.clusters.software.reports_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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