Get-SCDWJob

Get-SCDWJob

Gets the list of all data warehouse jobs, displaying information such as the status of these jobs.

Syntax

Parameter Set: JobNameSet
Get-SCDWJob [-ComputerName <String> ] [-Credential <PSCredential> ] [-JobName <String> ] [-NumberOfBatches <Int32> ] [ <CommonParameters>]

Parameter Set: JobIDSet
Get-SCDWJob -JobBatchID <Nullable`1> [-ComputerName <String> ] [-Credential <PSCredential> ] [ <CommonParameters>]

Detailed Description

The Get-SCDWJob cmdlet gets the list of all data warehouse jobs, displaying information such as the status of these jobs.

Parameters

-ComputerName<String>

Specifies the name of the computer on which the System Center Data Access service is running. The user account that is defined in the Credential parameter must have access rights to the specified computer. You can omit this parameter only if the System Center Data Access Service is running on the same computer that has Service Manager installed.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Credential<PSCredential>

Specifies the credentials to use when you are connecting to the server on which the System Center Data Access service is running. The provided user account must have access to that server.

Aliases

none

Required?

false

Position?

named

Default Value

none

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 in conjunction 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 in conjunction 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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None.

    You cannot pipe input to this cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.EnterpriseManagement.OrchestrationJob

Examples

-------------------------- EXAMPLE 1 --------------------------

The command in this example lists data warehouse jobs.

PS C:\> Get-SCDWJob -ComputerName serverDW7 –NumberOfBatches 4

-------------------------- EXAMPLE 2 --------------------------

This command gets Transform.Common jobs.

PS C:\> Get-SCDWjob -ComputerName serverDW7 -JobName Transform.Common -NumberOfBatches 2

------------------------- EXAMPLE 3 --------------------------

This command gets jobs that have a status of 'Not Started' and that have a batch ID greater than 800.

PS C:\> Get-SCDWJob -ComputerName ServerDW7 –NumberOfBatches 4| Where-Object {$_.Status -eq "Not Started" -and $_.BatchID -gt 800}

-------------------------- EXAMPLE 4 --------------------------

This command gets all the job property values and saves the results to a CSV file.

PS C:\> Get-SCDWJobModule -ComputerName serverDW7 -NumberOfBatches 4 | Select-Object -Property BatchId, CategoryId, CategoryName, CreationTime, Description, EndTime, Id, IsEnabled, IsRecuring, LastRunTime, ManagementGroup, ModifedTime, Modules, Name, NextRuntime, Schedule, ScheduleRuleID, SourceTypeName, StartTime, Status, StatusID, WorkflowRuleID | Export-Csv C:\DWData\JobData.csv

Enable-SCDWJob

Get-SCDWJobModule

Start-SCDWJob