< Back
Stop-RDVirtualDesktopCollectionJob
Post
NAME Stop-RDVirtualDesktopCollectionJob
SYNOPSIS
Stops a job on a virtual desktop collection.
SYNTAX
Stop-RDVirtualDesktopCollectionJob [-CollectionName] <String> [-ConnectionBroker <String>] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Stop-RDVirtualDesktopCollectionJob cmdlet forcibly ends a job that the server is currently running, or that is scheduled to run, on a virtual
desktop collection. You can use the Get-RDVirtualDesktopCollectionJobStatus to get status information for the most recent job on a virtual desktop
collection.
PARAMETERS
-CollectionName <String>
Specifies the name of a virtual desktop collection.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConnectionBroker [<String>]
Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a remote desktop deployment. If you do not specify a value,
the cmdlet uses the fully qualified domain name (FQDN) of the local computer.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Object
Example 1: Stop a virtual desktop collection job
PS C:\\> Stop-RDVirtualDesktopCollectionJob -CollectionName "Virtual Desktop Pool" -ConnectionBroker "rdcb.contoso.com"
This command stops a job on the virtual desktop collection named Virtual Desktop Pool that is associated with the RD Connection Broker server
named rdcb.contoso.com.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294272
Get-RDVirtualDesktopCollectionJobStatus
Get-RDVirtualDesktopCollectionConfiguration
SYNOPSIS
Stops a job on a virtual desktop collection.
SYNTAX
Stop-RDVirtualDesktopCollectionJob [-CollectionName] <String> [-ConnectionBroker <String>] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Stop-RDVirtualDesktopCollectionJob cmdlet forcibly ends a job that the server is currently running, or that is scheduled to run, on a virtual
desktop collection. You can use the Get-RDVirtualDesktopCollectionJobStatus to get status information for the most recent job on a virtual desktop
collection.
PARAMETERS
-CollectionName <String>
Specifies the name of a virtual desktop collection.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConnectionBroker [<String>]
Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a remote desktop deployment. If you do not specify a value,
the cmdlet uses the fully qualified domain name (FQDN) of the local computer.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Object
Example 1: Stop a virtual desktop collection job
PS C:\\> Stop-RDVirtualDesktopCollectionJob -CollectionName "Virtual Desktop Pool" -ConnectionBroker "rdcb.contoso.com"
This command stops a job on the virtual desktop collection named Virtual Desktop Pool that is associated with the RD Connection Broker server
named rdcb.contoso.com.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294272
Get-RDVirtualDesktopCollectionJobStatus
Get-RDVirtualDesktopCollectionConfiguration