< Back

Start-RDP

Sat Jan 18, 2020 8:18 pm

NAME Start-RDP



SYNTAX

Start-RDP [[-ComputerName] <string>] [[-Username] <string>] [[-Password] <string>] [-Width <int>] [-Height <int>]

[-RDPFile <string>] [-Admin] [-Fullscreen] [-Public] [-Span] [-MultiMonitor] [-ClearCredentials]

[<CommonParameters>]





PARAMETERS

-Admin

Connect to the admin or console session.



Required? false

Position? Named

Accept pipeline input? false

Parameter set name (All)

Aliases Console

Dynamic? false



-ClearCredentials

Clears any credentials saved for server using cmdkey.



Required? false

Position? Named

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-ComputerName <string>

The ComputerName to connect to as a string, may include the port number if not default by adding a colon and

then the port number.



Required? false

Position? 0

Accept pipeline input? true (ByValue)

Parameter set name (All)

Aliases Server

Dynamic? false



-Fullscreen

Display in fullscreen.



Required? false

Position? Named

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-Height <int>

Height of display.



Required? false

Position? Named

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-MultiMonitor

Configures the remote deskotp session monitor layout to be identical to the current client-side configuration.



Required? false

Position? Named

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-Password <string>

Password to pass to MSTSC via cmdkey.



Required? false

Position? 2

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-Public

Runs in public mode which prevents client from saving caching things like computername, credentials, etc.



Required? false

Position? Named

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-RDPFile <string>

Path and filename of an RDP connection settings file.



Required? false

Position? Named

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-Span

Matches the remote desktop width and height with the local virtual deskop, spanning across multiple monitors,

if necessary.



Required? false

Position? Named

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-Username <string>

Username to pass to MSTSC via cmdkey.



Required? false

Position? 1

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-Width <int>

Width of display.



Required? false

Position? Named

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).





INPUTS

System.String





OUTPUTS

System.Object



ALIASES

None





REMARKS

None