Set-RASAutoUpgradeMessage
NAME
Set-RASAutoUpgradeMessage
SYNOPSIS
Modifies an Auto-upgrade Message within Auto-upgrade settings.
SYNTAX
Set-RASAutoUpgradeMessage -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -MessageId <uint> [-Enabled <bool>] [-Message <string>] [-MessageTitle <string>] [-SendMsgSecs <uint>] [-SendMsgWhen {Before | After}] [-SiteId <uint>] [<CommonParameters>]
Set-RASAutoUpgradeMessage [-Id] <uint> -MessageId <uint> -ObjType {RDSHostPool | VDIHostPool | AVDHostPool} [-Enabled <bool>] [-Message <string>] [-MessageTitle <string>] [-SendMsgSecs <uint>] [-SendMsgWhen {Before | After}] [<CommonParameters>]
Set-RASAutoUpgradeMessage [-InputObject] <RASSerilazableObj> -MessageId <uint> [-Enabled <bool>] [-Message <string>] [-MessageTitle <string>] [-SendMsgSecs <uint>] [-SendMsgWhen {Before | After}] [<CommonParameters>]
Set-RASAutoUpgradeMessage [-Name] <string> [[-SiteId] <uint>] -MessageId <uint> -ObjType {RDSHostPool | VDIHostPool | AVDHostPool} [-Enabled <bool>] [-Message <string>] [-MessageTitle <string>] [-SendMsgSecs <uint>] [-SendMsgWhen {Before | After}] [<CommonParameters>]
DESCRIPTION
Modifies an Auto-upgrade Message within Auto-upgrade settings.
PARAMETERS
-MessageId <uint> Auto-upgrade job message ID.
Required? true
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false-Enabled <bool> Whether to enable or disable the message.
Required? false
Position? named
Default value
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? false
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
Accept pipeline input? false
Accept wildcard characters? false-SendMsgWhen <SendMsgWhen> Whether the message is sent Before/After the AutoUpgrade is triggered.
SendMsgWhen can only be set to After in the case of Reboot.
Possible values: Before, After
Required? false
Position? named
Default value
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> 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> 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> 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 ----------
Set-RASAutoUpgradeMessage -DefObjType RDSDef -MessageId 1 -Enabled 1 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"
Modifies the specified message by id within the Auto-upgrade settings of the RDS Default Settings. ---------- EXAMPLE 2 ----------
Set-RASAutoUpgradeMessage -Name "VDIHostPool1" -ObjType VDIHostPool -MessageId 1 -Enabled 1 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"
Modifies the specified message by id within the Auto-upgrade settings of the specified VDIHostPool by Name. ---------- EXAMPLE 3 ----------
Set-RASAutoUpgradeMessage -Id 1 -ObjType AVDHostPool -MessageId 1 -Enabled 1 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"
Modifies the specified message by id within the Auto-upgrade settings of the specified AVDHostPool by Id.
RELATED LINKS
Last updated