# Add-RASAutoUpgradeMessage

## NAME

Add-RASAutoUpgradeMessage

## SYNOPSIS

Adds schedule message information within Auto-upgrade settings.

## SYNTAX

**Add-RASAutoUpgradeMessage** -[DefObjType](#DefObjType) {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -[Message](#Message) _\<string>_ -[MessageTitle](#MessageTitle) _\<string>_ \[-[Enabled](#Enabled) _\<bool>_] \[-[SendMsgSecs](#SendMsgSecs) _\<uint>_] \[-[SendMsgWhen](#SendMsgWhen) {Before | After}] \[-[SiteId](#SiteId) _\<uint>_] \[_<_[_CommonParameters_](#CommonParameters)_>_]

**Add-RASAutoUpgradeMessage** \[-[Id](#Id)] _\<uint>_ -[Message](#Message) _\<string>_ -[MessageTitle](#MessageTitle) _\<string>_ -[ObjType](#ObjType) {RDSHostPool | VDIHostPool | AVDHostPool} \[-[Enabled](#Enabled) _\<bool>_] \[-[SendMsgSecs](#SendMsgSecs) _\<uint>_] \[-[SendMsgWhen](#SendMsgWhen) {Before | After}] \[_<_[_CommonParameters_](#CommonParameters)_>_]

**Add-RASAutoUpgradeMessage** \[-[InputObject](#InputObject)] _<_[_RASSerilazableObj_](../classes-and-enumerations/rasserilazableobj)_>_ -[Message](#Message) _\<string>_ -[MessageTitle](#MessageTitle) _\<string>_ \[-[Enabled](#Enabled) _\<bool>_] \[-[SendMsgSecs](#SendMsgSecs) _\<uint>_] \[-[SendMsgWhen](#SendMsgWhen) {Before | After}] \[_<_[_CommonParameters_](#CommonParameters)_>_]

**Add-RASAutoUpgradeMessage** \[-[Name](#Name)] _\<string>_ \[\[-[SiteId](#SiteId)] _\<uint>_] -[Message](#Message) _\<string>_ -[MessageTitle](#MessageTitle) _\<string>_ -[ObjType](#ObjType) {RDSHostPool | VDIHostPool | AVDHostPool} \[-[Enabled](#Enabled) _\<bool>_] \[-[SendMsgSecs](#SendMsgSecs) _\<uint>_] \[-[SendMsgWhen](#SendMsgWhen) {Before | After}] \[_<_[_CommonParameters_](#CommonParameters)_>_]

## DESCRIPTION

Adds schedule message information within Auto-upgrade settings.

## 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**](../classes-and-enumerations/sendmsgwhen)**>**\
Whether the message is sent Before/After the AutoUpgrade 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>**\
The name or server for which to modify the Auto-upgrade settings.

```
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

-**SiteId \<uint>**\
Site ID from which to modify the Auto-upgrade settings.

If the parameter is omitted, the Licensing Server site ID will be used.

```
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

-**Id \<uint>**\
The ID of a server for which to modify the Auto-upgrade settings.

```
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

-**InputObject <**[**RASSerilazableObj**](../classes-and-enumerations/rasserilazableobj)**>**\
An object of type RDS, RDSHostPool, VDITemplate or VDIDesktop for which to modify the Auto-upgrade settings.

```
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

-**ObjType <**[**HostPoolObjType**](../classes-and-enumerations/hostpoolobjtype)**>**\
The Object Type for which to modify the Auto-upgrade settings.

Possible values: RDSHostPool, VDIHostPool, AVDHostPool

```
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

-**DefObjType <**[**ServerDefObjType**](../classes-and-enumerations/serverdefobjtype)**>**\
The Default Object Type for which to modify the Auto-upgrade settings.

Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings, VDIGuestDef

```
        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 ----------**

Add-RASAutoUpgradeMessage -DefObjType RDSDef -Enabled 0 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"

Adds a message to the Auto-upgrade settings of the RDS Default Settings.\
&#xNAN;**---------- EXAMPLE 2 ----------**

Add-RASAutoUpgradeMessage -Name "VDIHostPool1" -ObjType VDIHostPool -Enabled 0 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"

Adds a message to the Auto-upgrade settings of the specified VDIHostPool by Name.\
&#xNAN;**---------- EXAMPLE 3 ----------**

Add-RASAutoUpgradeMessage -Id 1 -ObjType AVDHostPool -Enabled 0 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"

Adds a message to the Auto-upgrade settings of the specified AVDHostPool by Id.

## RELATED LINKS

* [Get-RASAutoUpgrade](get-rasautoupgrade)
* [Get-RASAutoUpgradeMessage](get-rasautoupgrademessage)
* [Set-RASAutoUpgradeMessage](set-rasautoupgrademessage)
* [Remove-RASAutoUpgradeMessage](remove-rasautoupgrademessage)
