Disable-SCDWJobCategory

Disable-SCDWJobCategory

Disables all jobs within a job category.

Syntax

Parameter Set: Default
Disable-SCDWJobCategory [-JobCategoryName] <String> [-ComputerName <String> ] [-Credential <PSCredential> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Disable-SCDWJobCategory cmdlet disables all jobs within a job category.

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 user account that is provided must have access to that server.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-JobCategoryName<String>

Specifies the name of the job category. You can use the Get-SCDWJob cmdlet to retrieve this value. Examples of valid job categories are Maintenance, Extract, Load, and Transform.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?

false

Position?

named

Default Value

false

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.

  • None.

    This cmdlet does not generate any output.

Examples

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

This command disables the jobs in the CubeProssing category.

PS C:\> Disable-SCDWJobCategory -ComputerName serverDW7 -JobCategoryName CubeProcessing

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

The first command stores user credentials for the Credential parameter.

The second command disables the jobs in the CubeProssing category using the specified credentials.

PS C:\> $credUser = Get-Credential
PS C:\> Disable-SCDWJobCategory -ComputerName serverDW7 -JobCategoryName CubeProcessing –Credential $credUser

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

This command provides information about enabled and disabled jobs in the job categories. If all the jobs in the category are either enabled or disabled, the value in the IsEnabled column in the output reflects that value.

If at least one job in a job category has an opposite IsEnabled value from the other jobs in the same category, the job category name is repeated with that value (as is the case for the Load category in the example output). This is achieved by using the Unique parameter with the Select-Object command.

PS C:\> Get-SCDWJob -ComputerName serverDW7 | Select-Object -Property CategoryName, IsEnabled -Unique | Format-Table -Property CategoryName, IsEnabled -AutoSize