Host Network System Update Port Group

Host Network System Update Port Group

Reconfigures a port group on the virtual switch.

Required privileges: Host.Config.Network

Request
URI
POST
https://{api_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 
"UpdatePortGroupRequestType Object"
string
pgName
Required

pgName

object
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.
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: InlineVimFault0 
"VimFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/HostNetworkSystem/{moId}/UpdatePortGroup
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
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
Deprecated
POST
Host Network System Update Ip Route Config
Deprecated
POST
Host Network System Update Ip Route Table Config
Deprecated
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
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
Deprecated
GET
Host Network System Get Ip Route Config
Deprecated
GET
Host Network System Get Network Config
GET
Host Network System Get Network Info
GET
Host Network System Get Offload Capabilities
Deprecated
GET
Host Network System Get Value