EXECUTION - General Knowledge
Linux activities can be executed in 2 different ways: via Windows Execution Agents or via Linux Execution Agents.
Using Windows Execution Agents:
- the Input variable is mandatory and it is the output of an SSH Connection activity.
Using Linux Execution Agents:
- the Input variable is not mandatory. Activities will be executed on the selected Linux agent and the results will be retrieved for the Linux machine where the execution agent is.
Activities
- Application Install
- Check Folder Existence
- Check Package Installed
- Connect to Linux
- Get Server State
- Get OS Metrics
- File Transfer
- Linux Disconnect
- Make Directory
- Package Management
- Run Bash Script
- Server Add Group
- Server Add User
- Server Boot Operations
- Server Copy File
- Server Links
- Server Move File
- Server Set User Group Privileges
- Service Operations
- Set Path CHMOD
- SSH Script Execution
- Unix OS File Transfer
- Unzip File
- Web Get
Application Install
This activity installs an application by a specific path to Linux.
Activity Parameters
The Application Install activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
- Installer Path (text box editor type) (type: string): the path where the installer is located.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs the SSH command execution.
- Output Result Code (type: int32): outputs the execution's result code.
Check Folder Existence
This activity checks if a folder exists.
Activity Parameters
The Check Folder Existence activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- Folder Name (text box editor type) (type: string): the name of the folder.
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: boolean): outputs the SSH command execution.
- Output Result Code (type: int32): outputs the execution's result code.
Check Package Installed
This activity checks if a package is installed.
Activity Parameters
The Check Package Installed activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
- Package Name (text box editor type) (type: string): the name of the package which will be searched.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs the SSH command execution.
- Output Result Code (type: int32): outputs the execution's result code.
Connect To Linux
This activity connects to an SSH Host. The Output of this activity should be used as Input for all Connection parameters used for all activities found under this category.
Activity Parameters
The Connect to Linux activity parameters can be provided by manual inserted values or via IN arguments or variables:
Double Hop Parameters:
- Double Hop Certificate Content (text box editor type) (type: string): the content of the authentication certificate (OpenSSH, SSH Type).
- Double Hop Certificate Path (text box editor type) (type: string): the path of the authentication certificate (OpenSSH, SSH Type).
- Double Hop Fowarding SSH Port (text box editor type) (type: int32): the port for the SSH tunnel from "Hostname" to the "Double Hop Hostname"
- Double Hop Hostname / IP Address (text box editor type) (type: string): the DNS name or IP address of the SSH host that will hop over the "Host name" specified under the "Parameters" category.
- Double Hop Passphrase (text box editor type) (type: string): the passphrase for the selected certificate for Double Hopping.
- Double Hop Passphrase Binding (text box editor type) (type: string): bind to a variable containing the encrypted passphrase for the certificate host. (This parameter is used only when the user wants to send an encrypted password from outside the workflow, for example Flowster Portal).
- Double Hop Password (text box editor type) (type: string): the password for the provided username.
- Double Hop Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the SSH host. (This parameter is used only when the user wants to send an encripted password from outside the workflow, for example Flowster Portal).
- Double Hop Username (text box editor type) (type: string): the username connect to the SSH host.
Parameters:
- Certificate Content (text box editor type) (type: string): the content of the authentication certificate (OpenSSH, SSH Type).
- Certificate Path (text box editor type) (type: string): the path of the authentication certificate (OpenSSH, SSH Type).
- Enable Keyboard Interactive (combo box editor type) (type: string): specify if this kind of authentication method should be used when establishing the connection to the machine. This should be set on Yes only if the Linux machine is configured to accept it. This will be used for "Double Hop Hostname" as well
- Hostname / IP Address (text box editor type) (type: string): the DNS name or IP address of the SSH host.
- Passphrase (text box editor type) (type: string): the passphrase for the selected certificate.
- Passphrase Binding (text box editor type) (type: string): bind to a variable containing the encrypted passphrase for the certificate host. (This parameter is used only when the user wants to send an encrypted password from outside the workflow, for example Flowster Portal).
- Password (text box editor type) (type: string): the password for the provided username.
- Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the SSH host. (This parameter is used only when the user wants to send an encripted password from outside the workflow, for example Flowster Portal).
- SSH Port(text box editor type) (type: int32): the SSH port.
- SSH Timeout (text box editor type) (type: int32): the SSH timeout (default 60 seconds).
- Username (text box editor type) (type: string): the username connect to the SSH host.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: object): outputs an SSH connection.
File Transfer
This activity copies a file from the current machine to a linux host.
Activity Parameters
The File Transfer activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- File Upload Type (combobox control type) (type: string): the combobox contains the three types of file upload: Replace, Delete and Empty. The default option is Replace.
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
- LocalFile (text box editor type) (type: string): the complete path to the file to be copied.
- RemoteFilePath (text box editor type) (type: string): the complete path to the destination file (destination folder/fileName).
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: object): obsolete. to be removed in the Flowster Studio 4.5.4. (used to return the SSH file transfer command output)
- Output Result Code (type: object): outputs the result code of the file transfer execution.
Get Server State
This activity gets the server's state.
Activity Parameters
The Get Server State activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- Input (text box editor type) (type: object): the SSH Connection, if no Linux Agents were used for execution.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs a LinuxStats object.
- Output CPU Load (type: string): outputs the CPU load (%).
- Output Disk Available (type: string): outputs the available disk memory (MB).
- Output Disk Free (type: string): outputs the free disk memory (MB).
- Output Disk Size (type: string): outputs the disk size (MB).
- Output Disk Used (type: string): outputs the disk memory used (MB).
- Output Disk Used Percentage (type: string): outputs the percentage of the used memory disk.
- Output Free Memory (type: string): outputs the free memory (MB).
- Output Total Memory (type: string): outputs the total memory (MB).
- Output Used Memory (type: string): outputs the used memory (MB).
Get OS Metrics
This activity gets server information (version, distribution).
Activity Parameters
The Get OS Metrics activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs the version and distribution of Linux.
- Output Result Code (type: int32): outputs the execution's result code.
Linux Disconnect
This activity disconnects from Linux.
Activity Parameters
The Linux Disconnect activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Input (text box editor type) (type: string): SSH Connection.
Make Directory
This activity makes a directory to Linux.
Activity Parameters
The Make Directory activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- Directory Path (text box editor type) (type: string): the name of the new directory.
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs the SSH command execution.
- Output Result Code (type: int32): outputs the execution's result code.
Package Management
This activity deploys a package for a specific path to Linux.
Activity Parameters
The Package Management activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
- Package File (text box editor type) (type: string): the package file name.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs the SSH command execution.
- Output Result Code (type: int32): outputs the execution's result code.
Run Bash Script
This activity creates a Linux bash script and executes it.
Activity Parameters
The Run Bash Script activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- Delete script (combobox editor type) (type: string): specify whether to delete or not the script after the script execution.
- Include Administrator Scripts (combobox editor type) (type: string): this parameter specifies whether to include the execution of the scripts assigned to the workflow in Administrator. The workflow selected from Administrator will be executed first and added to the result of the ssh script.
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
- Script (inline script editor type) (type: string): the bash script. Use $using:variableName for external workflow variables/arguments.
- Script Path (text box editor type) (type: string): the path where the bash script will be uploaded (e.h. /home/user/MyScript.sh).
- Split Separator (text box editor type) (type: string): Enter the separator used to split the script/command result in Output Results List (e.g. ';',':' '→'). By default is newline.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs the SSH command execution.
- Output Result Code (type: int32): outputs the execution's result code.
- Output Results List (type: collections.generic.list[string]): outputs a list of results.
Server Add Group
This activity adds a new group to Linux.
Activity Parameters
The Server Add Group activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- Group Name (text box editor type) (type: string): the name of the new group.
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs the SSH command execution.
- Output Result Code (type: int32): outputs the execution's result code.
Server Add User
This activity adds a user to a group.
Activity Parameters
The Server Add User activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- Group Name (text box editor type) (type: string): the group name or number of the user's initial login group.
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
- NewUser (text box editor type) (type: string): the name of the user.
- ShellUser (text box editor type) (type: string): the name of the user's login shell.
- Supplementary Groups (text box editor type) (type: string): a list of supplementary groups which the user is also a member of.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs the SSH command execution.
- Output Result Code (type: int32): outputs the execution's result code.
Server Boot Operations
This activity executes server boot operations.
Activity Parameters
The Server Boot Operations activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
- Operation (combo box editor type) (type: string): the server boot operation: reboot, halt, power down.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs the SSH command execution.
- Output Result Code (type: int32): outputs the execution's result code.
Server Copy File
This activity copies a file to a new location.
Activity Parameters
The Server Copy File activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
- New Path (text box editor type) (type: string): the name of the new file path.
- Target (text box editor type) (type: string): the name of the target file.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs the SSH command execution.
- Output Result Code (type: int32): outputs the execution's result code.
Server Links
This activity makes symbolic links between files. Creates a link to TARGET in the specified path.
Activity Parameters
The Server Links activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
- Symbolic Link Path (text box editor type) (type: string): the path of the symbolic link.
- Target Path (text box editor type) (type: string): the name of the target.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs the SSH command execution.
- Output Result Code (type: int32): outputs the execution's result code.
Server Move File
This activity moves a file to a new location.
Activity Parameters
The Server Move File activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
- New Path (text box editor type) (type: string): the name of the new file path.
- Target (text box editor type) (type: string): the name of the target file.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs the SSH command execution.
- Output Result Code (type: int32): outputs the execution's result code
Server Set User Group Privileges
This activity adds user privileges for a specified path.
Activity Parameters
The Server Set User Group Privileges activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
- Group Name (text box editor type) (type: string): the name of the group.
- Path (text box editor type) (type: string): the name of the path.
- User (text box editor type) (type: string): the name of the user.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs the SSH command execution.
- Output Result Code (type: int32): outputs the execution's result code
Service Operations
This activity executes operations on Linux services.
Activity Parameters
The Service Operations activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
- Operation (text box editor type) (type: string): the service operation type.
- Service Name (text box editor type) (type: string): the name of the service on which the operation will be performed.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs the SSH command execution.
- Output Result Code (type: int32): outputs the execution's result code
Set Path CHMOD
This activity sets CHMOD for a specified path.
Activity Parameters
The Set Path CHMOD activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- CHMOD (text box editor type) (type: string): the value of the CHMOD.
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
- Path (text box editor type) (type: string): the full path of the folder for which CHMOD value will be applied.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs the SSH command execution.
- Output Result Code (type: int32): outputs the execution's result code
SSH Script Execution
This activity executes an SSH script.
Activity Parameters
The SSH Script Execution activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- Command (text box editor type) (type: string): the command to be executed. For example "ls" (lists the content of a directory).
- Enable TTY (combo box editor type): this option enables the teletype terminals (TTY) for SSH.
- Expected String (text box editor type) (type: string): if TTY is enabled, then in this field should be provided the teletype expected character. Examples: #, $.
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
- Keep Shell (combo box editor type) (type: string): select this option if the commands executions should be remembered and passed to the next SSH Script Execution activity.
- Remove From History (text box editor type) (type: string): this is an optional parameter which was previously used for hiding the password sent to the console from the history. Currently this parameter is ignore, because the activity will not send the password as a command anymore.
- Script (text box editor type) (type: string): the bash script which should be executed. Use $using:variableName for external workflow variables/arguments or $UsingPassword:{GV_MyPassword} to use passwords. In order to bypass terminal colors (codes), use the --color=never option. This parameter takes precedence over the Command one.
- Split Separator (text box editor type) (type: string): Enter the separator used to split the script/command result in Output Results List (e.g. ';',':' '→'). By default is newline.
- SSH Console Response Timeout (text box editor type) (type: string): the SSH console response timeout. This option is required only if TTY or KeepShell parameters are being used. By default Flowster provides a wait time of 3 seconds, but it can be changed according to the user's need.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs the SSH command execution.
- Output Result Code (type: int32): outputs the execution's result code
- Output Results List (type: collections.generic.list[string]): outputs a list of results.
Unix OS File Transfer
This activity copies a file from the currently connected machine to another Linux host.
Activity Parameters
The Unix OS File Transfer activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Connection (text box editor type) (type: string): SSH Connection. The output from the SSH Connection activity should be used.
- Host File Path (text box editor type) (type: string): the complete path to the file to be copied, from the host where the activity is connected to. E.g. /home/user/MyScript.sh
- Target Password (password box editor type) (type: string): the password for the Unix machine where the file should be copied.
- Target Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Target Path (text box editor type) (type: string): the path on the Linux host where the file should be copied. E.g. /home/user/DemoFile.txt If no path is provided (the input value is ""), the files will be copied in the root folder.
- Target Server (text box editor type) (type: string): the name or IP of the target Linux server, where the file will be copied.
- Target Username (text box editor type) (type: string): the username for the Unix machine where the file will be copied.
The Read Only Output variable are the possible output values that the activity will provide:
- Output Result Code (type: object): outputs the result code of the file transfer execution.
Unzip File
This activity unzip a file to a specific Linux path.
Activity Parameters
The Unzip File activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- Destination Path (text box editor type) (type: string): the destination path where the file(s) will be extracted.
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
- File Path (text box editor type) (type: string): the path of the zip file.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs the SSH command execution.
- Output Result Code (type: int32): outputs the execution's result code
Web Get
This activity gets a web file for a specific Linux path. In order to use this activity make sure you have installed wget tool.
Activity Parameters
The Web Get activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Agent Password (password box editor type) (type: string): the password for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents.
- Agent Password Binding (text box editor type) (type: string): this parameter should be used to bind an IN argument that will be used to store an encrypted password from outside the workflow, for example Flowster Studio Portal.
- Agent Username (text box editor type) (type: string): the username for the Unix machine username provided. This parameter should only be used when the workflow is executed with Linux agents. E.g "demouser".
- Input (text box editor type) (type: string): SSH Connection. If the activity is not executed with Linux Execution Agents, then the output from the SSH Connection activity should be used.
- Web Path (text box editor type) (type: string): the web file path.
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): outputs the SSH command execution.
- Output Result Code (type: int32): outputs the execution's result code