All pages
Powered by GitBook
1 of 1

Loading...

Set-RASSchedule

NAME

Set-RASSchedule

SYNOPSIS

Modifies a Schedule.

SYNTAX

Set-RASSchedule [-] <uint> - {RDS | VDI | AVD} [- <uint>] [- <string>] [- <double>] [- <bool>] [- <bool>] [- <bool>] [- <uint>] [- <uint>] [- <string>] [- <bool>] [- <uint>] [- <uint>] [- <uint>] [- {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear | SpecificDays}] [- {Never | Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [- <DateTime>] [<>]

Set-RASSchedule [-] <> [- <uint>] [- <string>] [- <double>] [- <bool>] [- <bool>] [- <bool>] [- <uint>] [- <uint>] [- <string>] [- <bool>] [- <uint>] [- <uint>] [- <uint>] [- {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear | SpecificDays}] [- {Never | Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [- <DateTime>] [<>]

Set-RASSchedule [[-] <string>] [[-] <uint>] - {RDS | VDI | AVD} [- <uint>] [- <string>] [- <double>] [- <bool>] [- <bool>] [- <bool>] [- <uint>] [- <uint>] [- <string>] [- <bool>] [- <uint>] [- <uint>] [- <uint>] [- {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear | SpecificDays}] [- {Never | Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [- <DateTime>] [<>]

DESCRIPTION

Modifies a Schedule property.

PARAMETERS

-Name <string> Scheduler job name.

-SiteId <uint> Site ID from which to retrieve the schedule job.

-Id <uint> Scheduler job ID.

-ObjType <> Schedule object type.

Possible values: RDS, VDI, AVD

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

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

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

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

-Description <string> Schedule description.

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

-DurationInSecs <double> Duration in seconds.

-Repeat <> Repeat interval. Default: EveryWeek

Accepted values: Never, EveryDay, EveryWeek, Every2Weeks, EveryMonth, EveryYear.

Possible values: Never, EveryDay, EveryWeek, Every2Weeks, EveryMonth, EveryYear, SpecificDays

-SpecificDays <> Repeat on Specific Days.

Possible values: Never, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday

-CompleteIn <uint> The duration of the scheduler task in minutes.

Default: 15 minutes for disable task, 10 minutes for reboot task.

-PoolMembersType <uint> Whether to select the percentage or specific number of members to be started

-PercentageMembers <uint> Percentage of members to be started

-MembersToStart <uint> Specific number of members to be started

-PowerOnAssignedPoolMembers <uint> Power On Assigned Pool Members

-EnableDrainMode <bool> Whether to enable Drain Mode

-ForceServerRebootAfter <uint> Force server reboot after the specified time in seconds

-EnforceScheduleInactiveHost <bool> Enforce schedule for currently inactive host

-OnDisable <bool> What action to take on Disable

<CommonParameters>

INPUTS

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

Remove-RASScheduleMessage
Id
ObjType
CompleteIn
Description
DurationInSecs
Enabled
EnableDrainMode
EnforceScheduleInactiveHost
ForceServerRebootAfter
MembersToStart
NewName
OnDisable
PercentageMembers
PoolMembersType
PowerOnAssignedPoolMembers
Repeat
SpecificDays
StartDateTime
CommonParameters
InputObject
Schedule
CompleteIn
Description
DurationInSecs
Enabled
EnableDrainMode
EnforceScheduleInactiveHost
ForceServerRebootAfter
MembersToStart
NewName
OnDisable
PercentageMembers
PoolMembersType
PowerOnAssignedPoolMembers
Repeat
SpecificDays
StartDateTime
CommonParameters
Name
SiteId
ObjType
CompleteIn
Description
DurationInSecs
Enabled
EnableDrainMode
EnforceScheduleInactiveHost
ForceServerRebootAfter
MembersToStart
NewName
OnDisable
PercentageMembers
PoolMembersType
PowerOnAssignedPoolMembers
Repeat
SpecificDays
StartDateTime
CommonParameters
ScheduleObjType
Schedule
RepeatType
RepeatSpecificDays
Schedule
New-RASSchedule
Get-RASSchedule
Remove-RASSchedule
Add-RASScheduleMessage
        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation.