DH2i DxOdyssey 21.0 Software: DxCLI Guide
Summary
This document contains the list of DxCLI commands used for DxOdyssey administration.
Table of contents
activate-server
gateway-group-add-tunnel-group |
get-client-connections | remove-tunnel |
Command Details
activate-server
- Description: Activates the server via internet using the provided license key. See get-license-request for off-line gateway activation.
- Syntax:
dxcli activate-server <key> [gateway]
- Parameters:
Name | Description | Required |
---|---|---|
key | The license key. | TRUE |
gateway | The name of the gateway (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-client
- Description: Adds a DxConnect client to the gateway group.
- 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-gateway
- Description: Adds gateway(s) to a tunnel group.
- Syntax:
dxcli add-gateway <tunnel_group> <gateway>
- Parameters:
Name | Description | Required |
---|---|---|
tunnel_group | The name of the tunnel group. | TRUE |
gateway | The name of the gateway to add to the tunnel (multiple gateways can be specified by delimiting with a comma). | TRUE |
- Example:
dxcli add-gateway tunnelgroup1 gateway1,gateway2,gateway3
add-tunnel
- Description: Add a tunnel to the cluster.
- Syntax:
dxcli add-tunnel <name> <enabled [true|false]> <destination_gateway> <destination_address:destination_port> <origin_gateway,origin_address:origin_port,[address_filter]>|<origin_gateway,origin_address:origin_port,[address_filter]>
- Parameters:
Name | Description | Required |
---|---|---|
name | The name of the tunnel. | TRUE |
enabled | Enable the tunnel (true or false). | TRUE |
destination_gateway | The name of the destination gateway. | TRUE |
destination_address | The IP address of the tunnel destination. | TRUE |
destination_port | The port number for the destination IP. | TRUE |
origin_gateway | The name of the gateway 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 gateway. | TRUE |
address_filter | The name of the address filter to add to the tunnel. | FALSE |
tunnel-group | The name of the tunnel group. | FALSE |
- Example:
dxcli add-tunnel tunnel1 true gateway1 10.1.200.62:30004 "gateway2/0.0.0.0:30004/FILTER1|gateway3/127.0.0.1:30004/FILTER2"
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=="
clear-otpk
- Description: Clears and invalidates any generated one-time passkey for the gateway group.
- Syntax:
dxcli clear-otpk
- Parameters:None.
collect-log
- Description: Generates logs on all gateway group members; gateways can be specified using parameters. For Windows, the logs are created in the installation directory for DxOdyssey in the “Support” folder (Default “C:\Program Files\DH2i\Support”). For Linux, the logs are located in “/opt/dh2i/support”.
- Syntax:
dxcli collect-log [gateway]
- Parameters:
Name | Description | Required |
---|---|---|
gateway | The name of the gateway (multiple gateways can be specified by delimiting with a comma). | FALSE |
- Example:
dxcli collect-log gateway1,gateway2,gateway3
deactivate-server
- Description: Deactivates the specified gateway.
- Syntax:
dxcli deactivate-server <gateway>
- Parameters:
Name | Description | Required |
---|---|---|
gateway | The name of the gateway. | TRUE |
- Example:
dxcli deactivate-server gateway1
encrypt-text
- Description: Encrypts text for use in other DxCLI commands.
- Syntax:
dxcli encrypt-text <text>
- Parameters:
Name | Description | Required |
---|---|---|
text | The text to be encrypted. | TRUE |
- Example:
dxcli encrypt-text passw0rd
export-config
- Description: Exports a DxConnect configuration file to be used on DxConnect client machines. The file will be created in the working directory.
- Syntax:
dxcli export-config <filename>
- Parameters:
Name | Description | Required |
---|---|---|
filename | The name of the file, including the .dh2i extension. | TRUE |
- Example:
dxcli export-config dxo_client.dh2i
gateway-group-add-tunnel-group
- Description: Creates a tunnel group.
- Syntax:
dxcli gateway-group-add-tunnel-group <tunnel_group> <virtual_ip> <gateway>
- Parameters:
Name | Description | Required |
---|---|---|
tunnel_group | The name for the tunnel group. | TRUE |
virtual_ip | The virtual IP address(es) assigned to the tunnel group. If the loopback address is provided, add an asterisk (*) at the beginning of the address. Multiple virtual IPs can be specified by delimiting with a comma. | TRUE |
gateway | The gateway(s) to add to the tunnel group. Multiple gateways can be specified by delimiting with a comma. | TRUE |
- Example:
dxcli gateway-group-add-tunnel-group tunnelgroup1 *127.0.0.1,10.1.201.170 gateway1,gateway2,gateway3
gateway-group-disable-gateway
- Description: Disables the specified gateway.
- Syntax:
dxcli gateway-group-disable-gateway <gateway>
- Parameters:
Name | Description | Required |
---|---|---|
gateway | The name of the gateway. | TRUE |
- Example:
dxcli gateway-group-disable-gateway gateway1
gateway-group-enable-gateway
- Description: Enables the specified gateway.
- Syntax:
dxcli gateway-group-enable-gateway <gateway>
- Parameters:
Name | Description | Required |
---|---|---|
gateway | The name of the gateway. | TRUE |
- Example:
dxcli gateway-group-enable-gateway gateway1
gateway-group-get-features
- Description: Gets all gateway group members’ enabled features on a per-gateway basis, in XML.
- Syntax:
dxcli gateway-group-get-features
- Parameters: None
- Example:
dxcli gateway-group-get-features
gateway-group-get-licenses
- Description: Outputs the licenses used by each gateway group member.
- Syntax:
dxcli gateway-group-get-licenses
- Parameters:None.
gateway-group-remove-tunnel-group
- Description: Removes a tunnel group from the gateway group.
- Syntax:
dxcli gateway-group-remove-tunnel-group <tunnel_group>
- Parameters:
Name | Description | Required |
---|---|---|
tunnel_group | The name of the tunnel group. | TRUE |
- Example:
dxcli gateway-group-remove-tunnel-group tunnelgroup1
gateway-group-resync
- Description: Forces a resynchronization of the gateway group.
- Syntax:
dxcli gateway-group-resync
- Parameters:None.
gateway-group-set-secret
- Description: Begins process of setting the gateway group passkey. This command cannot be run remotely.
- Syntax:
dxcli gateway-group-set-secret
- Parameters:None.
gateway-group-set-secret-ex
- Description: Sets the cluster passkey. This command cannot be run remotely.
- Syntax:
dxcli gateway-group-set-secret-ex <passkey>
- Noninteractive only.
- Parameters:
Name | Description | Required |
---|---|---|
passkey | The passkey to use for the gateway group. | TRUE |
- Example:
dxcli gateway-group-set-secret-ex P@ssw0rd
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-alerts
- Description: Outputs any active alerts for the gateway group.
- Syntax:
dxcli get-alerts
- Parameters:None.
get-client-connections
- Description: Outputs DxConnect clients that are connected to the gateway group.
- Syntax:
dxcli get-client-connections
- Parameters:None.
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-coordinators
- Description: Outputs which gateway group member(s) are the gateway group (cluster) and app coordinators.
- Syntax:
dxcli get-coordinators
- Parameters:None.
get-coordinator-status
- Description: Outputs detailed status information for the gateway group coordinator.
- Syntax:
dxcli get-coordinator-status
- Parameters:None.
get-dxversion
- Description: Outputs the version of DxOdyssey installed on the gateway group member.
- Syntax:
dxcli get-dxversion
- Parameters:None.
get-features
- Description: Returns a list of features enabled on the connected gateway.
- Syntax:
dxcli get-features
- Parameters: None
- Example:
dxcli get-features
get-gateway-detail
- Description: Outputs detailed information about the current gateway.
- Syntax:
dxcli get-gateway-detail
- Parameters:None.
get-gateway-detail-xml
- Description: Outputs detailed information about the current gateway in XML format.
- Syntax:
dxcli get-gateway-detail-xml
- Parameters:None.
get-gateway-group-gateways
- Description: Outputs the name, IP, pubkey hash, status, role, and operating system of each gateway in the gateway group.
- Syntax:
dxcli get-gateway-group-gateways
- Parameters:None.
get-globalsettings
- Description: Outputs any non-default configurations of global settings.
- Syntax:
dxcli get-globalsettings
- Parameters:None.
get-interfaces
- Description: Returns an XML output of all interfaces available for connected gateway group, or a specified gateway if supplied.
- Syntax:
dxcli get-interfaces [node]
- Parameters:
Name | Description | Required |
---|---|---|
node | The name of the node | FALSE |
-
- Example:
dxcli get-interfaces GATEWAY1
get-license
- Description: Outputs the license key for the specified gateway.
- Syntax:
dxcli get-license <gateway>
- Parameters:
Name | Description | Required |
---|---|---|
gateway | The name of the gateway. | TRUE |
- Example:
dxcli get-license gateway1
get-license-detail
- Description: Returns details for license including license key, product, expirations, etc. for the connected server, or for a specified node.
- Syntax:
dxcli get-license-detail [node]
- Parameters:
Name | Description | Required |
---|---|---|
node | The name of the node | FALSE |
- Example:
dxcli get-license-detail NODE1
get-license-request
- Description: Outputs a license request for a gateway; use in conjunction with set-license. Go to https://clients.dh2i.com/Data/Activation.aspx and paste the output of get-license-request to obtain an activation response. The response from the website is used in the set-license command to activate the server.
- Syntax:
dxcli get-license-request <license_key> [gateway]
- Parameters:
Name | Description | Required |
---|---|---|
license_key | The license key used to activate the gateway. | TRUE |
gateway | The name of the gateway (if no gateway is specified, the command defaults to the currently connected gateway). | FALSE |
- Example:
dxcli get-license-request 1A2B-3C4D-5E6F-7G8H gateway2
get-otpk
- Description: Outputs the current OTPK for the gateway group and its expiration date.
- Syntax:
dxcli get-otpk
- Parameters:None.
get-producttype
- Description: Outputs the name of the DH2i software installed on the gateway. This command cannot be run remotely.
- Syntax:
dxcli get-producttype
- Parameters:None.
get-tunnel-group
- Description: Outputs configuration information for the given tunnel group.
- Syntax:
dxcli get-tunnel-group <tunnel_group>
- Parameters:
Name | Description | Required |
---|---|---|
tunnel_group | The name of the tunnel group. | TRUE |
- Example:
dxcli get-tunnel-group tunnelgroup1
get-tunnel-groups
- Description: Outputs configuration information for all tunnel groups.
- Syntax:
dxcli get-tunnel-groups
- Parameters:None.
get-witness
- Description: Get the current witness settings for the cluster.
- Syntax:
dxcli get-witness
- Parameters: None
- Example:
dxcli get-witness
join-gateway-group
- Description: Begins process of joining a gateway to a gateway group. This command cannot be run remotely.
- Syntax:
dxcli join-gateway-group
- Parameters:None.
join-gateway-group-ex
- Description: Join an existing gateway group. This command cannot be run remotely.
- Syntax:
dxcli join-gateway-group-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 the 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-gateway-group-ex 10.2.2.29 P@ssw0rd false
- Example 2:
dxcli join-gateway-group-ex match.dh2i.com 6e85fe3d-fa72-3d0c-5a02-94fddd91a2e7 true
list-globalsettings
- Description: Returns a list of all available global settings in plain text, including their definitions and defaults.
- Syntax:
dxcli list-globalsettings
- Parameters: None
- Example:
dxcli list-globalsettings
list-globalsettings-xml
- Description: Returns a list of all available global settings in XML, including their definitions and defaults.
- Syntax:
dxcli list-globalsettings-xml
- Parameters: None
- Example:
dxcli list-globalsettings-xml
remove-client
- Description: Removes a DxConnect client from the gateway group.
- Syntax:
dxcli remove-client <client>
- Parameters:
Name | Description | Required |
---|---|---|
client | The name of the client. | TRUE |
- Example:
dxcli remove-client client1
remove-client-group
- Description: Removes a DxConnect client group from the gateway group.
- Syntax:
dxcli remove-client-group <client_group>
- Parameters:
Name | Description | Required |
---|---|---|
client_group | The name of the client group. | TRUE |
- Example:
dxcli remove-client clientgroup1
remove-gateway
- Description: Removes gateway(s) from the specified tunnel group.
- Syntax:
dxcli remove-gateway <tunnel_group> <gateway>
- Parameters:
Name | Description | Required |
---|---|---|
tunnel_group | The name of the tunnel group. | TRUE |
gateway | The name of the gateway (multiple gateways can be specified by delimiting with a comma). | TRUE |
- Example:
dxcli remove-gateway tunnelgroup1 gateway2,gateway3
remove-gateway-group-members
- Description: Removes gateway(s) from the gateway group.
- Syntax:
dxcli remove-gateway-group-members <gateway>
- Parameters:
Name | Description | Required |
---|---|---|
gateway | The name of the gateway (multiple gateways can be specified by delimiting with a comma). | TRUE |
- Example:
dxcli remove-gateway-group-members gateway2,gateway3
remove-globalsetting
- Description: Resets a global setting to its default value.
- Syntax:
dxcli remove-globalsetting <setting>
- Parameters:
Name | Description | Required |
---|---|---|
setting | The name of the setting that is modified from its default value. | TRUE |
- Example:
dxcli remove-globalsetting nat.enabled
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
set-appcoordinator
- Description: Assigns the application coordinator role to the specified gateway.
- Syntax:
dxcli set-appcoordinator <gateway>
- Parameters:
Name | Description | Required |
---|---|---|
gateway | The name of the gateway. | TRUE |
- Example:
dxcli set-appcoordinator gateway2
set-gateway-group-member-addresses
- Description: Sets the gateway’s interface(s) and protocol(s) for gateway group communication.
- Syntax:
dxcli set-gateway-group-member-addresses <node> <IP Address>
- Parameters:
Name | Description | Required |
---|---|---|
node | The name of the node | TRUE |
IP Address | IP Address(es), alias(es), or asterisk(“*”). Ordered, comma delimited list for multiples of IP address and/or alias. The asterisk (*) selection will cycle through the interfaces until a valid connection is established to the other cluster members. | TRUE |
- Example 1:
dxcli set-gateway-group-member-addresses GATEWAY1 1.2.3.4
- Example 2:
dxcli set-gateway-group-member-addresses GATEWAY1 "{eth0:IPV4},172.16.1.1"
- Example 3:
dxcli set-gateway-group-member-addresses GATEWAY1 "*"
set-coordinator
- Description: Assigns the gateway group coordinator role to the specified gateway.
- Syntax:
dxcli set-coordinator <gateway>
- Parameters:
Name | Description | Required |
---|---|---|
gateway | The name of the gateway. | TRUE |
- Example:
dxcli set-coordinator gateway3
set-globalsetting
- Description: Assigns a new value to a global setting. For more information on the available global settings, please see DxCli Global Settings for DxOdyssey.
- Syntax:
dxcli set-globalsetting <setting> <value>
- Parameters:
Name | Description | Required |
---|---|---|
setting | The name of the setting. | TRUE |
value | The value to change the setting to. | TRUE |
- Example:
dxcli set-globalsetting nat.enabled true
set-license
- Description: Activates a server that has no internet connection; used in conjunction with get-license-request.
- Syntax:
dxcli set-license <license_key> <license_response> [gateway]
- Parameters:
Name | Description | Required |
---|---|---|
license_key | The license key for the gateway. | TRUE |
license_response | The activation response string given by the client portal. | TRUE |
gateway | The name of the gateway (if no gateway is specified, the command defaults to the currently connected gateway). | FALSE |
- Example:
dxcli set-license 1A2B-3C4D-5E6F-7G8H 2ki44uOaLK4gbfjSStNVUXNQsM4eMwjVRBNyAQrp6UABN0frE9ZiGwhP1oxLD+y6F5UDwfaZkTZqQF0JfoEpGhu8V8WAS/dkOGNkBqGv2Qi+Nuc21kV/d2p4elTZSdI2rGrL== gateway2
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-server
- Description: Begins the process to log into a remote gateway for administration.
- Syntax:
dxcli set-server
- Parameters:None.
set-server-ex
- Description: Sets the current server context for commands.
- Syntax:
dxcli set-server-ex <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 P@ssw0rd
set-witness
- Description: Sets the cluster witness settings.
- Syntax:
dxcli set-witness <witness1> <...> <witness1> : <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"
test-connection
- Description: Tests the connection between the gateway and the gateway group.
- Syntax:
dxcli test-connection
- Parameters:None.
test-nat
- Description: Determines NAT type for connected server.
- Syntax:
dxcli test-nat [-v]
- Parameters:
Name | Description | Required |
---|---|---|
-v | Verbose | FALSE |
- Example:
dxcli test-nat
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"
tunnel-group-start-gateway
- Description: Starts hosting the tunnel group on the specified gateway.
- Syntax:
dxcli tunnel-group-start-gateway <tunnel_group> <gateway>
- Parameters:
Name | Description | Required |
---|---|---|
tunnel_group | The name of the tunnel group. | TRUE |
gateway | The name of the gateway. | TRUE |
- Example:
dxcli tunnel-group-start-gateway tunnelgroup1 gateway2
tunnel-group-stop-gateway
- Description: Stops the specified tunnel group.
- Syntax:
dxcli tunnel-group-stop-gateway <tunnel_group>
- Parameters:
Name | Description | Required |
---|---|---|
tunnel_group | The name of the tunnel group. | TRUE |
- Example:
dxcli tunnel-group-stop-gateway tunnelgroup1
tunnel-group-update-vips
- Description: Changes the virutal IPs used by the tunnel group.
- Syntax:
dxcli tunnel-group-update-vips <tunnel_group> <vip>
- Parameters:
Name | Description | Required |
---|---|---|
tunnel_group | The name of the tunnel group. | TRUE |
vip | The IP address(es) to use (multiple IP addresses can be specified by delimiting with a comma). | TRUE |
- Example:
dxcli tunnel-group-update-vips tunnelgroup1 10.1.201.170,*127.0.0.1
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: Adds or updates a client group for the gateway group.
- Syntax:
dxcli update-client-group <group>:<client>
- Parameters:
Name | Description | Required |
---|---|---|
group | The name of the client group. | TRUE |
client | The name of the DxConnect client (multiple clients can be specified by delimiting with a comma). | TRUE |
- Example:
dxcli update-client-group group1:client1,client2,client3
update-tunnel
- Description: Update an existing tunnel.
- Syntax:
dxcli update-tunnel <name> <enabled [true|false]> <destination_gateway> <destination_address:destination_port> <origin_gateway,origin_address:origin_port,[address_filter]>|<origin_gateway,origin_address:origin_port,[address_filter]>
- Parameters:
Name | Description | Required |
---|---|---|
name | The name of the tunnel. | TRUE |
enabled | Enable the tunnel (true or false). | TRUE |
destination_gateway | The name of the destination gateway. | TRUE |
destination_address | The IP address of the tunnel destination. | TRUE |
destination_port | The port number for the destination IP. | TRUE |
origin_gateway | The name of the gateway 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 gateway. | TRUE |
address_filter | The name of the address filter to add to the tunnel. | FALSE |
- Example:
dxcli update-tunnel tunnel1 true gateway1 10.1.200.62:30004 "gateway2/0.0.0.0:30004/FILTER1|gateway3/127.0.0.1:30004/FILTER2"
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-tunnel-group
- Description: Updates the list of tunnels that are in a tunnel group.
- Syntax:
dxcli update-tunnel-group <tunnel_group> <gateway>
- Parameters:
Name | Description | Required |
---|---|---|
tunnel_group | The name of the tunnel group. | TRUE |
gateway | The name of the gateway(s) to add to the tunnel group (comma separated list for multiples). | TRUE |
- Example:
dxcli update-tunnel-group tunnelgroup1 gateway1,gateway2,gateway4