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
ofstr
orNone
) – 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
ofApplyImpact.Impact
) – Impact of steps performed during the setup and cleanup phase of the apply method.host_impact (
dict
ofstr
andlist
ofApplyImpact.Impact
) – Impact summary for each host within the clsuter. When clients pass a value of this class as a parameter, the key in the attributedict
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 attributedict
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
ofstr
andcom.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 attributedict
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 attributedict
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
orNone
) – Specification for how much information should be returned.
- Return type
- 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 withcluster
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 parametercluster
requiresVcIntegrity.lifecycleSoftwareRemediation.Read
.
-
class
com.vmware.esx.settings.clusters.software.reports_client.
CheckResult
(status=None, scan_time=None, v_san_data_only=None, commit=None, base_image_version=None, pci_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.v_san_data_only (
bool
orNone
) – HCL Validation Computed only for vSAN Clusters. None to show vSAN in UIcommit (
str
orNone
) – 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
. None if validation is performed with no specbase_image_version (
str
) – Target base image version E.g., version = BaseImageSpec->Versioncom.vmware.esx.settings_client.BaseImageSpec.version
classpci_device_compliance (
PciDeviceCompliance
orNone
) – Compliance result for the Pci Devices that are present in all hosts of the cluster.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 theComplianceStatus
instance.
-
COMPATIBLE
= ComplianceStatus(string='COMPATIBLE')¶ Target version is compliant with cluster hardware
-
HCL_DATA_UNAVAILABLE
= ComplianceStatus(string='HCL_DATA_UNAVAILABLE')¶ HCL data can not be fetched to validate cluster hardware.
-
INCOMPATIBLE
= ComplianceStatus(string='INCOMPATIBLE')¶ Target version is not compatible with the device present in one of the hosts part of this cluster.
-
NO_FIRMWARE_PROVIDER
= ComplianceStatus(string='NO_FIRMWARE_PROVIDER')¶ No Firmware HSM present in Software Spec to get Firmware Details com.vmware.esx.settings.hardware_support#HardwareSupportPackageCompliance class
-
UNAVAILABLE
= ComplianceStatus(string='UNAVAILABLE')¶ Hosts in cluster are not available to validate cluster hardware.
-
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.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
driver_version (
str
) – Compatible Driver Version.firmware_version (
str
) – Compatible Firmware Version.driver_name (
str
) – Compatible Driver Name.
-
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 state of HCL Validation on the host.scan_time (
datetime.datetime
) – HCL Validation check time.commit (
str
orNone
) – 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
. None if validation is performed with no specbase_image_version (
str
) – Target base image version E.g., version = BaseImageSpec->Versioncom.vmware.esx.settings_client.BaseImageSpec.version
classsummary_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 theComplianceStatus
instance.
-
COMPATIBLE
= ComplianceStatus(string='COMPATIBLE')¶ Target version is compliant with cluster hardware.
-
HCL_DATA_UNAVAILABLE
= ComplianceStatus(string='HCL_DATA_UNAVAILABLE')¶ HCL data can not be fetched to validate cluster hardware.
-
INCOMPATIBLE
= ComplianceStatus(string='INCOMPATIBLE')¶ Target version is not compatible with the device present in one of the hosts which is part of this cluster.
-
NO_FIRMWARE_PROVIDER
= ComplianceStatus(string='NO_FIRMWARE_PROVIDER')¶ No Firmware HSM present in Software Spec to get Firmware Details com.vmware.esx.settings.hardware_support#HardwareSupportPackageCompliance class
-
UNAVAILABLE
= ComplianceStatus(string='UNAVAILABLE')¶ Hosts in cluster are not available to validate cluster hardware.
-
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.- Raise
com.vmware.vapi.std.errors_client.NotFound
If there is no cluster associated withcluster
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
- 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.- Raise
com.vmware.vapi.std.errors_client.NotFound
If there is no cluster associated withcluster
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 parametercluster
requiresVcIntegrity.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)¶ 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
ofstr
andcom.vmware.esx.settings_client.HostInfo
) – Information of the hosts in this cluster to which the desired software document specified by theLastApplyResult.ApplyResult.commit
should be applied to. When clients pass a value of this class as a parameter, the key in the attributedict
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 attributedict
will be an identifier for the resource type:HostSystem
.host_status (
dict
ofstr
andLastApplyResult.ApplyStatus
) – Status of the hosts in this cluster to which the desired software document specified by theLastApplyResult.ApplyResult.commit
was applied to. Hosts on which the apply method was sucessful are specified byLastApplyResult.ApplyResult.successful_hosts
. Hosts on which the apply method failed are specified byLastApplyResult.ApplyResult.failed_hosts
. Hosts which were skipped by the apply method are specified byLastApplyResult.ApplyResult.skipped_hosts
. When clients pass a value of this class as a parameter, the key in the attributedict
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 attributedict
will be an identifier for the resource type:HostSystem
.successful_hosts (
set
ofstr
) – Hosts in this cluster to which the desired software document specified by theLastApplyResult.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
ofstr
) – Hosts in this cluster to which the desired software document specified by theLastApplyResult.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
ofstr
) – 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
.
-
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
orNone
) – Progress of the operation. This attribute was added in vSphere API 7.0.1.0. None for #ApplyStatus of the clusterstart_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 theStatus
instance.
-
ERROR
= Status(string='ERROR')¶ The method encountered an unspecified error.
-
OK
= Status(string='OK')¶ The method completed successfully.
-
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
- 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 withcluster
in the system or if there is no result associated with the clustercluster
- 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 parametercluster
requiresVcIntegrity.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
ofstr
andcom.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 attributedict
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 attributedict
will be an identifier for the resource type:HostSystem
.entity_results (
list
ofLastCheckResult.EntityCheckResult
) – List ofLastCheckResult.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
ofcom.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 oftype
isLastCheckResult.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 oftype
isLastCheckResult.EntityCheckResult.EntityType.HOST
.status (
LastCheckResult.Status
) – Aggregated status from all checks performed on this entity.check_statuses (
list
ofLastCheckResult.CheckStatus
) – List ofLastCheckResult.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 theEntityType
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 theStatus
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
- 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 withcluster
in the system or if there is no result associated with the clustercluster
- 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 parametercluster
requiresVcIntegrity.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
ofPciDeviceComplianceInfo
) – 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
ofPciDeviceComplianceInfo
) – 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
ofPciDeviceComplianceInfo
) – 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, supported=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
) – Compliance status of the device.device (
PciDevice
) – Pci Device Detailscompatible_versions (
list
ofstr
) – List of vSphere Versions compatible for this device. This field is populated only for device found INCOMPATIBLEhost_info (
dict
ofstr
andcom.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 attributedict
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 attributedict
will be an identifier for the resource type:HostSystem
.target (
DriverFirmwareVersion
) – Driver and Firmware Version from Image Specification.supported (
list
ofDriverFirmwareVersion
) – List of Supported Driver and Firmware Version combination from Harware Compatibility List.compatibility_guide_link (
str
orNone
) – 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
orNone
) – Device Specific notifications describing the compliance result.
-
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