Start DOS / PowerShell Session
Windows: Start DOS / PowerShell Session
Description
This step starts a PowerShell session on a remote Windows machine and keeps it open for subsequent steps. Use this step as the first step in workflows that need to run multiple commands on the same machine in sequence, maintaining the connection between steps for efficiency.
Configurations
Input Tab
| No. | Field Name | Description |
|---|---|---|
| 1 | Step Name | Name of the step. This name must be unique within a single workflow. |
| Connection: | ||
| 1 | Host Name* | Provide the Hostname/Server Name/Fully Qualified Domain Name (FQDN)/IP address of the Windows machine to start the session on. Data type: String. This field is mandatory. |
| 2 | Username | Specify the username of the Windows account to authenticate. You may also provide the username in the format <Domain name>\username or <Computer name>\username. To connect to a remote machine, use <Domain name>\username. Data type: String. |
| 3 | Accept Value as variable/static | Leave the checkbox unchecked to accept the Password value from a field in previous steps using a drop-down list. Enable the checkbox to enter the password as text. |
| 4 | Password | Specify the password of the Windows account. The password is stored in encrypted format and is not saved in the .psw workflow file. When the checkbox above is enabled, the Password field appears as a Text box. When disabled, it appears as a drop-down list to select a field from previous steps. This field is mandatory. |
| 5 | Port | Specify the port of Remote WinRM. Default HTTP port is 5985, and default HTTPS port is 5986. |
| 6 | Use SSL | Provide “Yes” if your server requires an SSL connection. Allowed values: Yes, No. Default: No. |
| 7 | Timeout (In Seconds) | Specify the timeout value in seconds. Default: 300 seconds. |
| 8 | Test Connection | Click this button to test the connection. Displays an appropriate dialog message (Timeout, Success, or Fail). Note: The Test Connection button does not work for previous step variables. It only works with static or environment variable values. |
Output Tab
| No. | Field Name | Description |
|---|---|---|
| 1 | Session Name* | Provide a name for the session to be created. It must be unique, and there must be no existing session with the same name. This is also an output field as the session is created with this name. This field can also be set using a previous step field or a variable. Data type: String. This field is mandatory. |
Common Buttons
| No. | Field Name | Description |
|---|---|---|
| 1 | OK | Validates all required field values. If valid, saves the values; otherwise, displays a validation error message. |
| 2 | Cancel | Cancels the window without saving any values. |