Get a device's topology zones (zones that are originated on the device itself). This API is relevant for device brands that support (topology) zones, like Palo Alto and FortiManager.
For more information see, Device names in the ASMS APIs.
Resource Name:
Request Method: GET
Request Parameters:|
Element |
Type |
Description |
|---|---|---|
|
device |
string |
Device or group name (display name or tree_name property of device properties). For more information see Device names in the ASMS APIs |
Response Parameters
|
Element |
Type |
Description |
|---|---|---|
| additionalInformation | string | For a group of devices, if only some devices return data, information about the failed devices is returned here |
| deviceZones | List of entities for each device zone | |
| name | string | Name of zone |
| interfaces | string | List of interfaces assigned to the zone |
| ipaddress | string | List IP addresses included in the zone, according to analyzed topology |
| deviceName | string | Name of device (unique AFA’s name) |
Response:
|
Code |
Description |
|---|---|
| 200 |
Operation completed successfully |
|
400 |
Validation error |
|
401 |
Unauthorized |
Request cURL examples
{curl -k --cookie "PHPSESSID=i66sh8f75o736eqhrvr4d1ijn3" 'https://[machine ip]/afa/api/v1/deviceZones?device=10.20.106.1'
Response examples
{
"deviceZones" : [
{ "name" : "vr1-topology", "interfaces" : [ "ethernet1/3", "ethernet1/6", "ethernet1/3.77" ], "ipaddress" : "10.50.60.0 - 10.50.60.255,2.2.2.0 - 2.2.2.255,10.160.0.248 - 10.160.0.251,33.3.3.0 - 33.3.3.255,55.5.5.0 - 55.5.5.255,88.8.8.0 - 88.8.8.255,89.10.0.0 - 89.10.0.255", "deviceName" : "10_20_124_1_Adele_1_1_vsys1_TT1" }
,
{ "name" : "external", "interfaces" : [ "ethernet1/2", "loopback", "ethernet1/1.51", "ethernet1/1.52", "ethernet1/1.53" ], "ipaddress" : "10.11.10.0 - 10.11.10.255,79.97.167.0 - 79.97.167.255,15.15.15.15 - 15.15.15.15,10.10.10.51 - 10.10.10.51,10.10.10.52 - 10.10.10.52,10.10.10.53 - 10.10.10.53", "deviceName" : "10_20_124_1_Adele_1_1_vsys1_TT1" }
,
{ "name" : "internal", "interfaces" : [ "ethernet1/1", "ethernet1/2.17", "ethernet1/1.3", "vlan", "ethernet1/2.4", "ethernet1/1.5", "ethernet1/1.54" ], "ipaddress" : "10.10.10.0 - 10.10.10.50,10.10.10.54 - 10.10.10.255,11.11.10.10 - 11.11.10.10,172.168.11.0 - 172.168.11.255,81.1.0.0 - 81.1.0.255,10.10.20.57 - 10.10.20.57", "deviceName" : "10_20_124_1_Adele_1_1_vsys1_TT1" }
],
"additionalInformation" : [ "Failed to find completed report for '10_20_124_1_Adele_1_1_vsys1_one_armed_vr'", "Failed to find completed report for '10_20_124_1_Adele_1_1_vsys1_vr_2'", "Failed to find completed report for '10_20_124_1_Britney_vsys1_RogerVwireLab'", "Failed to find completed report for '10_20_124_1_Britney_vsys1_Router___pan'"]
}
Yes 
No 
