The Get-CVJob
cmdlet returns a list of jobs in your CommCell environment. By default, the list filters jobs that completed in last 24 hours. To increase the completion time window, you can set the CompletedTime
parameter.
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-CVJob [[-ClientName] <String>] [[-SubclientName] <String>] [[-JobFilter] <String>] [[-JobCategory] <String>] [[-CompletedTime] <Int32>] [-AllProperties] [<CommonParameters>]
Optional
Commvault Parameters
Parameter | Description | Data type | Values | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter |
---|---|---|---|---|---|---|
– | The ID of the job. | Int32 | The default value is 0. | Yes, by:
| No | Named |
– | The name of the client to get a list of jobs for. | String | No | No | Named | |
– | The name of the subclient to get a list of jobs for. | String | No | No | Named | |
– | Filters the list of jobs by job type. | String | Valid values include the following:
| No | No | Named |
– | Filters the list of jobs by job category. | String | Valid values include the following:
| No | No | Named |
– | Filters the list of jobs that completed in last X hours. | Int32 | The default value is 24. | No | No | Named |
| Retrieves the details of the jobs. | SwitchParameter | No | No | Named | |
| Includes a total count of the jobs. | SwitchParameter | No | No | Named | |
| This parameter allows you to skip the first 'x' number of pages from the output and then displays the rest of the pages. | UInt64 | No | No | Named | |
| This parameter allows you to display first 'x' number of records in one page and the remaining records in the next page. | UInt64 | No | No | Named |
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
List Jobs By Subclient and Completed in Last 72 Hours
The following example retrieves a list of jobs that ran on the snap_backup2 subclient and that completed in last 72 hours.
Get-CVJob -ClientName VC2KR2 -SubclientName snap_backup2 -CompletedTime 72
List Jobs with Paging Support
The following example returns a total list of jobs with first 5 jobs in one page, starting the output on the first page.
Get-CVJob -IncludeTotalCount -First 5 -Skip 0