Vcenter ConsumptionDomains Zones Cluster Associations add
Maps a consumption-domain zone to the specified vSphere clusters. If a cluster or a subset of specified clusters are already members of the specified zone, the result is success for those clusters. This operation supports partial success, i.e., it is possible that a subset of the specified clusters get successfully associated with the specified zone but the association fails for a subset of clusters. The returned result will contain the details about only those clusters for which the association failed.
This operation was added in vSphere API 8.0.0.1.
Returns an authorization error if you do not have all of the privileges described as follows:
- The resource
com.vmware.vcenter.consumption_domains.Zonereferenced by the parameter zone requiresZone.Manage.
Identifier of the zone to be mapped to the specified vSphere clusters.
The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.
Set of identifiers of vSphere clusters to which the the specified zone should be mapped.
The parameter must contain identifiers for the resource type: ClusterComputeResource.
[
{}
]Status see Vcenter ConsumptionDomains Zones Cluster Associations Status. If the operation failed, returns the reason of failures. There will be an error message indicating the identifier of the cluster for which the association failed and the reason of failure. The cluster identifiers that are not present in Vcenter ConsumptionDomains Zones Cluster Associations Status will have been successfully associated.
{
"success": false,
"failed_clusters": {
"failed_clusters": {}
}
}This is true if the complete operation succeeded without any errors. Otherwise, it is false if all or some operations have failed.
This property was added in vSphere API 8.0.0.1.
Associations between the identifiers of the clusters for which the operation failed and the reason of the failure.
This property was added in vSphere API 8.0.0.1.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: ClusterComputeResource.
if more than one cluster or an empty set of clusters is specified.
"Vapi Std Errors InvalidArgument Object"if the user can not be authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
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 zone requires Zones.Manage privilege. - Each resource of ClusterComputeResource referenced by the parameter clusters requires Zone.ObjectAttachable privilege.
"Vapi Std Errors Unauthorized Object"if the specified zone is not known to this vCenter server.
"Vapi Std Errors NotFound Object"when unexpected error is encountered.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/vcenter/consumption-domains/zones/cluster/{zone}/associations?action=add