< Back
Set-DbaAgentJobOutputFile
Post
NAME Set-DbaAgentJobOutputFile
SYNOPSIS
Set the output file for a step within an Agent job.
SYNTAX
Set-DbaAgentJobOutputFile [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[-SqlCredential <Pscredential>] [-Job <System.Object[]>] [-Step <System.Object[]>] -OutputFile <String>
[-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Sets the Output File for a step of an agent job with the Job Names and steps provided dynamically if required
PARAMETERS
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Job [<System.Object[]>]
The job to process - this list is auto-populated from the server.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-OutputFile [<String>]
The Full Path to the New Output file
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Step [<System.Object[]>]
The Agent Job Step to provide Output File Path for. Also available dynamically
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Agent, Job, SqlAgent
Author: Rob Sewell, https://sqldbawithabeard.com
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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
RELATED LINKS
SYNOPSIS
Set the output file for a step within an Agent job.
SYNTAX
Set-DbaAgentJobOutputFile [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[-SqlCredential <Pscredential>] [-Job <System.Object[]>] [-Step <System.Object[]>] -OutputFile <String>
[-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Sets the Output File for a step of an agent job with the Job Names and steps provided dynamically if required
PARAMETERS
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Job [<System.Object[]>]
The job to process - this list is auto-populated from the server.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-OutputFile [<String>]
The Full Path to the New Output file
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Step [<System.Object[]>]
The Agent Job Step to provide Output File Path for. Also available dynamically
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Agent, Job, SqlAgent
Author: Rob Sewell, https://sqldbawithabeard.com
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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
RELATED LINKS