com.vmware.esx.settings.clusters package¶

Subpackages¶

Submodules¶

com.vmware.esx.settings.clusters.configuration_client module¶

The com.vmware.esx.settings.clusters.configuration_client module provides classes to manage the configuration of an ESX cluster. The com.vmware.esx.settings.clusters.configuration.reports_client module provides classes for accessing reports regarding the configuration state of the cluster.

class com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance(cluster_status=None, commit=None, software_commit=None, summary=None, host_info=None, hosts=None, compliant_hosts=None, non_compliant_hosts=None, failed_hosts=None, skipped_hosts=None, end_time=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This ClusterCompliance class contains attributes that describe the compliance result for each host in the cluster as well as overall cluster compliance status. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

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

Parameters

cluster_status (ClusterCompliance.Status) – Consolidated status of all host compliance checks. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
commit (str or None) – This identifier refers to the commit action of importing the desired configuration document. It will not be set for a draft execution of check compliance. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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.
software_commit (str) – The current commit ID for the software associated with the cluster. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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.
summary (com.vmware.vapi.std_client.LocalizableMessage) – Summarizing check compliance operation on the hosts in the cluster. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Map of host IDs to hostname. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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.
hosts (dict of str and HostResult) – Map of host IDs to their compliance results. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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.
compliant_hosts (set of str) – Identifiers of compliant hosts. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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.
non_compliant_hosts (set of str) – Identifiers of non-compliant hosts. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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) – Identifiers of hosts where the operation failed. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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) – Identifiers of hosts where the operation was skipped. i.e disconnected hosts. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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.
end_time (datetime.datetime) – CheckCompliance completion time. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

class Status(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Consolidated compliance status of the cluster. Warning: This enumeration is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

COMPLIANT = Status(string='COMPLIANT')¶: All hosts in the cluster are compliant. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

NOT_COMPLIANT = Status(string='NOT_COMPLIANT')¶

RUNNING = Status(string='RUNNING')¶: The task is in-progress. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

class com.vmware.esx.settings.clusters.configuration_client.ClusterPrecheckResult(status=None, commit=None, software_commit=None, end_time=None, summary=None, remediation_summary=None, remediation_notes=None, host_info=None, host_precheck=None, precheck_result=None, successful_hosts=None, failed_hosts=None, skipped_hosts=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The PrecheckResult class contains attributes that describe precheck status of applying the desired document to a group of hosts. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

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

Parameters

status (ClusterPrecheckResult.Status) – Overall status of precheck on the cluster. Operation is sucessfull when precheck is run on all hosts successfully and no validation or precheck errors are detected. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
commit (str or None) – This identifier refers to the commit action of importing the desired configuration document. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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 field is s not set for a precheck of a draft configuration.
software_commit (str) – The current commit ID for the software associated with the cluster. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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.
end_time (datetime.datetime) – Precheck completion time. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
summary (com.vmware.vapi.std_client.LocalizableMessage) – Summarizing precheck operation on the host and cluster. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
remediation_summary (list of com.vmware.vapi.std_client.LocalizableMessage) – Summarizing remediation stating number of hosts needing reboot and maintenance mode during remediation and number of precheck errors on host and cluster. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
remediation_notes (list of com.vmware.vapi.std_client.LocalizableMessage) – Static notes to the user describing steps that will be taken during remediation. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Map of host IDs to hostname. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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_precheck (dict of str and HostPrecheckResult) – Map of host IDs to their precheck results. If ClusterPrecheckResult.status is ERROR, This field will contain Validation errors or Host Impact and Health Check errors. If ClusterPrecheckResult.status is OK, This field will contain Impact and Health Check information. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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.
precheck_result (com.vmware.esx.settings_client.StatusInfo or None) – This field represents the precheck results on the cluster, if any one host in the cluster needs to be put in maintenance mode or to be rebooted. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This field is set if cluster prechecks are invoked.
successful_hosts (set of str) – Hosts in this cluster where the precheck was sucessfully run. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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 where the precheck failed to run. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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 where the precheck was not tried because the host was disconnected. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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 Status(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The ClusterPrecheckResult.Status class contains the possible statuses of the Precheck API on the cluster. Warning: This enumeration is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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 operation failed with errors. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

OK = Status(string='OK')¶: The operation completed successfully. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

RUNNING = Status(string='RUNNING')¶: The task is in-progress. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

class com.vmware.esx.settings.clusters.configuration_client.ComplianceInfo(sets=None, adds=None, deletes=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ComplianceInfo class contains attributes that describe the configuration drift between the desired document and the configurations on the ESXi host. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

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

Parameters

sets (list of SettingCompliance or None) – List of configuration drifts represented by SettingCompliance. Each describing a configuration whose value on ESXi host is different to that in the desired document. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This field is None if there are no drifts to report in this category.
adds (list of SettingCompliance or None) – List of configuration drifts represented by SettingCompliance. Each describing a configuration that is present in the desired document but absent on the ESXi host. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This field is None if there are no drifts to report in this category.
deletes (list of SettingCompliance or None) – List of configuration drifts represented by SettingCompliance. Each describing a configuration that is present on the ESXi host but absent in the desired document. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This field is None if there are no drifts to report in this category.

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

Bases: vmware.vapi.bindings.enum.Enum

This ComplianceStatus class represents the compliance status of desired configuration on the ESXi host. Warning: This enumeration is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

COMPLIANT = ComplianceStatus(string='COMPLIANT')¶: ESXi host is in compliance with Desired configuration. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

NON_COMPLIANT = ComplianceStatus(string='NON_COMPLIANT')¶: ESXi host is not in compliance with Desired configuration. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

class com.vmware.esx.settings.clusters.configuration_client.ConfigurationSpec(spec=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ConfigurationSpec class contains attributes that describe the desired configuration that is associated with a cluster. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

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

Parameters: spec (str) – Desired configuration document. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

class com.vmware.esx.settings.clusters.configuration_client.DocumentStructure(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The DocumentStructure class contains the possible structures of the configuration document. Warning: This enumeration is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

HOST_ORIENTED = DocumentStructure(string='HOST_ORIENTED')¶: The host-specific portions of the document are stored in the “host-specific” object at the top-level with entries for each host, organized by the host’s BIOS UUID. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

PROFILE_ORIENTED = DocumentStructure(string='PROFILE_ORIENTED')¶: The host-specific portions of the document are distributed through the “profile” object hierarchy. Each property that is host-specific will be an object with entries for each host where the property is defined. The hosts in the object are organized by BIOS UUID. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

class com.vmware.esx.settings.clusters.configuration_client.DraftImportResult(status=None, draft=None, error=None, warnings=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The DraftImportResult class contains attributes that describe the result of importing the desired configuration for a cluster into a draft.

Tip

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

Parameters

status (DraftImportResult.Status) – Status of importing desired configuration.
draft (str) – This identifier refers to the commit action of importing the desired configuration document. This identifier can be used in the apply API. 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.draft. 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.draft. This attribute is optional and it is only relevant when the value of status is DraftImportResult.Status.OK.
error (com.vmware.vapi.std_client.LocalizableMessage) – Localized message describing the error encountered while importing desired configuration. The import operation will fail if the configuration document is an invalid JSON. This attribute is optional and it is only relevant when the value of status is DraftImportResult.Status.ERROR.
warnings (list of com.vmware.vapi.std_client.LocalizableMessage or None) – Any issues found during the import are reported in this list.

class Status(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The DraftImportResult.Status class contains the possible status codes describing the result of importing desired configuration for a 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.

CANCELED = Status(string='CANCELED')¶

ERROR = Status(string='ERROR')¶: Desired configuration import failed with error.

OK = Status(string='OK')¶: Desired configuration imported successfully.

RUNNING = Status(string='RUNNING')¶: The task is in-progress.

class com.vmware.esx.settings.clusters.configuration_client.ExportResult(config=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This ExportResult class contains attributes that describe the result of exporting configuration from the cluster. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

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

Parameters: config (str) – Configuration of the cluster encoded as JSON. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

class com.vmware.esx.settings.clusters.configuration_client.HostCompliance(status=None, compliance_info=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The HostCompliance class contains attributes that describe compliance information for the ESXi host on which the Check Compliance operation completed successfully. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

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

Parameters

status (ComplianceStatus) – This field indicates whether the ESXi host is compliant with the desired configuration specified in com.vmware.esx.settings_daemon.Configuration#CheckComplianceSpec. If COMPLIANT, no other information is available. If NON_COMPLAINT, drift information can be fetched from {#ComplianceInfo}. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
compliance_info (ComplianceInfo) – Settings compliance information generated by the CheckCompliance operation. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This attribute is optional and it is only relevant when the value of status is ComplianceStatus.NON_COMPLIANT.

class com.vmware.esx.settings.clusters.configuration_client.HostPrecheckResult(status=None, summary=None, validation_errors=None, impact=None, precheck_result=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This HostPrecheckResult class contains attributes that describes the Precheck API result on a host. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

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

Parameters

status (HostStatus) – This field represents the status of the precheck request for this host. {link HostStatus#status} is ERROR or SKIPPED, if precheck was not completed on the host due to some error or if health checks failed. If precheck failed due to host validation errors, details are specified in HostPrecheckResult.validation_errors. If precheck failed due to generic error, details are specified in the HostPrecheckResult.summary. Health check result is specified in HostPrecheckResult.precheck_result. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
summary (com.vmware.vapi.std_client.LocalizableMessage) – Summarizing precheck operation on the host. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
validation_errors (list of ValidationError or None) – This field represents the validation errors if the desired configuration specified is not valid. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This field is set if #HostStatus#status is ERROR due to host returning validation errors.
impact (ImpactInfo or None) – This field represents the impact on the host to reach the desired configuration state. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This field is set if there are no validation errors on the host. The HostStatus.status may be OK or ERROR.
precheck_result (com.vmware.esx.settings_client.StatusInfo or None) – This field represents the health check results from the host, if the host needs to be put in maintenance mode or to be rebooted. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This field is set if there are not validation errors and health checks are run on the host. The HostStatus.status may be OK or ERROR.

class com.vmware.esx.settings.clusters.configuration_client.HostResult(host_status=None, summary=None, errors=None, host_compliance=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This HostResult class contains attributes that describe the result of the check compliance operation on an ESXi host. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

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

Parameters

host_status (HostStatus) – This field represents the status of the check compliance operation. If status is OK, the result of operation can be retrived from {#HostCompliance} {#Summary} field will summarize the status of the operation and if applicable, the specific error that occured. Additionally, {#ValidationError} is populated if the operation fails due to host validation errors in desired document. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
summary (com.vmware.vapi.std_client.LocalizableMessage) – Summary of check compliance operation on the host. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
errors (list of ValidationError or None) – List of validation errors returned by the host. This is only set for a specific HostStatus ERROR case. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This field is set only if the document fails to validate on the host.
host_compliance (HostCompliance or None) – This field provides compliance results for the host if the operation successfully completed on the host. That is, this field is populated only if HostStatus is OK. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This field is None if check compliance could not be completed on the host.

class com.vmware.esx.settings.clusters.configuration_client.HostStatus(status=None, attempts=None, remaining_retries=None, start_time=None, end_time=None, notifications=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The HostStatus class contains attributes that describe the status of an method. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

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

Parameters

status (HostStatus.Status) – The status of the method. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
attempts (long or None) – Number of the performed attempts of the method. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This field is None if it is not applicable.
remaining_retries (long or None) – Number of the remaining attempts of the method. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This field is None if it is not applicable.
start_time (datetime.datetime) – Time when the method started. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
end_time (datetime.datetime) – Time when the method completed. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
notifications (com.vmware.esx.settings_client.Notifications) – Notifications providing additional information about the status of the method. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

class Status(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The HostStatus.Status class contains the possible different status codes that can be returned while trying to perform an operation on the hosts within the cluster. Warning: This enumeration is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

CANCELED = Status(string='CANCELED')¶: The method was canceled. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

ERROR = Status(string='ERROR')¶: The method encountered an unspecified error. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

OK = Status(string='OK')¶: The method completed successfully. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

PENDING = Status(string='PENDING')¶: The method is pending. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

RETRY_PENDING = Status(string='RETRY_PENDING')¶: The method is pending a retry. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

RUNNING = Status(string='RUNNING')¶: The method is in progress. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

SKIPPED = Status(string='SKIPPED')¶: The method was skipped. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

TIMED_OUT = Status(string='TIMED_OUT')¶: The method timed out. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

class com.vmware.esx.settings.clusters.configuration_client.ImpactInfo(impact=None, info=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This ImpactInfo class contains attributes that describes the Impact if the host is not compliant against the desired configuration. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

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

Parameters

impact (ImpactType) – This field indicates the ESXi host impact on applying the desired configuration. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
info (list of com.vmware.vapi.std_client.LocalizableMessage) – This field represents the list of impact information describing the configuration changes needed on the host to reach the desired state. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

class com.vmware.esx.settings.clusters.configuration_client.ImpactType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The ImpactType class contains information about the impact of applying desired configuration on the ESXi host. Warning: This enumeration is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

MAINTENANCE_MODE_REQUIRED = ImpactType(string='MAINTENANCE_MODE_REQUIRED')¶: Host requires maintenance mode to reach the desired state. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

NO_IMPACT = ImpactType(string='NO_IMPACT')¶: Host has no impact. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

REBOOT_REQUIRED = ImpactType(string='REBOOT_REQUIRED')¶: Host requires reboot to reach the desired state. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

class com.vmware.esx.settings.clusters.configuration_client.ImportResult(status=None, commit=None, errors=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This ImportResult class contains attributes that describe the result of importing a configuration document in the cluster. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

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

Parameters

status (ImportResult.Status) –
commit (str) – This identifier refers to the commit action of importing the desired configuration document. This identifier can be used in the apply API. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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 is optional and it is only relevant when the value of status is ImportResult.Status.OK.
errors (list of ValidationError) – Lists all validation errors identified in the configuration document. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This is set when #success is false.

class Status(string)¶

Bases: vmware.vapi.bindings.enum.Enum

This enum indicates whether the configuration document was imported successfully in the cluster. Warning: This enumeration is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

CANCELED = Status(string='CANCELED')¶

ERROR = Status(string='ERROR')¶

OK = Status(string='OK')¶

RUNNING = Status(string='RUNNING')¶: The task is in-progress. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

class com.vmware.esx.settings.clusters.configuration_client.Schema(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Schema class provides methods to manage the desired configuration schema of an ESX cluster. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

get(cluster)¶

Returns the configuration schema associated with the cluster. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Parameters

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

Return type

SchemaResult

Returns

The schema associated with the cluster

Raise

com.vmware.vapi.std.errors_client.Error In case of an unknown internal error.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If the cluster is invalid

Raise

com.vmware.vapi.std.errors_client.NotFound If the schema associated with the cluster is not found

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is unavailable.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated If the session is unauthenticated.

Raise

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

Method execution requires VcIntegrity.ClusterConfiguration.View.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.

class com.vmware.esx.settings.clusters.configuration_client.SchemaResult(schema=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The SchemaResult class contains attributes that describe the configuration schema associated with the cluster. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

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

Parameters: schema (str) – The configuration schema associated with the cluster. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

class com.vmware.esx.settings.clusters.configuration_client.SettingCompliance(path=None, current=None, target=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The SettingCompliance class contains attributes that describe a drift in an ESXi host setting. This structure is used to describe either a change in configuration value(set) or addition of configuration or deletion of configuration. When used to describe addition or deletion of a setting, only the path is set. When used to describe a set operation, current and target values are set only if drift is in a property that is of primitive type. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

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

Parameters

path (str) – Full path to the setting within the desired document. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
current (str or None) – Value of setting on the ESXi host. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This field is None if there is no host value to report or if setting is of complex type.
target (str or None) – Value of setting in the desired document. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This field is None if there is no value in the desired document to report or if setting is of complex type.

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

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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

class com.vmware.esx.settings.clusters.configuration_client.ValidationError(path=None, messages=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ValidationError class contains attributes that describes a validation error in the configuration. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

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

Parameters

path (str) – Full path to the configuration or the property within the configuration which was found to be invalid. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
messages (list of com.vmware.vapi.std_client.LocalizableMessage) – Localized error message describing the validation error. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

class com.vmware.esx.settings.clusters.configuration_client.ValidationResult(valid=None, errors=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This ValidationResult class contains attributes that describe the result of validating a configuration document. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

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

Parameters

valid (bool) – This boolean flag indicates whether the configuration document validated successfully with no validation errors. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
errors (list of ValidationError or None) – Lists all validation errors identified in the configuration document. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This is set when ValidationResult.valid is false.

com.vmware.esx.settings.clusters.enablement_client module¶

The com.vmware.esx.settings.clusters.enablement_client module provides classes to manage enablement of the feature that allows to collectively manage hosts within the cluster with a single software specification.

class com.vmware.esx.settings.clusters.enablement_client.Configuration(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Configuration class provides methods to control whether the cluster is managed using desired configuration platform semantics. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

class Info(enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Configuration.Info class contains information describing whether the feature is enabled. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

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

Parameters: enabled (bool) – Status of the feature enablement True if feature is enabled, false otherwise. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

get(cluster)¶

Returns whether the given cluster is managed using a desired configuration plaftorm. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Parameters: cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
Return type: Configuration.Info
Returns: Information about the feature enablement.
Raise: com.vmware.vapi.std.errors_client.Error If there is 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.

class com.vmware.esx.settings.clusters.enablement_client.Software(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Software class provides methods to control whether the cluster is managed with a single software specification.

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

class CheckResult(notifications=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Software.CheckResult class contains information that describes the results of the checks.

Tip

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

Parameters: notifications (dict of Software.CheckType and com.vmware.esx.settings_client.Notifications) – Notifications containing check results grouped by Software.CheckType type.

class CheckSpec(checks_to_skip=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Software.CheckSpec class contains information describing what checks should be performed.

Tip

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

Parameters: checks_to_skip (set of Software.CheckType) – Specifies the checks that should be skipped. If the set is empty, all checks will be performed.

class CheckType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Software.CheckType class contains various checks to identify the possibility to enable the feature that manages the cluster with a single software specification.

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

SOFTWARE = CheckType(string='SOFTWARE')¶: Perform host software check. This check is to report standalone VIBs (VIBs which are not part of any component) and the features on the given cluster that cannot coexist with the feature which manages the cluster with a single software specification.

SOFTWARE_SPECIFICATION_EXISTENCE = CheckType(string='SOFTWARE_SPECIFICATION_EXISTENCE')¶: Perform cluster’s software specification existence check.

STATELESSNESS = CheckType(string='STATELESSNESS')¶: Perform host statelessness check. This feature does not support stateless hosts.

VERSION = CheckType(string='VERSION')¶: Perform host version check. This feature does not support hosts with version less than XYZ.

VSAN_WITNESS_ELIGIBILITY = CheckType(string='VSAN_WITNESS_ELIGIBILITY')¶: Checks to verify if the cluster software specification can be used to manage any vSAN witness hosts in the cluster. This class attribute was added in vSphere API 7.0.2.1.

VUM_REMEDIATION = CheckType(string='VUM_REMEDIATION')¶: Perform VUM active remediation check.

class EnableSpec(skip_software_check=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Software.EnableSpec class contains information describing checks that should be skipped during enablement. Currently only Software.CheckType.SOFTWARE check can be skipped.

Tip

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

Parameters: skip_software_check (bool) – Skip Software.CheckType.SOFTWARE check during feature enablement.

class Info(enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Software.Info class contains information describing whether the feature is enabled.

Tip

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

Parameters: enabled (bool) – Status of the feature enablement True if feature is enabled, false otherwise

check_task(cluster, spec=None)¶

Checks the possibility to manage the cluster with a single software specification.

Parameters

cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
spec (Software.CheckSpec or None) – Check specification. If None, all checks are performed.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState If the feature is already enabled for the given cluster.

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.

enable_task(cluster, spec=None)¶

Enables the feature which manages the cluster with a single software specification.

Parameters

cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
spec (Software.EnableSpec or None) – Enablement specification. If None, all checks are performed.

Raise

com.vmware.vapi.std.errors_client.Error If feature enablement failed for the given cluster. The value of the data attribute of com.vmware.vapi.std.errors_client.Error will be a class that contains all the attributes defined in Software.CheckResult.

Raise

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState If the feature is already enabled for the given cluster.

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 whether the given cluster is managed with a single software specification.

Parameters

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

Return type

Software.Info

Returns

Information about the feature enablement.

Raise

com.vmware.vapi.std.errors_client.Error If there is 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.lifecycleSettings.Read.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.

class com.vmware.esx.settings.clusters.enablement_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.policies_client module¶

The com.vmware.esx.settings.clusters.policies_client module provides classes to manage policies that affect management of desired state configuration and software for an ESXi cluster. Copyright 2019-2021 VMware, Inc. All rights reserved. VMware Confidential Copyright 2020-2021 VMware, Inc. All rights reserved. VMware Confidential

class com.vmware.esx.settings.clusters.policies_client.Apply(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Apply class provides methods to configure the policies that will impact how the software and configuration specification documents are applied to an ESXi cluster.

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

class ConfiguredPolicySpec(failure_action=None, pre_remediation_power_action=None, enable_quick_boot=None, disable_dpm=None, disable_hac=None, evacuate_offline_vms=None, enforce_hcl_validation=None, parallel_remediation_action=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Apply.ConfiguredPolicySpec class contains attributes that describe the policies configured to be used when the software and configuration specification documents are applied to an ESXi cluster.

Tip

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

Parameters

failure_action (Apply.FailureAction or None) – What action is to be taken if entering maintenance mode fails on a given host of the cluster. If None, configured value would be unset.
pre_remediation_power_action (Apply.ConfiguredPolicySpec.PreRemediationPowerAction or None) – Specifies what should be done to the power state of the VM before entering maintenance mode. If None, configured value would be unset.
enable_quick_boot (bool or None) – Enable Quick Boot during remediation in the cluster. If None, configured value would be unset.
disable_dpm (bool or None) – Disable DPM on the cluster. If None, configured value would be unset.
disable_hac (bool or None) – Disable HA Admission control on the cluster. If None, configured value would be unset.
evacuate_offline_vms (bool or None) – Evacuate powered off/suspended VMs when attempting maintenance mode. If None, configured value would be unset.
enforce_hcl_validation (bool or None) – Enforce Hcl validation, when applicable, to prevent remediation if hardware compatibility issues are found. This attribute was added in vSphere API 7.0.1.0. If None, hardware compatibility issues will not prevent remediation.
parallel_remediation_action (Apply.ParallelRemediationAction or None) – Enable parallel remediation of hosts in maintenance mode. Set max hosts when applicable. This attribute was added in vSphere API 8.0.0.1. If None, parallel remediation will not happen.

class PreRemediationPowerAction(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Apply.ConfiguredPolicySpec.PreRemediationPowerAction class defines the possible actions to be taken, before entering maintenance mode.

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

DO_NOT_CHANGE_VMS_POWER_STATE = PreRemediationPowerAction(string='DO_NOT_CHANGE_VMS_POWER_STATE')¶: Do not change the VM power state

POWER_OFF_VMS = PreRemediationPowerAction(string='POWER_OFF_VMS')¶: Power off VMs before entering maintenance mode.

SUSPEND_VMS = PreRemediationPowerAction(string='SUSPEND_VMS')¶: Suspend VMs before entering maintenance mode

SUSPEND_VMS_TO_MEMORY = PreRemediationPowerAction(string='SUSPEND_VMS_TO_MEMORY')¶: Suspend VMs to Memory before entering maintenance mode. This class attribute was added in vSphere API 7.0.2.0.

class FailureAction(action=None, retry_delay=None, retry_count=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Apply.FailureAction class contains attributes that describe the actions to be taken when entering maintenance mode fails on a single host within the cluster.

Tip

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

Parameters

action (Apply.FailureAction.Action) – What action (FAIL, RETRY) is to be taken if entering maintenance mode fails on a single host within the cluster.
retry_delay (long) – Time to wait to retry the failed operation in seconds. This attribute is optional and it is only relevant when the value of action is Apply.FailureAction.Action.RETRY.
retry_count (long) – Number of times to retry the failed operation. This attribute is optional and it is only relevant when the value of action is Apply.FailureAction.Action.RETRY.

class Action(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Apply.FailureAction.Action class defines the actions to be taken when entering maintenance mode fails on a single host 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 Action instance.

FAIL = Action(string='FAIL')¶: Fail the apply method

RETRY = Action(string='RETRY')¶: Retry the task Apply.FailureAction.retry_count number of times on the failed host after Apply.FailureAction.retry_delay.

class ParallelRemediationAction(enabled=None, max_hosts=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

enabled (bool) – Enable parallel remediation for hosts in maintenance mode within a cluster. This attribute was added in vSphere API 8.0.0.1.
max_hosts (long or None) – Maximum number of hosts that can be remediated in parallel. Setting Apply.ParallelRemediationAction.max_hosts does not guarantee maxHosts to be remediated in parallel. This attribute was added in vSphere API 8.0.0.1.

get(cluster)¶

Returns the configured policy that has been set for the cluster.

Parameters

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

Return type

Apply.ConfiguredPolicySpec

Returns

The configured policies that impact the 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.lifecycleSettings.Read.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.

set(cluster, spec)¶

This API will set the configured policy specification for the cluster.

Parameters

cluster (str) – The cluster identifier. The parameter must be an identifier for the resource type: ClusterComputeResource.
spec (Apply.ConfiguredPolicySpec) – The policy that needs to be configured.

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.InvalidArgument If invalid value is provided.

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.lifecycleSettings.Write.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write.

class com.vmware.esx.settings.clusters.policies_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_client module¶

The com.vmware.esx.settings.clusters.software_client module provides classes to manage desired state software for ESX cluster.

class com.vmware.esx.settings.clusters.software_client.AddOn(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The AddOn class provides methods to manage desired OEM add-on specification for a given cluster.

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

RESOURCE_TYPE = 'com.vmware.esx.settings.add_on'¶: Resource type for add-on resource

get(cluster)¶

Returns the desired OEM add-on specification for a given cluster.

Parameters

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

Return type

com.vmware.esx.settings_client.AddOnInfo

Returns

Desired OEM add-on specification.

Raise

com.vmware.vapi.std.errors_client.Error If there is 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 desired OEM add-on specification is not found.

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.lifecycleSoftwareSpecification.Read.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

class com.vmware.esx.settings.clusters.software_client.BaseImage(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The BaseImage class provides methods to manage desired ESX base image.

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

RESOURCE_TYPE = 'com.vmware.esx.settings.base_image'¶: Resource type for base-image resource

get(cluster)¶

Returns the desired base-image specification set for given cluster

Parameters

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

Return type

com.vmware.esx.settings_client.BaseImageInfo

Returns

Base-image specification.

Raise

com.vmware.vapi.std.errors_client.Error If there is 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 desired specification is not found.

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.lifecycleSoftwareSpecification.Read.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

class com.vmware.esx.settings.clusters.software_client.Commits(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Commits class provides methods to manage committed changes to desired software document.

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

class Info(author=None, commit_time=None, description=None, apply_status=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Commits.Info class defines the information about software draft.

Tip

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

Parameters

author (str) – Author of the commit.
commit_time (datetime.datetime) – Creation time of the commit.
description (str) – Description accompanying this commit.
apply_status (Commits.Info.ApplyStatusType) – Apply status of the commit.

class ApplyStatusType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Commits.Info.ApplyStatusType class defines possible values regarding the application of this commit.

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

APPLIED = ApplyStatusType(string='APPLIED')¶: Commit has been applied to the cluster.

NOT_APPLIED = ApplyStatusType(string='NOT_APPLIED')¶: Commit hasn’t been applied to the cluster.

RESOURCE_TYPE = 'com.vmware.esx.settings.commit'¶: Resource type for commit resource

get(cluster, commit)¶

Returns the information about a specific commit.

Parameters

cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
commit (str) – Identifier of the specific commit. The parameter must be an identifier for the resource type: com.vmware.esx.settings.commit.

Return type

Commits.Info

Returns

Information about the commit.

Raise

com.vmware.vapi.std.errors_client.Error If there is 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 desired specification commit is not found.

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.

class com.vmware.esx.settings.clusters.software_client.Compliance(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Compliance class provides methods to get the last software compliance result for an ESX cluster.

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

RESOURCE_TYPE = 'ClusterComputeResource'¶: Resource type for cluster resource

get(cluster)¶

Returns the compliance state for the cluster

Parameters

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

Return type

com.vmware.esx.settings_client.ClusterCompliance

Returns

Cluster compliance result.

Raise

com.vmware.vapi.std.errors_client.Error If there is 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 the compliance information is unavailable.

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.lifecycleSoftwareSpecification.Read.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

class com.vmware.esx.settings.clusters.software_client.Components(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Components class provides methods to get desired component specification for an ESX cluster.

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

RESOURCE_TYPE = 'com.vmware.esx.settings.component'¶: Resource type for component resource

get(cluster, component)¶

Returns the component version for the given component in the desired software specification.

Parameters

cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
component (str) – Identifier of the component. The parameter must be an identifier for the resource type: com.vmware.esx.settings.component.

Return type

com.vmware.esx.settings_client.ComponentInfo or None

Returns

Details about the component version. If None then version is supposed to be chosen based on the constraints in the system.

Raise

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

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If invalid component name is provided.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no cluster associated with cluster in the system or or no component associated with component 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.lifecycleSoftwareSpecification.Read.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

list(cluster)¶

Returns a list of components in the desired software specification.

Parameters

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

Return type

dict of str and com.vmware.esx.settings_client.ComponentInfo

Returns

Map of ComponentInfo keyed by the component identifier. If no version is specified in desired software specification, then ComponentInfo will not be present for that component. The key in the return value dict will be an identifier for the resource type: com.vmware.esx.settings.component.

Raise

com.vmware.vapi.std.errors_client.Error If there is some 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.lifecycleSoftwareSpecification.Read.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

class com.vmware.esx.settings.clusters.software_client.Drafts(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Drafts class provides methods to manage working copy of software documents.

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

class CommitSpec(message=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Drafts.CommitSpec class contains attributes that are used to create a new commit.

Tip

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

Parameters: message (str or None) – Message to include with the commit. If None, message is set to empty string.

class FilterSpec(owners=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Drafts.FilterSpec class contains attributes used to filter the results when listing software drafts. See Drafts.list().

Tip

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

Parameters: owners (set of str or None) – Owners of the drafts. If None or empty, drafts from all owners will be returned.

class ImportSpec(source_type=None, location=None, file_id=None, software_spec=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Drafts.ImportSpec class defines the information used to import the desired software specification.

Tip

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

Parameters

source_type (Drafts.SourceType) – Type of the source to import the desired software specification
location (str) – Location of the software specification file to be imported. This attribute is optional and it is only relevant when the value of sourceType is Drafts.SourceType.PULL.
file_id (str) – File identifier returned by the file upload endpoint after file is uploaded. This attribute is optional and it is only relevant when the value of sourceType is Drafts.SourceType.PUSH.
software_spec (str) – The JSON string representing the desired software specification. This attribute is optional and it is only relevant when the value of sourceType is Drafts.SourceType.JSON_STRING.

class Info(metadata=None, software=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Drafts.Info class defines the information about software draft.

Tip

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

Parameters

metadata (Drafts.Metadata) – Metadata about the software draft.
software (com.vmware.esx.settings_client.SoftwareInfo) – Software specification associated with the draft.

class Metadata(owner=None, status=None, creation_time=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Drafts.Metadata class defines the metadata information about software draft.

Tip

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

Parameters

owner (str) – Owner of the software draft.
status (Drafts.StatusType) – Status of the software draft.
creation_time (datetime.datetime) – Creation time of the software draft.

RESOURCE_TYPE = 'com.vmware.esx.settings.draft'¶: Resource type for draft resource

class SourceType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Drafts.SourceType class defines possible values of sources to import software specification.

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

CURRENT_SERIES_RECOMMENDATION = SourceType(string='CURRENT_SERIES_RECOMMENDATION')¶: Content is from recommended image specification based on latest base image patch or update of the current series. For example, a cluster’s current desired base image is 7.0. Recommendation engine will look into any recommendable image specification with 7.0 series base images available at depot manager and try to recommend the highest version within 7.0 series if possible. Let’s say in this example, depot manager has 7.0 patch a and 7.0 update 1 base images. Recommendation engine would first validate all possible images based on 7.0 update 1. If it finds a valid one, it will store the recommended content with that series. This enum value will point to that stored recommended image content. Recommendations can be generated using {\@link: com.vmware.esx.settings.clusters.software.Recommendations#generate}.

JSON_STRING = SourceType(string='JSON_STRING')¶: The string representing the content of the software specfication.

LATEST_RECOMMENDATION = SourceType(string='LATEST_RECOMMENDATION')¶: Content is from recommended image specification based on latest base image version. Recommendations can be generated using {\@link: com.vmware.esx.settings.clusters.software.Recommendations#generate}.

PULL = SourceType(string='PULL')¶: Content is pulled from the URL location. The URL scheme of the value in {\@link #pullLocation) can be http, https or file.

PUSH = SourceType(string='PUSH')¶: Content was previously uploaded using the file upload enpoint present on vCenter appliance. This endpoint is present at https://VCENTERFQDN:9087/vum-fileupload URL.

SPECIFIED_BASE_IMAGE_RECOMMENDATION = SourceType(string='SPECIFIED_BASE_IMAGE_RECOMMENDATION')¶: Content is from recommended image specification based on a specified base image version. Recommendations can be generated using {\@link: com.vmware.esx.settings.clusters.software.Recommendations#generate}. This class attribute was added in vSphere API 7.0.2.0.

class StatusType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Drafts.StatusType class defines possible values of status of a software draft.

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

INVALID = StatusType(string='INVALID')¶: Software draft is invalid.

VALID = StatusType(string='VALID')¶: Software draft is valid.

class Summary(metadata=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Drafts.Summary class defines the summary information about software draft.

Tip

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

Parameters: metadata (Drafts.Metadata) – Metadata about the software draft.

class ValidateResult(notifications=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Drafts.ValidateResult class contains attributes to describe result of validation of desired software specification.

Tip

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

Parameters: notifications (com.vmware.esx.settings_client.Notifications) – Notifications associated with the validation.

commit_task(cluster, draft, spec)¶

Commits the specified draft as the desired state document. 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.
draft (str) – Identifier of the draft. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.
spec (Drafts.CommitSpec) – The spec to be used to create the commit.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

Raise

com.vmware.vapi.std.errors_client.Error If there is 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 or no draft associated with draft in the system.

Raise

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState If there is another operation in progress.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If validation of the software document fails. The value of the data attribute of com.vmware.vapi.std.errors_client.Error will be a class that contains all the attributes defined in Drafts.ValidateResult.

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.

create(cluster)¶

Creates a new software draft from the desired document. It will be deleted, when the draft is committed successfully. If a desired document is missing, then this method will create an empty draft.

Parameters

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

Return type

str

Returns

Identifier of the working copy of the document. The return value will be an identifier for the resource type: com.vmware.esx.settings.draft.

Raise

com.vmware.vapi.std.errors_client.AlreadyExists If there is already a draft created by this user.

Raise

com.vmware.vapi.std.errors_client.Error If there is 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.lifecycleSoftwareSpecification.Write.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

delete(cluster, draft)¶

Deletes the software draft.

Parameters

cluster (str) – Identifier of the cluster The parameter must be an identifier for the resource type: ClusterComputeResource.
draft (str) – Identifier of the working copy of the document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

Raise

com.vmware.vapi.std.errors_client.Error If there is 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 or no draft associated with draft 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.lifecycleSoftwareSpecification.Write.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

get(cluster, draft)¶

Returns the information about given software draft.

Parameters

cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
draft (str) – Identifier of the software draft. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

Return type

Drafts.Info

Returns

Information about the Software Draft.

Raise

com.vmware.vapi.std.errors_client.Error If there is 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 or no draft associated with draft 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.lifecycleSoftwareSpecification.Read.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

import_software_spec(cluster, spec)¶

Imports the desired software specification as a new draft. If a desired document is missing, then this method will create an empty draft except when the source type is of either Drafts.SourceType.LATEST_RECOMMENDATION or Drafts.SourceType.CURRENT_SERIES_RECOMMENDATION, then com.vmware.vapi.std.errors_client.NotFound error is reported. In addition, the exisiting draft will be overwritten when the source type is of either LATEST_RECOMMENDATION or CURRENT_SERIES_RECOMMENDATION.

Parameters

cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
spec (Drafts.ImportSpec) – Specification to import desired software specification.

Return type

str

Returns

Identifier of the software draft. The return value will be an identifier for the resource type: com.vmware.esx.settings.draft.

Raise

com.vmware.vapi.std.errors_client.Error If there is 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 the source type of import specification is of either LATEST_RECOMMENDATION or CURRENT_SERIES_RECOMMENDATION, and a recommendation does not exist for the cluster. It was either never generated or deleted due to changes in cluster state such as a new desired image spec being committed.

Raise

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

Raise

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

Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

list(cluster, filter=None)¶

Returns information about the software drafts for the specified cluster that match the Drafts.FilterSpec.

Parameters

cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
filter (Drafts.FilterSpec or None) – Filter to be applied while returning drafts. If None, all drafts will be returned.

Return type

dict of str and Drafts.Summary

Returns

Map of software drafts keyed by their identifiers. The key in the return value dict will be an identifier for the resource type: com.vmware.esx.settings.draft.

Raise

com.vmware.vapi.std.errors_client.Error If there is 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.lifecycleSoftwareSpecification.Read.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

scan_task(cluster, draft)¶

Scans all the hosts in the cluster against the software draft. 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.
draft (str) – Identifier of the working copy of the document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

Raise

com.vmware.vapi.std.errors_client.Error If there is 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 or no draft associated with draft 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.

validate_task(cluster, draft)¶

Validates the software draft. 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.
draft (str) – Identifier of the software draft. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

Raise

com.vmware.vapi.std.errors_client.Error If there is 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 or no draft associated with draft 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.

class com.vmware.esx.settings.clusters.software_client.EffectiveComponents(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The EffectiveComponents class provides methods to get effective list of components.

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

list(cluster)¶

Returns the effective components for the cluster.

Parameters

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

Return type

dict of str and com.vmware.esx.settings_client.EffectiveComponentInfo

Returns

Map of effective components keyed by their identifier. The key in the return value dict will be an identifier for the resource type: com.vmware.esx.settings.component.

Raise

com.vmware.vapi.std.errors_client.Error If there is 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.lifecycleSoftwareSpecification.Read.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

class com.vmware.esx.settings.clusters.software_client.HardwareSupport(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The HardwareSupport class provides methods to manage a cluster’s Hardware Support Package (HSP) configuration.

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

get(cluster)¶

Returns a given cluster’s Hardware Support Package (HSP) configuration.

Parameters

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

Return type

com.vmware.esx.settings_client.HardwareSupportInfo

Returns

Hardware Support Package (HSP) selected for use

Raise

com.vmware.vapi.std.errors_client.Error If there is some 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 named cluster or no Hardware Support Package (HSP) configured in the cluster’s desired state document.

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.lifecycleSoftwareSpecification.Read.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

class com.vmware.esx.settings.clusters.software_client.Recommendations(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Recommendations class provides methods to manage the generation and retrieval of recommended image specs.

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

class ExplanationDetails(display_name=None, display_version=None, explanation=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Recommendations.ExplanationDetails class contains attributes to describe the result of validation of desired software specification.

Tip

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

Parameters

display_name (str) – Display name of an excluded image entity (base image, add-on etc.).
display_version (str) – Display version of an excluded image entity (base image, add-on etc.).
explanation (list of com.vmware.vapi.std_client.LocalizableMessage) – List of explanations on why the image entity is excluded.

class FilterSpec(base_image_version=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Recommendations.FilterSpec class contains attributes used to filter the generated recommendations (see Recommendations.generate()) based on a specified base image version. This class was added in vSphere API 7.0.2.0.

Tip

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

Parameters: base_image_version (str or None) – Base image version string is used in generating the specified base image recommendations. Default recommendations are generated when the value is empty. This attribute was added in vSphere API 7.0.2.0.

class Info(latest_recommendation=None, current_series_recommendation=None, specified_base_image_version_recommendation=None, base_image_explanation_details=None, check_time=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Recommendations.Info class defines the information about the most recent recommendation generation result.

Tip

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

Parameters

latest_recommendation (com.vmware.esx.settings_client.SoftwareInfo or None) – Recommended image specification based on latest base image version. None if no recommended image based on latest base image version is available.
current_series_recommendation (com.vmware.esx.settings_client.SoftwareInfo or None) – Recommended image specification based on latest base image patch or update of the current series. None if no recommended image based on latest base image patch or update of the current series is available.
specified_base_image_version_recommendation (com.vmware.esx.settings_client.SoftwareInfo or None) – Recommended image specification based on a specified base image version. This attribute was added in vSphere API 7.0.2.0. None if no recommendation image based on the specified base image version is available.
base_image_explanation_details (list of Recommendations.ExplanationDetails) – Details about why some base images are excluded in latest and current series recommendations. This is not applicable for specified base image recommendations.
check_time (datetime.datetime or None) – The most recent timestamp when check for recommended image is launched. None if no recommendation check has ever been launched.

generate_task(cluster, filter=None)¶

Generates recommended software image spec(s) based on current desired software spec. 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.
filter (Recommendations.FilterSpec or None) – Specification on how to filter recommendations based on a specified base image version. This parameter was added in vSphere API 7.0.2.0. If None, latest and current series recommendations are generated.

Raise

com.vmware.vapi.std.errors_client.Error If there is 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.

Raise

com.vmware.vapi.std.errors_client.ConcurrentChange If a new desired image is committed in parallel via a different client while recommendation is being generated.

Raise

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

get(cluster)¶

Returns Information about the most recent recommendation generation result.

Parameters

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

Return type

Recommendations.Info

Returns

Information about the most recent recommendation generation result.

Raise

com.vmware.vapi.std.errors_client.Error If there is 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 recommendation is non-existing for the cluster due to either it is never generated or deleted due to changes in cluster state such as a new desired image spec being committed.

Raise

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

Raise

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

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

class com.vmware.esx.settings.clusters.software_client.Solutions(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Solutions class provides methods to manage desired software solution specifications for an ESX cluster.

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

RESOURCE_TYPE = 'com.vmware.esx.settings.solution'¶: Resource type for solution resource

delete_task(cluster, solution)¶

Deletes the given solution from the desired software specification. The deletion will be validated along with the entire software specification before it is committed as new desired spec. 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.
solution (str) – Identifier of the solution. The parameter must be an identifier for the resource type: com.vmware.esx.settings.solution.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

Raise

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

Raise

com.vmware.vapi.std.errors_client.InvalidArgument if validation of the software document fails. The value of the data attribute of com.vmware.vapi.std.errors_client.Error will be a class that contains all the attributes defined in ValidateResult.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no cluster associated with cluster or no solution associated with solution 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, solution)¶

Returns components registered for the given solution in the desired software specification.

Parameters

cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
solution (str) – Identifier of the solution. The parameter must be an identifier for the resource type: com.vmware.esx.settings.solution.

Return type

com.vmware.esx.settings_client.SolutionInfo

Returns

Specification of components registered by the solution.

Raise

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

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If invalid component name is provided.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no cluster associated with cluster in the system or or no solution associated with solution 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.lifecycleSoftwareSpecification.Read.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

list(cluster)¶

Returns all solutions in the desired software specification.

Parameters

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

Return type

dict of str and com.vmware.esx.settings_client.SolutionInfo

Returns

Map of solutions where key is solution identifier and value is a list of components registered by that solution. The key in the return value dict will be an identifier for the resource type: com.vmware.esx.settings.solution.

Raise

com.vmware.vapi.std.errors_client.Error If there is 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.lifecycleSoftwareSpecification.Read.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

set_task(cluster, solution, spec)¶

Sets the components registered for the given solution in the desired software specification. The task will set only one solution specification at a time. Solution constraints would be validated with the current desired software specification before it is committed as new desired spec. 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.
solution (str) – Identifier of the solution. The parameter must be an identifier for the resource type: com.vmware.esx.settings.solution.
spec (com.vmware.esx.settings_client.SolutionSpec) – Registered solution specification.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

Raise

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

Raise

com.vmware.vapi.std.errors_client.InvalidArgument if validation of the software document fails. The value of the data attribute of com.vmware.vapi.std.errors_client.Error will be a class that contains all the attributes defined in ValidateResult.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no cluster associated with cluster or no solution associated with solution 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.

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

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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