NSX-T Data Center REST API

NsxFirewallRulesListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "A set of optional filter parameters to list NSX firewall rules of a cloud VM", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "NsxFirewallRulesListRequestParameters", 
  "module_id": "CloudTypes", 
  "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"
    }, 
    "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"
    }, 
    "status": {
      "description": "Optional filter parameter to the NSX firewall rules of a cloud VM based on it's realization status SUCCEEDED - NSX firewall rule is successfully realized on the cloud FAILED - NSX firewall rule has failed to realized on the cloud and has errors", 
      "enum": [
        "SUCCEEDED", 
        "FAILED"
      ], 
      "required": false, 
      "title": "NSX firewall rule realization status on the cloud", 
      "type": "string"
    }
  }, 
  "title": "NSX firewall rules list request parameters", 
  "type": "object"
}