DxCLI Global Settings for DxEnterprise
Applies to:
- DxEnterprise 19.5 through 21.0.132.0. (For newer versions, use the command
dxcli list-globalsettings
ordxcli list-globalsettings-xml
for a list of global settings)
Summary
This KB contains the list of global settings applicable to DxEnterprise using DxCLI. For more information on the set-globalsetting
command, please see the DxEnterprise DxCli Admin Guide.
Information
allocator.alerts
-
Description: Enables or disables allocator alerts. Default is true.
-
Example:
dxcli set-globalsetting allocator.alerts false
allocator.enabled
-
Description: Enables or disables allocation. Default is true.
-
Example:
dxcli set-globalsetting allocator.enabled false
client.heartbeat
-
Description: How often DxEnterprise will check the status of its remote client connections, in seconds. Default is 60.
-
Example:
dxcli set-globalsetting client.heartbeat 30
cluster.description
-
Description: The description for the DxEnterprise cluster. Default is null.
-
Example:
dxcli set-globalsetting cluster.description "Cluster description."
cluster.maintenance_mode
-
Description: Disables or enables automatic failovers cluster-wide. Default is false.
-
Example:
dxcli set-globalsetting cluster.maintenance_mode true
delay.startnode
-
Description: The activation delay of an IP address after the address is added, in seconds. Default is 4.
-
Example:
dxcli set-globalsetting delay.startnode 6
delay.stopnode
-
Description: The deactivation delay of an IP address after a node is stopped. Default is 2.
-
Example:
dxcli set-globalsetting delay.stopnode 3
interval.disk
-
Description: Sets the duration over which disk I/O is sampled to calculate average use, in seconds. Default is 120.
-
Example:
dxcli set-globalsetting interval.disk 180
interval.memory
-
Description: Sets the duration over which memory usage is sampled to calculate average use, in seconds. Default is 1.
-
Example:
dxcli set-globalsetting interval.memory 5
interval.network
-
Description: Sets the duration over which network usage is sampled to calculate average use, in seconds. Default is 120.
-
Example:
dxcli set-globalsetting interval.network 60
interval.processor
-
Description: Sets the duration over which the processor is sampled to calculate average use, in seconds. Default is 120.
-
Example:
dxcli set-globalsetting interval.processor 60
interval.reservationcheck
-
Description: Sets the interval the system uses to check disk reservations, in seconds. Default is 5.
-
Example:
dxcli set-globalsetting interval.reservationcheck 10
garp.enable
-
Description: Enables or disables Gratuitous ARP. Default is false.
-
Example:
dxcli set-globalsetting garp.enable true
limit.processes
-
Description: Sets the numbero of processes the system allows to work in parallel. Default is 10.
-
Example:
dxcli set-globalsetting limit.processes 20
nat.agent
-
Description: A comma-delimited list of match-making agents used to resolve cluster members and clients. Default is "match.dh2i.com".
-
Example:
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.
-
Example:
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.
-
Example:
dxcli set-globalsetting nat.keepalive 45
pathwatcher.enabled
-
Description: Enables or disables Pathwatcher. Default is true.
-
Example:
dxcli set-globalsetting pathwatcher.enabled false
perf_broadcast.enabled
-
Description: Enables or disables broadcasting of performance statistics. Default is false.
-
Example:
dxcli set-globalsetting perf_broadcast.enabled true
quorum.size
-
Description: The required amount of cluster 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).
-
Example:
dxcli set-globalsetting quorum.size 75%
relaybroadcast.enabled
-
Description: Enables or disables broadcasting relay. Default is true.
-
Example:
dxcli set-globalsetting relaybroadcast.enabled false
timeout.dismount
-
Description: The timeout period for volume file handles to close before performing a forced dismount, in seconds. Default is 15.
-
Example:
dxcli set-globalsetting timeout.dismount 20
timeout.docker
-
Description: The timeout period for a Docker container to return a running state after the container is added to a Vhost, in seconds. Default is 5.
-
Example:
dxcli set-globalsetting timeout.docker 3
timeout.filesystem
-
Description: The timeout period for a system path to appear to DxSQL before taking actions, in seconds. Default is 120.
-
Example:
dxcli set-globalsetting timeout.filesystem 180
timeout.io
-
Description: The timeout period for an I/O API call to complete, in seconds. Default is 15.
-
Example:
dxcli set-globalsetting timeout.io 30
timeout.pathrecheck
-
Description: The duration Path Watcher will wait before re-checking application paths, in seconds. This is also the maximum duration the system will take to notice an inaccessible path. Default is 120.
-
Example:
dxcli set-globalsetting timeout.pathrecheck 60
timeout.ping
-
Description: The timeout period for DxEnterprise services, in seconds. After reaching this timeout period, DxEnterprise will take action to remedy connectivity issues. Default is 9.
-
Example:
dxcli set-globalsetting timeout.ping 30
timeout.script
-
Description: The timeout period for a pre/post script to complete before taking actions, in seconds. Default is 300
-
Example:
dxcli set-globalsetting timeout.script 120
timeout.vdsassoc
-
Description: The duration the system will wait for the virtual disk service (VDS) to notice a PnP-enumerated disk and report it, in seconds. Default is 15.
-
Example:
dxcli set-globalsetting timeout.vdsassoc 20
timeout.vhost_retry
-
Description: The duration the system will wait after a Vhost fails to start before attempting another start, in seconds. Default is 120.
-
Example:
dxcli set-globalsetting timeout.vhost_retry 60
timeout.volume
-
Description: The timeout period for a volume PnP device to appear before the disk is set to the online state, in seconds. Default is 15.
-
Example:
dxcli set-globalsetting timeout.volume 30