Extract Hosts Configuration
Extracts a configuration document from the ESXi host, if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Modify. - The resource HostSystem referenced by the parameter host requires VcIntegrity.ClusterConfiguration.Modify.
Request
URLURL
https://{api_host}/api/esx/settings/hosts/{host}/configuration?action=extract
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
SettingsHostsConfigurationExtractResult
of type application/json
The result contains the configuration of the ESXi host encoded as JSON.
{
"config": "string"
}
string
config
Required
ESXi host configuration encoded as JSON.
Errors
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-ExtractHostConfiguration -Host "MyHost"
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/hosts/{host}/configuration?action=extract
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: extract
Availability
Added in 8.0.1.0
