DxCLI Global Settings for DxOdyssey

Applies to…

  • DxOdyssey 19.5 through 21.0.132.0. (For newer versions, use the command “dxcli list-globalsettings” or “dxcli list-globalsettings-xml” for a list of global settings.)

Summary

This KB contains the list of global settings applicable to DxOdyssey using DxCLI. For more information on the set-globalsetting command, please see the DxOdyssey DxCLI Guide.

Table of Contents

client.heartbeat 

cluster.description 

cluster.maintenance_mode 

nat.agent 

nat.enabled 

nat.keepalive 

quorum.size 

timeout.ping

Information

client.heartbeat

  • Description: How often DxOdyssey will check the status of its remote client connections, in seconds. Default is 60.
  • Syntax: 
dxcli set-globalsetting client.heartbeat 30

 

cluster.description

  • Description: The description for the DxOdyssey gateway group. Default is null.
  • Syntax: 
dxcli set-globalsetting cluster.description "Group description."

 

cluster.maintenance_mode

  • Description: Disables or enables automatic failovers group-wide. Default is false.
  • Syntax:
 dxcli set-globalsetting cluster.maintenance_mode true

 

nat.agent

  • Description: A comma-delimited list of match-making agents used to resolve gateway group members and clients. Default is “match.dh2i.com”.
  • Syntax: 
dxcli set-globalsetting nat.agent "172.217.3.174,216.58.193.78"

 

nat.enabled

  • Description: Disables or enables the use of the NAT match-making service. Default is false.
  • Syntax: 
dxcli set-globalsetting nat.enabled true

 

nat.keepalive

  • Description: How often nodes in the gateway group attempt to check-in with the NAT match-making service, in seconds. Default is 30.
  • Syntax: 
dxcli set-globalsetting nat.keepalive 45

 

quorum.size

  • Description: The required amount of gateway group members to have a quorum. Values can be expressed as a minimum number of nodes, a percentage of total alive nodes, or a maxiumum negative number of down nodes. Default is 0 (zero).
  • Syntax: 
dxcli set-globalsetting quorum.size 75%

 

timeout.ping

  • Description: The timeout period for DxOdyssey services, in seconds. After reaching this timeout period, DxOdyssey will take action to remedy connectivity issues. Default is 9.
  • Syntax: 
dxcli set-globalsetting timeout.ping 30