com.vmware.esx.settings.clusters.configuration package

Submodules

com.vmware.esx.settings.clusters.configuration.reports_client module

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

Bases: VapiInterface

The LastApplyResult class provides methods to get the most recent available result of applying the configuration to all hosts within a cluster. This class was added in vSphere API 8.0.1.0.

Parameters:

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

get(cluster)

Returns the most recent available result of applying the configuration document to all hosts within the cluster. This method was added in vSphere API 8.0.1.0.

Parameters:

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

Return type:

com.vmware.esx.settings.clusters_client.Configuration.ApplyResult

Returns:

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

Raise:

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

Raise:

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

Raise:

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

Raise:

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

Raise:

com.vmware.vapi.std.errors_client.Unauthorized if the caller does not have the necessary privileges to perform the request.

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.reports_client.LastComplianceResult(config)

Bases: VapiInterface

The LastComplianceResult class provides methods to get the last available check compliance result for the cluster. This class was added in vSphere API 8.0.1.0.

Parameters:

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

get(cluster)

This API provides results from the last completed Check Compliance operation on the cluster. This method was added in vSphere API 8.0.1.0.

Parameters:

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

Return type:

com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance

Returns:

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 last compliance result was 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.ClusterConfiguration.View.

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

class com.vmware.esx.settings.clusters.configuration.reports_client.LastPrecheckResult(config)

Bases: VapiInterface

The LastPrecheckResult class provides methods to get the most recent available result of Precheck. This class was added in vSphere API 8.0.1.0.

Parameters:

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

get(cluster)

This API returns results from the last Precheck operation on the cluster. This method was added in vSphere API 8.0.1.0.

Parameters:

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

Return type:

com.vmware.esx.settings.clusters.configuration_client.ClusterPrecheckResult

Returns:

Most recent available result of Precheck.

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 there is no result associated with the cluster cluster.

Raise:

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

Raise:

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

Raise:

com.vmware.vapi.std.errors_client.Unauthorized if the caller does not have the necessary privileges to perform the request.

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.reports_client.RecentTasks(config)

Bases: VapiInterface

The RecentTasks class provides methods to get the most recent configuration-related tasks. This class was added in vSphere API 8.0.1.0.

Parameters:

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

class DraftTasks(precheck=None)

Bases: VapiStruct

The RecentTasks.DraftTasks class contains attributes that specify the ID of the latest task to be executed for various operations on a draft. This class was added in vSphere API 8.0.1.0.

Tip

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

Parameters:

precheck (str or None) – The ID of the last precheck task to be executed for this draft. This attribute was added in vSphere API 8.0.1.0. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.cis.task. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.cis.task.

class Info(check_compliance=None, precheck=None, draft_tasks=None, apply=None)

Bases: VapiStruct

The RecentTasks.Info class contains attributes that specify the ID of the latest task to be executed for various operations. If a task is currently running, that ID will be returned, otherwise the most recently finished task will be returned. This class was added in vSphere API 8.0.1.0.

Tip

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

Parameters:

  • check_compliance (str or None) – The ID of the last check-compliance task to be executed. This attribute was added in vSphere API 8.0.1.0. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.cis.task. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.cis.task.

  • precheck (str or None) – The ID of the last precheck task to be executed. This attribute was added in vSphere API 8.0.1.0. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.cis.task. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.cis.task.

  • draft_tasks (dict of str and RecentTasks.DraftTasks) – Map of draft IDs to the latest tasks executed for that draft. This attribute was added in vSphere API 8.0.1.0. 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: com.vmware.esx.settings.draft. 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: com.vmware.esx.settings.draft.

  • apply (str or None) – The ID of the last apply task to be executed. This attribute was added in vSphere API 8.0.1.0. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.cis.task. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.cis.task.

get(cluster)

This API returns the IDs of the configuration tasks most recently executed on this cluster. This method was added in vSphere API 8.0.1.0.

Parameters:

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

Return type:

RecentTasks.Info

Returns:

A structure containing the most recent executions of draft- related tasks.

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 the caller does not have the necessary privileges to perform the request.

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.reports_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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