Appliance Networking Dns Servers set

Set the DNS server configuration. If you set the mode argument to "DHCP", a DHCP refresh is forced.

Request

URI

PUT

https://{api_host}/api/appliance/networking/dns/servers

COPY

Request Body

DNS server configuration.

Appliance Networking Dns Servers DNSServerConfig of type(s) application/json

Required

Show optional properties

{
    "mode": "string",
    "servers": [
        {}
    ]
}

{
    "mode": "string",
    "servers": [
        "string"
    ]
}

string

mode

Required

Define how to determine the DNS servers. Leave the servers argument empty if the mode argument is "DHCP". Set the servers argument to a comma-separated list of DNS servers if the mode argument is "static". The DNS server are assigned from the specified list.

For more information see: Appliance Networking Dns Servers DNSServerMode.

array of string

servers

Required

List of the currently used DNS servers.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

204

Success!

Operation doesn't return any data structure

500

Generic error

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

"Vapi Std Errors Error Object"

array of object

messages

Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string

error_type

Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"mode:"string","servers":["string"]}' https://{api_host}/api/appliance/networking/dns/servers

On This Page

Description

Request

Request Body

Authentication

Response

204 Response Body

Errors

Appliance Operations

POST

Appliance Networking Dns Servers test

GET