Use a Server Command Line Tool Option and Command

The Geo SCADA Expert Server Command Line Tool has several options that you may need to use before you can issue a Geo SCADA Expert command (depending on the configuration of your system).

The options available are:

• -s server [:port]

  This allows you to connect to a specific server via a specific port. The 'server' part of the entry is the name of the server PC or the IP address of the server PC.

• -u user

  This allows you to log on to a system via a Geo SCADA Expert user account (either one that is managed directly in Geo SCADA Expert, or one that is associated with a Windows or LDAP User Profile). This option is required if access to the server features is restricted by user account permissions. The 'user' part of the entry is the name of the user account.

• -p password

  Use this option to enter the password that is associated with the user account that you specified using the -u option, above. You need to include the password if access to server features is restricted by user account permissions. The 'password' part of the entry is the password that is required to gain access via the user account.

If the name of a value for an option includes a space, you have to enclose the value in double quotes. Remember that if the options need to be used, they have to be defined before you enter the command.

To run a command in the Geo SCADA Expert Server Command Line Tool:

1. Access the Server Command Line Tool

   If the Geo SCADA Expert server is configured to only communicate with clients that provide valid client certificates, you have to run the Server Command Line Tool on the server itself. A server requires the clients to have certificates if its Require Client Certificates check box is enabled in the Connection Security section of the Server Configuration Tool (see Configure the Connection Security Settings).

2. Enter any required options to connect, and log on, to the server (as described above).
3. Enter the required command and any required values, such as the name of a driver.
4. Press the Enter key.
   The command will run. If the command is successful, the expected result will occur (for example, a list of enabled logging options will be returned, or a driver will restart). If Geo SCADA Expert detects that the command has failed or the syntax is invalid, a diagnostic message is displayed providing further information.

   Example:

   SCXCmd -s ServerA:5481 -u "Engineer1" -p "Geo SCADA Expert23" SHOWLOG DB

   This command performs the following:

   • Connects to the system via port 5481 on the server that is named ServerA
   • Logs on to the server via the user account named Engineer1 using the password Geo SCADA Expert23
   • Performs the SHOWLOG command, which returns a list of the database (DB) logging options that are currently enabled. The logging options are displayed as acronyms in the Command Prompt window. (You can ascertain the meaning of the acronyms by looking at the Logging section of the Geo SCADA Expert Server Status Tool (see Logging in the Geo SCADA Expert Guide to the Server Status Tool).)

You can display a list of the commands that are available from the Geo SCADA Expert Server Command Line Tool by entering SCXCmd -h at the command prompt and pressing the Enter key. You can also display the list of commands by entering SCXCmd -? and pressing the Enter key. When you display the command list, you will see that the keyword for each command is shown along with a description of the command's function.

The commands are in uppercase. Some commands have lower case components. The lower case indicates that you have to define a value for that part of the command.

For a list of the drivers that are installed on your system and to ascertain the driver names in the format that you can use with a driver command, access the Modules section of the Geo SCADA Expert Server Status Tool (see Run the Server Status Tool in the Geo SCADA Expert Guide to the Server Status Tool).

For the LOG commands, you can obtain or change the logging options for the database or a specified driver. To do this, you enter any options that are required to connect and log on to the server (see earlier in this topic), followed by the relevant LOG command and either DB (for the Geo SCADA Expert database), or the name of the driver. With some LOG commands, you also need to specify the relevant logging option(s).

For the SHOWDIAG command, there is a built-in help display that provides a list of the classes of diagnostic information you can display. Run the SHOWDIAG HELP command to access the list, and then run the SHOWDIAG command followed by the keyword for the class of diagnostic information you require. For example SHOWDIAG DAITEM for diagnostic information about OPC DA items. (Remember to precede the command with the options that are required to enable you to connect and log on to the server (see earlier in this topic).)