com.vmware.esx.settings.clusters.software.reports.hardware_compatibility package

Submodules

com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client module

class com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus(config)

Bases: VapiInterface

This class provides methods to manage hardware hardware compatibility overrides for storage devices. This class was added in vSphere API 7.0.2.1.

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

class ComplianceAction(string)

Bases: Enum

The ComplianceStatus.ComplianceAction class enumerates the possible compliance status overrides for a storage device. 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 ComplianceAction instance.

FLAG_AS_INCOMPATIBLE = ComplianceAction(string='FLAG_AS_INCOMPATIBLE'): Specifying this override for a storage device would flag the drive as non-compliant with VMware Compatibility Guide (VCG). This class attribute was added in vSphere API 7.0.2.1.

MARK_AS_VERIFIED = ComplianceAction(string='MARK_AS_VERIFIED'): Specifying this override for a storage device would ignore the compatibility issues if any, and treat the drive as compliant with VMware Compatibility Guide (VCG). This class attribute was added in vSphere API 7.0.2.1.

SUPPRESS_WARNING = ComplianceAction(string='SUPPRESS_WARNING'): Specifying this override for a storage device would suppress the compatibility issues if any. This class attribute was added in vSphere API 7.0.2.1.

class Key(model=None, vendor=None, capacity=None, part_number=None, firmware_version=None, driver_name=None, driver_version=None, release=None, validated_features_in_use=None)

Bases: VapiStruct

The ComplianceStatus.Key class specifies information about the storage device for which this override must be applied to. 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) –
vendor (str) –
capacity (long) –
part_number (str or None) – storage device part number. This attribute was added in vSphere API 7.0.2.1. If None the override will be applied to the entries without a part number.
firmware_version (str or None) – storage device firmware version. This attribute was added in vSphere API 7.0.2.1. If None the override is applied to the entries with an unknown firmware version.
driver_name (str or None) – Driver name of this storage device if applicable/available. 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 of this storage device if applicable/available. 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.
release (str or None) – vSphere release that an override must be applied to. This attribute was added in vSphere API 7.0.2.1. If this attribute is unset, com.vmware.vapi.std.errors_client.InvalidArgument is thrown. The field is left optional to support wildcard matching in a future release.
validated_features_in_use ((dict of ComplianceStatus.Service and set of str) or None) – Validated features for which this override applies If a service is specified but no specific features are included, the device is taken to be in use by the service. This attribute was added in vSphere API 8.0.0.1. If this attribute is None this is taken to mean that the device is active for the vSAN service (and no specific features). This is done in order to support 7.0 U3 clients which do not set this field. Subset of validated features for which we provide certification - for example RDMA, not IPV6 Note that this list represents the features in actual current use, which could include features for which the device is not certified

class ReclassificationSpec(key=None, override=None)

Bases: VapiStruct

The ComplianceStatus.ReclassificationSpec class contains information about the storage device and the corresponding override that must be applied to the specified device. Note: This data structure is specifically limited to a ‘Key’/’Value’ pair to model smaller changes to the larger overall set of overrides applicable to a given 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:

key (ComplianceStatus.Key) – Information about the storage device for which this override must be applied to. This attribute was added in vSphere API 7.0.2.1.
override (ComplianceStatus.ComplianceAction or None) – Compliance status override for the stroage device. This attribute was added in vSphere API 7.0.2.1. If this attribute is None any existing compliance override for the specified device will be reset.

class Service(string)

Bases: Enum

The ComplianceStatus.Service class specifies information about vSphere services that have service 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 UpdateSpec(device_reclassifications=None)

Bases: VapiStruct

The ComplianceStatus.UpdateSpec class describes the updates to be made to the compatibility overrides for storage devices in a cluster. 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:: device_reclassifications (list of ComplianceStatus.ReclassificationSpec) – List of compatibility overrides to be applied for the storage devices in a cluster. This attribute was added in vSphere API 7.0.2.1.

update_task(cluster, update_spec)

Updates the Compliance staus overrides for storage devices in a cluster. This method also updates the existing com.vmware.esx.settings.clusters.software.reports_client.CheckResult if any, based on the device reclassification specified in ComplianceStatus.UpdateSpec The storage device categorization based on the compliance status from the last check result will remain the same until a com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.check() method is invoked. This method was added in vSphere API 7.0.2.1.

Parameters:

cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
update_spec (ComplianceStatus.UpdateSpec) – Specification for updating the compliance status overrides for storage devices in a cluster.

Raise:

com.vmware.vapi.std.errors_client.Error if there is an unknown 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 the cluster

Raise:

com.vmware.vapi.std.errors_client.InvalidArgument if one of the values in the update specification is invalid.

Raise:

com.vmware.vapi.std.errors_client.Unauthenticated if the user cannot be authenticated.

Raise:

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

class com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

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

class com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.VcgEntries(config)

Bases: VapiInterface

This class provides methods to manage VMware Compatibility Guide (VCG) product overrides for storage devices in a cluster. This class was added in vSphere API 7.0.2.1.

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

class Key(model=None, vendor=None, capacity=None, part_number=None, firmware_version=None)

Bases: VapiStruct

The VcgEntries.Key class specifies information about the storage device for which this override must be applied to. 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) –
vendor (str) –
capacity (long) –
part_number (str or None) – storage device part number. This attribute was added in vSphere API 7.0.2.1. If None the override will be applied to the entries without a part number.
firmware_version (str or None) – storage device firmware version. This attribute was added in vSphere API 7.0.2.1. If None the override is applied to all firmware versions.

class ProductSelectionSpec(key=None, vcg_product=None)

Bases: VapiStruct

The VcgEntries.ProductSelectionSpec class contains information about the storage device and the corresponding VMware Compatibility Guide (VCG) product override that must be applied to the specified 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:

key (VcgEntries.Key) – Information about the storage device for which this override must be applied to. This attribute was added in vSphere API 7.0.2.1.
vcg_product (str or None) – VMware Compatibility Guide (VCG) product selection that must be applied to the specified storage device. 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. if None any existing vcg selection for the storage device will be removed

class UpdateSpec(product_selections=None)

Bases: VapiStruct

The VcgEntries.UpdateSpec class desribes the updates to be made to the compatibility overrides for storage devices in a cluster. 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:: product_selections (list of VcgEntries.ProductSelectionSpec) – List of VMware Compatibility Guide (VCG) overrides to be applied for the storage devices in a cluster. This attribute was added in vSphere API 7.0.2.1.

update_task(cluster, update_spec)

Updates the storage device VMware Compatibility Guide (VCG) product overrides for a cluster. This method also updates the existing com.vmware.esx.settings.clusters.software.reports_client.CheckResult if any, based on the additional information provided by the vcg product overrides for the devices. The storage device categorization based on the compliance status from the last check result will remain the same until a com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.check() method is invoked. This method was added in vSphere API 7.0.2.1.

Parameters:

cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
update_spec (VcgEntries.UpdateSpec) – Specification for updating the compatibility overrides for the cluster.

Raise:

com.vmware.vapi.std.errors_client.Error if there is an unknown 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 the cluster

Raise:

com.vmware.vapi.std.errors_client.InvalidArgument if one of the values in the update specification is invalid.

Raise:

com.vmware.vapi.std.errors_client.Unauthenticated if the user cannot be authenticated.

Raise:

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.