VMwareDVSConfigSpec

VMwareDVSConfigSpec
VMwareDVSConfigSpec

This class defines the VMware specific configuration for DistributedVirtualSwitch.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "dynamicProperty": [
        {
            "_typeName": "string",
            "name": "string",
            "val": {
                "_typeName": "string"
            }
        }
    ],
    "configVersion": "string",
    "name": "string",
    "numStandalonePorts": 0,
    "maxPorts": 0,
    "uplinkPortPolicy": {
        "_typeName": "string"
    },
    "uplinkPortgroup": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "defaultPortConfig": {
        "_typeName": "string",
        "blocked": {
            "_typeName": "string",
            "inherited": false,
            "value": false
        },
        "vmDirectPathGen2Allowed": {
            "_typeName": "string",
            "inherited": false,
            "value": false
        },
        "inShapingPolicy": {
            "_typeName": "string",
            "inherited": false,
            "enabled": {
                "_typeName": "string",
                "inherited": false,
                "value": false
            },
            "averageBandwidth": {
                "_typeName": "string",
                "inherited": false,
                "value": 0
            },
            "peakBandwidth": {
                "_typeName": "string",
                "inherited": false,
                "value": 0
            },
            "burstSize": {
                "_typeName": "string",
                "inherited": false,
                "value": 0
            }
        },
        "outShapingPolicy": {
            "_typeName": "string",
            "inherited": false,
            "enabled": {
                "_typeName": "string",
                "inherited": false,
                "value": false
            },
            "averageBandwidth": {
                "_typeName": "string",
                "inherited": false,
                "value": 0
            },
            "peakBandwidth": {
                "_typeName": "string",
                "inherited": false,
                "value": 0
            },
            "burstSize": {
                "_typeName": "string",
                "inherited": false,
                "value": 0
            }
        },
        "vendorSpecificConfig": {
            "_typeName": "string",
            "inherited": false,
            "keyValue": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "opaqueData": "string"
                }
            ]
        },
        "networkResourcePoolKey": {
            "_typeName": "string",
            "inherited": false,
            "value": "string"
        },
        "filterPolicy": {
            "_typeName": "string",
            "inherited": false,
            "filterConfig": [
                {
                    "_typeName": "string",
                    "inherited": false,
                    "key": "string",
                    "agentName": "string",
                    "slotNumber": "string",
                    "parameters": {
                        "_typeName": "string",
                        "parameters": [
                            "string"
                        ]
                    },
                    "onFailure": "string"
                }
            ]
        }
    },
    "host": [
        {
            "_typeName": "string",
            "dynamicProperty": [
                {
                    "_typeName": "string",
                    "name": "string",
                    "val": {
                        "_typeName": "string"
                    }
                }
            ],
            "operation": "string",
            "host": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "backing": {
                "_typeName": "string"
            },
            "maxProxySwitchPorts": 0,
            "vendorSpecificConfig": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "opaqueData": "string"
                }
            ]
        }
    ],
    "extensionKey": "string",
    "description": "string",
    "policy": {
        "_typeName": "string",
        "autoPreInstallAllowed": false,
        "autoUpgradeAllowed": false,
        "partialUpgradeAllowed": false
    },
    "vendorSpecificConfig": [
        {
            "_typeName": "string",
            "key": "string",
            "opaqueData": "string"
        }
    ],
    "contact": {
        "_typeName": "string",
        "name": "string",
        "contact": "string"
    },
    "switchIpAddress": "string",
    "defaultProxySwitchMaxNumPorts": 0,
    "infrastructureTrafficResourceConfig": [
        {
            "_typeName": "string",
            "key": "string",
            "description": "string",
            "allocationInfo": {
                "_typeName": "string",
                "limit": 0,
                "shares": {
                    "_typeName": "string",
                    "shares": 0,
                    "level": "string"
                },
                "reservation": 0
            }
        }
    ],
    "netResourcePoolTrafficResourceConfig": [
        {
            "_typeName": "string",
            "key": "string",
            "description": "string",
            "allocationInfo": {
                "_typeName": "string",
                "limit": 0,
                "shares": {
                    "_typeName": "string",
                    "shares": 0,
                    "level": "string"
                },
                "reservation": 0
            }
        }
    ],
    "networkResourceControlVersion": "string",
    "pvlanConfigSpec": [
        {
            "_typeName": "string",
            "pvlanEntry": {
                "_typeName": "string",
                "primaryVlanId": 0,
                "secondaryVlanId": 0,
                "pvlanType": "string"
            },
            "operation": "string"
        }
    ],
    "vspanConfigSpec": [
        {
            "_typeName": "string",
            "vspanSession": {
                "_typeName": "string",
                "key": "string",
                "name": "string",
                "description": "string",
                "enabled": false,
                "sourcePortTransmitted": {
                    "_typeName": "string",
                    "portKey": [
                        "string"
                    ],
                    "uplinkPortName": [
                        "string"
                    ],
                    "wildcardPortConnecteeType": [
                        "string"
                    ],
                    "vlans": [
                        0
                    ],
                    "ipAddress": [
                        "string"
                    ]
                },
                "sourcePortReceived": {
                    "_typeName": "string",
                    "portKey": [
                        "string"
                    ],
                    "uplinkPortName": [
                        "string"
                    ],
                    "wildcardPortConnecteeType": [
                        "string"
                    ],
                    "vlans": [
                        0
                    ],
                    "ipAddress": [
                        "string"
                    ]
                },
                "destinationPort": {
                    "_typeName": "string",
                    "portKey": [
                        "string"
                    ],
                    "uplinkPortName": [
                        "string"
                    ],
                    "wildcardPortConnecteeType": [
                        "string"
                    ],
                    "vlans": [
                        0
                    ],
                    "ipAddress": [
                        "string"
                    ]
                },
                "encapsulationVlanId": 0,
                "stripOriginalVlan": false,
                "mirroredPacketLength": 0,
                "normalTrafficAllowed": false,
                "sessionType": "string",
                "samplingRate": 0,
                "encapType": "string",
                "erspanId": 0,
                "erspanCOS": 0,
                "erspanGraNanosec": false,
                "netstack": "string"
            },
            "operation": "string"
        }
    ],
    "maxMtu": 0,
    "linkDiscoveryProtocolConfig": {
        "_typeName": "string",
        "protocol": "string",
        "operation": "string"
    },
    "ipfixConfig": {
        "_typeName": "string",
        "collectorIpAddress": "string",
        "collectorPort": 0,
        "observationDomainId": 0,
        "activeFlowTimeout": 0,
        "idleFlowTimeout": 0,
        "samplingRate": 0,
        "internalFlowsOnly": false
    },
    "lacpApiVersion": "string",
    "multicastFilteringMode": "string",
    "networkOffloadSpecId": "string",
    "networkOffloadConfig": {
        "_typeName": "string",
        "dpuFailoverPolicy": {
            "_typeName": "string",
            "activeUplink": [
                "string"
            ],
            "standbyUplink": [
                "string"
            ]
        }
    },
    "realTimeConfig": {
        "_typeName": "string",
        "allowed": false,
        "lanAnnotation": {
            "_typeName": "string",
            "lanAUplink": [
                "string"
            ],
            "lanBUplink": [
                "string"
            ]
        }
    }
}
pvlanConfigSpec
Optional

The PVLAN configuration specification.

A VMwareDVSPvlanMapEntry that has the same value for primaryVlanId and secondaryVlanId is referred to as a primary PVLAN entry. Otherwise, the VMwareDVSPvlanMapEntry is referred to as a secondary PVLAN entry.

The pvlanType of a primary PVLAN entry must be promiscuous. A secondary PVLAN entry can have a pvlanType of either community or isolated.

Primary PVLAN entries must be explicitly added. If there is no primary PVLAN entry corresponding to the primaryVlanId of a secondary PVLAN entry, a fault is thrown.

While deleting a primary PVLAN entry, any associated secondary PVLAN entries must be explicitly deleted.

vspanConfigSpec
Optional

The Distributed Port Mirroring configuration specification.

The VSPAN sessions in the array cannot be of the same key.

integer As int32 As int32
maxMtu
Optional

The maximum MTU in the switch.

linkDiscoveryProtocolConfig
Optional
ipfixConfig
Optional

Configuration for ipfix monitoring of the switch traffic.

This must be set before ipfix monitoring can be enabled for the switch, or for any portgroup or port of the switch.

See also ipfixEnabled.

string
lacpApiVersion
Optional

The Link Aggregation Control Protocol group version in the switch.

See VMwareDvsLacpApiVersionEnum for valid values.

string
multicastFilteringMode
Optional

The Multicast Filtering mode in the switch.

See VMwareDvsMulticastFilteringModeEnum for valid values.

string
networkOffloadSpecId
Optional

Indicate the ID of NetworkOffloadSpec used in the switch.

Unset it when network offload is not allowed when creating a switch. Use ID "None" to change network offload from allowed to not allowed.

Since: vSphere API Release 8.0.0.1

networkOffloadConfig
Optional

The network offload specific configuration of the switch.

This can be set only when network offload is allowed (networkOffloadSpecId is not "None").

Since: vSphere API Release 8.0.3.0

realTimeConfig
Optional

The real-time specific configuration of the switch.

Since: vSphere API Release 8.0.3.1