> # Using the SequeLink® Manager Command-Line Tool

> The SequeLink Manager Command-Line Tool runs on Linux, UNIX, and Windows only. It allows you to configure and manage your SequeLink environment remotely from a networked client or locally from a SequeLink Server by issuing commands through the command-line interface.

> You can use any of the following methods to issue SequeLink Manager commands:

> - Direct
> - Batch
> - Interactive

> NOTE: To configure and manage SequeLink services on z/OS or to create z/OS-specific core entities such as DB2 interfaces, use the SequeLink Manager for z/OS. See "Configuring SequeLink® Services Using the SequeLink® Manager for z/OS" for more information. Monitoring can be performed using any SequeLink Manager.

> ### Direct Command Execution

> Using direct command execution, you can invoke one command at a time on the command line. The command syntax for direct execution is:

>     executable command_name [parameters]

> where:

> `executable` is installdir\admin\swcla.exe on Windows and installdir/admin/swcla.sh on Linux/UNIX. See "Invoking the SequeLink® Manager Command-Line Tool" for the parameters you can specify when invoking the tool.

> `command_name` is any SequeLink Manager command (short or long name). See "SequeLink® Manager Commands" for a list and description of each command.

> `parameters` are valid options for the specified command. When using direct command execution to issue a command, you must provide all of a command's required and optional parameters in the correct position (specify the parameters in the order they are documented).

> ### Batch Command Execution

> The batch method of executing commands allows you to execute a script file that contains SequeLink Manager commands. The command syntax for batch execution is:

>     executable -i script_file

> where:

> `executable` is installdir\admin\swcla.exe on Windows and installdir/admin/swcla.sh on Linux/UNIX. See "Invoking the SequeLink® Manager Command-Line Tool" for the parameters you can specify when invoking the tool.

> `script_file` is the name of the file to execute. This file can contain SequeLink Manager commands only. When using a script file to execute commands, you must provide all of a command's required and optional parameters in the script file (specify the parameters in the order they are documented).

> ### Interactive Command Execution

> Using interactive command execution, you do not have to specify all the command parameters on the command line. The command-line tool will prompt you for the required parameters. To start interactive mode, type:

> `executable`

> where:

> `executable` is installdir\admin\swcla.exe on Windows and installdir/admin/swcla.sh on Linux/UNIX. See "Invoking the SequeLink® Manager Command-Line Tool" for the parameters you can specify when invoking the tool.

> The tool is invoked and a command prompt is displayed, along with copyright text (unless you invoked the tool with the -nologo flag):

> `swcla>`

> At the swcla command prompt, type either a command with all of its parameters or a command name, and the tool will prompt you for the required parameters.

> To exit interactive mode, type:

>     exit

> ### General Rules

> - SequeLink Manager command names are not case-sensitive; however, the command parameter service_name is case sensitive.
> - If the value of a command parameter contains spaces, the value must be enclosed within single quotes (') or double quotes (").
> - If the value of a command parameter contains single or double quotes, use single quotes to quote double quotes and double quotes to quote single quotes.
> - The pound sign (#) is a comment character. All text that follows the pound sign on the same line is ignored.
> - When issuing commands using the direct or batch method, you must specify all of a command's required and optional parameters in the correct position (specify the parameters in the order they are documented).

> ### Invoking the SequeLink® Manager Command-Line Tool

> You invoke the SequeLink Manager Command-Line Tool using the following syntax:

>     executable [-nologo] [-i script_file] [-o output_file] [-e error_file]
>     [-l | -r host:port] [-uid user_id [-pwd password]] [command]

> where:

> `executable` is installdir\admin\swcla.exe on Windows and installdir/admin/swcla.sh on Linux/UNIX.

> `-nologo` disables the display of the copyright banner.

> `-i` `script_file` specifies a script file to execute.

> `-o` `output_file` specifies the name of a file in which the command-line tool will write all of its output (except errors).

> `-e` `error_file` specifies the name of a file in which the command-line tool will write all its errors (not normal output). All error and normal output can be written to the same file if the file specified for the `-o` and `-e` flags is the same.

> `-l` specifies to use the local host configuration.

> `-r` `host``:``port` specifies to use the remote host configuration. In this case, you must specify the host name and port of the remote server.

> `-uid` `user_id``` specifies the user ID to use for local or remote host configuration. This parameter is valid only in combination with the `-l` or `-r` parameters.

> `-pwd` `password` specifies a password to use for local or remote host configuration. This parameter is valid only in combination with the `-l` or `-r` parameters.

> `command` is the name of any SequeLink Manager command and its parameters. See "SequeLink® Manager Commands" for a list and description of each command.

> When invoking the SequeLink Manager Command-Line Tool, you must choose whether you want the tool to connect to a local SequeLink Agent (a SequeLink Agent service running on the same machine as the tool) or a remote SequeLink Agent (a SequeLink Agent service running on another machine). If you have not connected to a SequeLink Agent, the SequeLink Manager Command-Line Tool will return the following message when you issue a command:

>     [SequeLink error 5509] Command not available for current
>     configuration.

> You can invoke the SequeLink Manager Command-Line Tool and connect to a local or remote SequeLink Agent after you invoke the tool or when you invoke the tool as shown in the following examples:

> Example A: Connecting to a Local or Remote SequeLink Agent After Invoking the Tool

>     SLServer60\admin\swcla.exe

> This example invokes the tool without specifying whether it will connect to a local or remote SequeLink Agent. You must now explicitly connect to a local or remote SequeLink Agent using the ActivateLocalConfig or ActivateRemoteConfig commands described in "SequeLink® Manager Commands" before you can enter any other commands.

> Example B: Connecting to a Local SequeLink Agent When Invoking the Tool

>     SLServer60\admin\swcla.exe -l

> This example connects the tool to a local SequeLink Agent. The administrator will be prompted for the user ID and password for the SequeLink administrator. The administrator can now enter any SequeLink Manager command described in "SequeLink® Manager Commands".

> Example C: Connecting to a Remote SequeLink Agent When Invoking the Tool

>     SLServer60\admin\swcla.exe -r

> This example connects the tool to a remote SequeLink Agent. The administrator will be prompted for the host name and port of the remote server. Then, the administrator will be prompted for the user ID and password for the SequeLink administrator. The administrator can now enter any SequeLink Manager command described in "SequeLink® Manager Commands".

> ### Displaying Help for a Command

> To display help for a command, type the following at a command-line tool prompt:

>     help [long_command_name | short_command_name]

> For example:

>     help DataSourceCreate

> You can also display help about the different options you have when invoking the command-line tool. To do this, type the following at a command-line tool prompt:

>     help