commands

^

Get-DbaAgentJobOutputFile

Author Rob Sewell (https://sqldbawithabeard.com) , Simone Bizzotto (@niphold)
Availability Windows only

 

Synopsis

Returns the Output File for each step of one or many agent job with the Job Names provided dynamically if required for one or more SQL Instances

Description

This function returns for one or more SQL Instances the output file value for each step of one or many agent job with the Job Names provided dynamically. It will not return anything if there is no Output File

Syntax

Get-DbaAgentJobOutputFile
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [-Job <Object[]>]
    [-ExcludeJob <Object[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaAgentJobOutputFile -SqlInstance SERVERNAME -Job 'The Agent Job'

This will return the configured paths to the output files for each of the job step of the The Agent Job Job
on the SERVERNAME instance

Example: 2
PS C:\> Get-DbaAgentJobOutputFile -SqlInstance SERVERNAME

This will return the configured paths to the output files for each of the job step of all the Agent Jobs
on the SERVERNAME instance

Example: 3
PS C:\> Get-DbaAgentJobOutputFile -SqlInstance SERVERNAME,SERVERNAME2 -Job 'The Agent Job'

This will return the configured paths to the output files for each of the job step of the The Agent Job Job
on the SERVERNAME instance and SERVERNAME2

Example: 4
PS C:\> $Servers = 'SERVER','SERVER\INSTANCE1'

Get-DbaAgentJobOutputFile -SqlInstance $Servers -Job 'The Agent Job' -OpenFile
This will return the configured paths to the output files for each of the job step of the The Agent Job Job
on the SERVER instance and the SERVER\INSTANCE1 and open the files if they are available

Example: 5
PS C:\> Get-DbaAgentJobOutputFile -SqlInstance SERVERNAME  | Out-GridView

This will return the configured paths to the output files for each of the job step of all the Agent Jobs
on the SERVERNAME instance and Pipe them to Out-GridView

Example: 6
PS C:\> (Get-DbaAgentJobOutputFile -SqlInstance SERVERNAME | Out-GridView -PassThru).FileName | Invoke-Item

This will return the configured paths to the output files for each of the job step of all the Agent Jobs
on the SERVERNAME instance and Pipe them to Out-GridView and enable you to choose the output
file and open it

Example: 7
PS C:\> Get-DbaAgentJobOutputFile -SqlInstance SERVERNAME -Verbose

This will return the configured paths to the output files for each of the job step of all the Agent Jobs
on the SERVERNAME instance and also show the job steps without an output file

Required Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.

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 (ByPropertyName)
Default Value
-Job

The job(s) to process - this list is auto-populated from the server. If unspecified, all jobs will be processed.

Alias
Required False
Pipeline false
Default Value
-ExcludeJob

The job(s) to exclude - this list is auto-populated from the server

Alias
Required False
Pipeline false
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

 

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