Set-RASScheduleMessage.md

NAME

Set-RASScheduleMessage

SYNOPSIS

Modifies a Schedule Message from a Schedule Item.

SYNTAX

Set-RASScheduleMessage [Id] (uint) -MessageId (uint) -ObjType {RDS | VDI | AVD} [Enabled (bool)] [Message (string)] [MessageTitle (string)] [SendMsgSecs (uint)] [-SendMsgWhen {Before | After}] [(CommonParameters)]

Set-RASScheduleMessage [Name] (string) [[-SiteId] (uint)] -MessageId (uint) -ObjType {RDS | VDI | AVD} [Enabled (bool)] [Message (string)] [MessageTitle (string)] [SendMsgSecs (uint)] [-SendMsgWhen {Before | After}] [(CommonParameters)]

DESCRIPTION

Modifies a Schedule Message from a Schedule Item.

PARAMETERS

MessageId (uint)

Scheduler job message ID.

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Enabled (bool)

Whether to enable or disable the message.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

MessageTitle (string)

The title of the message.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Message (string)

A message that should be sent to users before the job starts.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SendMsgSecs (uint)

Time interval in seconds before the job starts when the message to users should be sent.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SendMsgWhen (SendMsgWhen)

Whether the message is sent Before/After the schedule is triggered.

SendMsgWhen can only be set to After in the case of Reboot.

Possible values: Before, After

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Name (string)

Scheduler job name.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SiteId (uint)

Site ID to modify the schedule job.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Id (uint)

Scheduler job ID.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

ObjType (ScheduleObjType)

Schedule message object type.

Possible values: RDS, VDI, AVD

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

**---------- EXAMPLE 1 ----------

Set-RASScheduleMessage -ObjType VDI -Name "SchedItem" -Enabled 0 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"

Modifies the specified message by id within the specified schedule item by name. **---------- EXAMPLE 2 ----------

Set-RASScheduleMessage -ObjType VDI -Id 1 -MessageId 1 -Enabled 0 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"

Modifies the specified message by id within the specified schedule item by id.

RELATED LINKS

• Get-RASSchedule

• Add-RASScheduleMessage

• Get-RASScheduleMessage

• Remove-RASScheduleMessage