Entering a pre-defined URL, a user or an external application can launch the Network Configuration Manager application, and then go directly to a specific location within the application to view device details or job status.
The system has the ability to launch the application in context, via a URL. The user is taken directly to information on specific jobs or devices based on the parameters of the URL. This is especially useful in integrations.
One scenario is where an external system receives an event or SNMP trap about a network device. Users in the external system can click a URL that then launches into the Network Configuration Manager system; directly to the device for detailed information.
Another scenario is where job warnings or failures are issued. A URL can launch the user directly to the offending job for a detailed description of the problem. The URL is constructed as follows:
http://<server-ip>:8881/contextual-launch/launch?<param_name=value>
or,
https://<server-ip>:8880/contextual-launch/launch?<param_name=value>
where server-ip is the IP Address of the machine where the server is installed. Refer to the "List of allowed query strings" sections for the allowed param_names.
For example, a URL to launch to job number 10005 would be as follows:
http://<server-ip>:8881/contextual-launch/launch?jobId=10005
Various parameters are available as query strings. Where multiple entities could be returned from the query, the user can select the entity they are most in interested in.
The URL query can also further restrict the scope of the launch by including a network parameter. This parameter must be used in conjunction with one of the above parameters. For example, to launch to any device that contains an IP address of 192.168.1.1 in a network called MyNetwork, the URL would be as follows:
http://<server-ip>:8881/contextual-launch/launch?networkId=MyNetwork&anyDeviceIP=192.168.1.1
The contextual launch capability was specifically designed to give the integration developer flexibility. It is intended to allow tighter integrations between disparate systems with less effort.
List of Allowed Query Strings
| Param Name |
Type |
Search Target |
| jobId |
int |
Specific job number |
| deviceAlias |
string |
Device with indicated alias |
| deviceIP |
ip address (management) |
Management ip |
| anyDeviceIP |
ip address (management/interfaces) |
Device with management ip as specific |
| deviceHostname |
string |
Host name of device |
| deviceFQDN |
string |
Any device where the FQDN, alias, derived name, or hostname match the parameter |
| deviceName |
string |
Device whose name has been derived by a method specified by the system administrator |
| anyDeviceName |
string |
All known names for the device |
| derivedName |
string |
Device whose name has been derived by a method specified by the system administrator |
| anyDeviceNameOrIP |
{string, ip address} |
A combination of the previous two – the system will check any name or ip address on the device |
| value |
{int, ip address, string} |
The system determines whether the value is a job number, device name, or ip address, and then launches to the appropriate entity |
