Skip to main content

Remove-LXCAJob

This cmdlet deletes one or more jobs from the Lenovo XClarity Administrator server. The job must be in a stopped, cancelled, or complete state before it can be removed.

Note

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

  • You cannot pipe objects to this cmdlet.

Syntax​

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

Remove-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 cmdlets deletes one or more jobs on the XClarity Administrator server and returns the job IDs of the deleted jobs as an array of strings.

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

Examples​

The following example deletes all jobs that are are in Cancelled state from the XClarity Administrator server.

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

$jobs = Get-LXCAJob -State Cancelled
Foreach($job in $jobs)
{
   Remove-LXCAJob -Job $job
}

Disconnect-LXCA