NSX-T Data Center REST API

LogicalPortListWithSourceParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LogicalPortListParameters
  }, 
  "id": "LogicalPortListWithSourceParameters", 
  "module_id": "AggSvcLogicalPort", 
  "properties": {
    "attachment_id": {
      "required": false, 
      "title": "Logical Port attachment Id", 
      "type": "string"
    }, 
    "attachment_type": {
      "$ref": "AttachmentTypeQueryString, 
      "required": false, 
      "title": "Type of attachment for logical port; NONE means no attachment."
    }, 
    "bridge_cluster_id": {
      "required": false, 
      "title": "Bridge Cluster identifier", 
      "type": "string"
    }, 
    "container_ports_only": {
      "default": false, 
      "required": false, 
      "title": "Only container VIF logical ports will be returned if true", 
      "type": "boolean"
    }, 
    "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 port.", 
      "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"
    }, 
    "logical_switch_id": {
      "required": false, 
      "title": "Logical Switch identifier", 
      "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"
    }, 
    "parent_vif_id": {
      "description": "Get logical ports that have CHILD VIF attachment of given PARENT VIF.", 
      "required": false, 
      "title": "ID of the VIF of type PARENT", 
      "type": "string"
    }, 
    "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."
    }, 
    "switching_profile_id": {
      "required": false, 
      "title": "Network Profile identifier", 
      "type": "string"
    }, 
    "transport_node_id": {
      "description": "Get logical ports on the transport node; it can not be given together with other parameters except container_ports_only and attachment_type VIF.", 
      "required": false, 
      "title": "Transport node identifier", 
      "type": "string"
    }, 
    "transport_zone_id": {
      "required": false, 
      "title": "Transport zone identifier", 
      "type": "string"
    }
  }, 
  "title": "Logical Port list with data source parameters", 
  "type": "object"
}