Skip to main content

Connect-RDP

SYNOPSIS

Establishes a Remote Desktop Protocol (RDP) connection to a specified computer.

SYNTAX

Connect-RDP [[-ComputerName] <String>] [<CommonParameters>]

DESCRIPTION

This function allows the user to connect to a remote computer via RDP. If a computer name is provided, it connects to that specific computer. If no computer name is provided, it will open the RDP client without specifying a target.

EXAMPLES

EXAMPLE 1

Connect-RDP -ComputerName "Server01"
Connects to the computer named "Server01" using RDP.

EXAMPLE 2

Connect-RDP
Opens the RDP client without specifying a target computer.

PARAMETERS

-ComputerName

Specifies the name of the computer to which you want to connect. This parameter is optional. If omitted, the RDP client will open without a specified target.

Type: String
Parameter Sets: (All)
Aliases: Host, Name, Computer, CN

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

None

NOTES

ALIASES

None.

PLATFORM APPLICABILITY

Windows only. The platform-aware loader does not export this command on Linux or macOS.

POWERSHELL COMPATIBILITY

See PowerShell compatibility for the supported runtime policy. PowerShell 7.6 LTS is preferred.

https://docs.keldor.dev/powershell/keldor/Connect-RDP