VdsSpec

VdsSpec

This specification contains vSphere distributed switch configurations

JSON Example

{
    "name": "string",
    "isUsedByNsxt": false,
    "nsxtSwitchConfig": {
        "transportZones": [
            {
                "name": "string",
                "transportType": "One among: VLAN, OVERLAY"
            }
        ],
        "hostSwitchOperationalMode": "One among: STANDARD, ENS, ENS_INTERRUPT",
        "ipAssignmentType": "string"
    },
    "portGroupSpecs": [
        {
            "name": "string",
            "transportType": "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT, VNA_MANAGEMENT, VSAN_EXTERNAL, FLEET_MANAGEMENT",
            "activeUplinks": [
                "string"
            ],
            "standByUplinks": [
                "string"
            ],
            "teamingPolicy": "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased"
        }
    ],
    "niocBandwidthAllocationSpecs": [
        {
            "type": "string",
            "niocTrafficResourceAllocation": {
                "limit": 0,
                "sharesInfo": {
                    "shares": 0,
                    "level": "One among: low, normal, high, custom"
                },
                "reservation": 0
            }
        }
    ],
    "mtu": 0,
    "lagSpecs": [
        {
            "name": "string",
            "uplinksCount": 0,
            "lacpMode": "One among:ACTIVE, PASSIVE",
            "loadBalancingMode": "One among:SOURCE_MAC, DESTINATION_MAC, SOURCE_AND_DESTINATION_MAC, DESTINATION_IP_AND_VLAN, SOURCE_IP_AND_VLAN, SOURCE_AND_DESTINATION_IP_AND_VLAN, DESTINATION_TCP_UDP_PORT, SOURCE_TCP_UDP_PORT, SOURCE_AND_DESTINATION_TCP_UDP_PORT, DESTINATION_IP_AND_TCP_UDP_PORT, SOURCE_IP_AND_TCP_UDP_PORT, SOURCE_AND_DESTINATION_IP_AND_TCP_UDP_PORT, DESTINATION_IP_AND_TCP_UDP_PORT_AND_VLAN, SOURCE_IP_AND_TCP_UDP_PORT_AND_VLAN, SOURCE_AND_DESTINATION_IP_AND_TCP_UDP_PORT_AND_VLAN, DESTINATION_IP, SOURCE_IP, SOURCE_AND_DESTINATION_IP, VLAN, SOURCE_PORT_ID",
            "lacpTimeoutMode": "One among:SLOW, FAST"
        }
    ],
    "vdsUplinkToNsxUplink": [
        {
            "vdsUplinkName": "string",
            "nsxUplinkName": "string"
        }
    ]
}

string

name

Required  

Constraints: minLength: 0 maxLength: 80

vSphere Distributed Switch name

boolean

isUsedByNsxt

Optional

Boolean to identify if the vSphere distributed switch is used by NSX. This property is deprecated in favor of nsxtSwitchConfig field

NsxtSwitchConfig

nsxtSwitchConfig

Optional

This specification contains the configurations to be associated with the vSphere Distributed Switch managed by NSX

array of PortgroupSpec

portGroupSpecs

Optional

List of portgroups to be associated with the vSphere Distributed Switch

array of NiocBandwidthAllocationSpec

niocBandwidthAllocationSpecs

Optional

List of Network I/O Control Bandwidth Allocations for System Traffic Based on shares, reservation, and limit, you can configure Network I/O Control to allocate certain amount of bandwidth for traffic generated by vSphere Fault Tolerance, iSCSI storage, vSphere vMotion, and so on. You can use Network I/O Control on a distributed switch to configure bandwidth allocation for the traffic that is related to the main system features in vSphere

integer As int32 As int32

mtu

Optional

Constraints: minimum: 0 maximum: 9223372036854776000

The maximum transmission unit (MTU) configured for the uplinks. If not specified during cluster creation or domain creation (with NSX sharing), this value will be automatically populated with the Physical Uplink MTU specified in the NSX Global Config from the associated NSX cluster.

array of LagSpec

lagSpecs

Optional

List of LAGs to be associated with the vSphere Distributed Switch

array of VdsUplinkToNsxUplinkConfiguration

vdsUplinkToNsxUplink

Optional

The map of vSphere Distributed Switch uplinks to the NSX switch uplinks. This information is available when the VDS is managed by NSX and has an associated Transport Node Profile (TNP) with uplink configurations.

Property Of

Cluster

NetworkSpec