Vcenter ConsumptionDomains ZoneAssociations Cluster ListItem

The Vcenter ConsumptionDomains ZoneAssociations Cluster ListItem schema describes a zone-cluster association.

This schema was added in vSphere API 8.0.0.1.

JSON Example

{
    "zone": "string",
    "cluster": "string",
    "state": "string",
    "remove_task": "string"
}

string

zone

Required

Identifier of the zone.

This property was added in vSphere API 8.0.0.1.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

string

cluster

Required

Identifier of the cluster.

This property was added in vSphere API 8.0.0.1.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ClusterComputeResource.

string

state

Optional

Association state of the cluster to the vSphere Zone.

For more information see: Vcenter ConsumptionDomains ZoneAssociations Cluster AssociationState.

This property was added in vSphere API 9.1.0.0.

This property is optional because it was added in a newer version than its parent node.

string

remove_task

Optional

The identifier of the cluster removal task. At the completion of this task, the cluster will be removed from the vSphere Zone.

This property was added in vSphere API 9.1.0.0.

This property is optional and it is only relevant when the value of state is Vcenter ConsumptionDomains ZoneAssociations Cluster AssociationState.REMOVING.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.cis.task. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.cis.task.

Property Of

Vcenter ConsumptionDomains ZoneAssociations Cluster ListResult