Get a list of disabled rules

Get a list of disabled rules for a specific device. Disabled rules are rules that were disabled temporarily.

For information about disabled rules, see POLICY OPTIMIZATION page.

Resource Name:

/afa/api/v1/rule/policy-optimization/{deviceTreeName}/disabledrules

Request Method: GET

Request Parameters:

Element

Type

Description

deviceTreeName
Mandatory

string

Tree name of the device.

(To get the entity name for a device, see Device names in the ASMS APIs. If the entity is a group, use the name from the UI).

pageNumber
optional
Integer The page number to include in the response. Default value : 0 (Value 0 means first page).
pageSize
optional
Integer The number of results to include on each page in the response. Default value : 50.
ruleDisplayType
optional
string

Determines the amount of details included in the response.

Available values :

  • BASIC: The source, destination and service contain network objects and services that only have canonized names.

  • FULL: The source destination and service contain the all network objects and services.

  • DISPLAY: Source, destination and service are partially filled and contain icons and NAT type data.

Response:

Code

Description

200

Operation completed successfully

400

Validation error

401

Unauthorized

Request examples

curl -X GET "https://[localhost]/afa/api/v1/rule/policy-optimization/{deviceTreeName}/disabledrules?pageNumber=0&pageSize=50&ruleDisplayType=DISPLAY" -H "accept: */*"

Response examples

Copy
{
  "content": [
    {
      "deviceId": 21100,
      "ruleId": "0xabcd1249",
      "ruleNum": "outside_acl(241)",
      "source": [
        {
          "canonizedName": "63.209.170.0/27",
          "natType": "NONE",
          "invalidNamedObject": false
        }
      ],
      "isNegateSource": false,
      "users": [
        {
          "display": "any"
        }
      ],
      "destination": [
        {
          "originalName": "Ext_MetropolisBPC",
          "canonizedName": "Ext_MetropolisBPC",
          "natType": "NONE",
          "invalidNamedObject": false
        }
      ],
      "isNegateDestination": false,
      "service": [
        {
          "originalName": "http",
          "canonizedName": "http_udp",
          "invalidNamedObject": false
        }
      ],
      "isNegateService": false,
      "action": "permit",
      "comment": [
        ""
      ],
      "enable": "disabled",
      "log": "",
      "documentation": {
        "business criticality": "",
        "business partner": "",
        "documentation": "",
        "business applications": ""
      },
      "additionalData": {
        "line": [
          {
            "value": "access-list outside_acl permit udp 63.209.170.0 255.255.255.224 host Ext_MetropolisBPC eq www time-range AuditAccess"
          }
        ],
        "rule": [
          {
            "value": "acl(739)"
          }
        ],
        "acl": [
          {
            "value": "outside_acl"
          }
        ],
        "interface": [
          {
            "value": "outside"
          }
        ],
        "name": [
          {
            "value": "outside_acl(241)"
          }
        ],
        "linenum": [
          {
            "value": "739"
          }
        ],
        "time": [
          {
            "value": "AuditAccess"
          }
        ],
        "user": [
          {
            "value": "any"
          }
        ]
      },
      "isValidUserSourceModel": true
    },
    {
      "deviceId": 21100,
      "ruleId": "0xabcd1234",
      "ruleNum": "outside_acl(226)",
      "source": [
        {
          "canonizedName": "63.208.175.128/26",
          "natType": "NONE",
          "invalidNamedObject": false
        }
      ],
      "isNegateSource": false,
      "users": [
        {
          "display": "any"
        }
      ],
      "destination": [
        {
          "originalName": "Ext_MetropolisBPC",
          "canonizedName": "Ext_MetropolisBPC",
          "natType": "NONE",
          "invalidNamedObject": false
        }
      ],
      "isNegateDestination": false,
      "service": [
        {
          "canonizedName": "udp/22",
          "invalidNamedObject": false
        }
      ],
      "isNegateService": false,
      "action": "permit",
      "comment": [
        ""
      ],
      "enable": "disabled",
      "log": "",
      "documentation": {
        "business criticality": "",
        "business partner": "",
        "documentation": "",
        "business applications": ""
      },
      "additionalData": {
        "line": [
          {
            "value": "access-list outside_acl permit udp 63.208.175.128 255.255.255.192 host Ext_MetropolisBPC eq 22 time-range Contractor"
          }
        ],
        "rule": [
          {
            "value": "acl(724)"
          }
        ],
        "acl": [
          {
            "value": "outside_acl"
          }
        ],
        "interface": [
          {
            "value": "outside"
          }
        ],
        "name": [
          {
            "value": "outside_acl(226)"
          }
        ],
        "linenum": [
          {
            "value": "724"
          }
        ],
        "time": [
          {
            "value": "Contractor"
          }
        ],
        "user": [
          {
            "value": "any"
          }
        ]
      },
      "isValidUserSourceModel": true
    },
    {
      "deviceId": 21100,
      "ruleId": "0xabcd1263",
      "ruleNum": "outside_acl(255)",
      "source": [
        {
          "canonizedName": "63.209.170.0/27",
          "natType": "NONE",
          "invalidNamedObject": false
        }
      ],
      "isNegateSource": false,
      "users": [
        {
          "display": "any"
        }
      ],
      "destination": [
        {
          "originalName": "Ext_NorthpoleBPC",
          "canonizedName": "Ext_NorthpoleBPC",
          "natType": "NONE",
          "invalidNamedObject": false
        }
      ],
      "isNegateDestination": false,
      "service": [
        {
          "originalName": "http",
          "canonizedName": "http_tcp",
          "invalidNamedObject": false
        }
      ],
      "isNegateService": false,
      "action": "permit",
      "comment": [
        ""
      ],
      "enable": "disabled",
      "log": "",
      "documentation": {
        "business criticality": "",
        "business partner": "",
        "documentation": "",
        "business applications": ""
      },
      "additionalData": {
        "line": [
          {
            "value": "access-list outside_acl permit tcp 63.209.170.0 255.255.255.224 host Ext_NorthpoleBPC eq www time-range AuditAccess"
          }
        ],
        "rule": [
          {
            "value": "acl(753)"
          }
        ],
        "acl": [
          {
            "value": "outside_acl"
          }
        ],
        "interface": [
          {
            "value": "outside"
          }
        ],
        "name": [
          {
            "value": "outside_acl(255)"
          }
        ],
        "linenum": [
          {
            "value": "753"
          }
        ],
        "time": [
          {
            "value": "AuditAccess"
          }
        ],
        "user": [
          {
            "value": "any"
          }
        ]
      },
      "isValidUserSourceModel": true
    },
    {
      "deviceId": 21100,
      "ruleId": "0xabcd1436",
      "ruleNum": "dmz2_acl(10)",
      "source": [
        {
          "originalName": "POTDB39",
          "canonizedName": "POTDB39",
          "natType": "NONE",
          "invalidNamedObject": false
        }
      ],
      "isNegateSource": false,
      "users": [
        {
          "display": "any"
        }
      ],
      "destination": [
        {
          "originalName": "TNG_DISM",
          "canonizedName": "TNG_DISM",
          "natType": "NONE",
          "invalidNamedObject": false
        }
      ],
      "isNegateDestination": false,
      "service": [
        {
          "canonizedName": "udp/161",
          "invalidNamedObject": false
        }
      ],
      "isNegateService": false,
      "action": "permit",
      "comment": [
        ""
      ],
      "enable": "disabled",
      "log": "",
      "documentation": {
        "business criticality": "",
        "business partner": "",
        "documentation": "",
        "business applications": ""
      },
      "additionalData": {
        "line": [
          {
            "value": "access-list dmz2_acl permit udp host POTDB39 host TNG_DISM eq 161 inactive"
          }
        ],
        "rule": [
          {
            "value": "acl(926)"
          }
        ],
        "acl": [
          {
            "value": "dmz2_acl"
          }
        ],
        "interface": [
          {
            "value": "dmz2"
          }
        ],
        "name": [
          {
            "value": "dmz2_acl(10)"
          }
        ],
        "linenum": [
          {
            "value": "926"
          }
        ],
        "time": [
          {
            "value": ""
          }
        ],
        "user": [
          {
            "value": "any"
          }
        ]
      },
      "isValidUserSourceModel": true
    },
    {
      "deviceId": 21100,
      "ruleId": "0xabcd1253",
      "ruleNum": "outside_acl(245)",
      "source": [
        {
          "canonizedName": "63.208.175.128/26",
          "natType": "NONE",
          "invalidNamedObject": false
        }
      ],
      "isNegateSource": false,
      "users": [
        {
          "display": "any"
        }
      ],
      "destination": [
        {
          "originalName": "Ext_NorthpoleBPC",
          "canonizedName": "Ext_NorthpoleBPC",
          "natType": "NONE",
          "invalidNamedObject": false
        }
      ],
      "isNegateDestination": false,
      "service": [
        {
          "canonizedName": "udp/22",
          "invalidNamedObject": false
        }
      ],
      "isNegateService": false,
      "action": "permit",
      "comment": [
        ""
      ],
      "enable": "disabled",
      "log": "",
      "documentation": {
        "business criticality": "",
        "business partner": "",
        "documentation": "",
        "business applications": ""
      },
      "additionalData": {
        "line": [
          {
            "value": "access-list outside_acl permit udp 63.208.175.128 255.255.255.192 host Ext_NorthpoleBPC eq 22 time-range Contractor"
          }
        ],
        "rule": [
          {
            "value": "acl(743)"
          }
        ],
        "acl": [
          {
            "value": "outside_acl"
          }
        ],
        "interface": [
          {
            "value": "outside"
          }
        ],
        "name": [
          {
            "value": "outside_acl(245)"
          }
        ],
        "linenum": [
          {
            "value": "743"
          }
        ],
        "time": [
          {
            "value": "Contractor"
          }
        ],
        "user": [
          {
            "value": "any"
          }
        ]
      },
      "isValidUserSourceModel": true
    },
    {
      "deviceId": 21100,
      "ruleId": "0xabcd1435",
      "ruleNum": "dmz2_acl(9)",
      "source": [
        {
          "originalName": "WEBSRV02",
          "canonizedName": "WEBSRV02",
          "natType": "NONE",
          "invalidNamedObject": false
        }
      ],
      "isNegateSource": false,
      "users": [
        {
          "display": "any"
        }
      ],
      "destination": [
        {
          "originalName": "TNG_DISM",
          "canonizedName": "TNG_DISM",
          "natType": "NONE",
          "invalidNamedObject": false
        }
      ],
      "isNegateDestination": false,
      "service": [
        {
          "canonizedName": "udp/161",
          "invalidNamedObject": false
        }
      ],
      "isNegateService": false,
      "action": "permit",
      "comment": [
        ""
      ],
      "enable": "disabled",
      "log": "",
      "documentation": {
        "business criticality": "",
        "business partner": "",
        "documentation": "",
        "business applications": ""
      },
      "additionalData": {
        "line": [
          {
            "value": "access-list dmz2_acl permit udp host WEBSRV02 host TNG_DISM eq 161 inactive"
          }
        ],
        "rule": [
          {
            "value": "acl(925)"
          }
        ],
        "acl": [
          {
            "value": "dmz2_acl"
          }
        ],
        "interface": [
          {
            "value": "dmz2"
          }
        ],
        "name": [
          {
            "value": "dmz2_acl(9)"
          }
        ],
        "linenum": [
          {
            "value": "925"
          }
        ],
        "time": [
          {
            "value": ""
          }
        ],
        "user": [
          {
            "value": "any"
          }
        ]
      },
      "isValidUserSourceModel": true
    },
    {
      "deviceId": 21100,
      "ruleId": "0xabcd1242",
      "ruleNum": "outside_acl(234)",
      "source": [
        {
          "canonizedName": "63.209.170.0/27",
          "natType": "NONE",
          "invalidNamedObject": false
        }
      ],
      "isNegateSource": false,
      "users": [
        {
          "display": "any"
        }
      ],
      "destination": [
        {
          "originalName": "Ext_MetropolisBPC",
          "canonizedName": "Ext_MetropolisBPC",
          "natType": "NONE",
          "invalidNamedObject": false
        }
      ],
      "isNegateDestination": false,
      "service": [
        {
          "originalName": "http",
          "canonizedName": "http_tcp",
          "invalidNamedObject": false
        }
      ],
      "isNegateService": false,
      "action": "permit",
      "comment": [
        ""
      ],
      "enable": "disabled",
      "log": "",
      "documentation": {
        "business criticality": "",
        "business partner": "",
        "documentation": "",
        "business applications": ""
      },
      "additionalData": {
        "line": [
          {
            "value": "access-list outside_acl permit tcp 63.209.170.0 255.255.255.224 host Ext_MetropolisBPC eq www time-range AuditAccess"
          }
        ],
        "rule": [
          {
            "value": "acl(732)"
          }
        ],
        "acl": [
          {
            "value": "outside_acl"
          }
        ],
        "interface": [
          {
            "value": "outside"
          }
        ],
        "name": [
          {
            "value": "outside_acl(234)"
          }
        ],
        "linenum": [
          {
            "value": "732"
          }
        ],
        "time": [
          {
            "value": "AuditAccess"
          }
        ],
        "user": [
          {
            "value": "any"
          }
        ]
      },
      "isValidUserSourceModel": true
    },
    {
      "deviceId": 21100,
      "ruleId": "0xabcd1270",
      "ruleNum": "outside_acl(262)",
      "source": [
        {
          "canonizedName": "63.209.170.0/27",
          "natType": "NONE",
          "invalidNamedObject": false
        }
      ],
      "isNegateSource": false,
      "users": [
        {
          "display": "any"
        }
      ],
      "destination": [
        {
          "originalName": "Ext_NorthpoleBPC",
          "canonizedName": "Ext_NorthpoleBPC",
          "natType": "NONE",
          "invalidNamedObject": false
        }
      ],
      "isNegateDestination": false,
      "service": [
        {
          "originalName": "http",
          "canonizedName": "http_udp",
          "invalidNamedObject": false
        }
      ],
      "isNegateService": false,
      "action": "permit",
      "comment": [
        ""
      ],
      "enable": "disabled",
      "log": "",
      "documentation": {
        "business criticality": "",
        "business partner": "",
        "documentation": "",
        "business applications": ""
      },
      "additionalData": {
        "line": [
          {
            "value": "access-list outside_acl permit udp 63.209.170.0 255.255.255.224 host Ext_NorthpoleBPC eq www time-range AuditAccess"
          }
        ],
        "rule": [
          {
            "value": "acl(760)"
          }
        ],
        "acl": [
          {
            "value": "outside_acl"
          }
        ],
        "interface": [
          {
            "value": "outside"
          }
        ],
        "name": [
          {
            "value": "outside_acl(262)"
          }
        ],
        "linenum": [
          {
            "value": "760"
          }
        ],
        "time": [
          {
            "value": "AuditAccess"
          }
        ],
        "user": [
          {
            "value": "any"
          }
        ]
      },
      "isValidUserSourceModel": true
    }
  ],
  "pageable": {
    "sort": {
      "sorted": false,
      "unsorted": true,
      "empty": true
    },
    "pageSize": 50,
    "pageNumber": 0,
    "offset": 0,
    "paged": true,
    "unpaged": false
  },
  "totalPages": 1,
  "totalElements": 8,
  "last": true,
  "number": 0,
  "size": 50,
  "numberOfElements": 8,
  "sort": {
    "sorted": false,
    "unsorted": true,
    "empty": true
  },
  "first": true,
  "empty": false
}