Remove-RASSchedule

NAME

Remove-RASSchedule

SYNOPSIS

Removes a Schedule.

SYNTAX

Remove-RASSchedule [-Id] <uint> -ObjType {RDS | VDI | AVD} [-TargetType {Host | HostPool}] [<CommonParameters>] Remove-RASSchedule [-InputObject] <Schedule> [-TargetType {Host | HostPool}] [<CommonParameters>] Remove-RASSchedule [-Name] <string> [[-SiteId] <uint>] -ObjType {RDS | VDI | AVD} [-TargetType {Host | HostPool}] [<CommonParameters>]

DESCRIPTION

Removes a Schedule property.

PARAMETERS

-SiteId <uint> Site ID from which to delete 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

-Name <string> Scheduler job name.

        Required?                    true
        Position?                    0
        Default value                
        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

<CommonParameters>

        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters . 

INPUTS

Schedule

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ---------- Remove-RASSchedule "My Schedule" -ObjType RDS Removes the Schedule property specified by name. To remove a Schedule property from a specific site, specify the -SiteId parameter. ---------- EXAMPLE 2 ---------- Remove-RASSchedule -Id 10 -ObjType RDS Removes the Schedule property specified by ID. To obtain the group ID, use the Get-RASSchedule cmdlet. ---------- EXAMPLE 3 ---------- Get-RASSchedule -Id 10 | Remove-RASSchedule Removes the Schedule property, which is identified by the object obtained from the pipeline output.

Last updated

© 2024 Parallels International GmbH. All rights reserved.