NSX-T Data Center REST API

TransportNodeListParameters (type)

{
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "TransportNodeListParameters", 
  "module_id": "TransportNode", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "in_maintenance_mode": {
      "description": "If the flag is true, transport node with 'ENABLED' or 'FORCE_ENABLED' desired state will be returned, otherwise transport nodes in 'DISABLED' will be returned.", 
      "required": false, 
      "title": "maintenance mode flag", 
      "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"
    }, 
    "node_id": {
      "description": "This property can be used by itself or along with 'transport_zone_id'.", 
      "required": false, 
      "title": "node identifier", 
      "type": "string"
    }, 
    "node_ip": {
      "description": "This property can only be used alone. It can not be combined with other filtering properties.", 
      "required": false, 
      "title": "Fabric node IP address", 
      "type": "string"
    }, 
    "node_types": {
      "description": "The fabric node type is the resource_type of the Node such as HostNode, EdgeNode and PublicCloudGatewayNode. If a list of fabric node types are given, all transport nodes of all given types will be returned.", 
      "required": false, 
      "title": "a list of fabric node types separated by comma or a single type", 
      "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"
    }, 
    "transport_zone_id": {
      "description": "This propery can be used along with 'node_id'.", 
      "required": false, 
      "title": "Transport zone identifier", 
      "type": "string"
    }
  }, 
  "title": "Transport Node list parameters", 
  "type": "object"
}