Skip to main content

Start DOS / PowerShell Session

Windows: Start DOS / PowerShell Session

Description

Windows: Start DOS Session starts a DOS session.

tip

This step is not a row-generating step; therefore, it must be used as an intermediate step in a workflow.

Configurations

Input Tab

No.Field NameDescription
1Step NameName of the step. This name must be unique within a single workflow.
Connection:
1Host 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.
2UsernameSpecify 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.
3Accept Value as variable/staticLeave 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.
4PasswordSpecify 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.
5PortSpecify the port of Remote WinRM. Default HTTP port is 5985, and default HTTPS port is 5986.
6Use SSLProvide “Yes” if your server requires an SSL connection.
Allowed values: Yes, No.
Default: No.
7Timeout (In Seconds)Specify the timeout value in seconds.
Default: 300 seconds.
8Test ConnectionClick 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 NameDescription
1Session 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 NameDescription
1OKValidates all required field values. If valid, saves the values; otherwise, displays a validation error message.
2CancelCancels the window without saving any values.