Host Network System Add Service Console Virtual Nic

Host Network System Add Service Console Virtual Nic

Adds a virtual service console network adapter.

Returns the device of the VirtualNic.

IP configuration is required although it does not have to be enabled if the host is an ESX Server system. 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 usesServiceConsoleNic.

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostNetworkSystem/{moId}/AddServiceConsoleVirtualNic
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
AddServiceConsoleVirtualNicRequestType of type(s) application/json
Required 
{
    "portgroup": "string",
    "nic": {
        "_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"
    }
}
string
portgroup
Required

portgroup

HostVirtualNicSpec
nic
Required

The HostVirtualNicSpec data object describes the HostVirtualNic configuration containing both the configured properties on a virtual NIC and identification information.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

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

500

InvalidArgument: if the IP address or subnet mask in the IP configuration are invalid or the named PortGroup does not exist.

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

HostConfigFault: for all other configuration failures.

Returns HostConfigFault of type(s) application/json
This response body class contains all of the following: VimFault 
{
    "_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