URL parameters for geographical maps
You can use URL parameters to open geographical maps with specific configurations.
Parameters for scoping geographical maps
The following URL parameters can be used to define the scope of the geographical maps.
| Parameter | Description | Example |
|---|---|---|
| None |
Displays all geographically enriched devices, locations, and links in all domains. |
https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp |
bounds |
Displays geographically enriched devices and links within a defined area. The area is defined as the rectangle between the north-west and south-east points. The values must be in the following format: The regular expression for the allowed values is:
|
|
deviceId |
Displays specific geographically enriched devices. The The regular expression for the allowed values is:
|
|
getAllLocations |
|
https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?getAllLocations |
getLocationsWithinBounds |
The area is defined as the rectangle between the north-west and south-east points. The values must be in the following format: The regular expression for the allowed values is:
|
|
getLocationsByViewId |
|
https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?getLocationsByViewId |
getLocationsByDeviceIds |
|
https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?getLocationsByDeviceIds |
locationId |
Displays geographically enriched locations. The value must be a positive numeric value representing a valid location collection
The regular expression for the allowed values is: |
|
viewId |
Displays all geographically enriched devices and links within the specified network view. Valid values are:
Where The regular expression for the allowed values is:
|
|
URL parameters for filtering geographical maps
The following URL parameters can be used to filter the contents of the geographical map.
| Parameter | Description | Example |
|---|---|---|
config.filter.domain |
Scopes the view to the specified domains. The value must be a comma-separated list of positive numeric value domain IDs. The regular expression for the allowed values is: |
The following example displays network entities in the specified domain:
|
config.filter.class |
Scopes the view to devices that match the specified class type. The value must be a comma-separated list of positive numeric value entity class type IDs. The regular expression for the allowed values is: |
The following example displays CiscoCat35xx class devices only:
|
config.filter.layer |
Scopes the view to links that match the defined topology layer type. The value must be a comma-separated list of positive numeric value topology layer type IDs. The regular expression for the allowed values is: |
The following example displays devices on only Layer 2:
|
config.enableLinks |
Scopes the view to exclude or include all links from the view. This value can be true or false. The regular expression for the allowed values is: |
The following example excludes links:
|
config.enableLinkStatus |
Scopes the view to exclude or include link status from the view. This value can be true or false. The regular expression for the allowed values is: |
The following example displays links without severity colors:
|
config.enableTopologyStatus |
Scopes the view to exclude or include device and location status from the view. This value can be true or false. The regular expression for the allowed values is: |
The following example displays devices and locations without any severity icons.
|
config.minTopologyStatus |
Scopes the view to show only status for devices and locations with events of a status greater than the specified value. The value must be one of the following:
The regular expression for the allowed values is: |
The following example displays device and location status of Warning or higher:
|
config.minLinkStatus |
Scopes the view to show only status for links with events of a status greater than the specified value. The value must be one of the following:
The regular expression for the allowed values is: |
The following example displays link status of Critical:
|
Controls regional aggregation. Displays all aggregated locations
within the top level.