|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Update-NcJob
NAME
Update-NcJob
SYNOPSIS
Stop, pause or resume one or more jobs.
SYNTAX
Update-NcJob [-VserverContext <String>] -Query <JobInfo> -Suspend -Soft [-Co
ntinueOnFailure] [-MaxFailureCount <Int32>] [-Controller <NcController[]>] [
-WhatIf] [-Confirm] [<CommonParameters>]
Update-NcJob [-VserverContext <String>] -Query <JobInfo> -Resume [-ContinueO
nFailure] [-MaxFailureCount <Int32>] [-Controller <NcController[]>] [-WhatIf
] [-Confirm] [<CommonParameters>]
Update-NcJob [-VserverContext <String>] -Query <JobInfo> -Stop [-ContinueOnF
ailure] [-MaxFailureCount <Int32>] [-Controller <NcController[]>] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
Stop, pause or resume one or more jobs. This cmdlets uses the query mechani
sm to update multiple records at once.
PARAMETERS
-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? false
Accept wildcard characters? false
-Query <JobInfo>
A JobInfo object with various fields set to indicate which jobs to modif
y. Other fields should remain set to null. Use "Get-NcJob -Template" t
o get the initially empty JobInfo object.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Suspend
Specify to suspend one or more jobs.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Soft
Specify along with -Suspend to effect a "soft" pause.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ContinueOnFailure
This input element is useful when multiple objects match a given query.
If set to true, the API will continue modifying the next matching objec
t even when modification of a previous object fails. If set to false, t
he API will return on the first failure. Default: false.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-MaxFailureCount <Int32>
When allowing failures, then this input element may be provided to limit
the number of failed modify operations before the server gives up and r
eturns. If set, the cmdlet will continue modifying the next matching ob
ject even when the modification of a previous matching object fails, and
do so until the total number of objects failed to be modified reaches t
he maximum specified. If set to the maximum or not provided, then there
will be no limit on the number of failed modify operations. Only appli
cable if ContinueOnFailure is specified. Default: 2^32-1
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
-Resume
Specify to resume one or more jobs.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Stop
Specify to stop one or more jobs.
Required? true
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.PowerShell.SDK.Cmdlets.TableModifyResult
NOTES
Category: job
API: job-pause-iter, job-soft-pause-iter, job-resume-iter, job-stop-iter
Family: cluster, vserver
-------------- Example 1 --------------
C:\PS>$q = Get-NcJob -Template
$q.JobName = "Volume Move"
$q.JobState = "running"
Update-NcJob -Query $q -Stop
Stop all running volume move jobs.
NcController : 192.168.182.119
SuccessCount : 1
FailureCount : 0
SuccessList : {DataONTAP.C.Types.Job.JobInfo}
FailureList : {}
RELATED LINKS
Get-NcJob
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|