Netopia CLI 874 manual Command Line Interface Commands Reference

2-14 Command Line Interface Commands Reference

heartbeat enable { yes no } show heartbeat enable

These commands allow you to enable, disable, or show the status of the system heartbeat.

Once a unit is configured and restarted, the WAN link is up and the WAN IP address is established, the heartbeat will begin executing and sending its payloads (or establishing its connection in the case of TCP). A special case is when the ip-server address is on the LAN. In this case, the payloads will be routed to the LAN side address, but only after the WAN link and WAN IP addresses have been established.

If, at any time during the heartbeat sequence, the link state changes – which means, for example, that there is a layer 1 disconnect or a change in the IP layer parameters from a DHCP acquisition or a renegotiated PPP session – the sequence will restart. You can also restart the sequence manually. In addition, in TCP mode once the connection has been established, the sequence will be restarted any time the remote server closes it.

heartbeat protocol { udp tcp } show heartbeat protocol

These commands allow you to specify or show the protocol to be used for the system heartbeat, udp or tcp.

The heartbeat is a state machine:

■If you select udp, there are no connections to the server. If the server address is known, it simply sends the payloads in UDP.

■If you select tcp, it tries to connect to the server address, and keeps trying to connect for 20 attempts at thirty-second intervals. If a connection is not established, it sleeps for a minimum of either 30 minutes, or whatever is programmed as the sleep-time. See below.

heartbeat client-port port show heartbeat client-port

These commands allow you to specify or show the client port to be used for the system heartbeat.

heartbeat interval time (in seconds) show heartbeat interval

These commands allow you to specify or show the heartbeat interval. in seconds.

heartbeat count count show heartbeat count

These commands allow you to specify or show the heartbeat count within the specified interval.

heartbeat sleep-time time (in seconds) show heartbeat sleep-time

These commands allow you to specify or show the heartbeat sleep time, in seconds, during which the system will wait before retrying a failed connection attempt, if tcp is the specified protocol.

heartbeat server port port show heartbeat server port

These commands allow you to specify or show the heartbeat server port number.