External link syntax

External links must be specified on the Administration > Integration > External Links page in order to be available on the right-click menu. They must be specified using the syntax that the external device expects.

You can use external links to pass the following types of information to external devices:

You can also use an external link as a shortcut to a NetProfiler report.   more

Host link type

The syntax for sending a host name, host IP address, or host MAC address to an external device is:

http://example.com?hostname={HOSTNAME}?hostip={HOSTIP}?hostmac={MAC}

where:

  • example.com is the resolvable host name or IP address of the external device to be contacted,

  • ?hostname={HOSTNAME}, ?hostip={HOSTIP} and ?hostmac={MAC} are the queries in the syntax that the device expects, and

  • {HOSTNAME} is replaced with the host name,

  • {HOSTIP} is replaced with the IP address, and

  • {MAC} is replaced with the MAC address

of the host that you right-clicked.

It is not necessary to include all three queries in the external link. The following links are also valid:

http://example.com?hostname={HOSTNAME}?hostip={HOSTIP}

http://example.com?hostname={HOSTNAME}

If the link includes all three queries, then the NetProfiler resolves the missing attributes from the one that is right-clicked. For example, if you right-click the host name, then the NetProfiler resolves the IP address and MAC address from the host name.  

If you send information about a host with an IPv6 address, ensure that the external device supports IPv6.

Device link type

The Administration > Devices/Interfaces page Devices tab lists the names and addresses of devices that are sending flow information to the NetProfiler. You can create an external link for devices so that right-clicking a device name or IP address sends a query to the device.

The syntax for sending a device name to an external device is:

http://example.com?devicename={DEVICENAME}?deviceip={DEVICEIP}

where:

  • example.com is the resolvable host name or IP address of the device to be contacted,

  • ?devicename={DEVICENAME} and ?deviceip={DEVICEIP} are the queries in the syntax that the device expects, and

  • {DEVICENAME} is replaced with the device name, and

  • {DEVICEIP} is replaced with the device IP

of the device that you right-clicked. One or both queries can present in an external link. If both are present, then the attribute you right-click is used to resolve the other attribute.

Interface link type

The Administration > Devices/Interfaces page Interfaces tab lists the names and addresses of devices that are sending flow information to the NetProfiler , and also the index and description of each device interface that is sending the flow information. You can create an external link for interfaces so that right-clicking any of these attributes sends a query to the device.

The syntax for sending a device name to an external device is:

http://example.com?devicename={DEVICENAME}?deviceip={DEVICEIP}?ifindex={IFINDEX}?ifdescr={IFDESCR}

where:

  • example.com is the resolvable host name or IP address of the device to be contacted,

  • ?devicename={DEVICENAME}, ?deviceip={DEVICEIP}, ?ifindex={IFINDEX} and ?ifdescr={IFDESCR} are the queries in the syntax that the device expects, and

  • {DEVICENAME} is replaced with the device name,

  • {DEVICEIP} is replaced with device IP address,

  • {IFINDEX} is replaced with ifindex of interface, and

  • {IFDESCR} is replaced with ifdsescr of interface

of the device or interface that you right-clicked.

It is not necessary for all four queries to be present in external link.

MAC address link type

If the NetProfiler is using DHCP integration, then you can also send a query on a MAC address:

http://exmaple.com?mac={MAC}?hostname={HOSTNAME}?hostip={HOSTIP}

where:

  • www.example.com is the resolvable host name or IP address of the device to be contacted,

  • ?mac={MAC}, ?hostname={HOSTNAME}, ?hostip={HOSTIP} are the queries in the syntax that the device expects, and

  • {MAC} is replaced with the MAC address,

  • {HOSTNAME} is replaced with host name resolved  from the MAC address,

  • {HOSTIP} is replaced with the host IP address resolved from MAC address

of the device that you right-clicked.

It is not necessary for all three queries to be present in external link.

Port link type

The syntax for sending a port number to an external device is:

http://example.com?host={PORT}

where:

  • example.com is the resolvable host name or IP address of the device to be contacted,

  • ?host={PORT} is the query in the syntax that the device expects, and

  • {PORT} is replaced with the port number that you right-clicked.

Username link type

The syntax for sending a user name to an external device is:

http://example.com?username={USERNAME}

where:

  • example.com is the resolvable host name or IP address of the device to be contacted,

  • ?username={USERNAME} is the query in the syntax that the device expects, and

  • {USERNAME} is replaced by the user name that you right-clicked.

ASN link type

The syntax for sending a BGP Autonomous System Number to an external device is:

http://example.com/AS/{ASN}

where:

  • example.com is the resolvable host name or IP address of the device to be contacted,

  • /AS/{ASN} is the query in the syntax that the device expects, and

  • {ASN} is replaced by the Autonomous System Number that you right-clicked.

For example, to request information about a BGP Autonomous System from Hurricane Electric Internet Services, you could use:

http://bgp.he.net/AS{ASN}

 

External links

External links as report shortcuts