NSX-T Data Center Global Manager REST API

RoutesRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "BaseListRequestParameters
  }, 
  "id": "RoutesRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "component_type": {
      "description": "Component type define to take the route from CCP.", 
      "enum": [
        "DR_ROUTES"
      ], 
      "title": "Define the DR routes.", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "edge_id": {
      "description": "UUID of edge node. Edge should be member of enforcement point.", 
      "title": "UUID of edge node", 
      "type": "string"
    }, 
    "edge_path": {
      "description": "Policy path of edge node. Edge should be member of enforcement point.", 
      "title": "Policy path of edge node", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format.", 
      "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"
    }, 
    "network_prefix": {
      "$ref": "IPAddressOrCIDRBlock, 
      "description": "IPAddress or CIDR network address to filter entries in the table.", 
      "title": "Network address filter parameter"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "route_source": {
      "description": "Filter routes based on the source from which route is learned.", 
      "enum": [
        "BGP", 
        "STATIC", 
        "CONNECTED", 
        "OSPF"
      ], 
      "title": "Filter routes based on the source from which route is learned", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Routes request parameters", 
  "type": "object"
}