Esx. Settings. Hosts. Configuration Get

Esx. Settings. Hosts. Configuration Get

Get the standalone host desired configuration and related metadata associated with the ESXi host using vSphere Configuration Profiles workflow. The configuration returned by this API only contains the user-visible configuration properties available for a the host.

Warning: this operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires VcIntegrity.StandaloneHostConfiguration.View.
  • The resource HostSystem referenced by the parameter host requires VcIntegrity.StandaloneHostConfiguration.View.
Request
URI
GET
https://{api_host}/esx/settings/hosts/{host}/configuration
COPY
Path Parameters
string
host
Required

Identifier of the host.

The parameter must be an identifier for the resource type: HostSystem.

Query Parameters
string
commit
Optional

Identifier of the commit to get.

The parameter must be an identifier for the resource type: HostSystem.

string
doc_structure
Optional

Describes how to structure the config document.

Possible values:

  • HOST_ORIENTED: The host-specific portions of the document are stored in the "host-specific" object at the top-level with entries for each host, organized by the host's BIOS UUID.
  • PROFILE_ORIENTED: The host-specific portions of the document are distributed through the "profile" object hierarchy. Each property that is host-specific will be an object with entries the host where the property is defined. The hosts in the object are organized by BIOS UUID.

For more information see: Esx.Settings.Hosts.Configuration.DocumentStructure.

Authentication
This operation uses the following authentication methods.
Responses
200

Success!

Returns Esx.Settings.Hosts.Configuration.Info of type(s) application/json 
"Esx.Settings.Hosts.Configuration.Info Object"

400

If API is called on a host that is not managed by desired configuration management platform, or if the host is not a standalone host.

Returns Vapi.Std.Errors.InvalidArgument of type(s) application/json 
"Vapi.Std.Errors.InvalidArgument Object"

401

If the caller is not authenticated.

Returns Vapi.Std.Errors.Unauthenticated of type(s) application/json 
"Vapi.Std.Errors.Unauthenticated Object"

404

If there is no host associated with host or no commit associated with commit in the system.

Returns Vapi.Std.Errors.NotFound of type(s) application/json 
"Vapi.Std.Errors.NotFound Object"

500

Vapi.Std.Errors.Error If there is unknown internal error. The accompanying error message will give more details about the failure.

Vapi.Std.Errors.TimedOut If the API timed out before completion.

Returns Vapi.Std.Errors.Error of type(s) application/json 
"Vapi.Std.Errors.Error Object"

503

If the service is not available.

Returns Vapi.Std.Errors.ServiceUnavailable of type(s) application/json 
"Vapi.Std.Errors.ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/esx/settings/hosts/{host}/configuration
On This Page
Esx.settings.hosts.configuration Operations
POST
Esx. Settings. Hosts. Configuration Extract
GET
Esx. Settings. Hosts. Configuration Get
POST
Esx. Settings. Hosts. Configuration Export Config
POST
Esx. Settings. Hosts. Configuration Apply$ Task
POST
Esx. Settings. Hosts. Configuration Check Compliance$ Task
POST
Esx. Settings. Hosts. Configuration Precheck$ Task