Get Hosts Software Commits
Returns the information about a specific commit. 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/commits/{commit}
Path Parameters
Path Parameters
string
host
Required
Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.
string
commit
Required
Identifier of the specific commit. The parameter must be an identifier for the resource type: com.vmware.esx.settings.commit.
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
SettingsHostsSoftwareCommitsInfo
of type application/json
Information about the commit.
{
"apply_status": "APPLIED",
"author": "string",
"commit_time": "string",
"description": "string"
}
apply_status
Required
The Commits.ApplyStatusType enumerated type defines possible values regarding the application of this commit.
APPLIED : Commit has been applied to the host.
NOT_APPLIED : Commit hasn’t been applied to the host.
Possible values are: APPLIED , NOT_APPLIED
string
author
Required
Author of the commit.
string
commit_time
Required
Creation time of the commit.
string
description
Required
Description accompanying this commit.
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 or if working copy of the software document is not found.
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-GetHostCommitSoftware -Host "MyHost" -Commit "MyCommit"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/hosts/{host}/software/commits/{commit}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 8.0.0.1
