Set-RASAutoUpgrade
NAME
Set-RASAutoUpgrade
SYNOPSIS
Modifies the Auto-upgrade settings.
SYNTAX
Set-RASAutoUpgrade -DefObjType** {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} [DrainModeDurationInSecs (double)] [Enabled (bool)] [ForceLogoffSessions (bool)] [-Repeat {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear | SpecificDays}] [SiteId (uint)] [-SpecificDays {Never | Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [StartDateTime (DateTime)] [(CommonParameters)]
Set-RASAutoUpgrade [Id] (uint)** -ObjType {RDSHostPool | VDIHostPool | AVDHostPool} [DrainModeDurationInSecs (double)] [Enabled (bool)] [ForceLogoffSessions (bool)] [-Repeat {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear | SpecificDays}] [-SpecificDays {Never | Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [StartDateTime (DateTime)] [(CommonParameters)]
Set-RASAutoUpgrade [-InputObject] (RASSerilazableObj) [DrainModeDurationInSecs (double)] [Enabled (bool)] [ForceLogoffSessions (bool)] [-Repeat {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear | SpecificDays}] [-SpecificDays {Never | Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [StartDateTime (DateTime)] [(CommonParameters)]
Set-RASAutoUpgrade [Name]** (string) [[-SiteId] (uint)] -ObjType {RDSHostPool | VDIHostPool | AVDHostPool} [DrainModeDurationInSecs (double)] [Enabled (bool)] [ForceLogoffSessions (bool)] [-Repeat {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear | SpecificDays}] [-SpecificDays {Never | Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [StartDateTime (DateTime)] [(CommonParameters)]
DESCRIPTION
Modifies the Auto-upgrade settings of RDSHostPool, RDSDefaults, VDIHostPool, VDIDefaults, AVDHostPool or AVDDefaults (Single-Session/Multi-Session).
PARAMETERS
Enabled (bool)
Enable auto-upgrade maintenance window
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
StartDateTime (DateTime)
Start Date
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
DrainModeDurationInSecs (double)
Drain mode duration
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
ForceLogoffSessions (bool)
Force logoff sessions at the end of the drain mode period
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
Repeat (RepeatType)
Recur
Possible values: Never, EveryDay, EveryWeek, Every2Weeks, EveryMonth, EveryYear, SpecificDays
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
SpecificDays
(RepeatSpecificDays) Specific Days
Possible values: Never, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
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-RASAutoUpgrade -DefObjType RDSDef -Enabled $true
Enables the Auto-upgrade settings of the RDS Default Settings. **---------- EXAMPLE 2 ----------
Set-RASAutoUpgrade -Name "VDIHostPool1" -ObjType VDIHostPool -Enabled $false
Disables the Auto-upgrade settings of the specified VDIHostPool by Name. **---------- EXAMPLE 3 ----------
Set-RASAutoUpgrade -Id 1 -ObjType AVDHostPool -Enabled $true
Enables the Auto-upgrade settings of the specified AVDHostPool by Id.
RELATED LINKS
Last updated