sti-heartbeat-config

You use the sti-heartbeat-config configuration element to define the operational parameters for the heartbeat that monitors STIR/SHAKEN servers' availability.

Parameters

sti-heartbeat-state
Enables/disables the heartbeat functionality for all STIR/SHAKEN servers at the system level. Values include:
  • Disabled (default)
  • Enabled
sti-heartbeat-msg-interval-time
Specifies, in seconds, the time-interval to send the heartbeat message to STIR/SHAKEN servers. Values include:
  • 5 seconds (default)
  • Range 1 - 3600 seconds

Note:

The value of this parameter should be more than the timeout value of each sti-server.
sti-orig-tn-number
Specifies the calling party TN number when sending heartbeat messages to STIR/SHAKEN servers, using a string value.
  • Default: 9999999999
  • Range is any 10 digits
sti-dest-tn-number
Specifies the called party TN number when sending heartbeat messages to STIR/SHAKEN servers, using a string value.
  • Default: 7777777777
  • Range is any 10 digits
sti-div-tn-number
Specifies the called party diverted TN number when sending heartbeat messages to STIR/SHAKEN servers, using a string value.
  • Default: 3333333333
  • Range is any 10 digits
sti-identity
The dummy identity header to use for verification service requests. The value is a string, and there is no default value. This value is not validated; you are responsible for entering a valid header.
sti-json-mandate
Enables or disables requiring JSON in the response body for the server to be considered available. Values are enabled or disabled, and the default is disabled.
mode
Whether to run the heartbeat check as soon as the server starts up, or only according to the circuit breaker state. Valid values are Default and HbAtStartup.
sti-in-service-response-code
The list of response codes for which the server is considered available. If this is set, and the response code is not in this list, the server will not be added to the rotation. The value is a comma-separated list of integers. There is no default.

Path

sti-heartbeat-config is an element of the session-router path. The full path from the topmost ACLI prompt is: configure terminal , and then session-router , and then sti-heartbeat-config.

Note:

This is a multiple instance configuration element.