Online Help > PowerShell Scripting

Set-RDMSessionStatus

SYNOPSIS

Set a status to a given session.

 

SYNTAX

Set-RDMSessionStatus -ID [ID] <Guid> -Message [Message] <String> -Session [Session] <PSConnection[]> -Status [Status] <String> [<CommonParameters>]

 

DESCRIPTION

Set a status to a given session.

 

PARAMETERS

  -ID <Guid>

(Required) Specifies the ID of the session to set the status to.

 

Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.

 

  -Message <String>

Status message

 

  -Session <PSConnection[]>

(Required) Specifies the session to set the status to

 

  -Status <String>

(Required) Status type

 

  <CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer and OutVariable.For more information, type, "get-help about_commonparameters".

 

NOTES

For more information, type "Get-Help Set-RDMSessionStatus -detailed". For technical information, type "Get-Help Set-RDMSessionStatus -full".

 

EXAMPLE 1

PS C:\> $list = Get-RDMSession; Set-RDMSessionStatus -Session $list[1] -Status Locked -Message 'Locked Message'

 

Set the status locked to the the second element in the list.

 

RELATED LINKS

Get-RDMSession

Get-RDMSessionPassword

Get-RDMSessionStatus

Get-RDMSessionUserName

Set-RDMSessionDomain

Set-RDMSessionPassword

Set-RDMSessionUsername