Get-SCDWJobModule
Gets detailed status information about the modules of the job.
Syntax
Get-SCDWJobModule
[-JobName <String>]
[-NumberOfBatches <Int32>]
[-ComputerName <String>]
[<CommonParameters>]
Get-SCDWJobModule
[-ModuleName <String>]
[-JobName <String>]
[-NumberOfBatches <Int32>]
[-ComputerName <String>]
[<CommonParameters>]
Get-SCDWJobModule
[-ModuleName <String>]
[-ModuleID <Int32>]
-JobBatchID <Int32>
[-ComputerName <String>]
[<CommonParameters>]
Get-SCDWJobModule
[-ModuleID <Int32>]
[-JobName <String>]
[-NumberOfBatches <Int32>]
[-ComputerName <String>]
[<CommonParameters>]
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-SCDWJobModulehttp://go.microsoft.com/fwlink/p/?LinkId=234991.
Examples
Example 1: Display module information about a job
PS C:\>Get-SCDWJobmodule -ComputerName "serverDW72" -JobName "Transform.common" -NumberOfBatches 4
This command displays module information about the Transform.common
job.
Example 2: Display module information about a job with a specific batch ID
PS C:\>Get-SCDWJobModule â€"ComputerName "serverDW72" -JobBatchID 4126 -NumberOfBatches 4
This command displays module information for jobs using a specified job batch ID.
Example 3: Display module information for a specific job and module ID
PS C:\>Get-SCDWJobModule -ComputerName "IXSMTestDW" -JobName "DWMaintenance" -ModuleID 7 -NumberOfBatches 12
This command displays module information for a specific job and module by its module ID.
Example 4: Display module information for a job with a specific module name
PS C:\>Get-SCDWJobModule -ComputerName "IXSMTestDW" -JobName "MPSyncJob" -ModuleName "Clean Up" -NumberOfBatches 12
This command displays module information for a specific job and module by its module name.
Example 5: List module error counts for modules with errors
PS C:\>Get-SCDWJobModule -ComputerName "serverDW72" -NumberOfBatches 12| Where-Object {$_.ModuleErrorCount -gt 0} | Format-Table -Property JobName, ModuleID, ModuleErrorCount -AutoSize
This command lists module error counts, but only if an error count is greater than zero.
Example 6: Save module property values 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"
This command gets all the job module property values and saves the results to a CSV file.
Parameters
-ComputerName
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.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-JobBatchID
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.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-JobName
Specifies the name of the specific Extract, Transform, or Load job for which you want to get status.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ModuleID
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.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ModuleName
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.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NumberOfBatches
Specifies the number of batches for which to return status.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
None.
You cannot pipe input to this cmdlet.
Outputs
Microsoft.EnterpriseManagement.OrchestrationJobModule