NSX-T Data Center REST API

Tier0StateRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "Tier0StateRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "String Path of the enforcement point. When not specified, routes from all enforcement-points are returned.", 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "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"
    }, 
    "interface_path": {
      "description": "String Path of interface on current Tier0 gateway for interface specified state such as IPv6 DAD state. When not specified, IPv6 NDRA state from from all interfaces is returned.", 
      "title": "Interface path for interface specific state such as IPv6 DAD state", 
      "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, 
      "description": "The data source can be either realtime or cached. If not provided, cached data is returned.", 
      "required": false, 
      "title": "Source of statistics data"
    }, 
    "type": {
      "description": "Returns specific information based on the value specified. When not specified response include gateway state, status and DAD status from interfaces.", 
      "enum": [
        "GATEWAY_STATE", 
        "GATEWAY_STATUS", 
        "IPV6_STATUS", 
        "RD_PER_EDGE_MAPPING"
      ], 
      "title": "Returns specific information based on the value specified.", 
      "type": "string"
    }
  }, 
  "title": "State request parameters for Tier0 gateway", 
  "type": "object"
}