New-RASSchedule

NAME

New-RASSchedule

SYNOPSIS

Creates a new Schedule.

SYNTAX

New-RASSchedule [-Name] <string> [[-SiteId] <uint>] -Action {Disable | Reboot | Startup | Shutdown} -GuestName <string> -GUID <string> -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} -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?  false

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

        Required?                    false
        Position?                    1
        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

-Action <ScheduleActionType>
Schedule Action Type

Possible values: Disable, Reboot, Startup, Shutdown 

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

-TargetType <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?  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

-Type <uint>
Type 

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

-TargetID <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?  false

-PoolId <uint>
Pool Id 

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

-GUID <string>
GUID 

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

-GuestName <string>
Guest Name 

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

-HostAzureID <string>
Host Azure ID 

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

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

        Required?                    false
        Position?                    named
        Default value                12/7/2023 10:24:12 AM
        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>
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?  false

-SpecificDays <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?  false

-CompleteIn <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?  false

-PoolMembersType <uint>
Pool Members Type 

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

-PercentageMembers <uint>
Percentage of members 

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

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

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

-PowerOnAssignedPoolMembers <uint>
Power On Assigned Pool Members 

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

-EnableDrainMode <bool>
Enable Drain Mode 

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

-ForceServerRebootAfter <uint>
Force server reboot after 

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

-EnforceScheduleInactiveHost <bool>
Enforce schedule for currently inactive host 

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

-OnDisable <bool>
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

Schedule

EXAMPLES


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

New-RASSchedule "My Schedule" -ObjType RDS -Action Disable -TargetType Server

Creates a new Schedule property with the specified name.

RELATED LINKS