Esx. Settings. Clusters. Configuration. Drafts Internal Get

Esx. Settings. Clusters. Configuration. Drafts Internal Get

Get the cluster configuration and related metadata from this draft.

This operation was added in vSphere API 8.0.2.0.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires VcIntegrity.ClusterConfiguration.Modify.
  • The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Modify.
Request
URI
GET
https://{api_host}/esx/settings/clusters/{cluster}/configuration/drafts-internal/{draft}
COPY
Path Parameters
string
cluster
Required

Identifier of the cluster

The parameter must be an identifier for the resource type: ClusterComputeResource.

string
draft
Required

Identifier of the working copy of the document.

The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

Query Parameters
string
doc_structure
Optional

Possible values:

  • HOST_ORIENTED: The host-specific portions of the document are stored in the "host-specific" object at the top-level with entries for each host, organized by the host's BIOS UUID.
  • PROFILE_ORIENTED: The host-specific portions of the document are distributed through the "profile" object hierarchy. Each property that is host-specific will be an object with entries for each host where the property is defined. The hosts in the object are organized by BIOS UUID.

For more information see: Esx.Settings.Clusters.Configuration.DocumentStructure.

Authentication
This operation uses the following authentication methods.
Responses
200

Success!

Returns Esx.Settings.Clusters.Configuration.Drafts.Info of type(s) application/json 
"Esx.Settings.Clusters.Configuration.Drafts.Info Object"

401

If the caller is not authenticated.

Returns Vapi.Std.Errors.Unauthenticated of type(s) application/json 
"Vapi.Std.Errors.Unauthenticated Object"

404

If there is no cluster associated with cluster or no draft associated with draft in the system.

Returns Vapi.Std.Errors.NotFound of type(s) application/json 
"Vapi.Std.Errors.NotFound Object"

500

If there is unknown internal error. The accompanying error message will give more details about the failure.

Returns Vapi.Std.Errors.Error of type(s) application/json 
"Vapi.Std.Errors.Error Object"

503

If the service is not available.

Returns Vapi.Std.Errors.ServiceUnavailable of type(s) application/json 
"Vapi.Std.Errors.ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/esx/settings/clusters/{cluster}/configuration/drafts-internal/{draft}
On This Page
Esx.settings.clusters.configuration.drafts Internal Operations
GET
Esx. Settings. Clusters. Configuration. Drafts Internal Get