Activities
...
The Interactive PSscript activity parameters can be provided by manual inserted values or via IN arguments or variables:
ParametersInteractive Agent:
- ClientHash (text box editor type) (type: string): the client hash for the Rest API client app. It can be copied from Flowster Administrator by selecting the client app for the Rest API.
- Parameters collection (collection editor type) (type: string): the parameters you want to send with the request. e.g. Name: parameter1 and Value: value1.
- Password (password editor type) (type: string): the password for the rest API username.
- Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for connection.(This parameter is only used when the user wants to send an encrypted password from outside the task, for example Flowster Studio Portal execution.
- Script Code (text box editor type) (type: string): the Powershell script code to be executed. For example: "mkdir 'C:\FlowsterSolutions'" (this command creates a folder with the specified path).
- Script File (text box editor type) (type: string): the Powershell script file. This parameter takes precedence over the Script Code parameter.
- Session ID (text box editor type) (type: string): specify an active session ID returned by the 'Connect To Remote Desktop' activity or 'Get Remote Desktop Session' activity.If left empty, the first active session will be used.
- Timeout (text box editor type) (type: Int32): specify the number of minutes to wait for the operations in script to be completed.
- Username (text box editor type) (type: string): the security user for the Rest API configured in Flowster Administrator. E.g. 'domain\username'.
Parameters:
- Command (text box editor type) (type: string):
- the PowerShell inline script. This parameter takes precedence over the Script Code parameter. Without $using, a $a workflow variable (variable defined via workflow, visible in the Variables area) is not visible in the script. $Using imports the variable and its current value (e.g. {$a = $using:a+1; $a})
- the Command editor has a syntax highlighting toggle, for displaying the lines according to the chosen language. In the example below, PowerShell was used:
the user can also use an external editor of his/her choice via the button to the left of the edit field (
). The external editor is by default Windows notepad, but it can be changed in the Designer Settings.
- 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 powershell script.
- Parameters collection (collection editor type) (type: string): the parameters you want to send with the request. e.g. Name: -ArgumentList and Value:arg1.
- Script Passwords (password collection editor type) (type: string): the names and the values for the password types variables which will be used in the script. These passwords will be incorporated in the script with the $using: syntax
- password value: this value should be manually configured in the editor window. The value will also be encrypted in thew workflow's content file
- password binding value: this field can be linked to an existing variable, argument or global variable, where the value would be automatically taken during the workflow's execution
- this is an example of a script which connects to a vCenter server using different credentials and including multiple passwords:
- Script Code (text box editor type) (type: string): the Powershell script code to be executed. For example: "mkdir 'C:\FlowsterSolutions'" (this command creates a folder with the specified path).
- Script File (text box editor type) (type: string): the Powershell script file. This parameter takes precedence over the Command and the Script Code parameter.
The Read Only Output variable are the possible output values that the activity will provide:
...
- Command (text box editor type) (type: string):
- the PowerShell inline script. This parameter takes precedence over the Script Code parameter. Without $using, a $a workflow variable (variable defined via workflow, visible in the Variables area) is not visible in the script. $Using imports the variable and its current value (e.g. {$a = $using:a+1; $a})
- the Command editor has a syntax highlighting toggle, for displaying the lines according to the chosen language. In the example below, PowerShell was used:
the user can also use an external editor of his/her choice via the button to the left of the edit field (
- 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 powershell script.
- Parameters collection (collection editor type) (type: string): the parameters you want to send with the request. e.g. Name: -ArgumentList and Value:arg1.
- Script Passwords (password collection editor type) (type: string): the names and the values for the password types variables which will be used in the script. These passwords will be incorporated in the script with the $using: syntax
- password value: this value should be manually configured in the editor window. The value will also be encrypted in thew workflow's content file
- password binding value: this field can be linked to an existing variable, argument or global variable, where the value would be automatically taken during the workflow's execution
- this is an example of a script which connects to a vCenter server using different credentials and including multiple passwords:
...