Add-RDSScheduleMessage

Add-RDSScheduleMessage

Adds a Message to an RDS Schedule Item.

Add-RDSScheduleMessage [-RDSSchedObject] <RDSSchedItem> -Message <string> [-Enabled <bool>] [-MessageTitle <string>] [-SendMsgSecs <uint>] [-SendMsgWhen <SendMsgWhen> {Before | After}] [<CommonParameters>]

Add-RDSScheduleMessage [-RDSSchedName] <string> [[-SiteId] <uint>] -Message <string> [-Enabled <bool>] [-MessageTitle <string>] [-SendMsgSecs <uint>] [-SendMsgWhen <SendMsgWhen> {Before | After}] [<CommonParameters>]

Add-RDSScheduleMessage [-RDSSchedId] <uint> -Message <string> [-Enabled <bool>] [-MessageTitle <string>] [-SendMsgSecs <uint>] [-SendMsgWhen <SendMsgWhen> {Before | After}] [<CommonParameters>]

Adds a Message to an RDS Schedule Item.

-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.

        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?                    true

        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                900

        Accept pipeline input?       false

        Accept wildcard characters?  false

-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

        Required?                    false

        Position?                    named

        Default value                Before

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RDSSchedObject <RDSSchedItem>
An object of type RDSSchedItem representing the target scheduler job.

To obtain the object, use the Get-RDSSchedule cmdlet.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

-RDSSchedName <string>
Scheduler job name.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint>
Site ID from which to retrieve the schedule job.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RDSSchedId <uint>
Scheduler job ID.

        Required?                    true

        Position?                    0

        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. 

RDSSchedItem

---------- EXAMPLE 1 ----------

Add-RDSScheduleMessage -RDSSchedName "RDSSchedItem" -Message "Test"

Adds the specified message to the specified RDS schedule item.

---------- EXAMPLE 2 ----------

Add-RDSScheduleMessage -RDSSchedId 1 -Message "Test"

Adds the specified message to the specified RDS schedule item.