Get Software
Returns details about the current software specification applied to the host. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
Request
URLURL
https://{api_host}/api/esx/software
Query Parameters
Query Parameters
auth_type
Required
Specifies what type of authentication (AuthenticationType) is to be used when connecting with the host. USERNAME_PASSWORD is intended to be used when connecting to a host that is not currently part of the vCenter inventory. EXISTING is intented for hosts that are in vCenter inventory, in which case, HostServiceTicket will be used to connect to the host.
string
host
Optional
Specifies the host Managed Object ID to be used during the Software.get operation This field is optional and it is only relevant when the value of Software.ConnectionSpec.auth-type is EXISTING. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: HostSystem. When operations return a value of this structure as a result, the field will be an identifier for the resource type: HostSystem.
host_credential
Optional
Specifies the host details to be used during the Software.get operation This field is optional and it is only relevant when the value of Software.ConnectionSpec.auth-type is USERNAME_PASSWORD.
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
HostsSoftwareInfo of type application/json
Info details about the current software specification applied to the host.
{
"notifications": {
"errors": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"time": "string"
}
],
"info": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"time": "string"
}
],
"warnings": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"time": "string"
}
]
},
"software_info": {
"add_on": {
"display_name": "string",
"display_version": "string",
"name": "string",
"vendor": "string",
"version": "string"
},
"base_image": {
"display_name": "string",
"display_version": "string",
"release_date": "string",
"version": "string"
},
"components": {
"key": {
"display_name": "string",
"display_version": "string",
"vendor": "string",
"version": "string"
}
},
"hardware_support": {
"packages": {
"key": {
"pkg": "string",
"version": "string"
}
}
},
"solutions": {
"key": {
"components": {
"key": {
"display_name": "string",
"display_version": "string",
"vendor": "string",
"version": "string"
}
},
"display_name": "string",
"version": "string"
}
}
}
}
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the ConnectionSpec.HostCredentials#hostName field of spec is invalid. | com.vmware.vapi.std.errors.unverified_peer : If the SSL certificate of the target node cannot be validated by comparing with the thumbprint provided in ConnectionSpec.HostCredentials#sslThumbPrint.
404
com.vmware.vapi.std.errors.not_found : If there is no ConnectionSpec.HostCredentials#hostName field associated with host id in the system.
500
com.vmware.vapi.std.errors.error : If there is some 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
$HostsSoftwareHostCredentials = Initialize-HostsSoftwareHostCredentials -HostName "MyHostName" -UserName "MyUserName" -Password "MyPassword" -Port 0 -SslThumbPrint "MySslThumbPrint"
Invoke-GetSoftware -AuthType "USERNAME_PASSWORD" -HostCredential $HostCredential -Host "MyHost"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/software?auth_type=string
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.2.0
