com.vmware.esx.settings.clusters package

Subpackages

• com.vmware.esx.settings.clusters.policies package
  • Submodules
  • com.vmware.esx.settings.clusters.policies.apply_client module
• com.vmware.esx.settings.clusters.software package
  • Subpackages
    • com.vmware.esx.settings.clusters.software.drafts package
      • Submodules
      • com.vmware.esx.settings.clusters.software.drafts.software_client module
    • com.vmware.esx.settings.clusters.software.reports package
      • Submodules
      • com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client module
  • Submodules
  • com.vmware.esx.settings.clusters.software.drafts_client module
  • com.vmware.esx.settings.clusters.software.reports_client module

Submodules

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

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.

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 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)

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.

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

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.

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.

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.

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 Info(latest_recommendation=None, current_series_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.

• base_image_explanation_details (list of Recommendations.ExplanationDetails) – Details about why some base images are excluded in recommendation.

• 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)

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.

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 null.

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 null.

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