Remote

Establishes a connection to a remote configuration receiver for one command or for subsequent commands. The named [and possibly remote addressed] configuration must exist and be operational.

A single command can be executed by being declared directly on the remote command line following the -execute operand. In this case the connection is established, the command is executed, and then the session is disconnected. A common use of this command form is to use a single [local] scheduler to cause commands to be issued to other configurations or iWay Integration Applications (iIAs).

If a single command is not specified, then a link is opened for subsequent commands. A common use of this form is to run commands to control several activities on the addressed configuration or iIA. In such a use case, once established, until the receiver is reset to the current configuration, all commands are executed by the addressed remote configuration.

You can also remote to a configuration running on another installation. To do this, you need to know the URL to reach the command handler of the configuration or the URL of the master configuration on that host. Each configuration has a command port which is shown in the control console for that configuration. Usually, the port for the base configuration on an installation is 9999, but can be changed during the installation. As additional configurations are created, they are assigned port numbers increasing by a value of one (for example, 10000, 10001, and so on). Again, this can be changed when the configuration is created. The port is in the Server Management (Manage configurations and users) page, as shown in the following image:

Some commands cannot be executed by a remote configuration. These include spool and remote.

remote -reset | -display | -host URL [-config <configuration name>] [-user user] [-password password] [-execute <command>]

Keyword

Use

Comments

-display

Show the current state of the remote connections.

-config <string>

Address the named configuration.

The keyword -config is optional in which case the name should be the first operand.

-host <url>

URL of the iSM (iwayhome) host.

The default is the current configuration. The URL should be the address of the master configuration. The default port is 9999.

-user <string>

Authorized user on the remote configuration.

The default is the current user.

-password <string>

Authorized credential for this user on the remote configuration.

The default is the current password.

-reset

Disconnect from the remote target and return to the local command handler.

-execute <command>

One command to be executed on the remote computer.

Surround multiple token command with quotes.

Examples:

  1. This example establishes a remote session to a local configuration named test and starts several channels.
    ->remote test
    ->start chan1*
    ->start two*
    ->remote -reset

    Note: The start chan1* command starts all channels that begin with chan1.

  2. This example stops a single channel on a remote configuration named test on the host otherhost.
    remote test -host otherhost  -exec 'stop one*'