This API has a deprecated equivalent from v7.0U1.
Change Networking 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
Request
URLURL
https://{api_host}/api/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
{
"SSO_password": "string",
"SSO_user": "string",
"hostname": "string"
}
string
SSO_password
Required
vCenter Server SSO administrator Password
string
SSO_user
Required
vCenter Server SSO administrator username
string
hostname
Required
New hostname to assign to the management network of vCenter appliance
dns
Optional
DNS Configuration to set for the machine If unset DNS settings will not be changed
ipv4
Optional
IPv4 Configuration to set for the machine If unset IPv4 settings will not be changed
ipv6
Optional
IPv6 Configuration to set for the machine If unset IPv6 settings will not be changed
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted returns
string
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.
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
PowerCLI Client SDK Example
$NetworkingChangeSpec = Initialize-NetworkingChangeSpec -Hostname "MyHostname" -SSOUser "MySSOUser" -SSOPassword "MySSOPassword"
Invoke-ChangeNetworkingAsync -NetworkingChangeSpec $NetworkingChangeSpec
PowerCLI Client SDK All Parameters Example
$NetworkingDnsServersDNSServerConfig = Initialize-NetworkingDnsServersDNSServerConfig -Mode "dhcp" -Servers "MyServers"
$NetworkingInterfacesIpv4Config = Initialize-NetworkingInterfacesIpv4Config -Mode "DHCP" -Address "MyAddress" -Prefix 0 -DefaultGateway "MyDefaultGateway"
$NetworkingInterfacesIpv6Address = Initialize-NetworkingInterfacesIpv6Address -Address "MyAddress" -Prefix 0
$NetworkingInterfacesIpv6Config = Initialize-NetworkingInterfacesIpv6Config -Dhcp $false -Autoconf $false -Addresses $NetworkingInterfacesIpv6Address -DefaultGateway "MyDefaultGateway"
$NetworkingChangeSpec = Initialize-NetworkingChangeSpec -Hostname "MyHostname" -SSOUser "MySSOUser" -SSOPassword "MySSOPassword" -Dns $NetworkingDnsServersDNSServerConfig -Ipv4 $NetworkingInterfacesIpv4Config -Ipv6 $NetworkingInterfacesIpv6Config
Invoke-ChangeNetworkingAsync -NetworkingChangeSpec $NetworkingChangeSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"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}/api/appliance/networking?action=change&vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/appliance/networking?action=change&vmw-task=true
x-vmw-doc-operation: change_task
Availability
Added in 7.0U2
