Get-SCDWJob
Get-SCDWJob
Gets the job status of all recurring jobs, including extract, transform, and load jobs.
Syntax
Parameter Set: JobNameSet
Get-SCDWJob [-ComputerName <String> ] [-JobName <String> ] [-NumberOfBatches <Int32> ] [ <CommonParameters>]
Parameter Set: JobIDSet
Get-SCDWJob -JobBatchID <Nullable`1> [-ComputerName <String> ] [ <CommonParameters>]
Detailed Description
The Get-SCDWJob cmdlet returns job status for all recurring Data Warehouse jobs.
Parameters
-ComputerName<String>
Specifies the name of the server on which the Data Warehouse management server is installed.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
. |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobBatchID<Nullable`1>
Specifies the batch ID of the job run to return. A job batch ID is generated by the system for each individual run of a job. This integer value is unique across job runs of all types. This parameter cannot be used together with the JobName parameter.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobName<String>
Specifies the name of the Data Warehouse job instance for which you want to get status. This parameter cannot be used together with the JobBatchID parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-NumberOfBatches<Int32>
Specifies the number of batches for which you want to display status. This value must be greater than or equal to 1.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None.
Outputs
The output type is the type of the objects that the cmdlet emits.
- None.
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
This command retrieves the status of all jobs.
C:\PS>Get-SCDWJob
BatchId Name Status CategoryName StartTime EndTime IsEnabled
------- ---- ------ ------------ --------- ------- ---------
75 Transform.Common Failed Transform 11/6/2009 1:05:00 PM 11/9/2009 10:36:00 AM True
1246 DWMaintenance Not Started Maintenance True
1248 Load.Common Not Started Load True
1261 MPSyncJob Not Started Synchronization True
1272 Extract_dwmg Running Extract 11/9/2009 10:59:00 AM True
1273 Extract_smg Running Extract 11/9/2009 10:59:00 AM True
-------------------------- EXAMPLE 2 --------------------------
Description
-----------
This command retrieves the current status of the Extract_smg job.
C:\PS>Get-SCDWJob -JobName Extract_smg
BatchId Name Status CategoryName StartTime EndTime IsEnabled
------- ---- ------ ------------ --------- ------- ---------
1273 Extract_smg Running Extract 11/9/2009 10:59:00 AM True
-------------------------- EXAMPLE 3 --------------------------
Description
-----------
This command retrieves the status of the job with batch ID 369.
C:\PS>Get-SCDWJob -JobBatchId 1273
BatchId Name Status CategoryName StartTime EndTime IsEnabled
------- ---- ------ ------------ --------- ------- ---------
1273 Extract_smg Completed Extract 11/9/2009 10:59:00 AM 11/9/2009 11:02:00 AM True
-------------------------- EXAMPLE 4 --------------------------
Description
-----------
This command retrieves the status of the last 2 runs of the Extract_smg job.
C:\PS>Get-SCDWJob -JobName Extract_smg -NumberOfBatches 2
BatchId Name Status CategoryName StartTime EndTime IsEnabled
------- ---- ------ ------------ --------- ------- ---------
1273 Extract_smg Completed Extract 11/9/2009 10:59:00 AM 11/9/2009 11:02:00 AM True
1275 Extract_smg Not Started Extract True
Related topics
Getting Started with Service Manager Cmdlets for Windows PowerShell
Disable-SCDWJob
Enable-SCDWJob
Get-SCDWJobModule
Resume-SCDWJob
Start-SCDWJob
Suspend-SCDWJob