# Add-RASScheduleMessage

## NAME

Add-RASScheduleMessage

## SYNOPSIS

Adds schedule message information for a Schedule.

## SYNTAX

**Add-RASScheduleMessage** \[[Id](#id-string)]\*\* *(uint)* -[Message](#message-string) *(string)* -[MessageTitle](#messagetitle-string) *(string)* -[ObjType](#objtype) {RDS | VDI | AVD} \[[Enabled](#enabled-string) *(bool)*] \[[SendMsgSecs](#sendmsgsecs-string) *(uint)*] \[-[SendMsgWhen](#SendMsgWhen) {Before | After}] \[*(*[*CommonParameters*](#CommonParameters)*)*]

**Add-RASScheduleMessage** \[[Name](#name-string)]\*\* *(string)* \[\[-[SiteId](#siteid-string)] *(uint)*] -[Message](#message-string) *(string)* -[MessageTitle](#messagetitle-string) *(string)* -[ObjType](#objtype) {RDS | VDI | AVD} \[[Enabled](#enabled-string) *(bool)*] \[[SendMsgSecs](#sendmsgsecs-string) *(uint)*] \[-[SendMsgWhen](#SendMsgWhen) {Before | After}] \[*(*[*CommonParameters*](#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.

```
        Required?                    true

        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](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/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
```

## 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](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/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

[ScheduleMessage](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/schedulemessage)

## 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.\
\&#xNAN;**---------- 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

* [Get-RASSchedule](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/get-rasschedule)
* [Get-RASScheduleMessage](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/get-rasschedulemessage)
* [Set-RASScheduleMessage](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/set-rasschedulemessage)
* [Remove-RASScheduleMessage](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/remove-rasschedulemessage)