nhb-profile
Required Command-Line Mode = Admin
Use the nhb-profile command to configure a negative heartbeat profile, which is a group of attributes that you can apply to an inline tool to configure the negative heartbeat operation of the inline tool.
This command is only applied to GigaVUE HC Seriesnodes. In a cluster environment, this command is only applied to GigaVUE HC Series nodes through the cluster leader.
The content of a negative heartbeat is configurable using the same PCAP file mechanism as for a custom heartbeat packet in a heartbeat profile. Refer to hb-profile.
Also refer to inline-tool for information on enabling negative heartbeat and associating a negative heartbeat profile with an inline tool.
The maximum number of negative heartbeat profiles supported is equal to the maximum number of inline tools, which is 48 on the GigaVUE‑HC3, and 8 on the GigaVUE‑HC1.
This command is used in the inline bypass solutions described in Configure Inline Bypass Solutions and in the flexible inline arrangements described in Configure Flexible Inline Arrangements.
The nhb-profile command has the following syntax:
nhb-profile alias <alias>
custom-packet <URL of PCAP file | none>
direction <a-to-b | b-to-a | bi-directional>
period <period>
recovery-time <recovery time>
The following table describes the arguments for the nhb-profile command.
|
Argument |
Description |
|||||||||
|
alias <alias> |
Specifies the name of the negative heartbeat profile. Use the alias to configure a negative heartbeat profile to associate with an inline tool. The alias must be unique and can contain up to 128 characters. Aliases are case-sensitive. Some of the parameters for nhb-profile have default values, so you can configure a negative heartbeat profile by providing an alias for it, as well as a PCAP file. For example: (config) # nhb-profile alias nhb_1 (config nhb-profile alias nhb_1) # custom-packet http://remote/home/nhb.pcap (config nhb-profile alias nhb_1) # exit (config) # |
|||||||||
|
custom-packet <URL of PCAP file | none> |
Specifies the URL of the custom heartbeat packet, downloaded from a PCAP file, or none. The default is none. Note: Unlike hb-profile, there is no standard ICMP ARP packet, so a custom packet must always be specified through a PCAP file. The size of a custom heartbeat packet must be less than 128 bytes. If the PCAP file contains several packets, the first packet present in the file is taken as the negative heartbeat packet. For example: (config nhb-profile alias nhb_1) # custom-packet http://remote/home/nhb.pcap The PCAP file must be valid before the negative heartbeat profile can be associated with an inline tool. If you are specifying a negative heartbeat packet as well as a custom heartbeat packet, do not use the same PCAP file for both. The supported formats for download are HTTP, HTTPS, FTP, TFTP, SCP, and SFTP. Use the show nhb-profile command to display the name of the PCAP file from which the custom heartbeat packet was imported. |
|||||||||
|
direction <a-to-b | b-to-a | bi-directional> |
Specifies the direction of the negative heartbeat packet as follows:
The default is bi-directional. For example: (config nhb-profile alias nhb_1) # direction a-to-b |
|||||||||
|
period <period> |
Specifies the period of the negative heartbeat packet. This is the number of milliseconds between sending subsequent negative heartbeat packets. The range is from 30 to 5000 milliseconds. The default is 1000 milliseconds. For example: (config nhb-profile alias nhb_1) # period 600 |
|||||||||
|
recovery-time <recovery time> |
Specifies the recovery time of the negative heartbeat packet. This is the minimum number of seconds, since the last negative heartbeat packet was received, to declare that the inline tool is up. The range is from 5 to 60 seconds. The default is 30 seconds. The recovery time starts when the negative heartbeat is first enabled on the inline tool and then every time a negative heartbeat is received. For example: (config nhb-profile alias nhb_1) # recovery-time 60 |
Related Commands
The following table summarizes other commands related to the nhb-profile command:
|
Task |
Command |
|
Displays all negative heartbeat profiles. |
# show nhb-profile |
|
Displays a specified negative heartbeat profile. |
# show nhb-profile alias nhb_1 |
|
Displays all negative heartbeat profiles. |
# show nhb-profile all |
|
Deletes a specified negative heartbeat profile. |
(config) # no nhb-profile alias nhb_1 |
|
Deletes a custom packet associated with the negative heartbeat profile. |
(config) # no nhb-profile alias nhb_1 custom-packet |
|
Deletes all negative heartbeat profiles. |
(config) # no nhb-profile all |
