NSX-T Data Center REST API
DistributedVirtualSwitch (schema)
DistributedVirtualSwitch on a VC
| Name | Description | Type | Notes |
|---|---|---|---|
| _last_sync_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
| _links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| cm_local_id | ID of the virtual switch in compute manager | string | Readonly |
| description | Description of this resource | string | Maximum length: 1024 Sortable |
| discovered_nodes | Array of discovered nodes connected Array of discovered nodes connected to this switch. |
array of DiscoveredNode | Readonly |
| display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
| dpu_failover_policy | Dpu Failover policy for a DVS This specifies the failover policy for a distributed virtual switch from vCenter DVS, specifically related to the Data Processing Unit(DPU). |
DpuFailoverPolicy | Readonly |
| external_id | External id of the virtual switch | string | Required Readonly |
| lacp_group_configs | Array of Link Aggregation Control Protocol (LACP) configuration It contains information about VMware specific multiple dynamic LACP groups. |
array of LacpGroupConfigInfo | |
| network_offload_spec_id | Id of network offload spec Specify the Id of network offload spec. |
string | Readonly |
| origin_id | ID of the compute manager ID of the compute manager where this virtual switch is discovered. |
string | Readonly |
| origin_properties | Key-Value map of additional properties of switch | array of KeyValuePair | Readonly |
| origin_type | Switch type like VmwareDistributedVirtualSwitch | string | Readonly |
| owner_nsx | Specifies owner nsx of the virtual switch Specifies owner nsx of the virtual switch. Owner nsx can be SELF, OTHER, MULTIPLE or NONE. SELF applies to when virtual switch owned by that nsx. OTHER applies to whenf virtual switch owned by other nsx. MULTIPLE applies to when virtual switch tried to own by multiple nsx at a time. NONE applies to when virtual switch is not owned by any nsx. |
string | Readonly Enum: SELF, OTHER, MULTIPLE, NONE |
| real_time_config | Real Time Config for a VDS Real time config for VDS which consists of vswitchRT flag and annotations for uplinks. |
RealTimeConfig | Readonly |
| resource_type | Must be set to the value DistributedVirtualSwitch | string | Required |
| scope | List of scopes for discovered resource Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC. |
array of DiscoveredResourceScope | |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
| uplink_port_names | Uplink port names The uniform name of uplink ports on each host. |
array of string | Readonly |
| uplink_portgroup | Uplink portgroup of distributed virtual switch | DistributedVirtualPortgroup | Readonly |
| uuid | UUID of the switch | string | Readonly |