commands

^

Set-DbaAgentJobOutputFile

Author Rob Sewell, https://sqldbawithabeard.com
Availability Windows only

 

Synopsis

Set the output file for a step within an Agent job.

Description

Sets the Output File for a step of an agent job with the Job Names and steps provided dynamically if required

Syntax

Set-DbaAgentJobOutputFile
    [-SqlInstance] <DbaInstanceParameter[]>
    [-SqlCredential <PSCredential>]
    [-Job <Object[]>]
    [-Step <Object[]>] -OutputFile <String>
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Set-DbaAgentJobOutputFile -SqlInstance SERVERNAME -Job 'The Agent Job' -OutPutFile E:\Logs\AgentJobStepOutput.txt

Sets the Job step for The Agent job on SERVERNAME to E:\Logs\AgentJobStepOutput.txt

Required Parameters

-SqlInstance

The target SQL Server instance or instances.

Alias
Required True
Pipeline true (ByValue, ByPropertyName)
Default Value
-OutputFile

The Full Path to the New Output file

Alias
Required True
Pipeline true (ByValue, ByPropertyName)
Default Value

Optional Parameters

-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential). Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported. For MFA support, please use Connect-DbaInstance. be it Windows or SQL Server. Windows users are determined by the existence of a backslash, so if you are intending to use an alternative Windows connection instead of a SQL login, ensure it contains a backslash.

Alias
Required False
Pipeline true (ByValue, ByPropertyName)
Default Value
-Job

The job to process - this list is auto-populated from the server.

Alias
Required False
Pipeline false
Default Value
-Step

The Agent Job Step to provide Output File Path for. Also available dynamically

Alias
Required False
Pipeline true (ByValue, ByPropertyName)
Default Value
-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.

Alias
Required False
Pipeline false
Default Value False
-WhatIf

Shows what would happen if the command were to run. No actions are actually performed.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

Prompts you for confirmation before executing any changing operations within the command.

Alias cf
Required False
Pipeline false
Default Value

 

Want to see the source code for this command? Check out Set-DbaAgentJobOutputFile on GitHub.
Want to see the Bill Of Health for this command? Check out Set-DbaAgentJobOutputFile.