|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Suspend-NcJob
NAME
Suspend-NcJob
SYNOPSIS
Pause a job.
SYNTAX
Suspend-NcJob [-Id] <Decimal> [-VserverContext <String>] [-Soft] [-Controlle
r <NcController[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Pause a job. A job must be of a type that has job-type-is-pausible set to t
rue before it may be paused. Once notified of a pause request, a job should
stop performing work until it is subsequently resumed.
If -Soft is specified:
Soft pause a job. Indicates to the job that a soft pause has been initiated
. It is up to the job to do what it needs to do for a soft pause. As a res
ult of this command the job may request to be moved into the runnnable queue
to perform further processing of the soft pause.
PARAMETERS
-Id <Decimal>
The ID of the job to pause.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-VserverContext <String>
Vserver to which to direct this command. If the currently connected con
troller (as embodied by an NcController object) represents a cluster, th
ere are multiple means to address commands to one of its vservers. Eith
er set the Vserver field on the NcController object to direct all subseq
uent commands to that vserver, or supply the VserverContext parameter to
an individual cmdlet. Only cmdlets which may be invoked on vservers of
fer the VserverContext parameter.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Soft
Specify to effect a "soft" pause.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Controller <NcController[]>
A clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach controller in succession.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-WhatIf
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm
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 and OutVariable. For more information, type,
"get-help about_commonparameters".
INPUTS
OUTPUTS
DataONTAP.C.Types.Job.JobInfo
NOTES
Category: job
API: job-resume
Family: vserver
RELATED LINKS
Resume-NcJob
Stop-NcJob
Update-NcJob
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|