Get Clusters Software Components
Returns the component version for the given component in the desired software specification. 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
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/software/components/{component}
Path Parameters
Path Parameters
string
cluster
Required
Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
string
component
Required
Identifier of the component. The parameter must be an identifier for the resource type: com.vmware.esx.settings.component.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
SettingsComponentInfo of type application/json
Details about the component version. If unset then version is supposed to be chosen based on the constraints in the system.
{
"details": {
"display_name": "string",
"display_version": "string",
"vendor": "string"
},
"version": "string"
}
details
Optional
Details about the component. unset if component is not present in the depot.
string
version
Optional
Version of the component. unset if version is not specified.
Code Samples
PowerCLI Client SDK Example
Invoke-GetClusterComponentSoftware -Cluster "MyCluster" -Component "MyComponent"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/software/components/{component}
Errors
404
com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster in the system or or no component associated with component in the system.
500
com.vmware.vapi.std.errors.error : If there is unknown internal error. The accompanying error message will give more details about the failure.
Vendor Extensions
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.0
