Task 02: Enable RDP
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.
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
| Requirement | Description | Source |
|---|---|---|
| Task 01 Complete | WinRM enabled on all nodes | Task 01: Enable WinRM |
| iDRAC console access | Virtual Console accessible for each node (if using SConfig or Direct tab) | infrastructure.yml: nodes[].bmc.ip_address |
| Administrator credentials | Local admin password set during OS installation | infrastructure.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
- SConfig Utility
- Orchestrated Script
Run on each node via iDRAC Virtual Console.
- Open
https://<idrac-ip>→ Virtual Console → Launch - Log in as
Administrator - Type
SConfigand press Enter - Select option 7 — Remote Desktop
- Enter E to enable
- Select 1 — Allow connections from any version
- Verify status shows Enabled
- Repeat for every node
PowerShell
No script in this task folder. The folder
scripts/deploy/04-cluster-deployment/phase-03-os-configuration/task-02-enable-rdpholds only a placeholder. A placeholder printsNOT IMPLEMENTED, changes nothing and exits with code 3. The earlierEnable-RDP.ps1is removed. The OS configuration does this task in its RemoteManagement step.
Script
| Script | What it does |
|---|---|
scripts/deploy/04-cluster-deployment/phase-03-os-configuration/Invoke-AzureLocalOsConfiguration.ps1 | The one entry point of the OS configuration. It runs Set-AzureLocalNodeConfiguration.ps1 for each node: it reads the node, changes only what differs from infrastructure.yml, and reports. -Step limits the run to one step. |
The nodes' local administrator comes from identity.local_admin of infrastructure.yml (the password is a secret reference), or from -Credential. The script never prompts. Run settings go in a JSON file given with -SettingsFile.
Run
# Plan (the default): read every node and list what would change
./Invoke-AzureLocalOsConfiguration.ps1 -InfrastructureFile ./infrastructure.yml -Step RemoteManagement
# Apply
./Invoke-AzureLocalOsConfiguration.ps1 -InfrastructureFile ./infrastructure.yml -Step RemoteManagement -Mode Apply
See how the run works.
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
| Issue | Cause | Resolution |
|---|---|---|
| Connection refused on port 3389 | RDP not enabled | Re-run enable script on the node |
| Port blocked | Firewall rule not enabled | Enable-NetFirewallRule -DisplayGroup "Remote Desktop" on the node |
| Authentication failure | Wrong credentials | Verify local Administrator password from Key Vault |
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.
Navigation
| ← Task 01: Enable WinRM | ↑ Phase 03: OS Configuration | Task 03: Configure Static IP → |
Version Control
| Version | Date | Author | Changes |
|---|---|---|---|
| 1.0 | 2026-01-31 | Azure Local Cloud | Initial document |
| 2.0 | 2026-03-04 | Azure Local Cloud | Full rewrite to standards — complete frontmatter, 4-tab structure, orchestrated reads infrastructure.yml, standalone with config region, Navigation and Version Control |