Esx. Settings. Clusters. Configuration. Host Specific Templates Get

Esx. Settings. Clusters. Configuration. Host Specific Templates Get

The API will create a template for host-specific properties for configuration present in the 'profile' section of the desired document.

The template bundle will contain the host-specific property metadata, the host-specific property form and the BIOS UUID of the hosts in the cluster. The user can use this template to configure host-specific settings for one or more hosts.

The bundle will contain three CSV files: Host-Specific configuration Metadata: Header row: HostSpecific Property, Data Type, Data Format, Sample Data, Default Value, Minimum, Maximum, Minimum Items, Maximum Items, Minimum Length, Maximum Length, Pattern, Enumerations, Dependent Property, Dependent Property Value. Row: /esx/network/vmknics/(device)/mac_from_user, STRING, "", "", "", "", "", "", "", "", "", "", "", esx/network/vmknics/(device)/mac_mode, USER_DEFINED

Host Specific Configuration Template: Header row: Host BIOS UUID, Host IP/Name, HostSpecific Property, Host Specific Data Row: (host UUID), (host ip/name), esx/network/vmknics/(device)/mac_from_user, (value)

Hosts: Header: Host BIOS UUID, Host IP/Name Row: 23B507F5-204B-4F6C-AA8A-000000000001, 1.1.1.1 Row: 23B507F5-204B-4F6C-AA8A-000000000002, 1.1.1.2

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.

Request
URI
GET
https://{api_host}/esx/settings/clusters/{cluster}/configuration/host-specific-templates
COPY
Path Parameters
string
cluster
Required

Identifier of the cluster

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

Query Parameters
params
Required

Input parameters

If missing or null, fallback to default parameters.


Authentication
This operation uses the following authentication methods.
Responses
200

Output structure containing host-specific configuration template, metadata and host UUIDs.

Returns Esx.Settings.Clusters.Configuration.HostSpecificTemplates.Info of type(s) application/json
"Esx.Settings.Clusters.Configuration.HostSpecificTemplates.Info 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 the cluster is not found in the system.

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

500

If there is some other unknown internal error. The accompanying error message will give more details about the failure.

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/clusters/{cluster}/configuration/host-specific-templates?params=v