Appliance Networking change$Task

Appliance Networking change$Task

Changes the Hostname/IP of the management network of vCenter appliance. The Hostname/IP change invokes the PNID change process which involves LDAP entry modification, updating registry entries, configuration files modification and network configuration changes. vCenter server is expected to be down for few minutes during these changes

This operation was added in vSphere API 6.7.3.

Request
URI
POST
https://{api_host}/api/appliance/networking?action=change&vmw-task=true
COPY
Request Body

Information required to change the hostname.

Appliance Networking ChangeSpec of type(s) application/json
Required

Show optional properties

{
    "hostname": "string",
    "sso_user": "string",
    "sso_password": "string"
}
{
    "hostname": "string",
    "sso_user": "string",
    "sso_password": "string",
    "dns": {
        "mode": "string",
        "servers": [
            "string"
        ]
    },
    "ipv4": {
        "mode": "string",
        "address": "string",
        "prefix": 0,
        "default_gateway": "string"
    },
    "ipv6": {
        "dhcp": false,
        "autoconf": false,
        "addresses": [
            {
                "address": "string",
                "prefix": 0
            }
        ],
        "default_gateway": "string"
    }
}
string
hostname
Required

New hostname to assign to the management network of vCenter appliance

This property was added in vSphere API 6.7.3.

string
sso_user
Required

vCenter Server SSO administrator username

This property was added in vSphere API 6.7.3.

string As password As password
sso_password
Required

vCenter Server SSO administrator Password

This property was added in vSphere API 6.7.3.

dns
Optional

DNS Configuration to set for the machine

This property was added in vSphere API 6.7.3.

If missing or null DNS settings will not be changed

ipv4
Optional

IPv4 Configuration to set for the machine

This property was added in vSphere API 6.7.3.

If missing or null IPv4 settings will not be changed

ipv6
Optional

IPv6 Configuration to set for the machine

This property was added in vSphere API 6.7.3.

If missing or null IPv6 settings will not be changed

Authentication
This operation uses the following authentication methods.
Responses
202

Success!

Returns string of type(s) application/json
Operation doesn't return any data structure

400

Vapi Std Errors Unsupported if it's not embedded node

Vapi Std Errors InvalidArgument if passed arguments are invalid.

Vapi Std Errors NotAllowedInCurrentState if another change task is in progress

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.


401

if the user is not authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0 
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"hostname:"string","sso_password:"string","sso_user:"string"}' https://{api_host}/api/appliance/networking?action=change&vmw-task=true
On This Page
Appliance Operations
GET
Appliance Networking get
PATCH
Appliance Networking update
POST
Appliance Networking reset
POST
Appliance Networking change$Task