Esx. Settings. Inventory. Reports. Summary. Clusters Get

Esx. Settings. Inventory. Reports. Summary. Clusters Get

Returns the information about the software specifications from the repository assigned to clusters as well as operations summary performed on the clusters under inventory defined in the Esx.Settings.Inventory.Reports.Summary.Clusters.GetParams as an input.

This operation was added in vSphere API 9.0.0.0.

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

  • Operation execution requires VcIntegrity.lifecycleSoftwareRemediation.Read.
  • The resource ClusterComputeResource referenced by the property Esx.Settings.Inventory.Reports.Summary.Clusters.GetParams.clusters requires VcIntegrity.lifecycleSoftwareRemediation.Read.
  • The resource Folder referenced by the property Esx.Settings.Inventory.Reports.Summary.Clusters.GetParams.folders requires VcIntegrity.lifecycleSoftwareRemediation.Read.
  • The resource Datacenter referenced by the property Esx.Settings.Inventory.Reports.Summary.Clusters.GetParams.datacenters requires VcIntegrity.lifecycleSoftwareRemediation.Read.
Request
URI
GET
https://{api_host}/esx/settings/inventory/reports/summary/clusters
COPY
Query Parameters
Esx.Settings.Inventory.Reports.Summary.Clusters.GetParams
spec
Required

Describe the inventory objects on which the specified operation will be performed.

string of array
clusters
Optional

List of clusters on which the operations summary needs to be generated.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of type is Esx.Settings.Inventory.Reports.Summary.Clusters.GetParams.InventoryType.CLUSTER.

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

string of array
folders
Optional

List of folders on which the operations summary needs to be generated. Internally the folder entities will be expanded to individual clusters which are underneath the designated folder. If the list contains the managed object ID of the root folder, the specified operation will be executed on all clusters in the vCenter.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of type is Esx.Settings.Inventory.Reports.Summary.Clusters.GetParams.InventoryType.FOLDER.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Folder. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Folder.

string of array
datacenters
Optional

List of data-centers on which the operations summary needs to be generated. Internally the data-center entities will be expanded to individual clusters which are underneath the designated data-center.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of type is Esx.Settings.Inventory.Reports.Summary.Clusters.GetParams.InventoryType.DATACENTER.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Datacenter. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Datacenter.

Authentication
This operation uses the following authentication methods.
Responses
200

Summary containing the software specifications from the repository assigned to clusters and operations summary performed on the clusters under inventory passed in as input

Returns Esx.Settings.Inventory.Reports.Summary.Clusters.Info of type(s) application/json 
"Esx.Settings.Inventory.Reports.Summary.Clusters.Info Object"

400

If invalid Esx.Settings.Inventory.Reports.Summary.Clusters.GetParams is passed as an input.

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

401

If the caller is not authenticated

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

403

If the caller is not authorized to invoke the interface.

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

404

If some of the provided inventories doesn't exist.

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 contain more details.

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/inventory/reports/summary/clusters?spec=v
On This Page
Esx.settings.inventory.reports.summary.clusters Operations
GET
Esx. Settings. Inventory. Reports. Summary. Clusters Get