Share via

Disable-SCDWJob

  • Article

Disable-SCDWJob

Disables a data warehouse job to prevent it from running in the future.

Syntax

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

Detailed Description

The Disable-SCDWJob cmdlet disables a job, which prevents it from running in the future. When a job is disabled, any remaining modules that have not run yet will complete. After the job completes its current run, it will not run according to its specified schedule and you cannot run it manually.

To re-enable a disabled job, use the Enable-SCDWJob cmdlet.

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

-JobName<String>

Specifies the Data Warehouse job to disable. The JobName parameter is a mandatory parameter.

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: Disable a job

This command disables the Extract_Contoso job.

PS C:\> Disable-SCDWJob -JobName "Extract_Contoso" –ComputerName "serverDW72"

Example 2: List jobs that are enabled

This command lists the jobs according to their IsEnabled state.

PS C:\> Get-SCDWJob -ComputerName "serverDW72" | Sort-Object -Property IsEnabled,Name | Format-Table -Property Name,IsEnabled -AutoSize

Example 3: Disable all jobs

The first command obtains user credentials to store in a variable for the Credential parameter.

The second command disables all the jobs using the ForEach-Object cmdlet and the specified credentials.

PS C:\> $creduser12 = Get-Credential
PS C:\>Get-SCDWJob -ComputerName "serverDW72" -credential $creduser12 | ForEach-Object {$_.DisableJob()}

Get-SCDWJob

Enable-SCDWJob

Start-SCDWJob