Running the Query Troubleshooting Tool

The troubleshoot method helps to determine why a group traffic simulation query produced an inaccurate traffic path.

The input is the ID of the query ran in the online wizard and a list of the expected devices on the query path. The output is a response message with the found paths, detected devices, problem scenario, recommended resolution steps, the device causing the inconsistency, and information about expected and unexpected devices.

Note: The Query Troubleshooting Tool is available only to admin users.

Resource Name:

ms-mapDiagnostics/v1/api/queryTroubleshootin/troubleshoot

Request Method: POST

Authentication: Cookie with session ID.

Request Body Parameters:

A JSON object with the following properties:

Element	Type	Description
queryIDMandatory	String	Query ID received from the troubleshooting wizard.
expectedQueryPathMandatory	List of ExpectedQueryDevice (see ExpectedQueryDevice type )	List containing details for expected query path: device display name and IP address.

Response:

Element	Type	Description
foundPaths	Map	All paths found for the query. Object consists of key/value pairs of the path number and its path. The path is a list of QueryNetworkObject (see QueryNetworkObject Type ).
detectedDevices	List of QueryTroubleshootingPathItem (see QueryTroubleshootingPathItem Type )	A list of the detected devices with identifying properties.
scenario	QueryTroublshootingScenario (see QueryTroubleshootingScenario Type )	Object containing the scenario which caused the problem and recommended steps for its resolution.
inconsistencyCauseDevice	QueryTroubleshootingInconsistencyCause (see QueryTroubleshootingInconsistencyCause Type )	Object containing data for the device causing inconsistency.
expectedDevice	ExpectedQueryDevice (see ExpectedDevice type )	Object containing identifying properties for expected device.
firstUnexpectedDevice	QueryTroubleshootingPathItem (see QueryTroubleshootingPathItem Type )	Object containing properties for first unexpected device.

Request examples:

curl -k -H 'Cookie: PHPSESSID=<sessionID>' -X POST "https://localhost/ms-mapDiagnostics/v1/api/queryTroubleshooting/troubleshoot" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"queryId\": \"ALL_FIREWALLS_query-1643215820602\", \"expectedQueryPath\": [ { \"displayName\": \"sup17412root\", \"ip\": \"10.0.0.1\" } ]}"

{
    "queryId":"ALL_FIREWALLS_query-1534764120587",
        "expectedQueryPath": [{
            "displayName": "Pecan_PaloAlto",
            "ip": "10.176.46.197"
            }, {
            "displayName": "Poppy_juniper",
            "ip": "192.168.6.6"
            }, {
            "displayName": "Violet_Fortinet",
            "ip": "10.42.65.100"
            }]
}

Response example:

{
   "foundPaths":{
      "1":[
         {
            "mapId":"Subnet__489",
            "id":489,
            "type":"SUBNET",
            "locationOnPath":1,
            "displayName":null,
            "ip":null,
            "empty":false
         },
         {
            "mapId":"Device__40",
            "id":40,
            "type":"DEVICE",
            "locationOnPath":2,
            "displayName":"Pecan_PaloAlto",
            "ip":{
               "id":0,
               "minIp":179318469,
               "maxIp":179318469,
               "display":"10.176.46.197",
               "displayRange":"10.176.46.197",
               "optimalDisplay":[
                  "10.176.46.197"
               ],
               "singleIP":true,
               "cidr":true,
               "any":false
            },
            "empty":false
         },
         {
            "mapId":"Subnet__11",
            "id":11,
            "type":"SUBNET",
            "locationOnPath":3,
            "displayName":null,
            "ip":null,
            "empty":false
         },
         {
            "mapId":"Device__252",
            "id":252,
            "type":"DEVICE",
            "locationOnPath":5,
            "displayName":"Poppy_juniper",
            "ip":{
               "id":0,
               "minIp":3232237062,
               "maxIp":3232237062,
               "display":"192.168.6.6",
               "displayRange":"192.168.6.6",
               "optimalDisplay":[
                  "192.168.6.6"
               ],
               "singleIP":true,
               "cidr":true,
               "any":false
            },
            "empty":false
         },
         {
            "mapId":"Subnet__9",
            "id":9,
            "type":"SUBNET",
            "locationOnPath":8,
            "displayName":null,
            "ip":null,
            "empty":false
         },
         {
            "mapId":"Device__8",
            "id":8,
            "type":"DEVICE",
            "locationOnPath":9,
            "displayName":"Rose_checkpoint",
            "ip":{
               "id":0,
               "minIp":173150740,
               "maxIp":173150740,
               "display":"10.82.18.20",
               "displayRange":"10.82.18.20",
               "optimalDisplay":[
                  "10.82.18.20"
               ],
               "singleIP":true,
               "cidr":true,
               "any":false
            },
            "empty":false
         },
         {
            "mapId":"Subnet__404",
            "id":404,
            "type":"SUBNET",
            "locationOnPath":11,
            "displayName":null,
            "ip":null,
            "empty":false
         }
      ]
   },
   "detectedDevices":[
      {
         "mapId":"Device__40",
         "ip":"10.176.46.197",
         "displayName":"Pecan_PaloAlto"
      },
      {
         "mapId":"Device__252",
         "ip":"192.168.6.6",
         "displayName":"Poppy_juniper"
      }
   ],
   "scenario":{
      "name":"REACHED_WRONG_DEVICE",
      "message":"There might be an issue with device",
      "recommendedSteps":[
         {
            "text":"Collect logs",
            "action":"support"
         },
         {
            "text":"Open a support case on Algosec Portal",
            "action":"portal"
         }
      ]
   },
   "inconsistencyCauseDevice":{
      "ip":"192.168.6.6",
      "dnsName":"192.168.6.6",
      "snmpName":null
   },
   "expectedDevice":{
      "displayName":"Violet_Fortinet",
      "ip":"10.42.65.100"
   },
   "firstUnexpectedDevice":{
      "mapId":"Device__8",
      "ip":"10.82.18.20",
      "displayName":"Rose_checkpoint"
   }

Acknowledge an notification

The acknowledge request marks active issues in the AFA Notification Center as acknowledged. Notifications marked as acknowledged will appear in the list of acknowledged issues and will no longer appear in the list of active notifications .

Resource Name:

/ms-watchdog/v1/api/issues-center/issues/acknowledge

Request Method: POST

Authentication: Cookie with session ID.

Request Body: Any array of issue IDs. To retrieve the issue IDs, see Manage AFA notifications .

Response:

Element	Type	Description
`newStatus`	String	The new status of the issues: ACKNOWLEDGED.
`updatedIssues`	Array	An array of issue IDs.
`successful`	Boolean	Whether the request was successful.

Request example

#/ms-watchdog/v1/api/issues-center/issues/acknowledge

[2,4]

Response example

{ 
	"newStatus":"ACKNOWLEDGED",
	"updatedIssues":[ 
		2,
		4
	],
	"successful":true
}

Running the Query Troubleshooting Tool

Acknowledge an notification

Sorry about that

Great!