GitHubContribute in GitHub: Open doc issue|Edit online

Remote Command Line Function Component

The Remote Command Line Function Component (Remote CLFC) enables command line system calls to be executed on remote machines. You can use the information provided here to know further about Remote Command Line FC.

The design and implementation uses the RXA toolkit v2.2 to connect to remote machines, execute the commands and return the results. The returned output can then be parsed to be consumed one value at a time and detect any problems with the executed command.

The Remote CLFC has the ability to connect to remote machines using any of the following protocols: RSH, REXEC, SSH, AS400 or Windows. You can select which of the protocols will be used; however, if left to the default value of 'ANY', the FC will attempt to connect to the remote machine using each of the available protocols one-by-one until a successful connection is made.

The RXA libraries used by this FC support interactive SSH sessions only; non-interactive SSH sessions are not supported.

You will need to provide information about the remote machine including hostname, username and password. If the connection is being made using the SSH protocol then you have the option of providing a keystore name and passphrase instead of using a password for authentication.

Note: SSH Connections are typically associated with Linux/UNIX hosts. However, by installing Cygwin and the Cygwin openssh package on the Windows target machine the SSH protocol can be used with those targets as well.

  • Configuration
    You can use the parameters provided here to configure the Remote Commandline FC.
  • Function Component Input
    You can provide some of the parameters configured in the Configuration screen of the Remote CLFC as Attributes mapped from the work Entry in the Input Map. When present and non-empty, they take precedence over the parameters in the Configuration screen as listed here.
  • Function Component Output
    You can use the attributes provided here to work with the output.
  • Using the FC
    You can use the information and links provided here to know the usage of Remote Commandline FC.