VMwareDVSConfigInfo

VMwareDVSConfigInfo
VMwareDVSConfigInfo

This class defines the VMware specific configuration for DistributedVirtualSwitch.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "uuid": "string",
    "name": "string",
    "numStandalonePorts": 0,
    "numPorts": 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"
                    }
                }
            ],
            "runtimeState": {
                "_typeName": "string",
                "currentMaxProxySwitchPorts": 0
            },
            "config": {
                "_typeName": "string",
                "host": {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                },
                "maxProxySwitchPorts": 0,
                "vendorSpecificConfig": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "opaqueData": "string"
                    }
                ],
                "backing": {
                    "_typeName": "string"
                },
                "nsxSwitch": false,
                "ensEnabled": false,
                "ensInterruptEnabled": false,
                "transportZones": [
                    {
                        "_typeName": "string",
                        "uuid": "string",
                        "type": "string"
                    }
                ],
                "nsxtUsedUplinkNames": [
                    "string"
                ],
                "networkOffloadingEnabled": false
            },
            "productInfo": {
                "_typeName": "string",
                "name": "string",
                "vendor": "string",
                "version": "string",
                "build": "string",
                "forwardingClass": "string",
                "bundleId": "string",
                "bundleUrl": "string"
            },
            "uplinkPortKey": [
                "string"
            ],
            "status": "string",
            "statusDetail": "string"
        }
    ],
    "productInfo": {
        "_typeName": "string",
        "name": "string",
        "vendor": "string",
        "version": "string",
        "build": "string",
        "forwardingClass": "string",
        "bundleId": "string",
        "bundleUrl": "string"
    },
    "targetInfo": {
        "_typeName": "string",
        "name": "string",
        "vendor": "string",
        "version": "string",
        "build": "string",
        "forwardingClass": "string",
        "bundleId": "string",
        "bundleUrl": "string"
    },
    "extensionKey": "string",
    "vendorSpecificConfig": [
        {
            "_typeName": "string",
            "key": "string",
            "opaqueData": "string"
        }
    ],
    "policy": {
        "_typeName": "string",
        "autoPreInstallAllowed": false,
        "autoUpgradeAllowed": false,
        "partialUpgradeAllowed": false
    },
    "description": "string",
    "configVersion": "string",
    "contact": {
        "_typeName": "string",
        "name": "string",
        "contact": "string"
    },
    "switchIpAddress": "string",
    "createTime": "string",
    "networkResourceManagementEnabled": false,
    "defaultProxySwitchMaxNumPorts": 0,
    "healthCheckConfig": [
        {
            "_typeName": "string",
            "enable": false,
            "interval": 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",
    "vmVnicNetworkResourcePool": [
        {
            "_typeName": "string",
            "key": "string",
            "name": "string",
            "description": "string",
            "configVersion": "string",
            "allocationInfo": {
                "_typeName": "string",
                "reservationQuota": 0
            }
        }
    ],
    "pnicCapacityRatioForReservation": 0,
    "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"
        }
    ],
    "pvlanConfig": [
        {
            "_typeName": "string",
            "primaryVlanId": 0,
            "secondaryVlanId": 0,
            "pvlanType": "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
    },
    "lacpGroupConfig": [
        {
            "_typeName": "string",
            "key": "string",
            "name": "string",
            "mode": "string",
            "uplinkNum": 0,
            "loadbalanceAlgorithm": "string",
            "vlan": {
                "_typeName": "string",
                "vlanId": [
                    {
                        "_typeName": "string",
                        "start": 0,
                        "end": 0
                    }
                ]
            },
            "ipfix": {
                "_typeName": "string",
                "ipfixEnabled": false
            },
            "uplinkName": [
                "string"
            ],
            "uplinkPortKey": [
                "string"
            ],
            "timeoutMode": "string"
        }
    ],
    "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"
            ]
        }
    }
}
vspanSession
Optional

The Distributed Port Mirroring sessions in the switch.

pvlanConfig
Optional

The PVLAN configured in the switch.

integer As int32 As int32
maxMtu
Required

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.

lacpGroupConfig
Optional

The Link Aggregation Control Protocol groups in the switch.

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.

ID "None" means that network offload is not allowed in the switch.

Since: vSphere API Release 8.0.0.1

networkOffloadConfig
Optional

The network offload specific configuration of the switch.

It is only set 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