Remove-RDSSchedule

NAME

Remove-RDSSchedule

SYNOPSIS

Removes RD Session Host scheduler job(s).

SYNTAX

Remove-RDSSchedule [-Name] <string> [[-SiteId] <uint>] [<CommonParameters>]

Remove-RDSSchedule [-Id] <uint> [<CommonParameters>]

Remove-RDSSchedule [-InputObject] <RDSSchedItem> [<CommonParameters>]

DESCRIPTION

The Remove-RDSSchedule command is used to remove RD Session Host scheduler jobs.

PARAMETERS


-Name <string>
Schedule job name. 

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

-SiteId <uint>
Site ID from which to remove the specified scheduler job. 

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

-Id <uint>
Schedule job ID. 

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

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

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

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        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

RDSSchedItem

OUTPUTS

-none-

EXAMPLES


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

Remove-RDSSchedule -SiteId 1 -Name TSSchedule1

Removes a scheduler job named 'TSSchedule1'.

---------- EXAMPLE 2 ----------

Remove-RDSSchedule -Id 1

Removes a scheduler job with ID 1.

---------- EXAMPLE 3 ----------

Remove-RDSSchedule -InputObject $schedJob

Removes a scheduler job represented by the $schedJob object.

---------- EXAMPLE 4 ----------

Get-RDSSchedule -Id 1 ! Remove-RDSSchedule

Removes a scheduler job represented by the object obtained from the pipeline output.

RELATED LINKS