Esx. Settings. Clusters. Software. Effective Components List

Esx. Settings. Clusters. Software. Effective Components List

Returns the effective components for the cluster.

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/effective-components
COPY
Path Parameters
string
cluster
Required

Identifier of the cluster.

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

Authentication
This operation uses the following authentication methods.
Responses
200

Map of effective components keyed by their identifier.

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

{
    "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": "E",
    "14": "f",
    "15": "f",
    "16": "e",
    "17": "c",
    "18": "t",
    "19": "i",
    "20": "v",
    "21": "e",
    "22": "C",
    "23": "o",
    "24": "m",
    "25": "p",
    "26": "o",
    "27": "n",
    "28": "e",
    "29": "n",
    "30": "t",
    "31": "I",
    "32": "n",
    "33": "f",
    "34": "o",
    "35": " ",
    "36": "O",
    "37": "b",
    "38": "j",
    "39": "e",
    "40": "c",
    "41": "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/effective-components
On This Page
Esx.settings.clusters.software.effective Components Operations
GET
Esx. Settings. Clusters. Software. Effective Components List
GET
Esx. Settings. Clusters. Software. Effective Components List With Removed Components