16.4.19.1 Defining a remote connection tool
Several remote access tools are already defined in GPS: ssh, rsh,
telnet and plink. It is possible to add other tools, using the node
remote_connection_config
.
The attributes for this node are:
name (string) (mandatory)
- The name of the tool. This name does not necessarilly correspond to
the command used to launch the tool.
The following children are defined:
start_command (mandatory)
- The command used to launch the tool.
This tag supports the
use_pipes
attribute. This attribute selects on
Windows the way GPS will launch the remote tools, and can take the following
values:
true
- use pipes to launch the tool.
false (default)
- use a tty emulation, which is a bit slower but allow
password prompts retrieval with some tools.
Note that this argument has effects only on Windows platforms.
start_command_common_args (optional)
- The common arguments that are provided to the tool.
start_command_user_args (optional)
- The arguments used to define a specific user during connection.
user_prompt_ptrn (optional)
- A regular expression, used to catch user name prompts from the
connection tool. If undefined, a default regular expression is used.
password_prompt_ptrn (optional)
- A regular expression, used to catch password prompts from the
connection tool. If undefined, a default regular expression is used.
passphrase_prompt_ptrn (optional)
- A regular expression, used to catch passphrase prompts from the
connection tool. If undefined, a default regular expression is used.
use_cr_lf (optional)
- Boolean value, used to tell GPS if the connection tool requires CR+LF
characters to determine an end of line, or if LF is sufficient. Set to
false by default.
extra_ptrn (optional)
- Complex child. Used to catch extra prompts from the connection tool,
other than password, passphrase or usename prompts. This tag has an
attribute
auto_answer
telling if GPS automatically answers to
this prompt, or ask the user. If auto_answer is true
, then this
tag needs an answer
child, whose value is used for the answer. If
auto_answer is false
, then this tag needs a question
child,
whose value is used as question to the end user.