functions/Get-DbaAgentJobOutputFile.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
function Get-DbaAgentJobOutputFile {
    <#
        .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
 
        .PARAMETER SqlInstance
            SQL Server name or SMO object representing the SQL Server to connect to. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.
 
        .PARAMETER SQLCredential
            Credential object used to connect to the SQL Server as a different user be it Windows or SQL Server. Windows users are determiend 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.
 
        .PARAMETER Job
            The job(s) to process - this list is auto-populated from the server. If unspecified, all jobs will be processed.
 
        .PARAMETER ExcludeJob
            The job(s) to exclude - this list is auto-populated from the server
 
        .PARAMETER 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.
 
        .NOTES
            Tags: Agent, Job
            Author: Rob Sewell (https://sqldbawithabeard.com)
            Editor: niphlod
 
            Website: https://dbatools.io
            Copyright: (C) Chrissy LeMaire, clemaire@gmail.com
            License: MIT https://opensource.org/licenses/MIT
 
        .EXAMPLE
            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
            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
            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
            $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
            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
            (Get-DbaAgentJobOutputFile -SqlInstance SERVERNAME | ogv -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
            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
    #>

    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory = $true, HelpMessage = 'The SQL Server Instance',
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            ValueFromRemainingArguments = $false,
            Position = 0)]
        [ValidateNotNull()]
        [ValidateNotNullOrEmpty()]
        [Alias("ServerInstance", "SqlServer")]
        [DbaInstanceParameter[]]$SqlInstance,
        [Parameter(Mandatory = $false, HelpMessage = 'SQL Credential',
            ValueFromPipelineByPropertyName = $true,
            ValueFromRemainingArguments = $false,
            Position = 1)]
        [PSCredential]$SqlCredential,
        [object[]]$Job,
        [object[]]$ExcludeJob,
        [Alias('Silent')]
        [switch]$EnableException
    )

    process {
        foreach ($instance in $sqlinstance) {
            Write-Message -Message "Connecting to $instance" -Level Verbose
            try {
                $server = Connect-SqlInstance -SqlInstance $instance -SqlCredential $SqlCredential
            }
            catch {
                Stop-Function -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $instance -Continue
            }

            $jobs = $Server.JobServer.Jobs
            if ($Job) {
                $jobs = $jobs | Where-Object Name -In $Job
            }
            if ($ExcludeJob) {
                $jobs = $jobs | Where-Object Name -NotIn $ExcludeJob
            }
            foreach ($j in $Jobs) {
                foreach ($Step in $j.JobSteps) {
                    if ($Step.OutputFileName) {
                        [pscustomobject]@{
                            ComputerName         = $server.ComputerName
                            InstanceName         = $server.ServiceName
                            SqlInstance          = $server.DomainInstanceName
                            Job                  = $j.Name
                            JobStep              = $Step.Name
                            OutputFileName       = $Step.OutputFileName
                            RemoteOutputFileName = Join-AdminUNC $Server.ComputerName $Step.OutputFileName
                            StepId               = $Step.Id
                        } | Select-DefaultView -ExcludeProperty StepId
                    }
                    else {
                        Write-Message -Level Verbose -Message "$step for $j has no output file"
                    }
                }
            }
        }
    }
}