NSX-T Data Center REST API

HostSwitchState (type)

{
  "id": "HostSwitchState",
  "module_id": "TransportNode",
  "properties": {
    "endpoints": {
      "items": {
        "$ref": "Endpoint"
      },
      "readonly": true,
      "title": "List of virtual tunnel endpoints which are configured on this switch",
      "type": "array"
    },
    "host_switch_id": {
      "readonly": true,
      "title": "External ID of the HostSwitch",
      "type": "string"
    },
    "host_switch_name": {
      "description": "The name must be unique among all host switches specified in a given Transport Node.",
      "readonly": true,
      "title": "HostSwitch name. This name will be used to reference this HostSwitch.",
      "type": "string"
    },
    "host_switch_type": {
      "default": "NVDS",
      "description": "VDS represents VMware vSphere Distributed Switch from vSphere that is used as HostSwitch through TransportNode or TransportNodeProfile configuration. When VDS is used as a HostSwitch, Hosts have to be added to VDS from vSphere and VDS instance is created on Hosts. To configure NSX on such hosts, you can use this VDS as a HostSwitch from NSX manager. vCenter has the ownership of MTU, LAG, NIOC and LLDP configuration of such VDS backed HostSwitch. Remaining configuration (e.g. UplinkHostswitchProfile) will be managed by NSX. NVDS represents NSX Virtual Switch which is NSX native HostSwitch. All configurations of NVDS will be managed by NSX.",
      "enum": [
        "NVDS",
        "VDS"
      ],
      "nsx_feature": "NsxtOnVds",
      "required": false,
      "title": "Type of HostSwitch",
      "type": "string"
    },
    "nsx_configured_uplinks": {
      "description": "This field, populated by system, lists which VDS uplinks are configured and in use by NSX. Starting with NSX 9.1 release, when IpAssignmentspec.FromEsxiVmknic is specified in HostTransportNode config, uplink hostswitch profile and hence NSX uplink to Vds uplink mapping is not required. Regardless of which IpAssignmentspec used this field will always be populated.",
      "items": {
        "type": "string"
      },
      "nsx_feature": "VcpVcenterVtepSupport",
      "readonly": true,
      "required": false,
      "title": "List of VDS uplink(s) configured by NSX",
      "type": "array"
    },
    "transport_zone_ids": {
      "items": {
        "type": "string"
      },
      "readonly": true,
      "title": "List of Ids of TransportZones this HostSwitch belongs to",
      "type": "array"
    },
    "vtepless": {
      "description": "This field is populated by system if the VDS joins default overlay transport zone. It will indicate if the TransportNode contains at least one VTEP connected to the VDS.",
      "nsx_feature": "VTEPLessMode",
      "required": false,
      "title": "The realized VTEP state of the host-switch on the host.",
      "type": "boolean"
    }
  },
  "title": "Host Switch State",
  "type": "object"
}