Skip to main content

Stop-LXCAJob

This cmdlet cancels one or more running or pending jobs on the Lenovo XClarity Administrator server.

Note

  • This cmdlet will be deprecated at a future date. Use Stop-LXCATask instead.

  • You cannot pipe objects to this cmdlet.

Syntax​

Stop-LXCAJob [-Connection LXCAConnection] 
              -JobID String[]
             [CommonParameter]

Stop-LXCAJob [-Connection LXCAConnection] 
              -Job Job[]
             [CommonParameter]

Parameters​

-Connection LXCAConnection
Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used.
-JobID String[]
Specifies one or more job IDs.
-Job Job[]
Specifies one or more job instances.
CommonParameters
This cmdlet supports the following common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable, -OutBuffer, -PipelineVariable, -OutVariable. For detailed information about each common parameter, see the Microsoft PowerShell Common Parameters webpage.

Results​

  • System.String[]

    This cmdlet stops one or more jobs on the XClarity Administrator server and returns the job IDs of the stopped jobs as an array of strings.

    If none of the specified tasks can be stopped, the returned object is an empty array.

Examples​

The following example cancels all running and pending jobs from the XClarity Administrator server.

$cred = Get-Credential
Connect-LXCA -Host 192.0.2.0 -Credential $cred

$jobs = Get-LXCAJob -State Running,Pending
Foreach($job in $jobs)
{
    Stop-LXCAJob -Job $job
}

Disconnect-LXCA