SharePlex 9.2.6 - Administration Guide

Command guidelines

Observe the following when issuing commands:

• To issue commands for a machine, sp_cop must be running on that machine.
• Enter the syntax exactly as shown in the command description in the SharePlex Reference Guide.
• The maximum string length of a SharePlex command is 255 characters, including spaces. To work around this operating-system limitation, use the edit command.

• Use the redo command to execute the previous command again without having to retype it. This command is useful when you are making frequent status checks with the information commands, for example using the qstatus command to monitor changes in queue volume.

• To view descriptions and syntax for SharePlex commands from within the sp_ctrl interface, issue the help command. To view just the syntax for a command, issue the usage command.

• Use the usage command to view the syntax for a SharePlex command. You can enter the entire command or just the first few keywords. For example, type usage compare to view syntax for both the compare using and compare commands.

• Use the edit command to edit a previously issued command.

• Use the authlevel command to determine your authorization level for issuing SharePlex commands on a system.

For more information, see About the SharePlex security groups.

Issue commands on a remote system

To issue a command that will affect a remote machine and to script commands that include a login name, password, port number, or combination of those items, use one of the [onhost] command options. These options are available for most commands.

The following table describes the command options for remote connection using the [onhost] options.

These options enable you to issue the command on a remote machine and to script commands that include a login name, password, port number, or combination of those items.

Issue commands for a clustered system

To issue sp_ctrl commands on clustered systems, use the name set with the SP_SYS_HOST_NAME parameter as the host in the [on host] options when connecting from a remote system, or set it as the default for sp_ctrl by using the host command. For more information about configuring SharePlex within a cluster, see the SharePlex Installation and Setup Guide.

Add a scroll bar to output on Windows

Scrolling might be necessary to view the entire output of certain sp_ctrl commands. If your Command Prompt window does not have a scroll bar, you can change the window properties to produce one.

1. Click the Command Prompt icon at the top left corner of the console, then select Properties from the menu.

2. In the Command Prompt Properties dialog box, click the Layout tab.

3. In the Screen Buffer Size option box, increase the Height value until it produces a scroll bar in the Command Prompt window.

4. Click OK to apply the settings.

5. In the Apply Properties To Shortcut dialog box, select one of the options, either to apply the new properties to the current command session or to apply them as the new default for all sessions.

6. Click OK to close the dialog box.