Using URLs to Access NNMi Objects

0
121
14 min read

 

HP Network Node Manager 9: Getting Started

HP Network Node Manager 9: Getting Started

Manage your network effectively with NNMi

  • Install, customize, and expand NNMi functionality by developing custom features
  • Integrate NNMi with other management tools, such as HP SW Operations Manager, Network Automation, Cisco Works, Business Availability center, UCMDB, and many others
  • Navigate between incidents and maps to reduce troubleshooting time
  • Screenshots and step-by-step instructions to customize NNMi in the way you want
  • Instructions in the book are valid for version 8 as well
        Read more about this book      

HP Network Node Manager 9

URLs that are listed in this section can be grouped into a few groups (refer to the preceding screenshot):

  • Generic URLs.
  • Workspace-related URLs.
  • Form-related URLs.
  • Menu item-related URLs. As an example, we can provide a quick access to menu items for our team. For example, building a smart-phone application that displays critical events and allows user to run ping, trace route, or other commands for faster troubleshooting (refer to the next diagram).

HP Network Node Manager 9

The following section lists these URLs and provides tables of parameters, which can be used for building URLs.

Note: If our NNMi is configured to use the https protocol, we need to modify our URLs in this article accordingly, as URLs here are provided for http access.

Generic URLs

Generic URLs that can be used for obtaining information about NNMi are:

  • View launching URL: To launch the NNMi console, use the following URL:http://<server_name>:<port_number>/nnm/launch?cmd=showMain.
    If we are passing by using a username and password within the URL, we need to use the following syntax: http://<server_name>:<port_number>/nnm/launch?cmd=showMain&j_username=<account_name>&j_password=<account_password>.
  • To confirm whether NNMi is running: The following URL should be used: http:/<serverName>:<portNumber>/nnm/launch?cmd=isRunning.
    Using this URL, we will receive a confirmation response on whether or not NNMi is running.

    HP Network Node Manager 9

Otherwise, a browser error message will be sent saying that the URL is unreachable.

HP Network Node Manager 9

Workspace-related URLs

This URL group is related to NNMi views. Here is a list of available URLs.

Launching view

The following table presents the required attributes and their values for launching views.

Attributes Values Description
Use following URL to show general view:
http://<serverName>:<portNumber>/nnm/launch?cmd=showView&objtype=<x>
objtype

Incident

Node

Interface

IP Address

IP Subnet

NodeGroup

InterfaceGroup

Incidents workspace, All Incidents table view.

Inventory workspace, Nodes table view.

Inventory workspace, Interfaces table view.

Inventory workspace, IP Addresses table view.

Inventory workspace, IP Subnets table view.

Inventory workspace, Node Groups table view.

Inventory workspace, Interface Groups table view.

Use the following URL to show general view for a specific node group, filtered by node group name, id, or uuid:
http://<serverName>:<portNumber>/nnm/launch?cmd=showView&objtype= <x>&nodegroup=<Name>
nodegroup
  • nodegroup
  • nodegroupid

 

 

  • nodegroupuuid
  • The Name attribute value of Node Group*.
  • The ID number of node group. This ID is unique across all NNMi database. Use nnmconfigexport.ovpl tool to see ID number of node group.
  • Universally Unique Object ID of the node group. Use nnmconfigexport.ovpl tool to see ID number of node group.
Use following URL to show general view for a specific node group, filtered by interface group name or id:
http://<serverName>:<portNumber>/nnm/launch?cmd=showView&objtype=<x>&ifgroup=<Name>
ifgroup
  • ifgroup
  • ifgroupid

 

 

  • ifgroupduuid
  • The name attribute value of interface group*.
  • The ID number of interface group. This ID is unique across all NNMi database. Use nnmconfigexport.ovpl tool to see id number of interface group.
  • Universally Unique Object ID of the interface group. Use nnmconfigexport.ovpl tool to see id number of interface group.
Use following URL to show general view with custom window settings:
http://<serverName>:<portNumber>/nnm/launch?cmd=showView&objtype=<x>&menus=<true|false>&newWindow=<true|false>&envattrs=<name1=value>;<name2=value>
menus [true|false]
  • True: Show the view menus.
  • False: Hide the view menus.

The default value is true.

newWindow [true|false]
  • True: To display view in new window.
  • False: To display view within same browser window.

Default value is false.

envattrs   This is session-specific attributes and they are stored by following syntax: <name=value>.

 

 

* If the node group name has spaces in it, use one of the following symbols to represent a “space” character (without brackets): “%20”, “+”, or ” ” (space symbol).

Consider the following example. To open a window with incidents, which are related to the node group Europe, run the following URL (assuming, that NNMi is installed on node “box1” and uses port number “8080”): http://box1:8080/nnm/launch?cmd=showView&objtype=Incident&nodegroup=Europe

Launching an Incident view

The following table presents the required attributes and their values for launching incident-specific views.

Attributes Values Description
Use following URL to show incident view, filtered by specific incident attributes:
http://<serverName>:<portNumber>/nnm/launch?cmd=showView&view=<x>
view
  • allIncidentsTableView
  • allOpenIncidentsTableView
  • closedKeyIncidentsTableView
  • closedRCIncidentTableView
  • customIncidentTableView
  • incidentsByNatureTableView
  • incidentsByFamilyTableView
  • keyIncidentsByLifecycleStateTableView
  • myIncidentTableView
  • nnm6x7xIncidentTableView
  • nnm6x7xIncidentByCategoryTableView
  • openKeyIncidentsTableView
  • openKeyIncidentsByCategoryTableView
  • openKeyIncidentsByFamilyTableView
  • openKeyIncidentsByPriorityTableView
  • openKeyIncidentsBySeverityTableView
  • openRCIncidentsByCategoryTableView
  • openRCIncidentsByFamilyTableView
  • openRCIncidentsByPriorityTableView
  • openRCIncidentsBySeverityTableView
  • openRCIncidentTableView
  • allRCIncidentTableView
  • RCIncidentsByLifecycleStateTableView
  • serviceImpactIncidentTableView
  • snmpTrapsIncidentTableView
  • snmpTrapsIncidentByFamilyTableView
  • streamCorrelationIncidentTableView
  • unassignedKeyIncidentsTableView
  • unassignedIncidentTableView
  • All incidents
  • All open incidents
  • Closed Key Incidents
  • Closed Root Cause Incidents
  • Custom Incidents
  • Incidents by Correlation Nature
  • Incidents by Family
  • Key Incidents by Lifecycle State
  • My Open Incidents
  • NNM 6.x / 7.x Events
  • NNM 6.x/7.x Event by Category
  • Open Key Incidents
  • Open Key Incidents by Category
  • Open Key Incidents by Family
  • Open Key Incidents by Priority
  • Open Key Incidents by Severity
  • Open Root Cause by Category
  • Open Root Cause by Family
  • Open Root Cause by Priority
  • Open Root Cause by Severity
  • Open Root Cause Incidents
  • Root Cause Incidents
  • Root Cause by Lifecycle State
  • Service Impact Incidents
  • SNMP Traps
  • SNMP Traps by Family
  • Stream Correlation Incidents
  • Unassigned Open Key Incidents
  • Unassigned Root Cause Incidents
Use following URL to show Incident view, filtered for specific node group:
http://<serverName>:<portNumber>/nnm/launch?cmd=showView&view=<x>&nodegroup_var=<Name>

See the preceding table for attribute description.

Use following URL to show Incident view with custom window settings:
http://<serverName>:<portNumber>/nnm/launch?cmd=showView&view=<x>&menus_var=<true|false>&newWindow=<true|false>&envattrs=<name1=value>;<name2=value>

See the preceding table for attribute description.

 

Launching a Topology Maps Workspace view

Here is a list of Topology Maps that can be opened using the following URLs:

Consider the following example. Here are the links to open a few groups on NNMi server “box1” (port number 8080):

  • Open Routers node groups:
    http://box1:8080/nnm/launch?cmd=showNodeGroup&name=Routers
  • Open Networking Infrastructure devices:
    http://box1:8080/nnm/launch?cmd=showView&objtype= Node&nodegroup=Networking%20Infrastructure%20Devices

Launching a Monitoring Workspace view

The following table presents the required attributes and their values for launching Monitoring workspace-specific views.

Attributes Values Description
Use following URL to show monitoring view, filtered by specific attributes:
http://<serverName>:<portNumber>/nnm/launch?cmd=showView&view=<x>
view
  • criticalComponentHealthTableView
  • criticalInterfaceTableView
  • criticalNodeTableView
  • nonNormalInterfaceTableView
  • nonNormalNodeTableView
  • notRespondingIPAddressTableView
  • nodesByStatusTableView
  • componentHealthByStatusTableView
  • interfacesByStatusTableView
  • interfacesByAdministrativeStateTableView
  • interfacesByOperationalStateTableView
  • IPAddressesByStateTableView
  • interfacePerformanceTableView
  • routerRedundancyGroupsTableView
  • nodeGroupsStatusTableView
  • Critical Component Health
  • Critical Interfaces
  • Critical Nodes
  • Non-Normal Interfaces
  • Non-Normal Nodes
  • Not Responding Addresses
  • Nodes by Status
  • Component Health by Status
  • Interfaces by Status
  • Interfaces by Administrative State
  • Interfaces by Operational State
  • IP Addresses by State
  • Interface Performance
  • Router Redundancy Groups
  • Node Groups
Use following URL to show monitoring view, filtered by node group:
http://<serverName>:<portNumber>/nnm/launch?cmd=showView&view=<x>&nodegroup=<Name>

Refer to the table under the Launching view section for attribute description.

Use following URL to show general view, filtered by interface group:
http://<serverName>:<portNumber>/nnm/launch?cmd=showView&view=<x>&ifgroup=<Name>

Refer to the table under the Launching view section for attribute description.

Use following URL to show monitoring view with custom window settings:
http://<serverName>:<portNumber>/nnm/launch?cmd=showView&view=<x>&menus=<true|false>&newWindow=<true|false>&envattrs=<name1=value>;<name2=value>

Refer to the table under the Launching view section for attribute description.

 

Launching a Troubleshooting Workspace view

Troubleshooting workspace contains the following four different views:

  • Layer 2 Neighbor view
  • Layer 3 Neighbor view
  • Path view
  • Node Group Map view

Use the following URL to show the Layer 2 Neighbor view:
http://<serverName>:<portNumber>/nnm/launch?cmd=showLayer2Neighbors.

Attributes

 

Values Description
Use following URL to show Layer 2 Neighbor view by specified number of hops:
http://<serverName>:<portNumber>/nnm/launch?cmd=showLayer2Neighbors&nodename=<x>&hops=<#>
nodename nodename The source node’s name or IP address
hops 1 – 9 Number of hops
Use following URL to show Layer 2 Neighbor view with custom window parameters: http://<serverName>:<portNumber>/nnm/launch?cmd=showLayer2Neighbors&menus=<true/false>&newWindow=<true/false>&envattrs=<name1=value>;<name2=value>

Refer to the table under the Launching view section for attribute description.

 

Use the following URL to show Layer 3 Neighbor view:
http://<serverName>:<portNumber>/nnm/launch?cmd= showLayer3Neighbors.

Attributes Values Description
Use following URL to show Layer 3 Neighbor view for specified node by specified number of hops:
http://<serverName>:<portNumber>/nnm/launch?cmd=showLayer3Neighbors&nodename=<x>&hops=<#>
nodename See the previous table for attribute description.
hops See the previous table for attribute description.
menus [true|false] Show (true) or hide (false) menu and window toolbar. Default value is “true“.

 

Use the following URL to show Layer 3 Neighbor view with the specified window parameters:
http://<serverName>:<portNumber>/nnm/launch?cmd=showLayer3Neighbors&menus=<true/false>&newWindow=<true/false>&envattrs=<name1=value>;<name2=value>.

Use the following URL to show Path view: http://<serverName>:<portNumber>/nnm/launch?cmd=showPath.

Attributes Values Description
Use the following URL to show Path view by specified source and destination nodes: http://<serverName>:<portNumber>/nnm/launch?cmd=showPath&src=<x>&dest=<y>
src src Source node’s hostname or IPv4 address.
dest dest Destination node’s hostname or IPv4 address.

Use the following URL to show Path view with custom window parameters: http://<serverName>:<portNumber>/nnm/launch?cmd=showPath&menus=<true/false>&newWindow=<true/false>&envattrs=<name1=value>;<name2= value>

Attributes Values Description

 

Use following URL to list nodes belonging to a specified node group:
http://<serverName>:<portNumber>/nnm/launch?cmd=showNodeGroup&name=<x>
name name The Name attribute value from the Node Group form

 

Use the following URL to list nodes belonging to a specified node group with custom window parameters: http://<serverName>:<portNumber>/nnm/launch?cmd=showNodeGroup&name=<x>&menus=<true/false>&newWindow=<true/false>&envattrs=<name1=value>;<name2=value>.

Launching an Inventory Workspace view

The following table presents the required attributes and their values for launching Inventory workspace-specific views.

Attributes Values Description
Use the following URL to show a view, specified in the view list below in this table:
http://<serverName>:<portNumber>/nnm/launch?cmd=showView&view=<x>
view
  • allNodesTableView
  • allInterfacesTableView
  • allIPAddressTableView
  • allIPSubnetsTableView
  • allVlansTableView
  • allLayer2ConnectionsTableView
  • nodesByDeviceCategoryTableView
  • interfacesByIfTypeTableView
  • customNodeTableView
  • customInterfaceTableView
  • customIPAddressTableView
  • routerRedundancyGroupsTableView
  • nodeGroupsTableView
  • interfaceGroupsTableView
  • allManagementStationsTableView
  • Nodes
  • Interfaces
  • IP Addresses
  • IP Subnets
  • VLANs
  • Layer 2 Connections
  • Nodes by Device Category
  • Interfaces by IfType
  • Custom Nodes
  • Custom Interfaces
  • Custom IP Addresses
  • Router Redundancy Groups
  • Node Groups
  • Interface Groups
  • Management Stations
Use the following URL to show a view, specified in the view list below in this table for specified node group: http://<serverName>:<portNumber>/nnm/launch?cmd=showView&view=<x>&nodegroup=<Name>.

Refer to the table under the Launching view section for attribute description.

nodegroup
  • nodegroup
  • nodegroupid
  • nodegroupuuid
Refer to the table under the Launching view section for attribute description.
Use the following URL to show a view, specified in the view list below in this table for specified interface group:
http://<serverName>:<portNumber>/nnm/launch?cmd=showView&view=<x>&interfacegroup=<Name>
interfacegroup
  • ifgroup
  • ifgroupid
  • ifgroupuuid
Refer to the table under the Launching view section for attribute description.

 

Use the following URL to show a view, specified in the view list above in a table with custom window settings: http://<serverName>:<portNumber>/nnm/launch?cmd=showView&view=<x>&menus= <true/false>&newWindow=<true/false>&envattrs=<name1=value>;<name2=value>.

Launching Management Mode Workspace views

The following table presents the required attributes and their values for launching Management Mode workspace-specific views:

Attributes Values Description
Use the following URL to show a view, specified in the view list below in this table:
http://<serverName>:<portNumber>/nnm/launch?cmd=showView&view=<x>
view
  • allNodesTableView
  • allInterfacesTableView
  • allIPAddressTableView
  • allIPSubnetsTableView
  • allVlansTableView
  • allLayer2ConnectionsTableView
  • nodesByDeviceCategoryTableView
  • interfacesByIfTypeTableView
  • customNodeTableView
  • customInterfaceTableView
  • customIPAddressTableView
  • routerRedundancyGroupsTableView
  • nodeGroupsTableView
  • interfaceGroupsTableView
  • allManagementStationsTableView
  • Nodes
  • Interfaces
  • IP Addresses
  • IP Subnets
  • VLANs
  • Layer 2 Connections
  • Nodes by Device Category
  • Interfaces by IfType
  • Custom Nodes
  • Custom Interfaces
  • Custom IP Addresses
  • Router Redundancy Groups
  • Node Groups
  • Interface Groups
  • Management Stations
Use the following URL to show a view, specified in the view list below in this table for specified node group: http://<serverName>:<portNumber>/nnm/launch?cmd=showView&view=<x>&nodegroup=<Name>.

Refer to the table under the Launching view section for attribute description.

nodegroup
  • nodegroup
  • nodegroupid
  • nodegroupuuid

Refer to the table under the Launching view section for attribute description.

Use the following URL to show a view, specified in the view list below in this table for specified interface group:

http://<serverName>:<portNumber>/nnm/launch?cmd=showView&view= <x>&interfacegroup=<Name>

interfacegroup
  • ifgroup
  • ifgroupid
  • ifgroupuuid
Refer to the table under the Launching view section for attribute description.

Use the following URL to show a view, from the Management Mode workspace, with specified window settings: http://<serverName>:<portNumber>/nnm/launch?cmd=showView&view=<x>&menus=<true/false>&newWindow=<true/false>&envattrs=<name1=value>;<name2=value>.

Launching a Configuration Workspace view

The following table presents the required attributes and their values for launching the Configuration workspace-specific views:

Attributes Values Description
Use the following URL to show a view from Configuration workspace for a view specified below: http://<serverName>:<portNumber>/nnm/launch?cmd=showView&view=<x>.
view
  • nodeGroupsTableView
  • allNodeGroupMapSettingsTableView
  • interfaceGroupsTableView
  • allManagementStationsTableView
  • ramsServerTableView
  • allURLActionInfosTableView
  • allAccountsTableView
  • allIfTypesTableView
  • allDeviceProfilesTableView
  • Node Groups
  • Node Group Map Settings
  • Interface Groups
  • Management Stations
  • RAMS Servers
  • URL Actions
  • User Accounts and Roles
  • IfTypes
  • Device Profiles

 

Use the following URL to show a view, from Configuration workspace, with specified window parameters: http://<serverName>:<portNumber>/nnm/launch?cmd=showView&view=<x>&menus=<true/false>&newWindow=<true/false>&envattrs=<name1=value>;<name2=value>.

 

LEAVE A REPLY

Please enter your comment!
Please enter your name here