Add-RASScheduleMessage
NAME
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.
PARAMETERS
-Enabled <bool> Whether to enable or disable the message.
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters? false-MessageTitle <string> The title of the message.
-Message <string> A message that should be sent to users before the job starts.
-SendMsgSecs <uint> Time interval in seconds before the job starts when the message to users should be sent.
-SendMsgWhen <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
-Name <string> Scheduler job name.
-SiteId <uint> Site ID to modify the schedule job.
-Id <uint> Scheduler job ID.
-ObjType <ScheduleObjType> Schedule message object type.
Possible values: RDS, VDI, AVD
<CommonParameters>
INPUTS
-none-
OUTPUTS
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 ----------
Add-RASScheduleMessage -ObjType VDI -Id 2 -Enabled 1 -SendMsgSecs 120 -MessageTitle "messageTitle" -Message "messageBody"
Adds a Message to the schedule item specified by id, set to send 2 minutes before schedule trigger.
RELATED LINKS
Last updated