Skip to main content
Version: v26.0

DxEnterprise Global Settings

AGS​

AgsDbHealthCheck​

  • ID: ags.dbhealthcheck
  • Type: bool
  • Default: false

Description

Enable or disable database-level health checking for Availability Groups.

Examples

dxcli set-globalsetting "ags.dbhealthcheck" "false"

AgsQuorum​

  • ID: ags.quorum
  • Type: bool
  • Default: true

Description

Enable or disable automatic quorum for Availability Groups.

Examples

dxcli set-globalsetting "ags.quorum" "true"

AgsWriteLease​

  • ID: ags.writelease
  • Type: bool
  • Default: false

Description

Enable or disable write lease feature when creating Availability Groups.

Examples

dxcli set-globalsetting "ags.writelease" "false"

DemoteDelay​

  • ID: ags.demotedelay
  • Type: int
  • Default: 3

Description

The duration the system waits after issuing a demotion for Availability Groups, in seconds, to allow all replicas to sync.

Examples

dxcli set-globalsetting "ags.demotedelay" "3"

DemoteOffline​

  • ID: ags.demoteoffline
  • Type: bool
  • Default: true

Description

Whether to set the primary replica offline on demotion for Availability Groups.

Examples

dxcli set-globalsetting "ags.demoteoffline" "true"

UseAgsMonitor2​

  • ID: use.agsmonitor2
  • Type: bool
  • Default: false

Description

Use sp_server_diagnostics health monitoring for Availability Groups. Note: run 'dxcli reload-monitored-ags <target_node>' to commit.

Examples

dxcli set-globalsetting "use.agsmonitor2" "false"

Allocation Settings​

AllocatorAlerts​

  • ID: allocator.alerts
  • Type: bool
  • Default: true

Description

Enable or Disable allocation alerts.

Examples

dxcli set-globalsetting "allocator.alerts" "true"

AllocatorEnabled​

  • ID: allocator.enabled
  • Type: bool
  • Default: true

Description

Enable or Disable allocation.

Examples

dxcli set-globalsetting "allocator.enabled" "true"

Broadcast Settings​

PerfBroadcastEnabled​

  • ID: perf_broadcast.enabled
  • Type: bool
  • Default: false

Description

Enable or Disable performance statistics broadcast. True via UDP. False via TCP.

Examples

dxcli set-globalsetting "perf_broadcast.enabled" "false"

RelayBroadcast​

  • ID: relaybroadcast.enabled
  • Type: bool
  • Default: true

Description

Enable or Disable broadcast relay.

Examples

dxcli set-globalsetting "relaybroadcast.enabled" "true"

General​

AdminSessionMaxAge​

  • ID: admin.session.maxage
  • Type: int
  • Default: 900

Description

Maximum age of administration session cookie, in seconds.

Examples

dxcli set-globalsetting "admin.session.maxage" "900"

GroupDescription​

  • ID: cluster.description
  • Type: string
  • Default: (none)

Description

The server group description.

Examples

dxcli set-globalsetting "cluster.description" <value>

GroupMaintenanceMode​

  • ID: cluster.maintenance_mode
  • Type: bool
  • Default: false

Description

Administratively disable automatic failovers for the entire group.

Examples

dxcli set-globalsetting "cluster.maintenance_mode" "false"

TelemetryDisable​

  • ID: telemetry.disable
  • Type: bool
  • Default: false

Description

Disable reporting of anonymized usage statistics

Examples

dxcli set-globalsetting "telemetry.disable" "false"

Licensing​

AutoReactivateEnabled​

  • ID: activation.enabled
  • Type: bool
  • Default: false

Description

Enable or disable automatic re-activation.

Examples

dxcli set-globalsetting "activation.enabled" "false"

Networking​

Beacons​

  • ID: beacons.enabled
  • Type: bool
  • Default: true

Description

Enable or Disable LAN beacons for finding peers.

Examples

dxcli set-globalsetting "beacons.enabled" "true"

ClientHeartBeat​

  • ID: client.heartbeat
  • Type: int
  • Default: 20

Description

The remote client heartbeat interval. How often the server checks the remote client connection for alive status, in seconds.

Examples

dxcli set-globalsetting "client.heartbeat" "20"

MemberNameAlerts​

  • ID: membername.alerts
  • Type: bool
  • Default: true

Description

Whether to raise alerts for hostname lookup failures for peer names.

Examples

dxcli set-globalsetting "membername.alerts" "true"

MemberNameLookup​

  • ID: membername.lookup
  • Type: bool
  • Default: false

Description

Whether to perform hostname lookup on peer names to find addresses.

Examples

dxcli set-globalsetting "membername.lookup" "false"

MemberNameSuffix​

  • ID: membername.suffix
  • Type: string
  • Default: (none)

Description

List of suffixes to append when performing hostname lookup on members, delimited by commas (",").

Examples

dxcli set-globalsetting "membername.suffix" <value>

NATAgentHeartbeat​

  • ID: natagent.heartbeat
  • Type: int
  • Default: 60

Description

How often members check in with MatchMaking agents, in seconds.

Examples

dxcli set-globalsetting "natagent.heartbeat" "60"

NATDNSRefresh​

  • ID: nat.dnsrefresh
  • Type: int
  • Default: 1800

Description

DNS refresh interval for MatchMaking agent, in seconds.

Examples

dxcli set-globalsetting "nat.dnsrefresh" "1800"

NATEnabled​

  • ID: nat.enabled
  • Type: bool
  • Default: false

Description

Enable or Disable registration with MatchMaking agent.

Examples

dxcli set-globalsetting "nat.enabled" "false"

NATKeepAlive​

  • ID: nat.keepalive
  • Type: int
  • Default: 30

Description

Heartbeat interval for non-coordinator peers connected over NAT routes, in seconds.

Examples

dxcli set-globalsetting "nat.keepalive" "30"

NATMatchAgent​

  • ID: nat.agent
  • Type: string
  • Default: match.dh2i.com

Description

The comma delimited list of MatchMaking agents used to resolve cluster member servers across clouds.

Examples

dxcli set-globalsetting "nat.agent" "match.dh2i.com"

TunnelBufSize​

  • ID: tunnel.bufsize
  • Type: int
  • Default: 1048576

Description

The maximum buffer size for tunnels in bytes.

Examples

dxcli set-globalsetting "tunnel.bufsize" "1048576"

TunnelConnectTimeout​

  • ID: tunnel.connecttimeout
  • Type: int
  • Default: 5

Description

Tunnel destination connection timeout, in seconds.

Examples

dxcli set-globalsetting "tunnel.connecttimeout" "5"

TunnelMaxPending​

  • ID: tunnel.maxpending
  • Type: int
  • Default: 5

Description

The maximum number of tunnels waiting to connect.

Examples

dxcli set-globalsetting "tunnel.maxpending" "5"

UDPBufSize​

  • ID: udp.bufsize
  • Type: int
  • Default: 1048576

Description

UDP socket buffer size, in bytes.

Examples

dxcli set-globalsetting "udp.bufsize" "1048576"

Quorum​

QuorumSize​

  • ID: quorum.size
  • Type: string
  • Default: 0

Description

The required quorum size for the overall cluster to be active. Value can be either number of alive members, a percent of the alive members, or the maximum down members. When the threshold is not met, all vhosts and applications are shut down cluster-wide. Note that this functions separately from AGS quorum. Default is zero (0). E.g. (1) = at least one alive member required (-2) = up to two down members are allowed (75%) = at least 75% of alive members required

Examples

dxcli set-globalsetting "quorum.size" "0"

Sampling Intervals​

IntervalDisk​

  • ID: interval.disk
  • Type: int
  • Default: 120

Description

The duration the disk I/O is sampled to calculate average use, in seconds.

Examples

dxcli set-globalsetting "interval.disk" "120"

IntervalEventFilter​

  • ID: interval.eventfilter
  • Type: int
  • Default: 15

Description

The duration to collect additional matching events for global alert policies before sending an email message, in seconds.

Examples

dxcli set-globalsetting "interval.eventfilter" "15"

IntervalMemory​

  • ID: interval.memory
  • Type: int
  • Default: 1

Description

The duration the system memory is sampled to calculate average use, in seconds.

Examples

dxcli set-globalsetting "interval.memory" "1"

IntervalNetwork​

  • ID: interval.network
  • Type: int
  • Default: 120

Description

The duration the network is sampled to calculate average use, in seconds.

Examples

dxcli set-globalsetting "interval.network" "120"

IntervalProcessor​

  • ID: interval.processor
  • Type: int
  • Default: 120

Description

The duration the processor is sampled to calculate average use, in seconds.

Examples

dxcli set-globalsetting "interval.processor" "120"

IntervalReservationCheck​

  • ID: interval.reservationcheck
  • Type: int
  • Default: 5

Description

The timeout period for a SCSI-3 persistent reservation check to complete, in seconds.

Examples

dxcli set-globalsetting "interval.reservationcheck" "5"

SQL​

SqlAgentAlertsEnabled​

  • ID: sql.agentalert.enabled
  • Type: bool
  • Default: true

Description

Enable availability alerts for SQL Agent.

Examples

dxcli set-globalsetting "sql.agentalert.enabled" "true"

SqlConnectionRedundancy​

  • ID: sql.connectionredundancy
  • Type: int
  • Default: 1

Description

Number of redundant connections to retain for SQL Server health monitoring.

Examples

dxcli set-globalsetting "sql.connectionredundancy" "1"

SqlDomainName​

  • ID: sql.domainname
  • Type: string
  • Default: (none)

Description

Domain suffix to use when connecting to SQL Server with Kerberos authentication

Examples

dxcli set-globalsetting "sql.domainname" <value>

Storage Management​

DiskWatcher​

  • ID: diskwatcher.enable
  • Type: bool
  • Default: true

Description

Enable or Disable failover based on availability of Vhost diskgroups.

Examples

dxcli set-globalsetting "diskwatcher.enable" "true"

PathWatcher​

  • ID: pathwatcher.enable
  • Type: bool
  • Default: true

Description

Enable or Disable Pathwatcher.

Examples

dxcli set-globalsetting "pathwatcher.enable" "true"

System Settings​

MaxProcesses​

  • ID: limit.processes
  • Type: int
  • Default: 10

Description

The number of processes the system allows to be worked on in parallel.

Examples

dxcli set-globalsetting "limit.processes" "10"

Timeouts​

AgsTimeout​

  • ID: timeout.ags
  • Type: int
  • Default: 30

Description

The duration the system will wait for an availability group replica to change role to primary, in seconds.

Examples

dxcli set-globalsetting "timeout.ags" "30"

AgsTimeoutDemote​

  • ID: timeout.ags.demote
  • Type: int
  • Default: 300

Description

The duration the system will wait for an availability group replica to change role to secondary, in seconds.

Examples

dxcli set-globalsetting "timeout.ags.demote" "300"

CreateProcessTimeout​

  • ID: timeout.createprocess
  • Type: int
  • Default: 30

Description

The timeout period for creating a new worker process, in seconds.

Examples

dxcli set-globalsetting "timeout.createprocess" "30"

DelayStartNode​

  • ID: delay.startnode
  • Type: int
  • Default: 4

Description

The activation delay of an IP address after the address is added, in seconds.

Examples

dxcli set-globalsetting "delay.startnode" "4"

DelayStopNode​

  • ID: delay.stopnode
  • Type: int
  • Default: 2

Description

The deactivation delay of an IP address after the address is removed (prevents false-positive duplicate addresses), in seconds.

Examples

dxcli set-globalsetting "delay.stopnode" "2"

DismountTimeout​

  • ID: timeout.dismount
  • Type: int
  • Default: 15

Description

The timeout period for volume file handles to close before performing a forced dismount, in seconds.

Examples

dxcli set-globalsetting "timeout.dismount" "15"

DockerTimeout​

  • ID: timeout.docker
  • Type: int
  • Default: 5

Description

The timeout period for a Docker container to return a running state after the container is added to a Vhost, in seconds.

Examples

dxcli set-globalsetting "timeout.docker" "5"

FileSystemTimeout​

  • ID: timeout.filesystem
  • Type: int
  • Default: 120

Description

The timeout period for a system path to appear before taking action, in seconds.

Examples

dxcli set-globalsetting "timeout.filesystem" "120"

IoTimeout​

  • ID: timeout.io
  • Type: int
  • Default: 15

Description

The timeout period for an I/O API call to complete, in seconds.

Examples

dxcli set-globalsetting "timeout.io" "15"

PathRecheckTimeout​

  • ID: timeout.pathrecheck
  • Type: int
  • Default: 120

Description

The duration the system 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.

Examples

dxcli set-globalsetting "timeout.pathrecheck" "120"

PingTimeout​

  • ID: timeout.ping
  • Type: int
  • Default: 9

Description

The timeout period for a successful ping before taking actions, in seconds.

Examples

dxcli set-globalsetting "timeout.ping" "9"

ScriptTimeout​

  • ID: timeout.script
  • Type: int
  • Default: 300

Description

The timeout period for a pre/post script to complete before taking actions, in seconds.

Examples

dxcli set-globalsetting "timeout.script" "300"

SqlServerConnectTimeout​

  • ID: timeout.sql
  • Type: int
  • Default: 45

Description

The timeout period for connecting to SQL Server, in seconds. Must be greater than 0.

Examples

dxcli set-globalsetting "timeout.sql" "45"

SqlServerShutdownTimeout​

  • ID: timeout.sql.shutdown
  • Type: int
  • Default: 300

Description

The timeout period for SQL Server to cleanly shut down, in seconds. 0 = timeout disabled.

Examples

dxcli set-globalsetting "timeout.sql.shutdown" "300"

SqlServerStartupTimeout​

  • ID: timeout.sql.startup
  • Type: int
  • Default: 300

Description

The timeout period for SQL Server to start, in seconds. 0 = timeout disabled.

Examples

dxcli set-globalsetting "timeout.sql.startup" "300"

VdsWait​

  • ID: timeout.vdsassoc
  • Type: int
  • Default: 15

Description

The duration the system will wait for the virtual disk service (VDS) to notice a PnP-enumerated disk and report it, in seconds.

Examples

dxcli set-globalsetting "timeout.vdsassoc" "15"

VhostRetryTimeout​

  • ID: timeout.vhost_retry
  • Type: int
  • Default: 120

Description

The duration the system will wait after a Vhost start failure before attempting another, in seconds.

Examples

dxcli set-globalsetting "timeout.vhost_retry" "120"

VolumeTimeout​

  • ID: timeout.volume
  • Type: int
  • Default: 15

Description

The timeout period for a volume PnP device to appear before the disk is set to the online state, in seconds.

Examples

dxcli set-globalsetting "timeout.volume" "15"