Get Hosts Software Reports Apply Impact
Returns a summary of how a standalone ESXi host will be impacted during an apply operation. The impact is generated from the compliance information obtained from Compliance.get if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareRemediation.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareRemediation.Read.
Request
URLURL
https://{api_host}/api/esx/settings/hosts/{host}/software/reports/apply-impact
Path Parameters
Path Parameters
string
host
Required
The host identifier. 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
SettingsHostsSoftwareReportsApplyImpactHostImpact
of type application/json
Summary of how hosts will be impacted during an apply operation
{
"commit": "string",
"host_info": {
"is_vsan_witness": false,
"name": "string"
},
"impact": [
{
"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"
}
}
}
}
]
}
string
commit
Required
Identifier of the commit on which the impact is generated. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.esx.settings.commit.
impact
Required
Impact of steps performed during the apply operation.
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 an 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-GetHostSoftwareReportsApplyImpact -Host "MyHost"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/hosts/{host}/software/reports/apply-impact
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
