Skip to main content

Task 02: Enable RDP

The automated run does this task for you

The automated OS configuration run covers this task in the RemoteManagement step (RDP allowed, with its firewall group). Use the manual steps below when you can't use the run, or to understand or troubleshoot what it does. See how the run works.

Runbook Azure Dell

DOCUMENT CATEGORY: Runbook
SCOPE: Remote desktop enablement
PURPOSE: Enable RDP on all cluster nodes for graphical remote access from the management server and delivery engineer workstation
MASTER REFERENCE: Phase 03: OS Configuration

Status: Active

Overview​

Enable Remote Desktop Protocol (RDP) on all Azure Local nodes. This provides graphical remote access for configuration and troubleshooting throughout the deployment engagement.

WinRM is already enabled from Task 01, so this task can be run either directly on each node via iDRAC Virtual Console or remotely from the management server.


Prerequisites​

RequirementDescriptionSource
Task 01 CompleteWinRM enabled on all nodesTask 01: Enable WinRM
iDRAC console accessVirtual Console accessible for each node (if using SConfig or Direct tab)infrastructure.yml: nodes[].bmc.ip_address
Administrator credentialsLocal admin password set during OS installationinfrastructure.yml: identity.local_admin.password (a secret reference)

Values from infrastructure.yml​

The values for this task come from infrastructure.yml (schema 5). Every key, with its type, default and example, is in the variables reference.


Execution​

Run on each node via iDRAC Virtual Console.

  1. Open https://<idrac-ip> → Virtual Console → Launch
  2. Log in as Administrator
  3. Type SConfig and press Enter
  4. Select option 7 — Remote Desktop
  5. Enter E to enable
  6. Select 1 — Allow connections from any version
  7. Verify status shows Enabled
  8. Repeat for every node

Validation Checklist​

  • RDP enabled on all nodes
  • RDP port 3389 accessible from management server
  • Can connect via Remote Desktop Client to each node
  • Firewall rules enabled for Remote Desktop group
# Test RDP port from management server
Test-NetConnection -ComputerName <node-ip> -Port 3389
# Expected: TcpTestSucceeded : True

Troubleshooting​

IssueCauseResolution
Connection refused on port 3389RDP not enabledRe-run enable script on the node
Port blockedFirewall rule not enabledEnable-NetFirewallRule -DisplayGroup "Remote Desktop" on the node
Authentication failureWrong credentialsVerify local Administrator password from Key Vault

Toolkit Reference

Scripts for this task are located in the azurelocal-toolkit repository under scripts/deploy/ in the appropriate task folder.


Alternatives​

The procedures in this task use the methods shown in the tabs above. The toolkit is PowerShell 7 only and has no Bash scripts. A few tasks that act on Azure also have an Azure CLI script written in PowerShell. The script status page of the toolkit lists which task has which script.

← Task 01: Enable WinRM↑ Phase 03: OS ConfigurationTask 03: Configure Static IP →

Version Control​

VersionDateAuthorChanges
1.02026-01-31Azure Local CloudInitial document
2.02026-03-04Azure Local CloudFull rewrite to standards — complete frontmatter, 4-tab structure, orchestrated reads infrastructure.yml, standalone with config region, Navigation and Version Control