Loading...

Get-CVJobDetail

The Get-CVJobDetail cmdlet returns the details of a job.

Before you can use this cmdlet, you must log on to your CommCell environment using the Connect-CVServer cmdlet. For more information, see Connecting to a CommCell Environment with PowerShell.

Syntax

Get-CVJobDetail [-JobId] <Int32> [<CommonParameters>]

Get-CVJobDetail -JobObject <Object> [<CommonParameters>]

Required Parameters

Parameter

Description

Data type

Values

Accepts pipeline input?

Accepts wildcard characters?

Type of parameter

-JobId

The ID of the job.

Int32

The default value is 0.

No

No

Named

-JobObject

An object that represents the job.

Object

 

Yes, by:

  • Value
  • Property name

No

Named

Optional Parameters

Microsoft PowerShell Parameters

You can use the following Microsoft PowerShell parameters:

  • Debug
  • ErrorAction
  • ErrorVariable
  • OutBuffer
  • OutVariable
  • PipelineVariable
  • Verbose
  • WarningAction
  • WarningVariable
  • Force
  • Confirm
  • WhatIf

Note: Only a few cmdlets support Force, Confirm, and WhatIf parameters.

For more information, see "About Common Parameters" in the Microsoft PowerShell documentation.

Input

This cmdlet does not support input.

Output

A PSCustomObject that contains job details.

Example: Get Details of a Job

The following example returns information for job 100.

Get-CVJobDetail -JobId 100

Last modified: 3/18/2020 7:43:26 AM