Host Network System Update Ip Route Config

Host Network System Update Ip Route Config

Deprecated as of vSphere API 5.5, which is moved to each NetStackInstance. This API only works on the default NetStackInstance.

Applies the IP route configuration.

Required privileges: Host.Config.Network

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostNetworkSystem/{moId}/UpdateIpRouteConfig
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostNetworkSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Request Body
UpdateIpRouteConfigRequestType of type(s) application/json
Required 
{
    "config": {
        "_typeName": "string",
        "defaultGateway": "string",
        "gatewayDevice": "string",
        "ipV6DefaultGateway": "string",
        "ipV6GatewayDevice": "string"
    }
}
HostIpRouteConfig
config
Required

IP Route Configuration.

All IPv4 addresses, subnet addresses, and netmasks are specified as strings using dotted decimal notation. For example, "192.0.2.1". IPv6 addresses are 128-bit addresses represented as eight fields of up to four hexadecimal digits. A colon separates each field (:). For example, 2001:DB8:101::230:6eff:fe04:d9ff. The address can also consist of symbol '::' to represent multiple 16-bit groups of contiguous 0's only once in an address as described in RFC 2373.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

InvalidArgument: if any of the IP addresses are invalid.

InvalidState: if the an ipv6 address is specified in an ipv4 only system

NotSupported: if the host is not an ESX Server system.

HostConfigFault: for all other configuration failures.

Returns VimFault of type(s) application/json
This response body class contains all of the following: MethodFault 
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page
Host Network System Operations
POST
Host Network System Add Port Group
POST
Host Network System Add Service Console Virtual Nic
POST
Host Network System Add Virtual Nic
POST
Host Network System Add Virtual Switch
GET
Host Network System Get Available Field
GET
Host Network System Get Capabilities
GET
Host Network System Get Console Ip Route Config
GET
Host Network System Get Dns Config
GET
Host Network System Get Ip Route Config
GET
Host Network System Get Network Config
GET
Host Network System Get Network Info
GET
Host Network System Get Offload Capabilities
GET
Host Network System Get Value
POST
Host Network System Query Network Hint
POST
Host Network System Refresh Network System
POST
Host Network System Remove Port Group
POST
Host Network System Remove Service Console Virtual Nic
POST
Host Network System Remove Virtual Nic
POST
Host Network System Remove Virtual Switch
POST
Host Network System Restart Service Console Virtual Nic
POST
Host Network System Set Custom Value
POST
Host Network System Update Console Ip Route Config
POST
Host Network System Update Dns Config
POST
Host Network System Update Ip Route Config
POST
Host Network System Update Ip Route Table Config
POST
Host Network System Update Network Config
POST
Host Network System Update Physical Nic Link Speed
POST
Host Network System Update Port Group
POST
Host Network System Update Service Console Virtual Nic
POST
Host Network System Update Virtual Nic
POST
Host Network System Update Virtual Switch