Set-RASSchedule

NAME

Set-RASSchedule

SYNOPSIS

Modifies a Schedule.

SYNTAX

Set-RASSchedule [- Id ] <uint> - ObjType {RDS | VDI | AVD} [- CompleteIn <uint> ] [- Description <string> ] [- DurationInSecs <double> ] [- Enabled <bool> ] [- EnableDrainMode <bool> ] [- EnforceScheduleInactiveHost <bool> ] [- ForceServerRebootAfter <uint> ] [- MembersToStart <uint> ] [- NewName <string> ] [- 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> ] [- TargetType {Host | HostPool}] [ < CommonParameters > ]

Set-RASSchedule [- InputObject ] < Schedule > [- CompleteIn <uint> ] [- Description <string> ] [- DurationInSecs <double> ] [- Enabled <bool> ] [- EnableDrainMode <bool> ] [- EnforceScheduleInactiveHost <bool> ] [- ForceServerRebootAfter <uint> ] [- MembersToStart <uint> ] [- NewName <string> ] [- 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> ] [- TargetType {Host | HostPool}] [ < CommonParameters > ]

Set-RASSchedule [[- Name ] <string> ] [[- SiteId ] <uint> ] - ObjType {RDS | VDI | AVD} [- CompleteIn <uint> ] [- Description <string> ] [- DurationInSecs <double> ] [- Enabled <bool> ] [- EnableDrainMode <bool> ] [- EnforceScheduleInactiveHost <bool> ] [- ForceServerRebootAfter <uint> ] [- MembersToStart <uint> ] [- NewName <string> ] [- 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> ] [- TargetType {Host | HostPool}] [ < CommonParameters > ]

DESCRIPTION

Modifies a Schedule property.

PARAMETERS


- Name <string>
Scheduler job name. 

        Required?                    false
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- SiteId <uint>
Site ID from which to retrieve 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 >
Schedule object type.

Possible values: RDS, VDI, AVD 

        Required?                    true
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

- InputObject < Schedule >
An object of type Schedule representing the target scheduler job.

To obtain the object, use the Get-RASSchedule command." 

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

- TargetType < Schedule >
Schedule target type.

Possible values: Host, HostPool 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- NewName <string>
A new name for the scheduler job. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- Enabled <bool>
Whether to enable or disable the schedule. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- Description <string>
Schedule description. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- StartDateTime <DateTime>
Start time. Default: Now. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- DurationInSecs <double>
Duration in seconds. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- Repeat < RepeatType >
Accepted values: Never, EveryDay, EveryWeek, Every2Weeks, EveryMonth, EveryYear.

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 >
Repeat on 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

- CompleteIn <uint>
Default: 15 minutes for disable task, 10 minutes for reboot task. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- PoolMembersType <uint> 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- PercentageMembers <uint> 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- MembersToStart <uint> 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- PowerOnAssignedPoolMembers <uint> 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- EnableDrainMode <bool> 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- ForceServerRebootAfter <uint> 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- EnforceScheduleInactiveHost <bool> 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- OnDisable <bool> 

        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

Schedule

OUTPUTS

-none-

EXAMPLES


---------- EXAMPLE 1 ----------

Set-RASSchedule "My Schedule" -ObjType RDS -Enabled $False

Disables the Schedule property specified by name.
---------- EXAMPLE 2 ----------

Set-RASSchedule -Id 10 -ObjType RDS -Enabled $False

Disables the Schedule property specified by ID.
---------- EXAMPLE 3 ----------

Set-RASSchedule $Schedule -Enabled $False

Disables the Schedule property specified by the $Schedule variable (an object of type Schedule).

RELATED LINKS