For the complete documentation index, see llms.txt. This page is also available as Markdown.

Add-RASScheduleMessage

SYNOPSIS

Adds schedule message information for a Schedule.

SYNTAX

Add-RASScheduleMessage [-Id] <uint> -Message <string> -MessageTitle <string>
 -ObjType {RDS | VDI | AVD} [-Enabled <bool>] [-SendMsgSecs <uint>] [-SendMsgWhen {Before | After}]
 [<CommonParameters>]
Add-RASScheduleMessage [-Name] <string> [[-SiteId] <uint>] -Message <string> -MessageTitle <string>
 -ObjType {RDS | VDI | AVD} [-Enabled <bool>] [-SendMsgSecs <uint>] [-SendMsgWhen {Before | After}]
 [<CommonParameters>]

DESCRIPTION

Adds schedule message information for a Schedule.

EXAMPLES

Example 1

Add-RASScheduleMessage -ObjType VDI -Name "SchedItem" -Enabled 0 -SendMsgSecs 60 -MessageTitle "messageTitle" -Message "messageBody"

Adds a Message to the schedule item specified by name, set to send 1 minute before schedule trigger.

Example 2

Adds a Message to the schedule item specified by id, set to send 2 minutes before schedule trigger.

PARAMETERS

-Enabled

Whether to enable or disable the message.

-MessageTitle

The title of the message.

-Message

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

-SendMsgSecs

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

-SendMsgWhen

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

Send Message When can only be set to After in the case of Reboot.

Possible values: Before, After

Type reference: SendMsgWhen

-Name

Scheduler job name.

-SiteId

Site ID to modify the schedule job.

-Id

Scheduler job ID.

-ObjType

Schedule message object type.

Possible values: RDS, VDI, AVD

Type reference: ScheduleObjType

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.

INPUTS

None

OUTPUTS

ScheduleMessage

Last updated