HostPortGroupSpec

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

AllOf

This class requires all of the following:

DataObject

JSON Example

{
    "_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

name

Required

The name of the port group.

integer As int32 As int32

vlanId

Required

The VLAN ID for ports using this port group.

Possible values:

A value of 0 specifies that you do not want the port group associated with a VLAN.
A value from 1 to 4094 specifies a VLAN ID for the port group.
A value of 4095 specifies that the port group should use trunk mode, which allows the guest operating system to manage its own VLAN tags.

string

vswitchName

Required

The identifier of the virtual switch on which this port group is located.

HostNetworkPolicy

policy

Required

This data object type describes network policies that can be configured for both virtual switches and port groups.

The policy settings on the port group can inherit policy settings from their containing virtual switch. These policy settings are inherited if the settings on the port group are not set. Since every policy setting on a port group is optional, every individual policy setting can be inherited.

By contrast, if a host is capable of implementing a policy setting, every virtual switch has some value assigned to the policy setting. In this case, although all of the policy settings are optional, they always have some value either by inheritance or by direct setting.

Policy settings are organized into policy groups such as SecurityPolicy. Policy groups are optional since it is possible that a host may not implement such policies. If a host does not support a policy group, the policy group is not set on both the virtual switches and the port groups.