Start Session
Description
This plugin is designed to start a Linux session.
Note: The step is not a row generating step hence; it must be an intermediate step in a workflow.
Prerequisite: Linux Instance with requisite User Access.
Configurations
| No. | Field Name | Description |
|---|---|---|
| 1 | Step Name | Name of the step. This name has to be unique in a single workflow. |
| Connection | ||
| 1 | Server Name / IP Address | Specify the server or IP address of the machine of which you want to get the Session to execute a command(s). The data type is String. This field is mandatory. |
| 2 | Server Port | Specify the TCP/IP port on which ssh protocol lives on the server. The default is 22. The data type is Number. Note: If the non-numeric value is provided for Server Port the default Port value 22 is considered during execution |
| 3 | Timeout (In Seconds) | Specify the timeout in seconds. If set to a number larger than zero you can specify a non-default connection timeout. Default Value 0 seconds. The data type is Number. |
| 4 | Username | Specify the username to log in with. The data type is String. This field is mandatory. |
| Password (Option 1): | ||
| 5 | Accept Value as variable/static | Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Password field to appear as Text box. |
| 6 | Password | Specify the password of the user. Password is encrypted and is not stored in the .psw workflow file. If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps. The data type is String. Connection can be authenticated using username/Password or Private Key. Accordingly, this field can be mandatory or optional. |
| Key-Pair Details (Option 2): | ||
| 7 | Use Key | Specify Yes if you want to login using a private key. Allowed Values: 'Yes', 'No'. Default: No. The data type is String. |
| 8 | Private Key | If Yes is specified in Use Key above, specify the Private Key. The private part of a private/public RSA key-pair (see: ssh-keygen). The data type is String. Connection can be authenticated using username/Password or Private Key. Accordingly, this field can be mandatory or optional. |
| 9 | Pass Phrase | Specify the optional pass-phrase used when the key-pair was generated. The data type is String. |
| Proxy Details (if required): | ||
| 10 | Proxy Host | Specify the proxy server host to use (name or IP address). The data type is String. |
| 11 | Proxy Port | Specify the proxy server port to use. The default value is 0. The data type is String. |
| 12 | Proxy Username | Specify the proxy username. The data type is String. |
| Proxy Password: | ||
| 13 | Accept Value as variable/static | Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Password field to appear as Text box. |
| 14 | Proxy Password | Specify the Proxy Password. Proxy Password is encrypted and is not stored in the .psw workflow file. If checkbox above is enabled Proxy Password field appears as Text box. Else if checkbox above is disabled Proxy Password field appears as a drop down to select fields from previous steps. The data type is String. |
| 15 | Test Connection | Click to see if the supplied credentials are sufficient for logging into the SSH server. It shows an appropriate message dialog (Timeout, success or fail). Note: The Test Connection button does not work for previous step fields. The button only works with static values and environment variables. |
| Output Field: | ||
| 1 | Session Name* | Provide the name of the session to be created. This must be a unique name and there must be no running session with this name, else the step execution gives an error. This is also an output field as a session is created with this name. The field can also be set using a previous field or a variable. The data type is string. This field is mandatory. Note: - The Session Name must be unique for each Linux: Start Session step used in the same workflow or Sub workflow - If multiple rows are passed to this step, it creates a session for each row, but session name must be unique, else an error is thrown. |