|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Stop-NcJob
NAME
Stop-NcJob
SYNOPSIS
Stop a job.
SYNTAX
Stop-NcJob [-Id] <Decimal> [-VserverContext <String>] [-Controller <NcContro
ller[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Stop a job. A job must be of a type that has job-type-is-quittable set to t
rue before it may be stopped. Stop-NcJob attempts to stop a job that's curr
ently running. If the job allows itself to stop it completes its current ru
n. If the job has a recurring schedule it will transition to the Queued sta
te; otherwise it will transition into either the Success or Failure state.
PARAMETERS
-Id <Decimal>
The ID of the job to stop.
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
-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-stop
Family: vserver
-------------- Example 1 --------------
C:\PS>Stop-NcJob -Id 61 -VserverContext tesla
Stop the job.
JobId : 61
NcController : 192.168.182.119
IsRestarted : False
JobAffinity : cluster
JobCategory : VOPL
JobCompletion :
JobDescription : Move "luns" in Vserver "joule" to aggregate "aggr
1"
JobDropdeadTime :
JobDropdeadTimeDT :
JobEndTime :
JobEndTimeDT :
JobName : Volume Move
JobNode : tesla-01
JobPriority : high
JobProcess : mgwd
JobProgress : Transferring data: 26.75MB sent.
JobQueueTime : 1342190438
JobQueueTimeDT : 7/13/2012 2:40:38 PM
JobSchedule : @now
JobStartTime : 1342190439
JobStartTimeDT : 7/13/2012 2:40:39 PM
JobState : running
JobStatusCode : 0
JobType : MOVE
JobUsername : admin
JobUuid : b6ceddc2-ccf8-11e1-b8ba-123478563412
JobVserver : tesla
IsRestartedSpecified : True
JobDropdeadTimeSpecified : False
JobEndTimeSpecified : False
JobIdSpecified : True
JobQueueTimeSpecified : True
JobStartTimeSpecified : True
JobStatusCodeSpecified : True
RELATED LINKS
Get-NcJob
Update-NcJob
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|