Edit

Set-WmsStation

  • Reference
Module:
MultiPoint

Modifies station information.

Syntax

Set-WmsStation
   [-StationId] <UInt32[]>
   -FriendlyName <String>
   [-Server <String>]
   [<CommonParameters>]
Set-WmsStation
   [-StationId] <UInt32[]>
   -AutoLogonCredential <PSCredential>
   [-OverrideAdminWarning]
   [-Server <String>]
   [<CommonParameters>]
Set-WmsStation
   [-StationId] <UInt32[]>
   [-DisableAutoLogon]
   [-Server <String>]
   [<CommonParameters>]
Set-WmsStation
   [-StationId] <UInt32[]>
   -SessionHost <String>
   [-Server <String>]
   [<CommonParameters>]
Set-WmsStation
   [-StationId] <UInt32[]>
   -VmName <String>
   [-Server <String>]
   [<CommonParameters>]
Set-WmsStation
   [-StationId] <UInt32[]>
   [-LocalSessionHost]
   [-Server <String>]
   [<CommonParameters>]
Set-WmsStation
   [-StationId] <UInt32[]>
   -DisplayOrientation <EDisplayOrientationPS>
   [-Server <String>]
   [<CommonParameters>]

Description

The Set-WmsStation cmdlet modifies station information. You can use this cmdlet to set the automatic logon and the friendly name for the station. If you want to enable a user in the Administrator group to auto-logon, specify the OverrideAdminWarning parameter.

Examples

Example 1: Set a station

PS C:\> $Creds = Get-Credential -UserName "Student01" -Message "Enter desired password" 
PS C:\> Set-WmsStation -StationId 1 -FriendlyName -"Patti's Station" -AutoLogonCredential $Creds

The first command gets the credentials for Student01, and then stores them in the $Creds variable.

The second command sets the friendly name of station 1 to Patti's Station. Station 1 is now configured to auto-logon as Student01.

Parameters

-AutoLogonCredential

Specifies the automatic logon credentials. Use Get-Credential cmdlet to get a PSCredential object.

Type:PSCredential
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DisableAutoLogon

Disables automatic logon for the station.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DisplayOrientation

Specifies the Display Orientation for the station.

Type:EDisplayOrientationPS
Accepted values:Portrait, Landscape, PortraitFlipped, LandscapeFlipped
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-FriendlyName

Specifies a friendly name for the station.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-LocalSessionHost

Specifies the local session host.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-OverrideAdminWarning

Indicates that this operation overrides the Administrator warning. Specify this parameter to enable an Administrator to automatically log on.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Server

Specifies the fully qualified host name of the MultiPoint Server that is the target of the command. The default is localhost.

Type:String
Aliases:ComputerName
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SessionHost

Specifies the session host.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-StationId

Specifies an array of station IDs.

Type:UInt32[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-VmName

Specifies the virtual machine guest host name for Virtual Desktop Infrastructure (VDI) stations.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

UInt32[]

String

Outputs

Object