List Hosts Software Effective Components
Returns the effective components for the host. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.
Request
URLURL
https://{api_host}/api/esx/settings/hosts/{host}/software/effective-components
Path Parameters
Path Parameters
string
host
Required
Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.
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
map of
Settings_EffectiveComponentInfo
of type application/json
Map of effective components keyed by their identifier. The key in the result map will be an identifier for the resource type: com.vmware.esx.settings.component.
Errors
400
com.vmware.vapi.std.errors.unsupported : If the host is not a vLCM managed standlone host.
404
com.vmware.vapi.std.errors.not_found : If there is no host associated with host 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.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-ListHostSoftwareEffectiveComponents -Host "MyHost"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/hosts/{host}/software/effective-components
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 8.0.0.1
