hb-profile
Required Command-Line Mode = Admin
Use the hb-profile command to configure a heartbeat profile, which is a group of attributes that you can apply to an inline tool to configure the heartbeat operation of the inline tool.
For a negative heartbeat profile, refer tonhb-profile.
Also refer toinline-tool for information on enabling heartbeat and associating a heartbeat profile with an inline tool.
This command is only applied to GigaVUE HC Series nodes. In a cluster environment, this command is only applied to GigaVUE HC Series nodes through the cluster leader.
If the inline tool through which the heartbeat packets are passed is expecting IPv6 traffic exclusively, you must select a custom heartbeat packet.
The maximum number of heartbeat profiles supported is equal to the maximum number of inline tools, which is 48 on the GigaVUE‑HC3 and GigaVUE‑HC2, 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 inConfigure Flexible Inline Arrangements.
The hb-profile command has the following syntax:
hb-profile <alias <alias> | default>
custom-packet <URL of PCAP file | none>
direction <a-to-b | b-to-a | bi-directional>
packet-format <arp | custom>
period <period>
recovery-time <recovery time>
retry-count <retry count>
timeout <timeout>
The following table describes the arguments for the hb-profile command.
|
Argument |
Description |
|||||||||
|
<alias <alias> | default> |
Specifies the name of the heartbeat profile. Use the alias to configure a heartbeat profile to associate with an inline tool. The alias must be unique and can contain up to 128 characters. Aliases are case-sensitive. The default alias is default. You can configure a default heartbeat profile, using the keyword default, for example: (config) # hb-profile alias default (config hb-profile alias default) # All the parameters for hb-profile have default values, so you can also configure a default heartbeat profile by providing an alias for it. For example: (config) # hb-profile alias hb_5 (config hb-profile alias hb_5) # |
|||||||||
|
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, which means a standard ICMP ARP packet will be used as a heartbeat packet. Custom heartbeat packets are needed in situations in which inline tools do not reliably pass standard ARP packets. For example, if an inline tool is configured to pass only IPv6 traffic, an ICMPv6 ARP packet might be appropriate. 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 heartbeat packet. For example: (config hb-profile alias hb_5) # custom-packet http://1.1.1.1/tftp/temp/ARPPackets.pcap The supported formats for download are HTTP, HTTPS, FTP, TFTP, SCP, and SFTP. Use the show hb-profile command to display the name of the PCAP file from which the custom heartbeat packet was imported. The PCAP file must be valid before the heartbeat profile can be associated with an inline tool. If you are specifying a custom heartbeat packet as well as a negative heartbeat packet, do not use the same PCAP file for both. Refer to the hb-ip-addr-a and hb-ip-addr-b parameters under inline-tool. |
|||||||||
|
direction <a-to-b | b-to-a | bi-directional> |
Specifies the direction of the heartbeat packet as follows:
The default is bi-directional. For example: (config hb-profile alias hb_5) # direction a-to-b |
|||||||||
|
packet-format <arp | custom> |
Specifies the format of the heartbeat packet as follows:
The default is arp. For example: (config hb-profile alias hb_5) # packet-format custom |
|||||||||
|
period <period> |
Specifies the period of the heartbeat packet. This is the number of milliseconds between sending subsequent heartbeat packets. The range is from 30 to 5000 milliseconds. The default is 1000 milliseconds. For example: (config hb-profile alias hb_5) # period 500 |
|||||||||
|
recovery-time <recovery time> |
Specifies the recovery time of the heartbeat packet. This is the minimum number of seconds of successfully received packets to declare that the inline tool is up. The range is from 5 to 60 seconds. The default is 30 seconds. For example: (config hb-profile alias hb_5) # recovery-time 50 |
|||||||||
|
retry-count <retry count> |
Specifies the retry count of the heartbeat packet. This is the number of consecutive timed-out heartbeat packets at which the system will trigger a failover condition. The range is from 0 to 5. The default is 3. For example: (config hb-profile alias hb_5) # retry-count 2 |
|||||||||
|
timeout <timeout> |
Specifies the timeout of sending the heartbeat packet. This is the number of milliseconds allowed for a heartbeat packet between sending and receiving. The range is from 20 to 1000 milliseconds. The default is 500 milliseconds. For example: (config hb-profile alias hb_5) # timeout 1000 |
Related Commands
The following table summarizes other commands related to the hb-profile command:
|
Task |
Command |
|
Displays all heartbeat profiles. |
# show hb-profile |
|
Displays a specified heartbeat profile. |
# show hb-profile alias hb_5 |
|
Displays the default heartbeat profile. |
# show hb-profile alias default |
|
Displays all heartbeat profiles. |
# show hb-profile all |
|
Deletes a specified heartbeat profile. |
(config) # no hb-profile alias hb_5 |
|
Deletes a custom packet associated with a specified heartbeat profile. |
(config) # no hb-profile alias hb_5 custom-packet |
|
Deletes the default heartbeat profile. |
(config) # no hb-profile alias default |
|
Deletes a custom packet associated with the default heartbeat profile. |
(config) # no hb-profile alias default custom-packet |
|
Deletes all heartbeat profiles. |
(config) # no hb-profile all |
