Host Network System Update Port Group

Reconfigures a port group on the virtual switch.

Required privileges: Host.Config.Network

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostNetworkSystem/{moId}/UpdatePortGroup

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

UpdatePortGroupRequestType of type(s) application/json

Required

{
    "pgName": "string",
    "portgrp": {
        "_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
            }
        }
    }
}

string

pgName

Required

pgName

HostPortGroupSpec

portgrp

Required

This data object type describes the PortGroup specification representing the properties on a PortGroup that can be configured.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

AlreadyExists: if the update causes the port group to conflict with an existing port group.

NotFound: if the port group or virtual switch does not exist.

InvalidArgument: if the PortGroup vlanId is invalid. Valid vlanIds range from [0,4095], where 0 means no vlan tagging. Exception is also thrown if network policy is invalid.

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

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Host Network System Operations