Get-SCDWJobModule

Get-SCDWJobModule

Gets detailed status information about the modules of the job.

Syntax

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

Parameter Set: JobIDSet
Get-SCDWJobModule -JobBatchID <Nullable`1> [-ComputerName <String> ] [-ModuleID <Nullable`1> ] [-ModuleName <String> ] [ <CommonParameters>]

Parameter Set: JobNameModuleIDSet
Get-SCDWJobModule [-ComputerName <String> ] [-JobName <String> ] [-ModuleID <Nullable`1> ] [-NumberOfBatches <Int32> ] [ <CommonParameters>]

Parameter Set: JobNameModuleNameSet
Get-SCDWJobModule [-ComputerName <String> ] [-JobName <String> ] [-ModuleName <String> ] [-NumberOfBatches <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-SCDWJobModule cmdlet returns detailed status information about the modules of the specified job. Each data warehouse job comprises multiple subprocesses, called modules, which perform the individual work items that are associated with the parent job.

For updated information about this cmdlet, see Get-SCDWJobModule.

Parameters

-ComputerName<String>

Specifies the name of the computer on which the System Center Data Access service is running. You can omit this parameter only if the System Center Data Access Service is running on the same computer that has Service Manager installed.

-JobBatchID<Nullable`1>

Specifies the job’s batch ID for which to retrieve all associated modules. You can use the Get-SCDWJob cmdlet to retrieve a job’s batch ID. By specifying the JobBatchID parameter, you retrieve all the modules of the specified job.

-JobName<String>

Specifies the name of the specific Extract, Transform, or Load job for which you want to get status.

-ModuleID<Nullable`1>

Specifies the ID of the job module for which to retrieve status. This must be a valid module ID for the specified job. This parameter cannot be used in conjunction with the JobModule parameter.

-ModuleName<String>

Specifies the name of the job module for which to retrieve status. This name must be a valid module name for the specified job. This parameter cannot be used in conjunction with the ModuleID parameter.

-NumberOfBatches<Int32>

Specifies the number of batches for which to return status.

<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.OrchestrationJobModule

Examples

Example 1: Display module information about a job

This command displays module information about the Transform.common job.

PS C:\>Get-SCDWJobmodule -ComputerName "serverDW72" -JobName "Transform.common" -NumberOfBatches 4

Example 2: Display module information about a job with a specific batch ID

This command displays module information for jobs using a specified job batch ID.

PS C:\>Get-SCDWJobModule –ComputerName "serverDW72" -JobBatchID 4126 -NumberOfBatches 4

Example 3: Display module information for a specific job and module ID

This command displays module information for a specific job and module by its module ID.

PS C:\> Get-SCDWJobModule -ComputerName "IXSMTestDW" -JobName "DWMaintenance" -ModuleID 7 -NumberOfBatches 12

Example 4: Display module information for a job with a specific module name

This command displays module information for a specific job and module by its module name.

PS C:\> Get-SCDWJobModule -ComputerName "IXSMTestDW" -JobName "MPSyncJob" -ModuleName "Clean Up" -NumberOfBatches 12 

Example 5: List module error counts for modules with errors

This command lists module error counts, but only if an error count is greater than zero.

PS C:\> Get-SCDWJobModule -ComputerName "serverDW72" -NumberOfBatches 12| Where-Object {$_.ModuleErrorCount -gt 0} | Format-Table -Property JobName, ModuleID, ModuleErrorCount -AutoSize

Example 6: Save module property values to a CSV file

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

PS C:\> Get-SCDWJobModule -ComputerName "serverDW72" –NumberOfBatches 4| Select-Object -Property BatchId, CategoryId, CategoryName, CreationTime, Description, JobId, JobModuleId, JobName, ManagementGroup, ManagementGroupId, ModuleCreationTime, ModuleDescription, ModuleErrorCount, ModuleErrorSummary, ModuleId, ModuleModifiedTime, ModuleName, ModuleRetryCount, ModuleStartTime, ModuleTypeId, ModuleTypeName, NotToBePickedBefore, Status | Export-Csv "C:\TEMP\JobModuleData.csv"

Related topics

Get-SCDWJob