Esx. Settings. Hosts. Software. Drafts. Display Name Set

Esx. Settings. Hosts. Software. Drafts. Display Name Set

Sets a new display name in the software draft. It will overwrite the existing name if one already exists.

This operation was added in vSphere API 9.0.0.0.

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

  • Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
  • The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.
Request
URI
PUT
https://{api_host}/esx/settings/hosts/{host}/software/drafts/{draft}/display-name
COPY
Path Parameters
string
host
Required

Identifier of the host.

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

string
draft
Required

Identifier of the working copy document.

The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

Request Body

Display name specification.

Esx.Settings.Hosts.Software.Drafts.DisplayName.SetSpec of type(s) application/json
Required 
"Esx.Settings.Hosts.Software.Drafts.DisplayName.SetSpec Object"
Authentication
This operation uses the following authentication methods.
Responses
204

Success!

Operation doesn't return any data structure

400

If the host is not a vLCM managed standalone host.

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

401

if the caller is not authenticated.

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

403

If the caller does not have the necessary privileges

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

404

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

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

500

If there is some 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 -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/esx/settings/hosts/{host}/software/drafts/{draft}/display-name
On This Page
Esx.settings.hosts.software.drafts.display Name Operations
GET
Esx. Settings. Hosts. Software. Drafts. Display Name Get
PUT
Esx. Settings. Hosts. Software. Drafts. Display Name Set