Change Networking Task Deprecated
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
Request
URLURL
https://{api_host}/rest/appliance/networking?action=change&vmw-task=true
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
NetworkingChangeTaskRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"spec": {
"SSO_password": "string",
"SSO_user": "string",
"hostname": "string"
}
}
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
NetworkingChangeTaskResponseBody
of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists.
{
"value": "string"
}
string
value
Optional
Identifier for the task created by this API invocation.
Errors
400
com.vmware.vapi.std.errors.unsupported : if it’s not embedded node | com.vmware.vapi.std.errors.invalid_argument : if passed arguments are invalid. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if another change task is in progress
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"SSO_password":"string","SSO_user":"string","dns":{"mode":"dhcp","servers":["string"]},"hostname":"string","ipv4":{"address":"string","default_gateway":"string","mode":"DHCP","prefix":0},"ipv6":{"addresses":[{"address":"string","prefix":0}],"autoconf":false,"default_gateway":"string","dhcp":false}}}' https://{api_host}/rest/appliance/networking?action=change&vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: post
x-vmw-doc-new-path: /api/appliance/networking?action=change&vmw-task=true
x-vmw-doc-operation: change_task
Availability
Added in 6.7.3
