Get-SCDWJobModule

Get-SCDWJobModule

Returns detailed information for the specified job. This information includes job modules that are executed as part 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

Each Data Warehouse job comprises multiple subprocesses called "modules." Modules perform the individual work items associated with their parent job. The Get-SCDWJobModule cmdlet allows you to retrieve the status of a job's constituent modules.

Parameters

-ComputerName<String>

Specifies the name of the Service Manager data warehouse server.

Aliases

none

Required?

false

Position?

named

Default Value

.

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-JobBatchID<Nullable`1>

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

-JobName<String>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ModuleID<Nullable`1>

Specifies the ID of the job module for which status should be returned. This must be a valid module ID for the specified job. This parameter cannot be used together with the JobModule parameter.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ModuleName<String>

Specifies the name of the job module for which status should be returned. It must be a valid module name for the specified job. This parameter cannot be used together with the ModuleID 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 to return status for.

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

Examples

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

Description

-----------

This command displays the status of job modules for the latest MPSyncJob job.

C:\PS>Get-SCDWJobModule -JobName MPSyncJob
Job Name: MPSyncJob, Batch Id: 33
ModuleID Module Name                                                  Status       Error Message
-------- -----------                                                  ------       -------------
15       Delete Data Source                                           Completed
16       MP Sync dwg : Associate Imported MP Vertex                   Waiting      <Errors><Error>Waiting for Deploy...
17       MP Sync dwg : Disable All jobs                               Completed
18       MP Sync dwg : Disable Deployment jobs                        Completed    <Errors><Error>Waiting for Acquir...
19       MP Sync dwg : Enable All jobs                                Not Started
20       MP Sync dwg : Synchronize ServiceManager MPs                 Completed
59       MP Sync smg : Associate Imported MP Vertex                   Not Started
60       MP Sync smg : Disable All jobs                               Not Started
61       MP Sync smg : Disable Deployment jobs                        Not Started
62       MP Sync smg : Enable All jobs                                Not Started
63       MP Sync smg : Synchronize ServiceManager MPs                 Not Started

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

Description

-----------

This command displays the status of MPSyncJob job modules containing the name "Synchronize" (for the latest MPSyncJob batch).

C:\PS>Get-SCDWJobModule -JobName MPSyncJob -ModuleName Synchronize
ModuleID Module Name                                                  Status       Error Message
-------- -----------                                                  ------       -------------
20       MP Sync dwg : Synchronize ServiceManager MPs                 Completed
63       MP Sync smg : Synchronize ServiceManager MPs                 Not Started

Getting Started with Service Manager Cmdlets for Windows PowerShell

Get-SCDWJob