com.vmware.vcenter.consumption_domains package

Subpackages

Submodules

com.vmware.vcenter.consumption_domains.zone_associations_client module

class com.vmware.vcenter.consumption_domains.zone_associations_client.Cluster(config)

Bases: VapiInterface

The CLUSTER class provides methods to query zone-cluster associations. This class was added in vSphere API 8.0.0.1.

Parameters:

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

class FilterSpec(clusters=None, zones=None)

Bases: VapiStruct

The Cluster.FilterSpec class contains attributes used to filter the results when listing associations between clusters and zones, see Cluster.list(). If multiple filtering criteria are provided in a Cluster.FilterSpec, then the filtering is done based on all of them, i.e., every returned zone-cluster association must satisfy all the filtering criteria. This Cluster.FilterSpec class can be used to list zones associated with a given cluster as well as to list the clusters associated with a given zone. This class was added in vSphere API 8.0.0.1.

Tip

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

Parameters:

  • clusters (set of str or None) – Zone-cluster associations will be filtered such that each association that is returned will have a cluster identifier from this set of specified cluster identifiers. This attribute was added in vSphere API 8.0.0.1. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: ClusterComputeResource. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: ClusterComputeResource. If None or empty, zone-cluster associations will not be filtered based on cluster identifiers. Associations with any cluster identifier will match this filter.

  • zones (set of str or None) – Zone-cluster associations will be filtered such that each association that is returned will have a zone identifier from this set of specified zone identifiers. This attribute was added in vSphere API 8.0.0.1. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: com.vmware.vcenter.consumption_domains.Zone. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: com.vmware.vcenter.consumption_domains.Zone. If None or empty, zone-cluster associations will not be filtered based on zone identifiers. Associations with any zone identifier will match this filter.

class ListItem(zone=None, cluster=None)

Bases: VapiStruct

The Cluster.ListItem class describes a zone-cluster association. This class was added in vSphere API 8.0.0.1.

Tip

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

Parameters:

  • zone (str) – Identifier of the zone. This attribute was added in vSphere API 8.0.0.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

  • cluster (str) – Identifier of the cluster. This attribute was added in vSphere API 8.0.0.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: ClusterComputeResource. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: ClusterComputeResource.

class ListResult(associations=None)

Bases: VapiStruct

The Cluster.ListResult class contains the list of zone-cluster associations. This class was added in vSphere API 8.0.0.1.

Tip

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

Parameters:

associations (list of Cluster.ListItem) – The list of zone-cluster associations. This attribute was added in vSphere API 8.0.0.1.

list(filter=None)

Returns zone-cluster associations that match the specified filter. This method was added in vSphere API 8.0.0.1.

Parameters:

filter (Cluster.FilterSpec or None) – The specification of matching zone-cluster associations. If None, the behavior is equivalent to a Cluster.FilterSpec with all attributes None, which means all the zone-cluster associations will be returned.

Return type:

Cluster.ListResult

Returns:

Zone-cluster associations matching the Cluster.FilterSpec.

Raise:

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

Raise:

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have all of the privileges described as follows: - The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zones in Cluster.FilterSpec requires System.Read privilege.

Raise:

com.vmware.vapi.std.errors_client.Error when unexpected error is encountered.

Raise:

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

  • Method execution requires System.Read.

class com.vmware.vcenter.consumption_domains.zone_associations_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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