NSX-T Data Center REST API

VirtualSwitch (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "VirtualSwitch", 
  "module_id": "InventoryCmObj", 
  "polymorphic-type-descriptor": {
    "type-identifier": "VirtualSwitch"
  }, 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cm_local_id": {
      "readonly": true, 
      "required": false, 
      "title": "ID of the virtual switch in compute manager", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "readonly": true, 
      "required": true, 
      "title": "External id of the virtual switch", 
      "type": "string"
    }, 
    "origin_id": {
      "description": "ID of the compute manager where this virtual switch is discovered.", 
      "readonly": true, 
      "required": false, 
      "title": "ID of the compute manager", 
      "type": "string"
    }, 
    "origin_type": {
      "readonly": true, 
      "required": false, 
      "title": "Switch type like VmwareDistributedVirtualSwitch", 
      "type": "string"
    }, 
    "owner_nsx": {
      "description": "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.", 
      "enum": [
        "SELF", 
        "OTHER", 
        "MULTIPLE", 
        "NONE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Specifies owner nsx of the virtual switch", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "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.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Virtual switch on a compute manager", 
  "type": "object"
}