Get-LXCATask

This cmdlet retrieves information about one or more tasks (jobs) from the Lenovo XClarity Administrator server.

Note: You cannot pipe objects to this cmdlet.

Syntax

Get-LXCATask [-Connection LXCAConnection] 
              -TaskID String[]
             [CommonParameter]

Get-LXCATask [-Connection LXCAConnection]
             [-TargetUuid String[]]
             [-Category String[]]
             [-State String[]]
             [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.
-TaskID String[]
Specifies one or more task IDs.
-TargetUuid String[]
Specifies one or more UUIDs of the components to which the task belongs.
-Category String[]
Specifies the categories to which the task belongs. You can specify one or more of the following values, separated by a comma.
  • Configuration

  • Custom

  • Firmware

  • Health

  • Inventory

  • Management

  • OsDeployment

  • OsImport

  • OsProfileExport

  • Power

  • RemoteAccess

  • SystemID

  • Service

  • Unknown

-State String[]
Specifies the current states of the task. You can specify one or more of the following values, separated by a comma.
  • Pending
  • Running
  • Complete
  • Cancelled
  • RunningWithErrors
  • CancelledWithErrors
  • StoppedWithError
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

This cmdlet returns one or more Task objects.

Examples

The following example retrieves all tasks that are currently running.

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

$tasks = Get-LXCATask -State Running,RunningWithErrors

Disconnect-LXCA

Related links