Host Network System Update Network Config

Host Network System Update Network Config

Applies the network configuration.

This method operates primarily in two modes: replace or modify mode.

replace When called in replace mode, this method applies the fully specified networking configuration to the networking system.

Upon successful completion of the call, the state of networking will match the configuration specified in config. In general, objects are created or destroyed to match the elements in the array of configurations. The identifier field in each element in an array of configurations is used to match an existing network entity. The state of existing network entities is patched to match that of the configuration.

An exception to this approach applies to the array of PhysicalNic.Config objects. The cardinality of physical network adapters cannot be changed through this operation. Thus, the identifier of every element in the array must match an existing PhysicalNic. If there are fewer elements in the array than there are existing PhysicalNics, then no change is made on the unreferenced PhysicalNic objects.

If the call fails, the networking error is returned as an exception and the state of networking reverts to the state prior to the start of the call.

modify When called in modify mode, only changes that are specified are made. For singleton entities like DnsConfig, the state is changed only if the data object is set. For array elements, there is an Operation field that indicates if the element should be added, removed, or edited. In the case of editing or removal, the entity must exist or an exception is thrown. In the case of adding, a specification needs to be provided.

It returns device names of vmkernel and service console virtual network adapter added to the system.

Currently, the only mode that is implemented is incremental mode. Only add operations are supported for instances. Singleton configuration is not supported. The dynamic privilege check will ensure that users have Host.Config.Network privilege on the host, and Network.Assign privilege on the connecting DVPortGroup, or DVS if connecting to a standalone DVPort. Network.Assign privilege is not required for operations on standard network or for operations performed directly on the host

See also HostConfigChangeModeEnum.

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostNetworkSystem/{moId}/UpdateNetworkConfig
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
UpdateNetworkConfigRequestType of type(s) application/json
Required
{
    "config": {
        "_typeName": "string",
        "vswitch": [
            {
                "_typeName": "string",
                "changeOperation": "string",
                "name": "string",
                "spec": {
                    "_typeName": "string",
                    "numPorts": 0,
                    "bridge": {
                        "_typeName": "string"
                    },
                    "policy": {
                        "_typeName": "string",
                        "security": {
                            "_typeName": "string",
                            "allowPromiscuous": false,
                            "macChanges": false,
                            "forgedTransmits": false
                        },
                        "nicTeaming": {
                            "_typeName": "string",
                            "policy": "string",
                            "reversePolicy": false,
                            "notifySwitches": false,
                            "rollingOrder": false,
                            "failureCriteria": {
                                "_typeName": "string",
                                "checkSpeed": "string",
                                "speed": 0,
                                "checkDuplex": false,
                                "fullDuplex": false,
                                "checkErrorPercent": false,
                                "percentage": 0,
                                "checkBeacon": false
                            },
                            "nicOrder": {
                                "_typeName": "string",
                                "activeNic": [
                                    "string"
                                ],
                                "standbyNic": [
                                    "string"
                                ]
                            }
                        },
                        "offloadPolicy": {
                            "_typeName": "string",
                            "csumOffload": false,
                            "tcpSegmentation": false,
                            "zeroCopyXmit": false
                        },
                        "shapingPolicy": {
                            "_typeName": "string",
                            "enabled": false,
                            "averageBandwidth": 0,
                            "peakBandwidth": 0,
                            "burstSize": 0
                        }
                    },
                    "mtu": 0
                }
            }
        ],
        "proxySwitch": [
            {
                "_typeName": "string",
                "changeOperation": "string",
                "uuid": "string",
                "spec": {
                    "_typeName": "string",
                    "backing": {
                        "_typeName": "string"
                    }
                }
            }
        ],
        "portgroup": [
            {
                "_typeName": "string",
                "changeOperation": "string",
                "spec": {
                    "_typeName": "string",
                    "name": "string",
                    "vlanId": 0,
                    "vswitchName": "string",
                    "policy": {
                        "_typeName": "string",
                        "security": {
                            "_typeName": "string",
                            "allowPromiscuous": false,
                            "macChanges": false,
                            "forgedTransmits": false
                        },
                        "nicTeaming": {
                            "_typeName": "string",
                            "policy": "string",
                            "reversePolicy": false,
                            "notifySwitches": false,
                            "rollingOrder": false,
                            "failureCriteria": {
                                "_typeName": "string",
                                "checkSpeed": "string",
                                "speed": 0,
                                "checkDuplex": false,
                                "fullDuplex": false,
                                "checkErrorPercent": false,
                                "percentage": 0,
                                "checkBeacon": false
                            },
                            "nicOrder": {
                                "_typeName": "string",
                                "activeNic": [
                                    "string"
                                ],
                                "standbyNic": [
                                    "string"
                                ]
                            }
                        },
                        "offloadPolicy": {
                            "_typeName": "string",
                            "csumOffload": false,
                            "tcpSegmentation": false,
                            "zeroCopyXmit": false
                        },
                        "shapingPolicy": {
                            "_typeName": "string",
                            "enabled": false,
                            "averageBandwidth": 0,
                            "peakBandwidth": 0,
                            "burstSize": 0
                        }
                    }
                }
            }
        ],
        "pnic": [
            {
                "_typeName": "string",
                "device": "string",
                "spec": {
                    "_typeName": "string",
                    "ip": {
                        "_typeName": "string",
                        "dhcp": false,
                        "ipAddress": "string",
                        "subnetMask": "string",
                        "ipV6Config": {
                            "_typeName": "string",
                            "ipV6Address": [
                                {
                                    "_typeName": "string",
                                    "ipAddress": "string",
                                    "prefixLength": 0,
                                    "origin": "string",
                                    "dadState": "string",
                                    "lifetime": "string",
                                    "operation": "string"
                                }
                            ],
                            "autoConfigurationEnabled": false,
                            "dhcpV6Enabled": false
                        }
                    },
                    "linkSpeed": {
                        "_typeName": "string",
                        "speedMb": 0,
                        "duplex": false
                    },
                    "enableEnhancedNetworkingStack": false,
                    "ensInterruptEnabled": false
                }
            }
        ],
        "vnic": [
            {
                "_typeName": "string",
                "changeOperation": "string",
                "device": "string",
                "portgroup": "string",
                "spec": {
                    "_typeName": "string",
                    "dynamicProperty": [
                        {
                            "_typeName": "string",
                            "name": "string",
                            "val": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "ip": {
                        "_typeName": "string",
                        "dhcp": false,
                        "ipAddress": "string",
                        "subnetMask": "string",
                        "ipV6Config": {
                            "_typeName": "string",
                            "ipV6Address": [
                                {
                                    "_typeName": "string",
                                    "ipAddress": "string",
                                    "prefixLength": 0,
                                    "origin": "string",
                                    "dadState": "string",
                                    "lifetime": "string",
                                    "operation": "string"
                                }
                            ],
                            "autoConfigurationEnabled": false,
                            "dhcpV6Enabled": false
                        }
                    },
                    "mac": "string",
                    "distributedVirtualPort": {
                        "_typeName": "string",
                        "switchUuid": "string",
                        "portgroupKey": "string",
                        "portKey": "string",
                        "connectionCookie": 0
                    },
                    "portgroup": "string",
                    "mtu": 0,
                    "tsoEnabled": false,
                    "netStackInstanceKey": "string",
                    "opaqueNetwork": {
                        "_typeName": "string",
                        "opaqueNetworkId": "string",
                        "opaqueNetworkType": "string"
                    },
                    "externalId": "string",
                    "pinnedPnic": "string",
                    "ipRouteSpec": {
                        "_typeName": "string",
                        "ipRouteConfig": {
                            "_typeName": "string",
                            "defaultGateway": "string",
                            "gatewayDevice": "string",
                            "ipV6DefaultGateway": "string",
                            "ipV6GatewayDevice": "string"
                        }
                    },
                    "systemOwned": false,
                    "dpuId": "string"
                }
            }
        ],
        "consoleVnic": [
            {
                "_typeName": "string",
                "changeOperation": "string",
                "device": "string",
                "portgroup": "string",
                "spec": {
                    "_typeName": "string",
                    "dynamicProperty": [
                        {
                            "_typeName": "string",
                            "name": "string",
                            "val": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "ip": {
                        "_typeName": "string",
                        "dhcp": false,
                        "ipAddress": "string",
                        "subnetMask": "string",
                        "ipV6Config": {
                            "_typeName": "string",
                            "ipV6Address": [
                                {
                                    "_typeName": "string",
                                    "ipAddress": "string",
                                    "prefixLength": 0,
                                    "origin": "string",
                                    "dadState": "string",
                                    "lifetime": "string",
                                    "operation": "string"
                                }
                            ],
                            "autoConfigurationEnabled": false,
                            "dhcpV6Enabled": false
                        }
                    },
                    "mac": "string",
                    "distributedVirtualPort": {
                        "_typeName": "string",
                        "switchUuid": "string",
                        "portgroupKey": "string",
                        "portKey": "string",
                        "connectionCookie": 0
                    },
                    "portgroup": "string",
                    "mtu": 0,
                    "tsoEnabled": false,
                    "netStackInstanceKey": "string",
                    "opaqueNetwork": {
                        "_typeName": "string",
                        "opaqueNetworkId": "string",
                        "opaqueNetworkType": "string"
                    },
                    "externalId": "string",
                    "pinnedPnic": "string",
                    "ipRouteSpec": {
                        "_typeName": "string",
                        "ipRouteConfig": {
                            "_typeName": "string",
                            "defaultGateway": "string",
                            "gatewayDevice": "string",
                            "ipV6DefaultGateway": "string",
                            "ipV6GatewayDevice": "string"
                        }
                    },
                    "systemOwned": false,
                    "dpuId": "string"
                }
            }
        ],
        "dnsConfig": {
            "_typeName": "string",
            "dhcp": false,
            "virtualNicDevice": "string",
            "ipv6VirtualNicDevice": "string",
            "hostName": "string",
            "domainName": "string",
            "address": [
                "string"
            ],
            "searchDomain": [
                "string"
            ]
        },
        "ipRouteConfig": {
            "_typeName": "string",
            "defaultGateway": "string",
            "gatewayDevice": "string",
            "ipV6DefaultGateway": "string",
            "ipV6GatewayDevice": "string"
        },
        "consoleIpRouteConfig": {
            "_typeName": "string",
            "defaultGateway": "string",
            "gatewayDevice": "string",
            "ipV6DefaultGateway": "string",
            "ipV6GatewayDevice": "string"
        },
        "routeTableConfig": {
            "_typeName": "string",
            "ipRoute": [
                {
                    "_typeName": "string",
                    "changeOperation": "string",
                    "route": {
                        "_typeName": "string",
                        "network": "string",
                        "prefixLength": 0,
                        "gateway": "string",
                        "deviceName": "string"
                    }
                }
            ],
            "ipv6Route": [
                {
                    "_typeName": "string",
                    "changeOperation": "string",
                    "route": {
                        "_typeName": "string",
                        "network": "string",
                        "prefixLength": 0,
                        "gateway": "string",
                        "deviceName": "string"
                    }
                }
            ]
        },
        "dhcp": [
            {
                "_typeName": "string",
                "changeOperation": "string",
                "key": "string",
                "spec": {
                    "_typeName": "string",
                    "virtualSwitch": "string",
                    "defaultLeaseDuration": 0,
                    "leaseBeginIp": "string",
                    "leaseEndIp": "string",
                    "maxLeaseDuration": 0,
                    "unlimitedLease": false,
                    "ipSubnetAddr": "string",
                    "ipSubnetMask": "string"
                }
            }
        ],
        "nat": [
            {
                "_typeName": "string",
                "changeOperation": "string",
                "key": "string",
                "spec": {
                    "_typeName": "string",
                    "virtualSwitch": "string",
                    "activeFtp": false,
                    "allowAnyOui": false,
                    "configPort": false,
                    "ipGatewayAddress": "string",
                    "udpTimeout": 0,
                    "portForward": [
                        {
                            "_typeName": "string",
                            "type": "string",
                            "name": "string",
                            "hostPort": 0,
                            "guestPort": 0,
                            "guestIpAddress": "string"
                        }
                    ],
                    "nameService": {
                        "_typeName": "string",
                        "dnsAutoDetect": false,
                        "dnsPolicy": "string",
                        "dnsRetries": 0,
                        "dnsTimeout": 0,
                        "dnsNameServer": [
                            "string"
                        ],
                        "nbdsTimeout": 0,
                        "nbnsRetries": 0,
                        "nbnsTimeout": 0
                    }
                }
            }
        ],
        "ipV6Enabled": false,
        "netStackSpec": [
            {
                "_typeName": "string",
                "netStackInstance": {
                    "_typeName": "string",
                    "key": "string",
                    "name": "string",
                    "dnsConfig": {
                        "_typeName": "string",
                        "dhcp": false,
                        "virtualNicDevice": "string",
                        "ipv6VirtualNicDevice": "string",
                        "hostName": "string",
                        "domainName": "string",
                        "address": [
                            "string"
                        ],
                        "searchDomain": [
                            "string"
                        ]
                    },
                    "ipRouteConfig": {
                        "_typeName": "string",
                        "defaultGateway": "string",
                        "gatewayDevice": "string",
                        "ipV6DefaultGateway": "string",
                        "ipV6GatewayDevice": "string"
                    },
                    "requestedMaxNumberOfConnections": 0,
                    "congestionControlAlgorithm": "string",
                    "ipV6Enabled": false,
                    "routeTableConfig": {
                        "_typeName": "string",
                        "ipRoute": [
                            {
                                "_typeName": "string",
                                "changeOperation": "string",
                                "route": {
                                    "_typeName": "string",
                                    "network": "string",
                                    "prefixLength": 0,
                                    "gateway": "string",
                                    "deviceName": "string"
                                }
                            }
                        ],
                        "ipv6Route": [
                            {
                                "_typeName": "string",
                                "changeOperation": "string",
                                "route": {
                                    "_typeName": "string",
                                    "network": "string",
                                    "prefixLength": 0,
                                    "gateway": "string",
                                    "deviceName": "string"
                                }
                            }
                        ]
                    }
                },
                "operation": "string"
            }
        ],
        "migrationStatus": "string"
    },
    "changeMode": "string"
}
config
Required

This data object type describes networking host configuration data objects.

These objects contain only the configuration information for networking. The runtime information is available from the NetworkInfo data object type.

See also HostNetworkInfo.

string
changeMode
Required

changeMode

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns HostNetworkConfigResult of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_typeName": "string",
    "vnicDevice": [
        "string"
    ],
    "consoleVnicDevice": [
        "string"
    ]
}
array of string
vnicDevice
Optional

Virtual network adapter keys.

array of string
consoleVnicDevice
Optional

Service console virtual network adapter keys.


500

AlreadyExists: when a network entity specified in the configuration already exists.

NotFound: when a network entity specified in the configuration already exists.

InvalidArgument: if an invalid parameter is passed in for one of the networking objects.

NotSupported: if modify mode is not used, a remove or set operation is specified for an instance, or a singleton entity is configured.

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"
        }
    ]
}

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