Get-LabVMRdpFile
SYNOPSIS
Get RDP connection file
SYNTAX
ByName
Get-LabVMRdpFile -ComputerName <String[]> [-UseLocalCredential] [-Path <String>] [<CommonParameters>]
All
Get-LabVMRdpFile [-UseLocalCredential] [-All] [-Path <String>] [<CommonParameters>]
DESCRIPTION
Gets a Remote Desktop connection file for one or more lab machines and stores the files in the LabLocation, e.g. %ProgramData%\AutomatedLab\Labs\\<LabName>\
EXAMPLES
Example 1
PS C:\> Get-LabVMRdpFile -ComputerName DC01
Stores an RDP connection file to DC01
PARAMETERS
-All
Create RDP files for all lab VMs
Type: SwitchParameter
Parameter Sets: All
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ComputerName
The computer names
Type: String[]
Parameter Sets: ByName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Path
Output path for RDP files
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-UseLocalCredential
Indicates whether the machines' local credentials should be used to connect
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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.