Skip to main content

Start Session

Starts a new Windows Remote Desktop Protocol (RDP) session to a remote computer.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If the ContinueOnError property is true, no error is caught when the project is executed, even if a Catch node is used.

Inputs​

  • Remote Computer - The hostname or IP address of the remote computer to connect to. Default is "localhost".
  • Credentials - Login credentials (username and password) for the remote computer.

Output​

  • Session - The session object representing the established RDP connection.

How It Works​

The Start Session node establishes a new Windows Remote Desktop Protocol (RDP) session to a remote computer. When executed, the node:

  1. Validates the provided credentials (username and password)
  2. Stores the credentials securely using Windows cmdkey
  3. Launches an RDP connection using mstsc with full-screen mode
  4. Waits for the session to be established and identifies the new session
  5. Cleans up the stored credentials
  6. Returns the session information as an output

Requirements​

  • Valid login credentials for the remote computer
  • Network connectivity to the remote computer
  • Windows Remote Desktop services enabled on the remote computer
  • Appropriate permissions to establish RDP connections

Error Handling​

The node will return specific errors in the following cases:

  • No credentials provided
  • Username is missing or empty
  • Password is missing or empty
  • Unable to establish RDP session within the specified timeout (60 seconds)
  • Network connectivity issues to the remote computer

Usage Notes​

  • This node is typically used at the beginning of automation workflows that need to interact with remote Windows systems
  • The session object can be passed to other Windows Automation nodes that require a session
  • Credentials are stored temporarily and cleaned up after the session is established
  • The connection is launched in full-screen mode for optimal interaction
  • For localhost connections, ensure that Remote Desktop is enabled on the local machine
  • The node waits up to 60 seconds for the session to be established