NSX-T Data Center REST API

LogicalSwitchListWithSourceParameters (type)

{
  "additionalProperties": false,
  "extends": {
    "$ref": "LogicalSwitchListParameters"
  },
  "id": "LogicalSwitchListWithSourceParameters",
  "module_id": "AggSvcLogicalSwitch",
  "properties": {
    "cursor": {
      "readonly": false,
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
      "type": "string"
    },
    "diagnostic": {
      "default": false,
      "required": false,
      "title": "Flag to enable showing of transit logical switch.",
      "type": "boolean"
    },
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.",
      "title": "Comma separated list of fields that should be included in query result",
      "type": "string"
    },
    "page_size": {
      "default": 1000,
      "maximum": 1000,
      "minimum": 0,
      "title": "Maximum number of results to return in this page (server may return fewer)",
      "type": "integer"
    },
    "sort_ascending": {
      "type": "boolean"
    },
    "sort_by": {
      "title": "Field by which records are sorted",
      "type": "string"
    },
    "source": {
      "$ref": "DataSourceType",
      "required": false,
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    },
    "switch_type": {
      "enum": [
        "DEFAULT",
        "SERVICE_PLANE",
        "DHCP_RELAY",
        "GLOBAL",
        "INTER_ROUTER",
        "EVPN",
        "DVPG"
      ],
      "required": false,
      "title": "Logical Switch type",
      "type": "string"
    },
    "switching_profile_id": {
      "required": false,
      "title": "Switching Profile identifier",
      "type": "string"
    },
    "transport_type": {
      "$ref": "TransportType",
      "required": false,
      "title": "Mode of transport supported in the transport zone for this logical switch"
    },
    "transport_zone_id": {
      "required": false,
      "title": "Transport zone identifier",
      "type": "string"
    },
    "uplink_teaming_policy_name": {
      "required": false,
      "title": "The logical switch's uplink teaming policy name",
      "type": "string"
    },
    "vlan": {
      "$ref": "VlanID",
      "required": false,
      "title": "Return VLAN logical switches whose \"vlan\" field matches this value"
    },
    "vni": {
      "required": false,
      "title": "VNI of the OVERLAY LogicalSwitch(es) to return.",
      "type": "int"
    }
  },
  "title": "Logical Switch list with data source parameters",
  "type": "object"
}