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.lifecycleSettings.Read.
  • The resource ClusterComputeResource referenced by the property Esx Settings Inventory Reports Summary Clusters GetParams.clusters requires VcIntegrity.lifecycleSettings.Read.
  • The resource Folder referenced by the property Esx Settings Inventory Reports Summary Clusters GetParams.folders requires VcIntegrity.lifecycleSettings.Read.
  • The resource Datacenter referenced by the property Esx Settings Inventory Reports Summary Clusters GetParams.datacenters requires VcIntegrity.lifecycleSettings.Read.
Request
URI
GET
https://{api_host}/api/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"
array of object
cluster_summaries
Required

List of cluster summaries.

This property was added in vSphere API 9.0.0.0.


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
This response body class contains all of the following: InlineVapi Std Errors InvalidArgument0 
"Vapi Std Errors InvalidArgument Object"

401

If the caller is not authenticated

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0 
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

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.


403

If the caller is not authorized to invoke the interface.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0 
"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
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"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"
array of object
messages
Required

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.

object
data
Optional

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.

string
error_type
Required

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.


503

If the service is not available.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0 
"Vapi Std Errors ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/esx/settings/inventory/reports/summary/clusters?spec=v
On This Page
Esx Settings Operations
GET
Esx Settings Inventory Reports Summary Clusters get