dssagenttest - DSS 6 | Data Source Solutions Documentation

Documentation: dssagenttest - DSS 6 | Data Source Solutions Documentation

dssagenttest

Usage

<b>dssagenttest</b> [<b>-C</b><em>agent_pub_cert_fname</em>] [<b>-K</b><em>client_pub_cert_fname</em>] <br /> [<b>-k</b><em>client_priv_key_fname</em>] [<b>-L</b><em>user</em>[<em>/pwd</em>]] [<b>-S</b>] [<b>-s</b><em>token</em>] <em>host port</em>

Description

Command dssagenttest tests the remote connection to DSS Agent. To test the connection to the DSS Agent, execute the command dssagenttest on the machine from which you are connecting to the DSS Agent. You can also check whether dssagentlistener is running by executing the dssagenttest command directly on the DSS Agent machine.

Options

This section describes the options available for command dsstestagent.

Parameter Description
-Cagent_pub_cert_fname

The directory path where a PEM file containing the agent public certificate is located. This is required to verify the identity of the remote DSS Agent by verifying its public certificate. For more information, see the agent property Agent_Server_Public_Certificate.

-Kclient_pub_cert_fname

The directory path where a PEM file containing the client public certificate is located. This is required to verify the public certificate and private key (option -k) of the hub that connects to the agent. For more information, see the repository property Agent_Client_Public_Certificate.

-kclient_priv_key_fname

The directory path where a PEM file containing the client private key is located. A password will be prompted for the client private key. For more information, see the repository properties Agent_Client_Private_Key and Agent_Client_Private_Key_Password.

-Luser[/pwd]

Authenticate with the user name (user) or user name and password (user/pwd) on the agent machine for connecting the hub to the agent. If you do not specify a password pwd, it will be prompted for.

This option cannot be combined with options -S and -s.

For more information, see the location properties Agent_User and Agent_Password.

-Ttestcase

Perform test (requires successful authorization).

Valid values for testcase are:

  • perf: Performance test
  • ping: Network performance test
  • echo: Network liveliness test: echo
  • sleep: Network liveliness test: sleep
-tN Timeout after N seconds if the network is hanging or it takes too long for the agent to reply.
-S

Authenticate using the time-based setup mode. This option cannot be combined with options -L and -s.

For more information, see the agent property Setup_Mode_Timed_Until.

-stoken

Authenticate using the token-based setup mode. This option cannot be combined with options -L and -S.

For more information, see the agent properties Setup_Mode_Token_Name and Setup_Mode_Token_Value.

-v Verbose. Print the discovered location properties of the agent.

Examples

This section provides examples of using the dssagenttest command.

Example 1. Check connection to DSS Agent

You can check the connection to the DSS Agent installed/running on a remote machine with username and password authentication enabled. Execute the following command on the hub machine or on the machine from which you are connecting to the DSS Agent:

dssagenttest -L myuser/mypassword mynode 4343

Sample output in Linux with successful authentication and also indicating that the agent listener is running:

dssagenttest: DSS 6.0.1/2 (linux_glibc2.17-x64-64bit)
dssagenttest: Agent version 6.0.1/2.
dssagenttest: Authentication with username and password enabled.
dssagenttest: Authentication successful.
dssagenttest: Finished. (elapsed=0.34s)
Example 2. Check whether dssagentlistener is running

After installing and starting the DSS Agent Listener service, you can verify whether the dssagentlistener is running on the agent machine. Execute the following command on the agent machine:

dssagenttest mynode 4343

Sample output in Windows with successful authentication indicating that the agent listener is running:

dssagenttest: DSS 6.0.1/2 (windows-x64-64bit)
dssagenttest: Agent version 6.0.1/2.
dssagenttest: Authentication with username and password enabled.
dssagenttest: Authentication successful.
dssagenttest: Finished. (elapsed=0.18s)