> For the complete documentation index, see [llms.txt](https://docs.parallels.com/landing/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/set-rasschedule.md).

# Set-RASSchedule

## SYNOPSIS

Modifies a Schedule.

## SYNTAX

```powershell
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>] [-TriggerOnlyIfSessionStateDown <bool>] [<CommonParameters>]
```

```powershell
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>] [-TriggerOnlyIfSessionStateDown <bool>] [<CommonParameters>]
```

```powershell
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>] [-TriggerOnlyIfSessionStateDown <bool>] [<CommonParameters>]
```

## DESCRIPTION

Modifies a Schedule property.

## EXAMPLES

### Example 1

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

Disables the Schedule property specified by name.

### Example 2

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

Disables the Schedule property specified by ID.

### Example 3

```powershell
Set-RASSchedule $Schedule -Enabled $False
```

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

## PARAMETERS

### -Name

Scheduler job name.

```yaml
Type: string
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SiteId

Site ID from which to retrieve the schedule job.

```yaml
Type: uint
Required: False
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -Id

Scheduler job ID.

```yaml
Type: uint
Required: True
Position: 0
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -ObjType

Schedule object type.

Possible values: RDS, VDI, AVD

Type reference: [ScheduleObjType](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/scheduleobjtype.md)

```yaml
Type: ScheduleObjType
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -InputObject

An object of type Schedule representing the target scheduler job.

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

Type reference: [Schedule](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/schedule.md)

```yaml
Type: Schedule
Required: True
Position: 0
Default value: None
Accept pipeline input: true (ByValue)
Accept wildcard characters: False
```

### -NewName

A new name for the scheduler job.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Enabled

Whether to enable or disable the schedule.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Description

Schedule description.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -StartDateTime

Start time. Default: Now.

```yaml
Type: DateTime
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -DurationInSecs

Duration in seconds.

```yaml
Type: double
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Repeat

Repeat interval. Default: EveryWeek

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

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

Type reference: [RepeatType](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/repeattype.md)

```yaml
Type: RepeatType
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SpecificDays

Repeat on Specific Days.

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

Type reference: [RepeatSpecificDays](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/repeatspecificdays.md)

```yaml
Type: RepeatSpecificDays
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -CompleteIn

The duration of the scheduler task in seconds. Minimum: 60 seconds. Maximum: 2592000 seconds (30 days).

Default: 900 seconds for disable task, 600 seconds for reboot task.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -TriggerOnlyIfSessionStateDown

Specifies if 'Trigger only if a session state is "Down"' option is enabled or disabled.

Only available for reboot schedules for object types RDS and AVD.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -PoolMembersType

Whether to select the percentage or specific number of members to be started

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -PercentageMembers

Percentage of members to be started

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -MembersToStart

Specific number of members to be started

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -PowerOnAssignedPoolMembers

Power On Assigned Pool Members

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -EnableDrainMode

Whether to enable Drain Mode

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ForceServerRebootAfter

Force server reboot after the specified time in seconds

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -EnforceScheduleInactiveHost

Enforce schedule for currently inactive host

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -OnDisable

What action to take on Disable

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about\_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### [Schedule](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/schedule.md)

## OUTPUTS

### None

## RELATED LINKS

* [New-RASSchedule](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/new-rasschedule.md)
* [Get-RASSchedule](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rasschedule.md)
* [Remove-RASSchedule](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/remove-rasschedule.md)
* [Add-RASScheduleMessage](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/add-rasschedulemessage.md)
* [Remove-RASScheduleMessage](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/remove-rasschedulemessage.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/set-rasschedule.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
