Esx. Settings. Clusters. Software. Drafts List

Esx. Settings. Clusters. Software. Drafts List

Returns information about the software drafts for the specified cluster that match the Esx.Settings.Clusters.Software.Drafts.FilterSpec.

This operation was added in vSphere API 7.0.0.0.

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

  • Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
  • The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
Request
URI
GET
https://{api_host}/esx/settings/clusters/{cluster}/software/drafts
COPY
Path Parameters
string
cluster
Required

Identifier of the cluster.

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

Query Parameters
string of array
owners
Optional

Owners of the drafts.

This property was added in vSphere API 7.0.0.0.

If missing or null or empty, drafts from all owners will be returned.


Authentication
This operation uses the following authentication methods.
Responses
200

Map of software drafts keyed by their identifiers.

The key in the response map will be an identifier for the resource type: com.vmware.esx.settings.draft.

{
    "0": "E",
    "1": "s",
    "2": "x",
    "3": ".",
    "4": "S",
    "5": "e",
    "6": "t",
    "7": "t",
    "8": "i",
    "9": "n",
    "10": "g",
    "11": "s",
    "12": ".",
    "13": "C",
    "14": "l",
    "15": "u",
    "16": "s",
    "17": "t",
    "18": "e",
    "19": "r",
    "20": "s",
    "21": ".",
    "22": "S",
    "23": "o",
    "24": "f",
    "25": "t",
    "26": "w",
    "27": "a",
    "28": "r",
    "29": "e",
    "30": ".",
    "31": "D",
    "32": "r",
    "33": "a",
    "34": "f",
    "35": "t",
    "36": "s",
    "37": ".",
    "38": "S",
    "39": "u",
    "40": "m",
    "41": "m",
    "42": "a",
    "43": "r",
    "44": "y",
    "45": " ",
    "46": "O",
    "47": "b",
    "48": "j",
    "49": "e",
    "50": "c",
    "51": "t"
}

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 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}/software/drafts