Edit

Share via

Set-WmsStation

Module:
MultiPoint Module

Modifies station information.

Syntax

FriendlyName 

Set-WmsStation
    [-StationId] <UInt32[]>
    -FriendlyName <String>
    [-Server <String>]
    [<CommonParameters>]

AutoLogonEnable 

Set-WmsStation
    [-StationId] <UInt32[]>
    -AutoLogonCredential <PSCredential>
    [-OverrideAdminWarning]
    [-Server <String>]
    [<CommonParameters>]

DisableAutoLogon 

Set-WmsStation
    [-StationId] <UInt32[]>
    [-DisableAutoLogon]
    [-Server <String>]
    [<CommonParameters>]

RemoteConnection 

Set-WmsStation
    [-StationId] <UInt32[]>
    -SessionHost <String>
    [-Server <String>]
    [<CommonParameters>]

RemoteConnectionVM 

Set-WmsStation
    [-StationId] <UInt32[]>
    -VmName <String>
    [-Server <String>]
    [<CommonParameters>]

DisableRemoteConnection 

Set-WmsStation
    [-StationId] <UInt32[]>
    [-LocalSessionHost]
    [-Server <String>]
    [<CommonParameters>]

DisplayOrientation 

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.

Parameter properties

Type:PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AutoLogonEnable
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableAutoLogon

Disables automatic logon for the station.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

DisableAutoLogon
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisplayOrientation

Specifies the Display Orientation for the station.

Parameter properties

Type:EDisplayOrientationPS
Default value:None
Accepted values:Portrait, Landscape, PortraitFlipped, LandscapeFlipped
Supports wildcards:False
DontShow:False

Parameter sets

DisplayOrientation
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FriendlyName

Specifies a friendly name for the station.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

FriendlyName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LocalSessionHost

Specifies the local session host.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

DisableRemoteConnection
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OverrideAdminWarning

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AutoLogonEnable
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Server

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ComputerName

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-SessionHost

Specifies the session host.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

RemoteConnection
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StationId

Specifies an array of station IDs.

Parameter properties

Type:

UInt32[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-VmName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

RemoteConnectionVM
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Inputs

UInt32

String

Outputs

Object