DH2i DxEnterprise 21.0 Software: DxCLI Guide

Summary

This document contains the list of DxCLI commands used for DxEnterprise administration.

Table of contents

activate-server

add-addressfilter

add-ags

add-ags-databases

add-ags-listener

add-ags-node

add-client

add-client-group

add-contact

add-disk

add-docker

add-instance

add-node

add-policy

add-service

add-service-registry

add-share

add-smtp

add-tunnel

add-witness

attach-ags

clean-disk

clear-otpk

clear-reservation

cluster-add-vhost

cluster-disable-node

cluster-enable-node

cluster-get-docker-images

cluster-get-licenses

cluster-get-sql-instances

cluster-rehost-docker

cluster-rehost-instance

cluster-rehost-service

cluster-remove-vhost

cluster-resync

cluster-set-secret

cluster-set-secret-ex

collect-log

create-volume

deactivate-server

delete-volume

demote-ags-node

detach-ags

encrypt-text

export-config

extend-volume

format-volume

freeze-node

freeze-vhost

generate-otpk

get-addressfilter

get-ags-detail

get-alerts

get-client-connections

get-client-detail

get-cluster-disks

get-cluster-nodes

get-contacts

get-coordinators

get-coordinator-status

get-counters

get-disk-detail

get-diskinfo

get-disks

get-docker-detail

get-dxversion

get-globalsettings

get-instance-detail

get-license

get-license-request

get-monitored-apps

get-monitored-dockers

get-monitored-instances

get-monitored-services

get-monitored-shares

get-node-detail

get-node-detail-xml

get-otpk

get-policies

get-policy

get-producttype

get-reservation

get-service-detail

get-sql-instances

get-sql-paths

get-tunnels

get-unused-driveletters

get-vhost

get-vhosts

get-volume-detail

get-witness

join-cluster

join-cluster-ex

refresh-volmonitor-applications

reload-monitored-apps

reload-monitored-dockers

reload-monitored-instances

reload-monitored-services

reload-monitored-shares

relocate-systemdatabases

remove-ags

remove-ags-databases

remove-ags-listener

remove-client

remove-client-group

remove-cluster-members

remove-contact

remove-disk

remove-docker

remove-globalsetting

remove-instance

remove-node

remove-policy

remove-script

remove-service

remove-service-registry

remove-share

remove-smtp

remove-tunnel

remove-witness

rescan-disk

resync-ags-secondary

 

set-ags-cred

set-ags-node-availability-mode

set-appcoordinator

set-coordinator

set-depends

set-docker-description

set-failback

set-globalsetting

set-instance-description

set-license

set-mountpoint

set-otpk

set-script

set-script-embedded

set-server

set-server-ex

set-service-description

set-sqlcred

set-storcoordinator

set-vhost-ilbports

set-vhost-priority

set-volume-label

set-witness

shrink-volume

start-disk

start-disk-associates

start-docker

start-instance

start-service

start-volume

stop-disk

stop-disk-associates

stop-docker

stop-instance

stop-service

stop-volume

test-connection

test-witness

test-witness-ex

unfreeze-node

unfreeze-vhost

update-addressfilter

update-client

update-client-group

update-contact

update-disk

update-policy

update-share

update-tunnel

update-tunnel-clients

update-vhost

vhost-get-docker-images

vhost-get-services

vhost-get-sql-instances

vhost-set-diskgroup

vhost-set-docker-image

vhost-start-diskgroup

vhost-start-node

vhost-stop-diskgroup

vhost-stop-node

vhost-update-vips

Command Details

activate-server

  • Description: Activates the server via internet using the provided license key. See get-license-request for off-line node activation.
  • Syntax:
dxcli activate-server <key> [node]
  • Parameters:
Name Description Required
key The license key. TRUE
node The name of the node (comma separated list for multiples). FALSE

  • Example:
dxcli activate-server AAAA-BBBB-CCCC-DDDD

 

add-addressfilter

  • Description: Adds an address filter to accept or deny connections from specific IP addresses or subnets.
  • Syntax:
dxcli add-addressfilter <name> <address>,<action[accept|deny]>|<address>,<action[accept|deny]> <default_action[accept|deny]>
  • Parameters:
Name Description Required
name The name of the filter. TRUE
address The IP address or subnet. TRUE
action[accept|deny] Whether or not to accept or deny the IP address or subnet. TRUE
default_action[accept|deny] Whether or not the default action for the filter is to accept-all or deny-all connections outside of the specified IP or subnet. TRUE

  • Example:
dxcli add-addressfilter filter1 "10.1.1.0,accept|10.1.2.0,accept" deny

 

add-ags

  • Description: Adds an availability group to a Vhost.
  • Syntax:
dxcli add-ags <vhost> <ags_name> <param1> <param2> <...>
<param1> : <node_name|instance_name|sql_login|sql_pass|mirror_port|availability_mode|[tunnel_port]>
<param2> : <node_name|instance_name|sql_login|sql_pass|mirror_port|availability_mode|[tunnel_port]>
<...> : <node_name|instance_name|sql_login|sql_pass|mirror_port|availability_mode|[tunnel_port]>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
ags_name The name of the availability group. TRUE
param1 A set of parameters for the primary node in the availability group. TRUE
param2 A set of parameters for the secondary node in the availability group. TRUE
... A set of parameters for each additional node that will be a member of the availability group. FALSE
node_name The name of the node. TRUE
instance_name The name of the instance. TRUE
sql_login The user name used to login to SQL Server. The SQL Server login can be any SQL login or Windows domain accounts that has been assigned the sysadmin role for the instance being managed. When supplying a domain account, the username needs to follow the UPN format (for example: user@domain.com). TRUE
sql_pass The password used to login to SQL Server (encrypted using "dxcli encrypt-text"). TRUE
mirror_port The mirroring port to use for the availability group (default is 5022). TRUE
availability_mode Synchronous_commit, asynchronous_commit or configuration_only. TRUE
tunnel_port The port to be used for tunnel connections (for cross-site, cross-domain replication). FALSE

  • Example:
dxcli add-ags vhost1 ags1 "node1|MSSQLSERVER|SA|6pnFaDrRS+W/F+dkRuPKAA==|5022|SYNCHRONOUS_COMMIT" "node2|MSSQLSERVER|SA|6pnFaDrRS+W/F+dkRuPKAA==|5022|SYNCHRONOUS_COMMIT"

 

add-ags-databases

  • Description: Adds databases to an availability group.
  • Syntax:
dxcli add-ags-databases <vhost> <ags_name> <db_name>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
ags_name The name of the availability group. TRUE
db_name The name of the database (comma separated list for multiples). TRUE

  • Example:
dxcli add-ags-databases vhost1 ags1 db1,db2,db3

 

add-ags-listener

  • Description: Adds a listener to an availability group.
  • Syntax:
dxcli add-ags-listener <vhost> <ags_name> <port>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
ags_name The name of the availability group. TRUE
port The port number for the listener. TRUE

  • Example:
dxcli add-ags-listener vhost1 ags1 55001

 

add-ags-node

  • Description: Adds a node to a Vhost with an availability group.
  • Syntax:
dxcli add-ags-node <vhost> <ags_name> <node_name|instance_name|sql_login|sql_pass|mirror_port|availability_mode|[tunnel_port]>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
ags_name The name of the availability group. TRUE
node_name The name of the node. TRUE
instance_name The name of the instance. TRUE
sql_login The user name used to login to SQL Server. The SQL Server login can be any SQL login or Windows domain accounts that has been assigned the sysadmin role for the instance being managed. When supplying a domain account, the username needs to follow the UPN format (for example: user@domain.com). TRUE
sql_pass The password used to login to SQL Server (encrypted using "dxcli encrypt-text"). TRUE
mirror_port The mirroring port to use for the availability group (default is 5022). TRUE
availability_mode Synchronous_commit, asynchronous_commit or configuration_only. TRUE
tunnel_port The port to be used for tunnel connections (for cross-site, cross-domain replication). FALSE

  • Example:
dxcli add-ags-node vhost1 ags1 "node1|MSSQLSERVER|SA|6pnFaDrRS+W/F+dkRuPKAA==|5022|SYNCHRONOUS_COMMIT"

 

add-client

  • Description: Adds a DxConnect client to the cluster.
  • Syntax:
add-client <client_name> <password> [client_description] [max_session_count] [group_name]
  • Parameters:
Name Description Required
client_name The name of the client. TRUE
password The password for the client. TRUE
client_desciption The description for the client. FALSE
max_session_count The maximum sessions for the client. FALSE
group_name The name of the group to add the client. FALSE

  • Example:
dxcli add-client client1 passw0rd "Accounting admins" 25 group1

 

add-client-group

  • Description: Adds a client group.
  • Syntax:
dxcli add-client-group <group_name> <member_delta_list [+|-]> [group_description]
  • Parameters:
Name Description Required
group_name The name of the group. TRUE
member_delta_list The name of the client(s) (comma separated list for multiples). TRUE
group_description The description for the group. FALSE

  • Example:
dxcli add-client-group group1 client1,client2,-client3

 

add-contact

  • Description: Adds contact to Contact Address Book.
  • Syntax:
dxcli add-contact <name> <email>
  • Parameters:
Name Description Required
name The name of the user. TRUE
email The email address of the user. TRUE

  • Example:
dxcli add-contact user1 user1@mail.com

 

add-disk

  • Description: Adds a disk to DxEnterprise management.
Syntax: dxcl add-disk <disk_id> [label]
  • Parameters:
Name Description Required
disk_id The ID of the disk. TRUE
label The label for the disk. FALSE

  • Example:
dxcli add-disk 50842140-be32-d3a7-45d4-3999bf3ad3a8 "Disk 1"

 

add-docker

  • Description: Add a docker image to a Vhost.
  • Syntax:
dxcli add-docker <vhost> <docker_name> <image_name> <docker_params> [label]
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
docker_name The name of the docker. TRUE
image_name The name of the docker image. TRUE
docker_params Docker run parameters. TRUE
label The label for the docker. FALSE

  • Example:
dxcli add-docker vhost1 centos1 mcr.microsoft.com/mssql/server:2017-latest "-p 10000:1433 -d" "Latest SQL Server 2017"

 

add-instance

  • Description: Adds a SQL instance to a Vhost.
  • Syntax:
add-instance <vhost>\<instance> <port> <sql_data_path> <sql_log_path> [sql_login] [sql_pass] [keep]
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
instance The name of the SQL instance. TRUE
port The port to be used. TRUE
sql_data_path The path for the SQL data. TRUE
sql_log_path The path for the SQL logs. TRUE
sql_login The user name used to login to SQL Server. The SQL Server login can be any SQL login or Windows domain accounts that has been assigned the sysadmin role for the instance being managed. When supplying a domain account, the username needs to follow the UPN format (for example: user@domain.com). FALSE
sql_pass The password used to login to SQL Server (encrypted using "dxcli encrypt-text"). FALSE
keep Specify this parameter to keep the current SQL data. FALSE

  • Example:
dxcli add-instance vhost1\instance1 30002 C:\mount1\data C:\mount1\logs sa p@ssw0rd

 

add-node

  • Description: Adds the specified node to a Vhost
  • Syntax:
dxcli add-node <vhost> <node>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
node The name of the node. TRUE

  • Example:
dxcli add-node vhost1 node1

 

add-policy

  • Description: Add a policy
  • Syntax:
add-policy <SYSTEM|PERF|ALLOC|FILTER> <guid> [description] <counter> <object> <threshold> <emails> <script_path> <priority> [filter_options]
  • Parameters:
Name Description Required
SYSTEM System type policy. Used to alert when a system is down. TRUE
PERF Performance type policy. Used to alert when a performance threshold is hit. TRUE
ALLOC Allocation type policy. Used to alert when an allocation threshold is hit. TRUE
FILTER Global filter alert type policy. TRUE
Guid The globally unique identifier (GUID) of the policy. FALSE
description The description of policy. FALSE
counter The performance counter or type of resource to be monitored (e.g. System-Disk-Io, System-Down, System-Free-Memory, System-Networking). TRUE
object The node to attach the policy to. TRUE
threshold When to invoke alert i.e. 99 (where resource hits 99%). TRUE
email The email address to send alert. TRUE
script_path The full path to the script to invoke. TRUE
priority The priority level 0-5. TRUE
filter_options Enables the policy when set to true. FALSE

  • Example:
dxcli add-policy PERF "f7d70673-dde1-4b71-84a7-ae7324e4ace4" "test" System-Disk-Io "node1" "99" "user1@email.com" "c:\scripts\script.ps1" 0 true

 

add-service

  • Description: Add a service to Vhost
  • Syntax:
dxcli add-service <vhost> <service_name> [description] [assume_vhost_name:true|false]
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
service_name The name of the service. TRUE
description The description for the service. FALSE
assume_vhost_name Whether or not to run the service under the Vhost name. FALSE

  • Example:
dxcli add-service vhost1 spooler

 

add-service-registry

  • Description: Add registry management to a virtualized service.
  • Syntax:
dxcli add-service-registry <vhost> <service_name> <reg_key> <reg_path>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
service_name The name of the service. TRUE
reg_key The full path to the registry key. TRUE
reg_path The full path of where the service reg_key is backed up. It is recommended to put this on a shared volume for the Vhost. TRUE

  • Example:
dxcli add-service-registry vhost1 service1 HKLM\Software\service1 c:\mounts\volume1\service1

 

add-share

  • Description: Add a file share to a Vhost.
  • Syntax:
dxcli add-share <vhost> <share_name=share_path> [/remarks:"text"] [/unlimited|/users:number] [/cache:Manual|Documents|Programs|BranchCache|None] [/grant:user,[READ|CHANGE|FULL]
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
share_name=share_path The name of the file share and the full path to the shared folder. TRUE
/remarks:"text" The description for the file share. FALSE
/unlimited|/users:number The number of users to allow. FALSE
/cache:Manual|Documents|Programs|BranchCache|None Sets the caching options. FALSE
/grant:user,READ|CHANGE|FULL Grants the user privileges. FALSE

  • Example:
dxcli add-share vhost1 "share1=c:\mount1\share1" /remarks:"This is share1" /unlimited /cache:none /grant:everyone,read /grant:user1,full

 

add-smtp

  • Description: Add SMTP server configuration.
  • Syntax:
dxcli add-smtp <server> <port> <email_address> <password> <NONE|TLS|SSL> <user_name>
  • Parameters:
Name Description Required
server The name of the server. TRUE
port The port for the server. TRUE
email_address The user email address. TRUE
password The user password. TRUE
NONE|TLS|SSL Email protocol setting. TRUE
user The name of the user. TRUE

  • Example:
dxcli add-smtp server.mail.com user1@mail.com p@ssw0rd 555 TLS user1

 

add-tunnel

  • Description: Add a tunnel to the cluster.
  • Syntax:
dxcli add-tunnel <name> <enabled [true|false]> <destination_node_name> <destination_address:destination_port> <origin_node,origin_address:origin_port[,address_filter]>|<origin_node,origin_address:origin_port[,address_filter]> [vhost]
  • Parameters:
Name Description Required
name The name of the tunnel. TRUE
enabled Enable the tunnel (true or false). TRUE
destination_node_name The name of the destination node. TRUE
destination_address The IP address of the tunnel destination. TRUE
destination_port The port number for the destination IP. TRUE
origin_node The name of the node where the listener is active. TRUE
origin_address Set to 0.0.0.0 to allow all IP connections or 127.0.0.1 for local connections only. TRUE
origin_port The port number for the origin node. TRUE
address_filter The name of the address filter to add to the tunnel. FALSE
vhost The name of the Vhost. FALSE

  • Example:
dxcli add-tunnel tunnel1 true node1 10.1.200.62:30004 "node2,0.0.0.0:30004/FILTER1|node3,127.0.0.1:30004/FILTER2" VHOST1

 

add-witness

  • Description: Add a network fileshare witness.
  • Syntax:
dxcli add-witness <share> <user> <password>
    • Parameters:
Name Description Required
share Up to three UNC paths of the network shares, delimited by comma. TRUE
user The name of the user. TRUE
password The password of the user (encrypted using "dxcli encrypt-text" recommended). TRUE

  • Example1:
    dxcli add-witness "\\server1\myshare1" "user1" "6pnFaDrRS+W/F+dkRuPKAA=="
  • Example2:
    dxcli add-witness "\\server1\myshare1,\\server2\myshare2" "user1" "6pnFaDrRS+W/F+dkRuPKAA=="
  • Example3:
    dxcli add-witness "\\mystorage.file.core.windows.net\azshare1" "mystorage" "/nbFVz1fOKH7b0RaY/5Ms8uytbY99PZsspZkcHvNtVRj//pUk4jUPV7owaUSuDd6eExv96sBvkCXsleATEsT33=="

 

attach-ags

  • Description: Attach an existing availability group to a Vhost. Make sure the existing primary node for the AG is also the current primary node for the Vhost.
  • Syntax:
dxcli attach-ags <vhost> <ags_name> <param1> <param2> <...>
<param1> : <node_name|instance_name|sql_login|sql_pass|mirror_port|availability_mode>
<param2> : <node_name|instance_name|sql_login|sql_pass|mirror_port|availability_mode>
<...> : <node_name|instance_name|sql_login|sql_pass|mirror_port|availability_mode>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
ags_name The name of the availability group. TRUE
param1 A set of parameters for the primary node in the availability group. TRUE
param2 A set of parameters for the secondary node in the availability group. TRUE
... A set of parameters for each additional node that is a member of the availability group. FALSE
node_name The name of the node. TRUE
instance_name The name of the instance. TRUE
sql_login The user name used to login to SQL Server. The SQL Server login can be any SQL login or Windows domain accounts that has been assigned the sysadmin role for the instance being managed. When supplying a domain account, the username needs to follow the UPN format (for example: user@domain.com). TRUE
sql_pass The password used to login to SQL Server (encrypted using "dxcli encrypt-text"). TRUE
mirror_port The mirroring port to use for the availability group (default is 5022). TRUE
availability_mode Synchronous_commit, asynchronous_commit or configuration_only. TRUE

  • Example:
dxcli attach-ags vhost1 ags1 "node1|MSSQLSERVER|SA|6pnFaDrRS+W/F+dkRuPKAA==|5022|SYNCHRONOUS_COMMIT" "node2|MSSQLSERVER|SA|6pnFaDrRS+W/F+dkRuPKAA==|5022|SYNCHRONOUS_COMMIT"

 

clean-disk

  • Description: Under some circumstances, a disk may need to be cleaned to delete all of its partitions, volumes, and any hidden sector information.
  • Syntax:
dxcli clean-disk <disk_id>
  • Parameters:
Name Description Required
disk_id The ID of the disk. TRUE

  • Example:
dxcli clean-disk 9b85d24a-5c5a-136d-e3ba-7ffd9584feaf

 

clear-otpk

  • Description: Clears and invalidates any generated one time passkey for a node.
  • Syntax:
dxcli clear-otpk
  • Parameters:None

 

clear-reservation

  • Description: Clears the current SCSI-3 persistent reservation on the specified disk.
  • Syntax:
dxcli clear-reservation <disk_id>
  • Parameters:
Name Description Required
disk_id The ID of the disk. TRUE

  • Example:
dxcli clear-reservation 9b85d24a-5c5a-136d-e3ba-7ffd9584feaf

 

cluster-add-vhost

  • Description: Adds a virtual host to the cluster.
  • Syntax:
dxcli cluster-add-vhost <vhost> <vips> <nodes> [autofailback] [priority[1-5]] [ilbports]
  • Parameters:
Name Description Required
vhost The name of Vhost. TRUE
vips The virtual IP(s) for the Vhost (comma separated list for multiples). TRUE
nodes | VHOST:vhosts The node(s) or Vhost(s) to add to the Vhost (comma separated list for multiples). TRUE
autofailback Set autofailback or leave blank if autofailback is not desired. FALSE
priority The priority order of failover between Vhosts (1 is the highest and 5 is the lowest). FALSE
ilbports The ports to use for internal load balancer probing (comma separated list for multiples). FALSE

  • Example:
dxcli cluster-add-vhost vhost1 10.1.200.10,10.2.100.5 node1,node2,node3

 

cluster-disable-node

  • Description: Disables the specified node.
  • Syntax:
dxcli cluster-disable-node <node>
  • Parameters:
Name Description Required
node The name of the node. TRUE

  • Example:
dxcli cluster-disable-node node1

 

cluster-enable-node

  • Description: Enables the specified node.
  • Syntax:
dxcli cluster-enable-node <node>
  • Parameters:
Name Description Required
node The name of the node. TRUE

  • Example:
dxcli cluster-enable-node node1

 

cluster-get-docker-images

  • Description: Gets a list of docker images.
  • Syntax:
dxcli cluster-get-docker-images
  • Parameters:None
  • Example:
dxcli cluster-get-docker-images

 

cluster-get-licenses

  • Description: Get a list of licenses.
  • Syntax:
dxcli cluster-get-licenses
  • Parameters:None
  • Example:
dxcli cluster-get-licenses

 

cluster-get-sql-instances

  • Description: Get a list of SQL instances.
  • Syntax:
dxcli cluster-get-sql-instances
  • Parameters:None
  • Example:
dxcli cluster-get-sql-instances

 

cluster-rehost-docker

  • Description: Moves a docker instance from one Vhost to another Vhost.
  • Syntax:
dxcli cluster-rehost-docker <source_vhost>\<source_docker> <target_vhost>\<target_docker>
  • Parameters:
Name Description Required
source_vhost The name of the source Vhost. TRUE
source_docker The name of the source docker. TRUE
target_vhost The name of the target Vhost. TRUE
target_docker The name of the target docker. TRUE

  • Example:
dxcli cluster-rehost-docker vhost1\mydocker vhost2\mydocker

 

cluster-rehost-instance

  • Description: Moves an instance from one Vhost to another Vhost.
  • Syntax:
cluster-rehost-instance <source_vhost>\<source_instance> <target_vhost>\<target_instance>
  • Parameters:
Name Description Required
source_vhost The name of the source Vhost. TRUE
source_instance The name of the source instance. TRUE
target_vhost The name of the target Vhost. TRUE
target_instance The name of the target instance. TRUE

  • Example:
dxcli cluster-rehost-instance vhost1\instance1 vhost2\instance1

 

cluster-rehost-service

  • Description: Moves a service from one Vhost to another Vhost.
  • Syntax:
cluster-rehost-service <source_vhost>\<source_service> <target_vhost>\<target_service>
  • Parameters:
Name Description Required
source_vhost The name of the source Vhost. TRUE
source_service The name of the source service. TRUE
target_vhost The name of the target Vhost. TRUE
target_service The name of the target service. TRUE

  • Example:
dxcli cluster-rehost-service vhost1\spooler vhost2\spooler

 

cluster-remove-vhost

  • Description: Removes a Vhost from the cluster.
  • Syntax:
dxcli cluster-remove-vhost <vhost>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE

  • Example:
dxcli cluster-remove-vhost vhost1

 

cluster-resync

  • Description: Refresh cluster configuration for all members.
  • Syntax:
dxcli cluster-resync
  • Parameters:None
  • Example:
dxcli cluster-resync

 

cluster-set-secret

  • Description: Sets the cluster passkey. This command cannot be run remotely.
  • Syntax:
dxcli cluster-set-secret
  • Interactive only.
  • Example:
dxcli cluster-set-secret

 

cluster-set-secret-ex

  • Description: Sets the cluster passkey. This command cannot be run remotely.
  • Syntax:
dxcli cluster-set-secret-ex <passkey>
  • Noninteractive only.
  • Parameters:
    Name Description Required
    passkey The passkey to use for the cluster. TRUE

  • Example:
    dxcli cluster-set-secret-ex P@ssw0rd

 

collect-log

  • Description: Generates logs on the specified node(s).
  • Syntax:
dxcli collect-log [node_name]
  • Parameters:
Name Description Required
node_name The name of the node(s) (comma separated list for multiples). FALSE

  • Example:
dxcli collect-log node1,node2,node3

 

create-volume

  • Description: Creates a volume on the specified disk.
  • Syntax:
dxcli create-volume <disk_id>,<size_in_bytes>
  • Parameters:
Name Description Required
disk_id The ID of the disk. TRUE
size_in_bytes The size of the volume to create in bytes. TRUE

  • Example:
dxcli create-volume 9b85d24a-5c5a-136d-e3ba-7ffd9584feaf,1073741824

 

deactivate-server

  • Description: Deactivates the specified node.
  • Syntax:
dxcli deactivate-server <node>
  • Parameters:
Name Description Required
node The name of the node. TRUE

  • Example:
dxcli deactivate-server node1

 

delete-volume

  • Description: Deletes a volume on the specified disk.
  • Syntax:
dxcli delete-volume <volume_id>
  • Parameters:
Name Description Required
volume_id The ID of the volume. TRUE

  • Example:
dxcli delete-volume 8218ceeb-6ff1-4818-89e9-4d7f1a7ad0ef

 

demote-ags-node

  • Description: Demotes the specified replica to secondary role in the availability group.
  • Syntax:
dxcli demote-ags-node <vhost> <ags_name> <node>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
ags_name The name of the availability group. TRUE
node The name of the node. TRUE

  • Example:
dxcli demote-ags-node vhost1 ags1 node1

 

detach-ags

  • Description: Detaches availability group from the specified Vhost, but does not delete the configuration from SQL Server.
  • Syntax:
dxcli detach-ags <vhost> <ags_name>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
ags_name The name of the availability group. TRUE

  • Example:
dxcli detach-ags vhost1 ags1

 

encrypt-text

  • Description: Encrypts text for use in other DxCli commands.
  • Syntax:
dxcli encrypt-text <value>
  • Parameters:
Name Description Required
value The text to be encrypted. TRUE

  • Example:
dxcli encrypt-text p@ssw0rd

 

export-config

  • Description: Exports a client configuration file to be used on DxConnect client machines. The file will be created in the working directory.
  • Syntax:
dxcli export-config <file_name>
  • Parameters:
Name Description Required
file_name The name of the file, including the .dh2i extension. TRUE

  • Example:
dxcli export-config dxe_client.dh2i

 

extend-volume

  • Description: Extends a volume on the specified disk.
  • Syntax:
dxcli extend-volume <volume_id> <disk_id>,<size_in_bytes>
  • Parameters:
Name Description Required
volume_id The ID of the volume. TRUE
disk_id The ID of the disk. TRUE
size_in_bytes The size to extend the volume in bytes. TRUE

  • Example:
dxcli extend-volume 8218ceeb-6ff1-4818-89e9-4d7f1a7ad0ef 9b85d24a-5c5a-136d-e3ba-7ffd9584feaf,1073741824

 

format-volume

  • Description: Formats the specified volume.
  • Syntax:
dxcli format-volume <volume_id> <fstype> <label> <block_size> <quick_format:true|false> <compression:true|false> [optional_parameters]
  • Parameters:
Name Description Required
volume_id The ID of the volume TRUE
fstype [FAT|FAT32|exFAT|EXT3|EXT4|NTFS|UDF|ReFS|XFS] The file system type. TRUE
label The label for the volume. TRUE
block_size [512|1024|2048|4096|8192|16384|32768|65536] The block size in bytes. TRUE
quick_format:true|false Whether or not to perform a quick format. TRUE
compression:true|false Whether or not to enable compression. TRUE
optional_parameters Optional parameters from format.com. FALSE

  • Example:
dxcli format-volume 8218ceeb-6ff1-4818-89e9-4d7f1a7ad0ef NTFS Volume1 4096 quick_format:true compression:false

 

freeze-node

  • Description: Freezes the specified node and disables automatic failover of any active Vhosts.
  • Syntax:
dxcli freeze-node <node>
  • Parameters:
Name Description Required
node The name of the node. TRUE

  • Example:
dxcli freeze-node node1

 

freeze-vhost

  • Description: Freezes a specified Vhost and disables automatic failover.
  • Syntax:
dxcli freeze-vhost <vhost>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE

  • Example:
dxcli freeze-vhost vhost1

 

generate-otpk

  • Description: Generates a new one time passkey.
  • Syntax:
dxcli generate-otpk
  • Parameters:None.

 

get-addressfilter

  • Description: Get address filter details.
  • Syntax:
dxcli get-addressfilter <filter_name>
  • Parameters:
Name Description Required
filter_name The name of the address filter. TRUE

  • Example:
dxcli get-addressfilter filter1

 

get-ags-detail

  • Description: Get availability group details.
  • Syntax:
dxcli get-ags-detail <vhost> <ags_name>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
ags_name The name of the availability group. TRUE

  • Example:
dxcli get-ags-detail vhost1 AG1

 

get-alerts

  • Description: Get all active alerts.
  • Syntax:
dxcli get-alerts
  • Parameters:None
  • Example:
dxcli get-alerts

 

get-client-connections

  • Description: Get all active client connections.
  • Syntax:
dxcli get-client-connections
  • Parameters:None
  • Example:
dxcli get-client-connections

 

get-client-detail

  • Description: Outputs the details for the specified client.
  • Syntax:
dxcli get-client-detail <client_name>
  • Parameters:
Name Description Required
client_name The name of the client. TRUE

  • Example:
dxcli get-client-detail client1

 

get-cluster-disks

  • Description: Get all disks under DxEnterprise management.
  • Syntax:
dxcli get-cluster-disks
  • Parameters:None
  • Example:
dxcli get-cluster-disks

 

get-cluster-nodes

  • Description: Get all cluster nodes.
  • Syntax:
dxcli get-cluster-nodes
  • Parameters:None
  • Example:
dxcli get-cluster-nodes

 

get-contacts

  • Description: Get all contacts in the address book.
  • Syntax:
dxcli get-contacts
  • Parameters:None
  • Example:
dxcli get-contacts

 

get-coordinators

  • Description: Get all of the cluster coordinators.
  • Syntax:
dxcli get-coordinators
  • Parameters:None
  • Example:
dxcli get-coordinators

 

get-coordinator-status

  • Description: Get the cluster coordinator status.
  • Syntax:
dxcli get-coordinator-status
  • Parameters:None
  • Example:
dxcli get-coordinator-status

 

get-counters

  • Description: Get all performance counters.
  • Syntax:
dxcli get-counters
  • Parameters:None
  • Example:
dxcli get-counters

 

get-disk-detail

  • Description: Get the specified disk details.
  • Syntax:
dxcli get-disk-detail <disk_id>
  • Parameters:
Name Description Required
disk_id The ID of the disk. TRUE

  • Example:
dxcli get-disk-detail 9b85d24a-5c5a-136d-e3ba-7ffd9584feaf

 

get-diskinfo

  • Description: Get the specified disk information.
  • Syntax:
dxcli get-diskinfo <disk_id> [node]
  • Parameters:
Name Description Required
disk_id The ID of the disk. TRUE
node The name of the node. FALSE

  • Example:
dxcli get-diskinfo 9b85d24a-5c5a-136d-e3ba-7ffd9584feaf node1

 

get-disks

  • Description: Get all disk information from all nodes.
  • Syntax:
dxcli get-disks
  • Parameters:None
  • Example:
dxcli get-disks

 

get-docker-detail

  • Description: Get the specified docker image information.
  • Syntax:
dxcli get-docker-detail <vhost> <docker>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
docker The name of the docker image. TRUE

  • Example:
dxcli get-docker-detail vhost1 centos1

 

get-dxversion

  • Description: Get the DxEnterprise version.
  • Syntax:
dxcli get-dxversion
  • Parameters:None
  • Example:
dxcli get-dxversion

 

get-globalsettings

  • Description: Get the global cluster settings.
  • Syntax:
dxcli get-globalsettings
  • Parameters:None
  • Example:
dxcli get-globalsettings

 

get-instance-detail

  • Description: Get the specified instance details.
  • Syntax:
dxcli get-instance-detail <vhost> <instance>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
instance The name of the instance. TRUE

  • Example:
dxcli get-instance-detail vhost1\instance1

 

get-license

  • Description: Get the current license of the node.
  • Syntax:
dxcli get-license <node>
  • Parameters:
Name Description Required
node The name of the node. TRUE

  • Example:
dxcli get-license node1

 

get-license-request

  • Description: Get the license feature details.
  • Syntax:
dxcli get-license-request <license_code> [node]
  • Parameters:
Name Description Required
license_code The license of the node. TRUE
node The name of the node. FALSE

  • Example:
dxcli get-license-request AAAA-BBBB-CCCC-DDDD node1

 

get-monitored-apps

  • Description: Get the information on all monitored applications.
  • Syntax:
dxcli get-monitored-apps [node [dxhealthmonitor|dxregmonitor]]
  • Parameters:
Name Description Required
node The name of the node. FALSE
dxhealthmonitor Applications monitored by DxHealthMonitor. FALSE
dxregmonitor Applications monitored by DxRegMonitor. FALSE

  • Example:
dxcli get-monitored-apps

 

get-monitored-dockers

  • Description: Get information on monitored dockers.
  • Syntax:
dxcli get-monitored-dockers [node [dxhealthmonitor|dxregmonitor]]
  • Parameters:
Name Description Required
node The name of the node. FALSE
dxhealthmonitor Dockers monitored by DxHealthMonitor. FALSE
dxregmonitor Dockers monitored by DxRegMonitor. FALSE

  • Example:
dxcli get-monitored-dockers

 

get-monitored-instances

  • Description: Get information on monitored instances.
  • Syntax:
dxcli get-monitored-instances [node [dxhealthmonitor|dxregmonitor]]
  • Parameters:
Name Description Required
node The name of the node. FALSE
dxhealthmonitor Instances monitored by DxHealthMonitor. FALSE
dxregmonitor Instances monitored by DxRegMonitor. FALSE

  • Example:
dxcli get-monitored-instances

 

get-monitored-services

  • Description: Get information on monitored services.
  • Syntax:
dxcli get-monitored-services [node [dxhealthmonitor|dxregmonitor]]
  • Parameters:
Name Description Required
node The name of the node. FALSE
dxhealthmonitor Services monitored by DxHealthMonitor. FALSE
dxregmonitor Services monitored by DxRegMonitor. FALSE

  • Example:
dxcli get-monitored-services

 

get-monitored-shares

  • Description: Get information on monitored shares.
  • Syntax:
dxcli get-monitored-shares [node [dxhealthmonitor|dxregmonitor]]
  • Parameters:
Name Description Required
node The name of the node. FALSE
dxhealthmonitor Shares monitored by DxHealthMonitor. FALSE
dxregmonitor Shares monitored by DxRegMonitor. FALSE

  • Example:
dxcli get-monitored-shares

 

get-node-detail

  • Description: Get detailed information on the node.
  • Syntax:
dxcli get-node-detail [node]
  • Parameters:
Name Description Required
node The name of the node. FALSE

  • Example:
dxcli get-node-detail

 

get-node-detail-xml

  • Description: Get detailed information on the node in XML.
  • Syntax:
dxcli get-node-detail-xml [node]
  • Parameters:
Name Description Required
node The name of the node. FALSE

  • Example:
dxcli get-node-detail-xml

 

get-otpk

  • Description: Get the current one time pass key (OTPK).
  • Syntax:
dxcli get-otpk
  • Parameters:None
  • Example:
dxcli get-otpk

 

get-policies

  • Description: Get the current policies.
  • Syntax:
dxcli get-policies
  • Parameters:None
  • Example:
dxcli get-policies

 

get-policy

  • Description: Get information on a specific policy.
  • Syntax:
dxcli get-policy <policy_id>
  • Parameters:
Name Description Required
policy_id The ID of the policy. TRUE

  • Example:
dxcli get-policy 676db1d4-91f5-4a68-b897-9fe75c27edcc

 

get-producttype

  • Description: Get the current product type. This command cannot be run remotely.
  • Syntax:
dxcli get-producttype
  • Parameters:None
  • Example:
dxcli get-producttype

 

get-reservation

  • Description: Get the reservation information from a specific disk.
  • Syntax:
dxcli get-reservation <disk_id>
  • Parameters:
Name Description Required
disk_id The ID of the disk. TRUE

  • Example:
dxcli get-reservation 9b85d24a-5c5a-136d-e3ba-7ffd9584feaf

 

get-service-detail

  • Description: Get the service detail.
  • Syntax:
dxcli get-service-detail <vhost> <service>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
service The name of the service. TRUE

  • Example:
dxcli get-service detail vhost1 spooler

 

get-sql-instances

  • Description: Get the installed SQL instances.
  • Syntax:
dxcli get-sql-instances
  • Parameters:None
  • Example:
dxcli get-sql-instances

 

get-sql-paths

  • Description: Get the SQL data and log paths.
  • Syntax:
dxcli get-sql-paths <vhost>\<instance>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
instance The name of the instance. TRUE

  • Example:
dxcli get-sql-paths vhost1\instance1

 

get-tunnels

  • Description: Get tunnel details.
  • Syntax:
dxcli get-tunnels <tunnel_name>
  • Parameters:
Name Description Required
tunnel_name The name of the tunnel. TRUE

  • Example:
dxcli get-tunnels tunnel1

 

get-unused-driveletters

  • Description: Get the unused drive letters.
  • Syntax:
dxcli get-unused-driveletters [volume_id]
  • Parameters:
Name Description Required
volume_id The ID of the volume. FALSE

  • Example:
dxcli get-unused-driveletters

 

get-vhost

  • Description: Get the Vhost information.
  • Syntax:
dxcli get-vhost <vhost>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE

  • Example:
dxcli get-vhost vhost1

 

get-vhosts

  • Description: Get the information for all vhosts.
  • Syntax:
dxcli get-vhosts
  • Parameters:None
  • Example:
dxcli get-vhosts

 

get-volume-detail

  • Description: Get the specified volume details.
  • Syntax:
dxcli get-volume-detail <volume_id>
  • Parameters:
Name Description Required
volume_id The ID of the volume. TRUE

  • Example:
dxcli get-volume-detail 8218ceeb-6ff1-4818-89e9-4d7f1a7ad0ef

 

get-witness

  • Description: Get the current witness settings for the cluster.
  • Syntax:
dxcli get-witness
  • Parameters: None
  • Example:
dxcli get-witness

 

join-cluster

  • Description: Join an existing cluster. This command cannot be run remotely.
  • Syntax:
dxcli join-cluster
  • Interactive only.
  • Example:
dxcli join-cluster

 

join-cluster-ex

  • Description: Join an existing cluster. This command cannot be run remotely.
  • Syntax:
dxcli join-cluster-ex <target> <passkey> [do_nat [true|false]]
  • Noninteractive only.
  • Parameters:
Name Description Required
target The IP of the target server, or match.dh2i.com if joining via the DH2i matchmaking service. TRUE
passkey The passkey of the target server, or OTPK if joining via the DH2i matchmaking service. TRUE
do_nat Use match.dh2i.com as target with OTPK instead of passkey. FALSE

  • Example 1:
dxcli join-cluster-ex 10.2.2.29 P@ssw0rd
  • Example 2:
dxcli join-cluster-ex match.dh2i.com 6e85fe3d-fa72-3d0c-5a02-94fddd91a2e7 true

 

refresh-volmonitor-applications

  • Description: Refresh volmonitor-applications.
  • Syntax:
dxcli refresh-volmonitor-applications
  • Parameters:None
  • Example:
dxcli refresh-volmonitor-applications

 

reload-monitored-apps

  • Description: Reload the monitors for all applications.
  • Syntax:
dxcli reload-monitored-apps [node [dxhealthmonitor|dxregmonitor]]
  • Parameters:
Name Description Required
node The name of the node. FALSE
dxhealthmonitor Applications monitored by DxHealthMonitor. FALSE
dxregmonitor Applications monitored by DxRegMonitor. FALSE

  • Example:
dxcli reload-monitored-apps

 

reload-monitored-dockers

  • Description: Reload the monitors for all dockers.
  • Syntax:
dxcli reload-monitored-dockers [node [dxhealthmonitor|dxregmonitor]]
  • Parameters:
Name Description Required
node The name of the node. FALSE
dxhealthmonitor Dockers monitored by DxHealthMonitor. FALSE
dxregmonitor Dockers monitored by DxRegMonitor. FALSE

  • Example:
dxcli reload-monitored-dockers

 

reload-monitored-instances

  • Description: Reload the monitors for all instances.
  • Syntax:
dxcli reload-monitored-instances [node [dxhealthmonitor|dxregmonitor]]
  • Parameters:
Name Description Required
node The name of the node. FALSE
dxhealthmonitor Instances monitored by DxHealthMonitor. FALSE
dxregmonitor Instances monitored by DxRegMonitor. FALSE

  • Example:
dxcli reload-monitored-instances

 

reload-monitored-services

  • Description: Reload the monitors for all services.
  • Syntax:
dxcli reload-monitored-services [node [dxhealthmonitor|dxregmonitor]]
  • Parameters:
Name Description Required
node The name of the node. FALSE
dxhealthmonitor Services monitored by DxHealthMonitor. FALSE
dxregmonitor Services monitored by DxRegMonitor. FALSE

  • Example:
dxcli reload-monitored-services

 

reload-monitored-shares

  • Description: Reload the monitors for all shares.
  • Syntax:
dxcli reload-monitored-shares [node [dxhealthmonitor|dxregmonitor]]
  • Parameters:
Name Description Required
node The name of the node. FALSE
dxhealthmonitor Shares monitored by DxHealthMonitor. FALSE
dxregmonitor Shares monitored by DxRegMonitor. FALSE

  • Example:
dxcli reload-monitored-shares

 

relocate-systemdatabases

  • Description: Relocate the system databases for the specified instance. Moving master is required.
  • Syntax:
dxcli relocate-systemdatabases <vhost>\<instance> <sql_data_path> <sql_log_path> [msdb,model,tempdb]
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
instance The name of the instance. TRUE
sql_data_path The new path for instance data. TRUE
sql_log_path The new path for instance logs. TRUE
[msdb,model,tempdb] System databases to move along with the master database. FALSE

  • Example:
dxcli relocate-systemdatabases vhost1\instance1 C:\mount1\data C:\mount1\logs msdb,model

 

remove-ags

  • Description: Removes an availability group from a Vhost, and deletes the configuration from SQL Server.
  • Syntax:
dxcli remove-ags <vhost> <ags_name>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
ags_name The name of the availability group. TRUE

  • Example:
dxcli remove-ags vhost1 ags1

 

remove-ags-databases

  • Description: Removes databases from an availability group.
  • Syntax:
dxcli remove-ags-databases <vhost> <ags_name> <db_name>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
ags_name The name of the availability group. TRUE

  • Example:
dxcli remove-ags-databases vhost1 ags1 db1,db2,db3

 

remove-ags-listener

  • Description: Removes listener from an availability group.
  • Syntax:
dxcli remove-ags-listener <vhost> <ags_name>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
ags_name The name of the availability group. TRUE

  • Example:
dxcli remove-ags-listener vhost1 ags1

 

remove-client

  • Description: Remove a remote client.
  • Syntax:
dxcli remove-client <client_name>
  • Parameters:
Name Description Required
client_name The name of the client. TRUE

  • Example:
dxcli remove-client client1

 

remove-client-group

  • Description: Remove a client group.
  • Syntax:
dxcli remove-client-group <group_name>
  • Parameters:
Name Description Required
group_name The name of the group. TRUE

  • Example:
dxcli remove-client-group group1

 

remove-cluster-members

  • Description: Remove a node from the cluster.
  • Syntax:
dxcli remove-cluster-members <node>
  • Parameters:
Name Description Required
node The name of the node. TRUE

  • Example:
dxcli remove-cluster-members node1

 

remove-contact

  • Description: Remove a contact from the address book.
  • Syntax:
dxcli remove-contact <name>
  • Parameters:
Name Description Required
name The name of the contact. TRUE

  • Example:
dxcli remove-contact user1

 

remove-disk

  • Description: Removes the specified disk from DxEnterprise management.
  • Syntax:
dxcli remove-disk <disk_id>
  • Parameters:
Name Description Required
disk_id The ID of the disk. TRUE

  • Example:
dxcli remove-disk 9b85d24a-5c5a-136d-e3ba-7ffd9584feaf

 

remove-docker

  • Description: Removes a docker from a Vhost.
  • Syntax:
dxcli remove-docker <vhost> <docker>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
docker The name of the docker. TRUE

  • Example:
dxcli remove-docker vhost1 centos1

 

remove-globalsetting

  • Description: Removes a cluster global setting.
  • Syntax:
dxcli remove-globalsetting <name>
  • Parameters:
Name Description Required
name The name of the global setting. TRUE

  • Example:
dxcli remove-globalsetting timeout.ping

 

remove-instance

  • Description: Removes an instance from a Vhost.
  • Syntax:
dxcli remove-instance <vhost\instance>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
instance The name of the instance. TRUE

  • Example:
dxcli remove-instance vhost1\instance1

 

remove-node

  • Description: Removes a node from a Vhost.
  • Syntax:
dxcli remove-node <vhost> <node>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
node The name of the node. TRUE

  • Example:
dxcli remove-node vhost1 node1

 

remove-policy

  • Description: Removes a policy.
  • Syntax:
dxcli remove-policy <SYSTEM|PERF|ALLOC|FILTER> <guid>
  • Parameters:
Name Description Required
SYSTEM|PERF|ALLOC|FILTER The policy type. TRUE
guid The globally unique identifier (GUID) of the policy. TRUE

  • Example:
dxcli remove-policy PERF 51b753b2-0969-473e-804b-a5c4db210faf

 

remove-script

  • Description: Removes a script.
  • Syntax:
dxcli remove-script <vhost|instance|service> <prestart|poststart|prestop|poststop> [script_type]
  • Parameters:
Name Description Required
vhost|instance|service The name of the Vhost, instance or service. TRUE
prestart|poststart|prestop|poststop Specifies whether it is a PreStart, PostStart, PreStop or PostStop script. TRUE

  • Example:
dxcli remove-script vhost1 prestart

 

remove-service

  • Description: Removes a service from a Vhost.
  • Syntax:
dxcli remove-service <vhost> <service>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
service The name of the service. TRUE

  • Example:
dxcli remove-service vhost1 spooler

 

remove-service-registry

  • Description: Removes registry management from a virtualized service.
  • Syntax:
dxcli remove-service-registry <vhost> <service_name>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
service_name The name of the service. TRUE

  • Example:
dxcli remove-service-registry vhost1 spooler

 

remove-share

  • Description: Removes a share from a Vhost.
  • Syntax:
dxcli remove-share <vhost> <share_name>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
share_name The name of the share. TRUE

  • Example:
dxcli remove-share vhost1 share1

 

remove-smtp

  • Description: Removes the SMTP configuration.
  • Syntax:
dxcli remove-smtp <server>
  • Parameters:
Name Description Required
server The name of the server. TRUE

  • Example:
dxcli remove-smtp server.mail.com

 

remove-tunnel

  • Description: Remove a tunnel.
  • Syntax:
dxcli remove-tunnel <name>
  • Parameters:
Name Description Required
name The name of the tunnel to remove. TRUE

  • Example:
dxcli remove-tunnel tunnel1

 

remove-witness

  • Description: Remove current witness settings for the cluster.
  • Syntax:
dxcli remove-witness
  • Parameters: None
  • Example:
dxcli remove-witness

 

rescan-disk

  • Description: Rescans the specified disk.
  • Syntax:
dxcli rescan-disk <disk_id>
  • Parameters:
Name Description Required
disk_id The ID of the disk. TRUE

  • Example:
dxcli rescan-disk 9b85d24a-5c5a-136d-e3ba-7ffd9584feaf

 

resync-ags-secondary

  • Description: Resyncs the ags secondary node.
  • Syntax:
dxcli resync-ags-secondary <vhost> <ags_name> <node>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
ags_name The name of the avaialability group. TRUE
node The name of the node. TRUE

  • Example:
dxcli resync-ags-secondary vhost1 ag1 node2

 

set-ags-cred

  • Description: Modify availability group sysadmin credentials.
  • Syntax:
dxcli set-ags-cred <vhost> <ags_name> <param1> <param2> <...>
   <param1> : <node_name|instance_name|sql_login|sql_pass>
   <param2> : <node_name|instance_name|sql_login|sql_pass>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
ags_name The name of the availability group. TRUE
param1 A set of parameters for the primary node in the availability group. TRUE
param2 A set of parameters for the secondary node in the availability group. TRUE
... A set of parameters for each additional node that will be a member of the availability group. FALSE
node_name The name of the node. TRUE
instance_name The name of the instance. TRUE
sql_login The user name used to login to SQL Server. The SQL Server login can be any SQL login or Windows domain accounts that has been assigned the sysadmin role for the instance being managed. When supplying a domain account, the username needs to follow the UPN format (for example: user@domain.com). TRUE
sql_pass The password used to login to SQL Server (encrypted using "dxcli encrypt-text"). TRUE

  • Example:
dxcli set-ags-cred vhost1 ags1 "node1|MSSQLSERVER|SA|6pnFaDrRS+W/F+dkRuPKAA==" "node2|MSSQLSERVER|SA|6pnFaDrRS+W/F+dkRuPKAA=="

 

set-ags-node-availability-mode

  • Description: Modify availability mode.
  • Syntax:
dxcli set-ags-node-availability-mode <vhost> <ags_name> <replica_name> <sync or async>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
ags_name The name of the availability group. TRUE
replica name The name of the replica TRUE
sync or async Select 0 for synchronous_commit or 1 for asynchronous_commit. TRUE

  • Example:
dxcli set-ags-node-availability-mode vhost1 ags1 replica2 1

 

set-appcoordinator

  • Description: Sets the cluster application coordinator.
  • Syntax:
dxcli set-appcoordinator <node>
  • Parameters:
Name Description Required
node The name of the node. TRUE

  • Example:
dxcli set-appcoordinator node1

 

set-coordinator

  • Description: Sets the cluster coordinator.
  • Syntax:
dxcli set-coordinator <node>
  • Parameters:
Name Description Required
node The name of the node. TRUE

  • Example:
dxcli set-coordinator node1

 

set-depends

  • Description: Defines the start-up order of services in a list of dependencies.
  • Syntax:
dxcli set-depends <vhost> <SQL:INSTANCE|SVC:SERVICE|VFS:SHARE|DCK:DOCKER> <DEPENDS [SQL:INSTANCE|SVC:SERVICE|VFS:SHARE|DCK:DOCKER]>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
SQL:INSTANCE|SVC:SERVICE|VFS:SHARE|DCK:DOCKER The type and name of the parent application in all caps. TRUE
DEPENDS [SQL:INSTANCE|SVC:SERVICE|VFS:SHARE|DCK:DOCKER] The type and name of the child application in all caps. TRUE

  • Example:
dxcli set-depends vhost1 SQL:INSTANCE1 SVC:SQLBROWSER

 

set-docker-description

  • Description: Sets the description of a docker.
  • Syntax:
dxcli set-docker-description <docker> <description>
  • Parameters:
Name Description Required
docker The name of the docker. TRUE
description The description for the docker. TRUE

  • Example:
dxcli set-docker-description centos1 "This is a CentOS docker"

 

set-failback

  • Description: Sets the auto-failback option for a Vhost.
  • Syntax:
dxcli set-failback <vhost> <true|false>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
true|false Sets auto-failback to true or false. TRUE

  • Example:
dxcli set-failback vhost1 true

 

set-globalsetting

dxcli set-globalsetting <name> <value>
  • Parameters:
Name Description Required
name The name of the global setting. TRUE
value The value for the global setting. TRUE

  • Example:
dxcli set-globalsetting timeout.ping 10

 

set-instance-description

  • Description: Sets the description for an instance.
  • Syntax:
dxcli set-instance-description <instance> <description>
  • Parameters:
Name Description Required
instance The name of the instance. TRUE
description The description for the instance. TRUE

  • Example:
dxcli set-instance-description instance1 "This is a SQL 2014 instance"

 

set-license

  • Description: Sets the node license key.
  • Syntax:
dxcli set-license <license_code> <license_answer> [node]
  • Parameters:
Name Description Required
license_code The license code. TRUE
license_answer The license answer obtained from the DH2i client portal. FALSE
node The name of the node. FALSE

  • Example:
dxcli set-license "AAAA-BBBB-CCCC-DDDD"

 

set-mountpoint

  • Description: Sets the volume mount point.
  • Syntax:
dxcli set-mountpoint <volume_id> <mount_point>
  • Parameters:
Name Description Required
volume_id The ID of the volume. TRUE
mount_point The mount point path or drive letter. TRUE

  • Example:
dxcli set-mountpoint 8218ceeb-6ff1-4818-89e9-4d7f1a7ad0ef C:\mount1

 

set-otpk

  • Description: Sets the one time passkey (OTPK).
  • Syntax:
dxcli set-otpk [ttl] [otpk]
  • Parameters:
Name Description Required
ttl The time to live. FALSE
otpk The one time passkey in base64. FALSE

  • Example:
dxcli set-otpk 2020-01-06T13:48:54 7fd269d7-e788-3d40-d704-ce7bb00f5046

 

set-script

  • Description: This sets a PreStart, PostStart, PreStop or Poststop script for a Vhost, instance or service.
  • Syntax:
dxcli set-script <vhost|instance|service> <prestart|poststart|prestop|poststop> <script_path>
  • Parameters:
Name Description Required
vhost|instance|service The name of the Vhost, instance or service. TRUE
prestart|poststart|prestop|poststop Whether it is a PreStart, PostStart, PreStop or PostStop script. TRUE
script_path The full path to the script file. TRUE

  • Example:
dxcli set-script vhost1 PreStart C:\mount1\script.ps1

 

set-script-embedded

  • Description: Sets an embedded PreStart, PostStart, PreStop or PostStop script for a Vhost, instance or service. The advantage of having an embedded script is that it is part of the cluster configuration and is always available to all of the cluster member nodes.
  • Syntax:
dxcli set-script <vhost|instance|service> <prestart|poststart|prestop|poststop> <script_content> <script_extension>
  • Parameters:
Name Description Required
vhost|instance|service The name of the Vhost, instance or service. TRUE
prestart|poststart|prestop|poststop Whether it is a PreStart, PostStart, PreStop, or PostStop script. TRUE
script_content The script content to be embedded into the cluster configuration. TRUE
Script_extension The file extension, e.g. CMD, BAT, PS1. TRUE

  • Example:
dxcli set-script-embedded vhost1 PreStart "echo %computername%" CMD

 

set-server

  • Description: Sets the current server context for commands.
  • Syntax:
dxcli set-server
  • Interactive only.
  • Example:
dxcli set-server

 

set-server-ex

  • Description: Sets the current server context for commands.
  • Syntax:
dxcli set-server <target> <passkey>
  • Noninteractive only.
  • Parameters:
Name Description Required
target The target server. TRUE
passkey The passkey of the target server. TRUE

  • Example:
dxcli set-server-ex 10.2.2.29 passkey

 

set-service-description

  • Description: Sets the description for the service.
  • Syntax:
dxcli set-service-description <service> <description>
  • Parameters:
Name Description Required
service The name of the service. TRUE
description The description for the service. TRUE

  • Example:
dxcli set-service-description BITS "Background Intelligent Transfer Service"

 

set-sqlcred

  • Description: Sets the sysadmin credentials DxEnterprise will use for instance management.
  • Syntax:
dxcli set-sqlcred <instance_name> <sql_login> <sql_pass>
  • Parameters:
Name Description Required
instance_name The name of the SQL instance. TRUE
sql_login The user name used to login to SQL Server. The SQL Server login can be any SQL login or Windows domain accounts that has been assigned the sysadmin role for the instance being managed. When supplying a domain account, the username needs to follow the UPN format (for example: user@domain.com). TRUE
sql_pass The password used to login to SQL Server (encrypted using "dxcli encrypt-text"). TRUE

  • Example:
dxcli set-sqlcred instance1 sa 6pnFaDrRS+W/F+dkRuPKAA==

 

set-storcoordinator

  • Description: Sets the cluster storage coordinator.
  • Syntax:
dxcli set-storcoordinator <node>
  • Parameters:
Name Description Required
node The name of the node. TRUE

  • Example:
dxcli set-storcoordinator node1

 

set-vhost-ilbports

  • Description: Sets the Vhost internal load balancer probe port.
  • Syntax:
dxcli set-vhost-ilbports <vhost> <ilbports>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
ilbports The port to use for internal load balancer probing (comma separated list for multiples). TRUE

  • Example:
dxcli set-vhost-ilbports vhost1 30001

 

set-vhost-priority

  • Description: Sets the Vhost failover priority.
  • Syntax:
dxcli set-vhost-priority <vhost> < 1-5 >
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
1-5 The priority level (1 is the highest and 5 is the lowest). TRUE

  • Example:
dxcli set-vhost-priority vhost1 3

 

set-volume-label

  • Description: Sets the label for the specified volume.
  • Syntax:
dxcli set-volume-label <volume_id> <label>
  • Parameters:
Name Description Required
volume_id The name of the volume. TRUE
label The label for the volume. TRUE

  • Example:
dxcli set-volume-label 8218ceeb-6ff1-4818-89e9-4d7f1a7ad0ef "Volume 1"

 

set-witness

  • Description: Sets the cluster witness settings.
  • Syntax:
dxcli set-witness <param1> <...>
                <param1> : <witness_path|user|password>
  • Parameters:
Name Description Required
param1 A set of parameters for the witness. TRUE
... A set of parameters for each additional witness for the cluster. FALSE
witness_path The UNC path of the network share or Azure Blob Storage connection string or SAS URL. Prefix with "az:" if using Azure Blob Storage connection string or SAS URL. Empty to remove current cluster witness settings. TRUE
user The name of the user. Not specified for Azure Blob Storage connection string or SAS URL. FALSE
password The password of the user (encrypted using "dxcli encrypt-text" recommended). Not specified for Azure Blob Storage connection string or SAS URL. FALSE

  • Example1:
dxcli set-witness "\\server1\myshare1|user1|6pnFaDrRS+W/F+dkRuPKAA=="
  • Example2:
dxcli set-witness "\\mystorage.file.core.windows.net\azshare1|mystorage|/nbFVz1fOKH7b0RaY/5Ms8uytbY99PZsspZkcHvNtVRj//pUk4jUPV7owaUSuDd6eExv96sBvkCXsleATEsT33=="
  • Example3:
dxcli set-witness "az:DefaultEndpointsProtocol=https;AccountName=mystorage;AccountKey=/nbFVz1fOKH7b0RaY/5Ms8uytbY99PZsspZkcHvNtVRj//pUk4jUPV7owaUSuDd6eExv96sBvkCXsleATEsT33==;EndpointSuffix=core.windows.net"
  • Example4:
dxcli set-witness "az:https://mystorage.blob.core.windows.net/?sv=2020-02-10&ss=b&srt=o&sp=rwdlactfx&se=2021-06-09T13:15:48Z&st=2021-06-09T05:15:48Z&spr=https&sig=cRDqOc25lpHfbP8X1hlkDnV4H1wJycCyuuqlgu8U1xg%3D"
  • Example5:
dxcli set-witness "\\server1\myshare1|user1|6pnFaDrRS+W/F+dkRuPKAA==" "\\mystorage.file.core.windows.net\azshare1|mystorage|/nbFVz1fOKH7b0RaY/5Ms8uytbY99PZsspZkcHvNtVRj//pUk4jUPV7owaUSuDd6eExv96sBvkCXsleATEsT33==" "az:DefaultEndpointsProtocol=https;AccountName=mystorage;AccountKey=/nbFVz1fOKH7b0RaY/5Ms8uytbY99PZsspZkcHvNtVRj//pUk4jUPV7owaUSuDd6eExv96sBvkCXsleATEsT33==;EndpointSuffix=core.windows.net"

 

shrink-volume

  • Description: Shrinks the current volume size.
  • Syntax:
dxcli shrink-volume <volume_id> <size_in_byte>
  • Parameters:
Name Description Required
volume_id The name of the volume. TRUE
size_in_byte The number of bytes the volume size will be reduced by. TRUE

  • Example:
dxcli shrink-volume 23d6d8a0-c3bd-0ec3-9e98-c0021494b827 500000000

 

start-disk

  • Description: Starts the disk on the specified node.
  • Syntax:
dxcli start-disk <disk_id> <node>
  • Parameters:
Name Description Required
disk_id The ID of the disk. TRUE
node The name of the node. TRUE

  • Example:
dxcli start-disk 9b85d24a-5c5a-136d-e3ba-7ffd9584feaf node1

 

start-disk-associates

  • Description: Starts all associated disks in a diskgroup.
  • Syntax:
dxcli start-disk-associates <disk_id> <node>
  • Parameters:
Name Description Required
disk_id The ID of the disk. TRUE
node The name of the node. TRUE

  • Example:
dxcli start-disk-associates 9b85d24a-5c5a-136d-e3ba-7ffd9584feaf node1

 

start-docker

  • Description: Starts the specified docker.
  • Syntax:
dxcli start-docker <vhost> <docker>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
docker The name of the docker. TRUE

  • Example:
dxcli start-docker vhost1 centos1

 

start-instance

  • Description: Starts the specified instance.
  • Syntax:
dxcli start-instance <vhost>\<instance>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
instance The name of the instance. TRUE

  • Example:
dxcli start-instance vhost1\instance1

 

start-service

  • Description: Starts the specified service.
  • Syntax:
dxcli start-service <vhost> <service>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
service The name of the service. TRUE

  • Example:
dxcli start-service vhost1 spooler

 

start-volume

  • Description: Starts the specified volume on a node.
  • Syntax:
dxcli start-volume <volume_id> <node>
  • Parameters:
Name Description Required
volume_id The ID of the volume. TRUE
node The name of the node. TRUE

  • Example:
dxcli start-volume 8218ceeb-6ff1-4818-89e9-4d7f1a7ad0ef node1

 

stop-disk

  • Description: Stops the specified disk.
  • Syntax:
dxcli stop-disk <disk_id>
  • Parameters:
Name Description Required
disk_id The ID of the disk. TRUE

  • Example:
dxcli stop-disk 9b85d24a-5c5a-136d-e3ba-7ffd9584feaf

 

stop-disk-associates

  • Description: Stops all associated disks in a diskgroup.
  • Syntax:
dxcli stop-disk-associates <disk_id>
  • Parameters:
Name Description Required
disk_id The ID of the disk. TRUE

  • Example:
dxcli stop-disk-associates 9b85d24a-5c5a-136d-e3ba-7ffd9584feaf

 

stop-docker

  • Description: Stops the specified docker.
  • Syntax:
dxcli stop-docker <vhost> <docker>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
docker The name of the docker. TRUE

  • Example:
dxcli stop-docker vhost1 centos1

 

stop-instance

  • Description: Stops the specified instance.
  • Syntax:
dxcli stop-instance <vhost>\<instance>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
instance The name of the instance. TRUE

  • Example:
dxcli stop-instance vhost1\instance1

 

stop-service

  • Description: Stops the specified service.
  • Syntax:
dxcli stop-service <vhost> <service>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
service The name of the service. TRUE

  • Example:
dxcli stop-service vhost1 spooler

 

stop-volume

  • Description: Stops the specified volume.
  • Syntax:
dxcli stop-volume <volume_id>
  • Parameters:
Name Description Required
volume_id The ID of the volume. TRUE

  • Example:
dxcli stop-volume 8218ceeb-6ff1-4818-89e9-4d7f1a7ad0ef

 

test-connection

  • Description: Tests cluster communication.
  • Syntax:
dxcli test-connection
  • Parameters:None
  • Example:
dxcli test-connection

 

test-witness

  • Description: Tests the availability and authentication to the UNC network share(s).
  • Syntax:
dxcli test-witness <share> <user> <password>
  • Parameters:
Name Description Required
share The UNC path of the network shares). Delimited by comma. TRUE
user The name of the user. TRUE
password The password of the user (encrypted using "dxcli encrypt-text" recommended). TRUE

  • Example1:
dxcli test-witness "\\server1\myshare1" "user1" "6pnFaDrRS+W/F+dkRuPKAA=="
  • Example2:
dxcli test-witness "\\mystorage.file.core.windows.net\azshare1" "mystorage" "/nbFVz1fOKH7b0RaY/5Ms8uytbY99PZsspZkcHvNtVRj//pUk4jUPV7owaUSuDd6eExv96sBvkCXsleATEsT33=="

 

test-witness-ex

  • Description: Tests the availability and authentication to the UNC network share(s) and/or Azure Blob Storage connection string or SAS URL. Prefix with “az:” if using Azure Blob Storage connection string or SAS URL.
  • Syntax:
dxcli test-witness-ex <witness1> <...>
   <witness1> : <witness_path|user|password>
  • Parameters:
Name Description Required
witness1 A set of parameters for the witness. TRUE
... A set of parameters for each additional witness to validate. FALSE
witness_path The UNC path of the network share or Azure Blob Storage connection string or SAS URL. Prefix with "az:" if using Azure Blob Storage connection string or SAS URL. Empty to remove current cluster witness settings. TRUE
user The name of the user. Not specified for Azure Blob Storage connection string or SAS URL. FALSE
password The password of the user (encrypted using "dxcli encrypt-text" recommended). Not specified for Azure Blob Storage connection string or SAS URL. FALSE

  • Example1:
dxcli test-witness-ex "\\server1\myshare1|user1|6pnFaDrRS+W/F+dkRuPKAA=="
  • Example2:
dxcli test-witness-ex "\\mystorage.file.core.windows.net\azshare1|mystorage|/nbFVz1fOKH7b0RaY/5Ms8uytbY99PZsspZkcHvNtVRj//pUk4jUPV7owaUSuDd6eExv96sBvkCXsleATEsT33=="
  • Example3:
dxcli test-witness-ex "az:DefaultEndpointsProtocol=https;AccountName=mystorage;AccountKey=/nbFVz1fOKH7b0RaY/5Ms8uytbY99PZsspZkcHvNtVRj//pUk4jUPV7owaUSuDd6eExv96sBvkCXsleATEsT33==;EndpointSuffix=core.windows.net"
  • Example4:
dxcli test-witness-ex "az:https://mystorage.blob.core.windows.net/?sv=2020-02-10&ss=b&srt=o&sp=rwdlactfx&se=2021-06-09T13:15:48Z&st=2021-06-09T05:15:48Z&spr=https&sig=cRDqOc25lpHfbP8X1hlkDnV4H1wJycCyuuqlgu8U1xg%3D"
  • Example5:
dxcli test-witness-ex "\\server1\myshare1|user1|6pnFaDrRS+W/F+dkRuPKAA==" "\\mystorage.file.core.windows.net\azshare1|mystorage|/nbFVz1fOKH7b0RaY/5Ms8uytbY99PZsspZkcHvNtVRj//pUk4jUPV7owaUSuDd6eExv96sBvkCXsleATEsT33==" "az:DefaultEndpointsProtocol=https;AccountName=mystorage;AccountKey=/nbFVz1fOKH7b0RaY/5Ms8uytbY99PZsspZkcHvNtVRj//pUk4jUPV7owaUSuDd6eExv96sBvkCXsleATEsT33==;EndpointSuffix=core.windows.net"

 

unfreeze-node

  • Description: Unfreezes the specified cluster node and enables automatic failover.
  • Syntax:
dxcli unfreeze-node <node>
  • Parameters:
Name Description Required
node The name of the node. TRUE

  • Example:
dxcli unfreeze-node node1

 

unfreeze-vhost

  • Description: Unfreezes the specified Vhost and enables automatic failover.
  • Syntax:
dxcli unfreeze-vhost <vhost>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE

  • Example:
dxcli unfreeze-vhost vhost1

 

update-addressfilter

  • Description: Updates an address filter to accept or deny connections from specific IP addresses or subnets.
  • Syntax:
dxcli update-addressfilter <name> <address>,<action[accept|deny]>|<address>,<action[accept|deny]> <default_action[accept|deny]>
  • Parameters:
Name Description Required
name The name of the filter. TRUE
address The IP address or subnet. TRUE
action[accept|deny] Whether or not to accept or deny the IP address or subnet. TRUE
default_action[accept|deny] Whether or not the default action for the filter is to accept-all or deny-all connections outside of the specified IP or subnet. TRUE

  • Example:
dxcli update-addressfilter filter1 "10.1.1.0,accept|10.1.2.0,accept" deny

 

update-client

  • Description: Updates the specified client.
  • Syntax:
dxcli update-client <client_name> <password> [client_description] [max_session_count]
  • Parameters:
Name Description Required
client_name The name of the client. TRUE
password The password of the client. TRUE
client_description The description for the client. FALSE
max_session_count The number of client sessions allowed. FALSE

  • Example:
dxcli update-client client1 p@ssw0rd 10 "Accounting Admins"

 

update-client-group

  • Description: Updates an existing client group.
  • Syntax:
dxcli update-client-group <group_name> <member_delta_list [+|-]> [group_description]
  • Parameters:
Name Description Required
group_name The name of the group. TRUE
member_delta_list A list of clients to either add or remove. TRUE
group_description The description for the group. FALSE

  • Example:
dxcli update-client-group group1 client1,-client2

 

update-contact

  • Description: Updates the contact in the address book.
  • Syntax:
dxcli update-contact <name> <email>
  • Parameters:
Name Description Required
name The name of the contact. TRUE
email The email address of contact. TRUE

  • Example:
dxcli update-contact user1 user1@mail.com

 

update-disk

  • Description: Updates the disk label.
  • Syntax:
dxcli update-disk <disk_id> <label>
  • Parameters:
Name Description Required
disk_id The ID of the disk. TRUE
label The label for the disk. TRUE

  • Example:
dxcli update-disk 23d6d8a0-c3bd-0ec3-9e98-c0021494b827 "Disk 1"

 

update-policy

  • Description: Update policy.
  • Syntax:
dxcli update-policy <SYSTEM|PERF|ALLOC|FILTER> <guid> [description] <counter> <object> <threshold> <emails> <script_path> <priority> [filter_options]
  • Parameters:
Name Description Required
SYSTEM System type policy. Used to alert when a system is down. TRUE
PERF Performance type policy. Used to alert when performance thresholds are hit. TRUE
ALLOC Allocation type policy. Used to alert when allocation thresholds are hit. TRUE
FILTER Global filter alert type policy. TRUE
guid The globally unique identifier (GUID) of the policy. TRUE
description The description for the policy. FALSE
counter The performance counter or type of resource to be monitored (E.g. System-Disk-Io, System-Down, System-Free-Memory, System-Networking). TRUE
object The node to attach to. TRUE
threshold When to invoke alert i.e. 99 (where resource hits 99%). TRUE
email The email recipient(s) for alerts. TRUE
script_path The full path of a script to invoke. TRUE
priority The priority level 0-5. TRUE
filter_options Enables the policy when set to True. FALSE

  • Example:
dxcli update-policy PERF "f7d70673-dde1-4b71-84a7-ae7324e4ace4" "test" System-Disk-Io "node1" "99" "user1@mail.com" "c:\scripts\script.ps1" 0 true

 

update-share

  • Description: Updates the file share.
  • Syntax:
dxcli update-share <vhost> <share_name> [/remarks:"text"] [/unlimited|/users:number] [/cache:Manual|Documents|Programs|BranchCache|None] [/grant:user,[READ|CHANGE|FULL]
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
share_name The name of the share. TRUE
remarks Remarks to add to the share. FALSE
/unlimited|/users The number of users allowed. FALSE
cache The cache options for the share (manual, documents, programs, branchcache, none). FALSE
/grant:everyone,read Grant everyone read permissions. FALSE
/grant:user1,read Grant specific user permissions. FALSE

  • Example:
dxcli update-share vhost1 "share1=c:\mount1\share1" /remarks:"This is fileshare1" /unlimited /cache:manual /grant:everyone,READ

 

update-tunnel

  • Description: Update an existing tunnel.
  • Syntax:
dxcli update-tunnel <name> <enabled [true|false]> <destination_node_name> <destination_address:destination_port> <origin_node,origin_address:origin_port[,address_filter]>|<origin_node,origin_address:origin_port[,address_filter]> [vhost]
  • Parameters:
Name Description Required
name The name of the tunnel. TRUE
enabled Enable the tunnel (true or false). TRUE
destination_node The name of the destination node. TRUE
destination_address The IP address of the tunnel destination. TRUE
destination_port The port number for the destination IP. TRUE
origin_node The name of the node where the listener is active. TRUE
origin_address Set to 0.0.0.0 to allow all IP connections or 127.0.0.1 for local connections only. TRUE
origin_port The port number for the origin node. TRUE
address_filter The name of the address filter to add to the tunnel. FALSE
vhost The name of the Vhost. FALSE

  • Example:
dxcli update-tunnel tunnel1 true node1 10.1.200.62:30004 "node2,0.0.0.0:30004/FILTER1|node3,127.0.0.1:30004/FILTER2" VHOST1

 

update-tunnel-clients

  • Description: Updates the clients associated with a tunnel.
  • Syntax:
dxcli update-tunnel-clients <tunnel_name> [modifier]<client_name>:<ip_address>:<endpoint> [modifier]<client_group>:<ip_address>:<endpoint>
  • Parameters:
Name Description Required
tunnel_name The name of the tunnel. TRUE
modifier Plus (+) or minus (-) symbol to add or remove a client or client group from the tunnel group (the plus sign may be omitted for add parameters). FALSE
client_name The name of the client to add or remove from the tunnel (multiple clients can be specified by delimiting the list with a comma after each endpoint). If no clients are specified, then this parameter needs to be replaced with empty quotes (""). TRUE
client_group The name of the client group to add or remove from the tunnel (multiple client groups can be specified by delimiting the list with a comma after each endpoint). FALSE
ip_address The IP address the client or client group uses to connect to the tunnel. TRUE
endpoint The listening port the client or client group uses to connect to the tunnel. TRUE

  • Example:
dxcli update-tunnel-clients tunnel1 client1:127.0.0.1:30001,client2:127.0.0.1:40001,-client3:127.0.0.1:40001 clientgroup1:127.0.0.1:40001

 

update-vhost

  • Description: Updates the node list for an existing Vhost.
  • Syntax:
dxcli update-vhost <vhost> <nodes>
  • Parameters:
Name Description Required
vhost The name of the Vhost TRUE
nodes A comma separated list of node names. TRUE

  • Example:
dxcli update-vhost vhost1 "node1,node3,node2"

 

vhost-get-docker-images

  • Description: Gets a list of the available docker images.
  • Syntax:
dxcli vhost-get-docker-images <vhost>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE

  • Example:
dxcli vhost-get-docker-images vhost1

 

vhost-get-services

  • Description: Gets a list of the available Vhost services.
  • Syntax:
dxcli vhost-get-services <vhost>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE

  • Example:
dxcli vhost-get-services vhost1

 

vhost-get-sql-instances

  • Description: Gets a list of the available SQL instances.
  • Syntax:
dxcli vhost-get-sql-instances <vhost>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE

  • Example:
dxcli vhost-get-sql-instances vhost1

 

vhost-set-diskgroup

  • Description: A pipe (|) delimited list of disk IDs to be added to the specified Vhost diskgroup. The disk(s) will be brought online on the active node of the Vhost. The list of disk IDs must include all disk(s) that are to be assigned to the diskgroup.
  • Syntax:
dxcli vhost-set-diskgroup <vhost> <disk_ids>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
disk_ids A full list of pipe (|) delimited disk IDs to add to the diskgroup. TRUE

  • Example:
dxcli vhost-set-diskgroup vhost1 "9b85d24a-5c5a-136d-e3ba-7ffd9584feaf|23d6d8a0-c3bd-0ec3-9e98-c0021494b827"

 

vhost-set-docker-image

  • Description: Sets the docker to use the specified image.
  • Syntax:
dxcli vhost-set-docker-image <vhost> <docker> <image>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
docker The name of the docker. TRUE
image The name of the docker image. TRUE

  • Example:
dxcli vhost-set-docker-image vhost1 centos1 centosimage

 

vhost-start-diskgroup

  • Description: Starts the Vhost diskgroup on the specified node.
  • Syntax:
dxcli vhost-start-diskgroup <vhost> <node>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
node The name of the node. TRUE

  • Example:
dxcli vhost-start-diskgroup vhost1 node1

 

vhost-start-node

  • Description: Starts the Vhost on the specified node.
  • Syntax:
dxcli vhost-start-node <vhost> <node> [force_failover_with_data_loss <true|false>]
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
node The name of the node. TRUE
force_failover_with_data_loss Whether or not to force the AG to failover to an asynchronous replica. FALSE

  • Example:
dxcli vhost-start-node vhost1 node1 true

 

vhost-stop-diskgroup

  • Description: Stops the diskgroup on the specified Vhost.
  • Syntax:
dxcli vhost-stop-diskgroup <vhost>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE

  • Example:
dxcli vhost-stop-diskgroup vhost1

 

vhost-stop-node

  • Description: Stops the specified Vhost.
  • Syntax:
dxcli vhost-stop-node <vhost> [node] [disabled]
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
node The name of the node. FALSE
disabled Option to also disable the node. FALSE

  • Example:
dxcli vhost-stop-node vhost1

 

vhost-update-vips

  • Description: Updates the specified Vhost virtual IPs.
  • Syntax:
dxcli vhost-update-vips <vhost> <vips>
  • Parameters:
Name Description Required
vhost The name of the Vhost. TRUE
vips Comma delimited list of virtual IP(s). TRUE

  • Example:
dxcli vhost-update-vips vhost1 10.2.2.29