Hop View URL parameters

Edit online

Use this information to understand how to construct a URL to display layer 1, layer 2, and layer 3 connectivity maps in the Network Hop View.

URL parameters

The following table shows the URL parameters that you can pass to the Hop View to display layer 2 or layer 3 connectivity maps.

Note: If you specify a seed that has no matches or multiple matches, the search dialogue is displayed. Multiple matches can occur if no domain is specified and a device with the same name or IP address exists in more than one domain. Multiple matches can also occur if a domain is specified and more than one device in that domain has the same name.
Table 1. URL parameters for Hop View maps 

Parameter

Description

Required?

connectivity

This takes an integer or string (case-sensitive) value corresponding to the entityType of the connectivity. Only entityTypes of type Topology are allowed, for example, 71 (Layer 1 Topology).

This parameter corresponds to the Connectivity field in the Hop View toolbar.

Allowed values for the connectivity parameter are given in Connectivity parameters.

The default value is the default for the Hop View, or 72 (layer 2) if no default is configured.

No

domain

The name of the Network Manager domain. This corresponds to the Domain field in the Hop View toolbar. If you do not specify a domain, all domains are searched.

No

endNodes

This can take one of the following values:

  • true: Show end nodes in the map.
  • false: Do not show end nodes in the map.

The default is false.

No

hops

This is the number of hops from the seed device. This corresponds to the Hops field in the Hop View toolbar.

The default is 1.

No

layout

This can be any of the following:

  • hierarchical
  • symmetric
  • orthogonal
  • circular

The default is symmetric.

No

seed

An identifier for the seed device. This may be the EntityName, IPAddress or EntityId of the required seed device. This corresponds to the Seed field in the Hop View toolbar.

You can use multiple seed devices in the same Hop View. Administrator can set a limit for seed devices using the topoviz.hopview.maximum.seeds property in topoviz.properties. This defaults value for topoviz.hopview.maximum.seeds is 10. If it is set to a negative value, then it does not limit the number of seed devices.

Yes

Example 1: URL for layer 2 connectivity map

The following example shows the format of a Topoviz URL for a layer 2 connectivity map. Note that Topoviz URLs are case-sensitive. 

https://host:port/ibm/console/ncp_topoviz/HopView.do?domain=MPLSTEST&type=layer2&layout=hierarchical&seed=lon-core-cis-h.ibm.com&hops=2&endNodes=true

Example 2: URL for layer 3 connectivity map

The following example shows the format of a Topoviz URL for a layer 3 map. Note that Topoviz URLs are case-sensitive.

https://host:port/ibm/console/ncp_topoviz/HopView.do?domain=MPLSTEST&type=layer3&layout=symmetric&seed=lon-core-cis-h.ibm.com&HOPS=2&endNodes=true

Example 3: URL for layer 2 connectivity map with multiple seed devices

The following example shows the format of a Topoviz URL for a layer 2 map with two devices. Note that Topoviz URLs are case-sensitive.

https://host:port/ibm/console/ncp_topoviz/HopView.do?domain=MPLSTEST&type=layer2&layout=hierarchical&seed=lon-core-cis-h.ibm.com&seed=dub-core-cis-g.ibm.com&hops=2&endNodes=true
https://host:port/ibm/console/ncp_topoviz/HopView.do?domain=MPLSTEST&type=layer3&layout=symmetric&seed=lon-core-cis-h.ibm.com&HOPS=2&endNodes=true

Connectivity parameters

The following table shows the integer and string values that you can use for the connectivity parameter in Topoviz URLs.

Table 2.
Integer String Description
-1 ipsubnets Logical collection that lists the IP address in a class A, B, or C subnet.
71 layer1 Grouping of connections which belong to a Layer 1 topology.
72 layer2 Grouping of connections which belong to a Layer 2 topology.
73 layer3 Grouping of connections which belong to a Layer 3 meshed topology.
74 convergedtopology Based on data available in NCIM, groups together connections at the lowest layer for which data is available.
75 mplste Grouping of connections which belong to an MPLS TE topology.
77 pseudowire Grouping of connections which belong to a Pseudo Wire topology.
78 OSPF Represents an OSPF topology.
81 pim Represents PIM topologies.
83 ipmroute Represents an IP Multicast Routing topology.
86 microwave Represents a microwave topology.
87 logicalran Represents a radio access network topology.
90 ltecontrolplane Represents the devices and connectivity that make up the LTE control plane.
91 lteuserplane Represents the devices and connectivity that make up the LTE user plane.
92 probe Represents the source/target connectivity for an IP SLA probe.