Identify missing routers

The following requests allow you to identify routers in the AFA graphic network map that should be defined as devices in AFA.

For more details, see Manage the map.

In this topic:

Run the Topology Advisor

The execute method runs the Topology Advisor. This tool searches for routers missing from the AFA graphic network map.

The input will be the network's SNMP key, internal networks, external networks, and the maximum number of queries the tool should run. The output is a status message. To retrieve the results, Retrieve suggested routers results.

Resource Name: /ms-mapDiagnostics/v1/api/mapCompleteness/execute*/

Request Method: POST

Authentication: Cookie with session ID.

Request Body Parameters:

Element	Type	Description
maxQueriesOptional	Integer	The maximum number of paths to query. By default, the maximum number of queries is 400.
snmpKeyOptional	String	The network's SNMP key. This is used to retrieve the names of the routers. If the DNS lookup fails and the SNMP key is not provided, the results will only provide the router's IP address.
internalNetworksOptional	A list of subnets (CIDR format).	All of the network's internal subnets. In order to determine the default values for your environment, seeRetrieve Topology Advisor default values.
externalNetworksOptional	A list of subnets (CIDR format).	All of the external subnets that should be reachable from each of the network's internal subnets. In order to determine the default values for your environment, see Retrieve Topology Advisor default values.

Response:

Element	Type	Description
status	String	A message which indicates success or a reason for failure.

Request Body Example

Response example

Back to top

Retrieve suggested routers results

The missingStubRouters request provides the results of the execute request: a list of routers missing from the graphic network map.

The input will be the page number you want to retrieve. You can optionally filter the result that you want to retrieve by providing the name of a router, the name of the closest device, or a relevant subnet. The output is a list of routers.

Resource Name: ms-mapDiagnostics/v1/api/mapCompleteness/missingStubRouters

Request Method: GET

Authentication: Cookie with session ID.

Request URL Parameters:

Element	Type	Description
form	String	A URL encoded JSON object with the following properties.

Properties:

Element	Type	Description
pageNumberMandatory	Integer	The page number for the page of results to return in the response.
byStubNameOptional	String	The name of router to return in the response.
byClosestDeviceNameOptional	String	The name of the closest device to the routers to return in the results.
byNetworkOptional	String	A subnet (in CIDR format) that is relevant to the routers to return in the results.

Response:

Element	Type	Description
totalStubs	Integer	The number of routers returned in the response.
pageNumber	Integer	The page number of the results returned in the response.
stubs	A list of stub objects.	A list of routers. See Stub Type (see Stub Type ).
score	Integer	The score of suggested routers.

Request Body Example

Response example

Back to top

Retrieve the last run configuration

The lastExecution request provides the parameters that were used the last time the Topology Advisor was executed.

Resource Name: ms-mapDiagnostics/v1/api/mapCompleteness/lastExecution*/

Request Method: GET

Authentication: Cookie with session ID.

Response:

Element	Type	Description
score	Integer	The score of suggested routers.
executionTime	Integer	The timestamp for the last execution.
queries	Integer	The number of queries that were run.
snmpKey	String	The network's SNMP key.
internalNetworks	A list of ip objects	The internal subnets that were used for the execution.
externalNetworks	A list of ip objects	The external subnets that were used for the execution.
status	String	The status of the last execution.
progress	Boolean	The last execution's progress.

Response example

Back to top

Stop a Topology Advisor job

The abort request stops an execution that is in progress.

Resource Name: ms-mapDiagnostics/v1/api/mapCompleteness/abort*/

Request Method: POST

Authentication: Cookie with session ID.

Response:

Element	Type	Description
status	String	A message which indicates success or a reason for failure.

Back to top

Retrieve Topology Advisor default values

The defaultValues request provides the default values of the Topology Advisor parameters for the specific AFA environment.

By default, the maximum number of paths that will be simulated (queries that will be run) is 400. The default external networks used in the calculation is 8.8.8.8. If a custom risk profile spreadsheet is being used in AFA, the networks in the spreadsheet are used as the default internal networks. If no such spreadsheet is being used, RFC 1918 is used to provide the default internal networks.

Resource Name: ms-mapDiagnostics/v1/api/mapCompleteness/defaultValues*/

Request Method: GET

Authentication: Cookie with session ID.

Response:

Element	Type	Description
score	Integer	The score of suggested routers.
executionTime	Integer	The timestamp for the execution.
executionTimeofLastSucceccfulJob	Integer	The timestamp for the last execution.
queries	Integer	The default number of queries.
snmpKey	String	The network's SNMP key.
internalNetworks	A list of ip objects	The default internal subnets for the environment.
externalNetworks	A list of ip objects	The default external subnets for the environment.
status	String	The status of the last execution.
progress	Boolean	The last execution's progress.

Response example

Back to top