V4.2 Fix Pack 2:

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.

Table 1. URL parameters for scoping 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: ((northern latitude,western longitude),(southern latitude,eastern longitude))

The regular expression for the allowed values is: (\\()(\\()([+-]?\\d*\\.\\d+)(?![-+0-9\\.])(,)([+-]?\\d*\\.\\d+)(?![-+0-9\\.])(\\))(,)(\\()([+-]?\\d*\\.\\d+)(?![-+0-9\\.])(,)([+-]?\\d*\\.\\d+)(?![-+0-9\\.])(\\))(\\))

https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?bounds=((northern latitude,western longitude),(southern latitude,eastern longitude))

https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?bounds=%28%2851.50,-0.15%29,%2851.45,-0.09%29%29

deviceId

Displays specific geographically enriched devices.

The deviceId parameter must be a comma-separated list of positive numeric value device IDs.

The regular expression for the allowed values is:

([1-9][0-9]*,[ ])*[1-9][0-9]*
https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?deviceId=19078,19062,19067
getAllLocations

V4.2 Fix Pack 3: Controls regional aggregation. Displays all aggregated locations within the top level. For example, if the top level is Country, displays Regions. Locations that do not contain any in-scope entities, for example, because entities have been excluded by domain or class, are not shown.

https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?getAllLocations
getLocationsWithinBounds

V4.2 Fix Pack 3: Controls regional aggregation. Displays all aggregated locations within the top level, within the specified map boundaries. For example, if the top level is Country, displays Regions. Locations that do not contain any in-scope entities, for example, because entities have been excluded by domain or class, are not shown.

The area is defined as the rectangle between the north-west and south-east points.

The values must be in the following format: ((northern latitude,western longitude),(southern latitude,eastern longitude))

The regular expression for the allowed values is: (\\()(\\()([+-]?\\d*\\.\\d+)(?![-+0-9\\.])(,)([+-]?\\d*\\.\\d+)(?![-+0-9\\.])(\\))(,)(\\()([+-]?\\d*\\.\\d+)(?![-+0-9\\.])(,)([+-]?\\d*\\.\\d+)(?![-+0-9\\.])(\\))(\\))

https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?getLocationsWithinBounds=%28%2851.50,-0.15%29,%2851.45,-0.09%29%29

getLocationsByViewId

V4.2 Fix Pack 3: Controls regional aggregation. Displays all aggregated locations within the top level, for the given network view ID and all views that it contains. For example, if the top level is Country, displays Regions. Locations that do not contain any in-scope entities, for example, because entities have been excluded by domain or class, are not shown.

https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?getLocationsByViewId
getLocationsByDeviceIds

V4.2 Fix Pack 3: Controls regional aggregation. Displays all aggregated locations within the top level, for the given device IDs (recursively traversing the view tree). For example, if the top level is Country, displays Regions. Locations that do not contain any in-scope entities, for example, because entities have been excluded by domain or class, are not shown.

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 entityId.

The regular expression for the allowed values is: (\\d+)

https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?locationId=47672
viewId

Displays all geographically enriched devices and links within the specified network view.

Valid values are:

  • NCP_VIEW_$viewId
  • $viewId

Where viewId is a positive numeric value only, and a valid Id of a network view..

The regular expression for the allowed values is:

(((NCP_VIEW_)(\\d+))|(\\d+))

https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?viewId=760

https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?viewId=NCP_VIEW_760

URL parameters for filtering geographical maps

The following URL parameters can be used to filter the contents of the geographical map.

Table 2. URL parameters for filtering geographical maps
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: ([1-9][0-9]*,[ ])*[1-9][0-9]*

The following example displays network entities in the specified domain:

https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?config.filter.domain=5

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: ([1-9][0-9]*,[ ])*[1-9][0-9]*

The following example displays CiscoCat35xx class devices only:

https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?config.filter.class=110

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: ([1-9][0-9]*,[ ])*[1-9][0-9]*

The following example displays devices on only Layer 2:

https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?config.filter.layer=72

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: ((true)|(false))

The following example excludes links:

https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?config.enableLinks=false

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: ((true)|(false))

The following example displays links without severity colors:

https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?config.enableLinkStatus=false

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: ((true)|(false))

The following example displays devices and locations without any severity icons.

https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?config.enableTopologyStatus=false

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:

  • 0 : Clear or Higher
  • 1: Indeterminate or Higher
  • 2: Warning or Higher
  • 3: Minor or Higher
  • 4: Major or Higher
  • 5: Critical only

The regular expression for the allowed values is: [0-5]

The following example displays device and location status of Warning or higher:

https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?config.minTopologyStatus=2

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:

  • 0 : Clear or Higher
  • 1: Indeterminate or Higher
  • 2: Warning or Higher
  • 3: Minor or Higher
  • 4: Major or Higher
  • 5: Critical only

The regular expression for the allowed values is: [0-5]

The following example displays link status of Critical:

https://server:port/ibm/console/ncp_gis/NetKitMapWidget.jsp?config.minTopologyStatus=5