HostPortGroup

HostPortGroup
HostPortGroup

This data object type is used to describe port groups.

Port groups are used to group virtual network adapters on a virtual switch, associating them with networks and network policies.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "key": "string",
    "port": [
        {
            "_typeName": "string",
            "key": "string",
            "mac": [
                "string"
            ],
            "type": "string"
        }
    ],
    "vswitch": "string",
    "computedPolicy": {
        "_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
        }
    },
    "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
            }
        }
    }
}
string
key
Optional

The linkable identifier.

array of HostPortGroupPort
port
Optional

The ports that currently exist and are used on this port group.

string
vswitch
Optional

The virtual switch that contains this port group.

computedPolicy
Required

Computed network policies that are applicable for a port group.

The inheritance scheme for PortGroup requires knowledge about the NetworkPolicy for a port group and its parent virtual switch as well as the logic for computing the results. This information is provided as a convenience so that callers need not duplicate the inheritance logic to determine the proper values for a network policy.

See the description of the NetworkPolicy data object type for more information.

spec
Required

The specification of a port group.

Property Of