New-RASSchedule
NAME
New-RASSchedule
SYNOPSIS
Creates a new Schedule.
SYNTAX
New-RASSchedule [Name] (string)** [[-SiteId] (uint)] -Action {Disable | Reboot | Startup | Shutdown | Recreate} -HostAzureID (string) -ObjType {RDS | VDI | AVD} -PoolId (uint) -TargetType {Host | HostPool} [CompleteIn (uint)] [Description (string)] [DurationInSecs (double)] [Enabled (bool)] [EnableDrainMode (bool)] [EnforceScheduleInactiveHost (bool)] [ForceServerRebootAfter (uint)] [MembersToStart (uint)] [OnDisable (bool)] [PercentageMembers (uint)] [PoolMembersType (uint)] [PowerOnAssignedPoolMembers (uint)] [-Repeat {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear | SpecificDays}] [-SpecificDays {Never | Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [StartDateTime (DateTime)] [Type (uint)] [(CommonParameters)]
New-RASSchedule [Name] (string)** [[-SiteId] (uint)] -Action {Disable | Reboot | Startup | Shutdown | Recreate} -GuestName (string) -GUID (string) -ObjType {RDS | VDI | AVD} -PoolId (uint) -TargetType {Host | HostPool} [CompleteIn (uint)] [Description (string)] [DurationInSecs (double)] [Enabled (bool)] [EnableDrainMode (bool)] [EnforceScheduleInactiveHost (bool)] [ForceServerRebootAfter (uint)] [MembersToStart (uint)] [OnDisable (bool)] [PercentageMembers (uint)] [PoolMembersType (uint)] [PowerOnAssignedPoolMembers (uint)] [-Repeat {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear | SpecificDays}] [-SpecificDays {Never | Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [StartDateTime (DateTime)] [Type (uint)] [(CommonParameters)]
New-RASSchedule [Name] (string)** [[-SiteId] (uint)] -Action {Disable | Reboot | Startup | Shutdown | Recreate} -ObjType {RDS | VDI | AVD} -TargetID (uint) -TargetType {Host | HostPool} [CompleteIn (uint)] [Description (string)] [DurationInSecs (double)] [Enabled (bool)] [EnableDrainMode (bool)] [EnforceScheduleInactiveHost (bool)] [ForceServerRebootAfter (uint)] [MembersToStart (uint)] [OnDisable (bool)] [PercentageMembers (uint)] [PoolMembersType (uint)] [PowerOnAssignedPoolMembers (uint)] [-Repeat {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear | SpecificDays}] [-SpecificDays {Never | Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [StartDateTime (DateTime)] [Type (uint)] [(CommonParameters)]
DESCRIPTION
Creates a new Schedule property.
PARAMETERS
Name (string)
Schedule name.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? falseSiteId (uint)
Site ID from which to retrieve the schedule.
Required? false
Position? 1
Default value 0
Accept pipeline input? false
Accept wildcard characters? falseObjType (ScheduleObjType)
Schedule object type.
Possible values: RDS, VDI, AVD
Required? true
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? falseAction (ScheduleActionType)
Schedule Action Type
Possible values: Disable, Reboot, Startup, Shutdown, Recreate
Required? true
Position? named
Default value Disable
Accept pipeline input? false
Accept wildcard characters? falseTargetType
(ScheduleTargetType) Schedule target type. Accepted values: Host, Host Pool.
Possible values: Host, HostPool
Required? true
Position? named
Default value Host
Accept pipeline input? false
Accept wildcard characters? falseEnabled (bool)
Whether to enable or disable the schedule.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDescription (string)
Schedule description.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseType (uint)
Schedule type
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseTargetID (uint)
The target RD Session Host server or server group Ids depending on the TargetType parameter.
Required? true
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? falsePoolId (uint)
The TargetNativeHost Pool Id
Required? true
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? falseGUID (string)
The TargetNativeHost GUID
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseGuestName (string)
The TargetNativeHost Guest Name
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseHostAzureID (string)
The TargetNativeHost Host Azure ID
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseStartDateTime (DateTime)
Start time. Default: Now.
Required? false
Position? named
Default value 28/04/2025 14:21:02
Accept pipeline input? false
Accept wildcard characters? falseDurationInSecs (double)
Duration in seconds.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseRepeat (RepeatType)
Repeat interval. Default: EveryWeek
Accepted values: Never, EveryDay, EveryWeek, Every2Weeks, EveryMonth, EveryYear.
Possible values: Never, EveryDay, EveryWeek, Every2Weeks, EveryMonth, EveryYear, SpecificDays
Required? false
Position? named
Default value EveryWeek
Accept pipeline input? false
Accept wildcard characters? falseSpecificDays
(RepeatSpecificDays) Repeat on Specific Days.
Possible values: Never, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
Required? false
Position? named
Default value Never
Accept pipeline input? false
Accept wildcard characters? falseCompleteIn (uint)
The duration of the scheduler task in minutes.
Default: 15 minutes for disable task, 10 minutes for reboot task.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falsePoolMembersType (uint)
Whether to select the percentage or specific number of members to be started
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falsePercentageMembers (uint)
Percentage of members to be started
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseMembersToStart (uint)
Specific number of members to be started
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falsePowerOnAssignedPoolMembers (uint)
Power On Assigned Pool Members
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseEnableDrainMode (bool)
Whether to enable Drain Mode
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseForceServerRebootAfter (uint)
Force server reboot after the specified time in seconds
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseEnforceScheduleInactiveHost (bool)
Enforce schedule for currently inactive host
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseOnDisable (bool)
What action to take on Disable
Required? false
Position? named
Default value
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
EXAMPLES
**---------- EXAMPLE 1 ----------
New-RASSchedule "My Schedule" -ObjType RDS -Action Disable -TargetType Host
Creates a new Schedule property with the specified name.
RELATED LINKS
Last updated