NSX-T Data Center REST API

LogicalRouterRIBListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Filter parameters for filtering routes from RIB depending on provided properties", 
  "extends": {
    "$ref": "ListByRequiredNodeIdParameters
  }, 
  "id": "LogicalRouterRIBListRequestParameters", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "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 the RIB table.", 
      "required": false, 
      "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": "To filter the RIB table based on the source from which route is learned.", 
      "enum": [
        "BGP", 
        "STATIC", 
        "CONNECTED", 
        "OSPF"
      ], 
      "title": "Route source filter parameter", 
      "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."
    }, 
    "transport_node_id": {
      "required": false, 
      "title": "TransportNode Id", 
      "type": "string"
    }, 
    "vrf_table": {
      "description": "To filter RIB table depending on the parameters specified (not specified - empty) - get all routes DEFAULT - get entries from default VRF INTER_SR - get entries from inter SR VRF", 
      "enum": [
        "DEFAULT", 
        "INTER_SR"
      ], 
      "required": false, 
      "title": "VRF filter parameter", 
      "type": "string"
    }
  }, 
  "title": "Logical Router RIB List Request Parameters\n", 
  "type": "object"
}