functions/Set-DbaJobOwner.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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
function Set-DbaJobOwner
{
<#
.SYNOPSIS
Sets SQL Agent job owners with a desired login if jobs do not match that owner.
 
.DESCRIPTION
This function will alter SQL Agent Job ownership to match a specified login if their
current owner does not match the target login. By default, the target login will
be 'sa', but the fuction will allow the user to specify a different login for
ownership. The user can also apply this to all jobs or only to a select list
of jobs (passed as either a comma separated list or a string array).
  
Best practice reference: http://sqlmag.com/blog/sql-server-tip-assign-ownership-jobs-sysadmin-account
  
.NOTES
Original Author: Michael Fal (@Mike_Fal), http://mikefal.net
 
dbatools PowerShell module (https://dbatools.io, clemaire@gmail.com)
Copyright (C) 2016 Chrissy LeMaire
 
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
 
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
 
.PARAMETER SqlServer
SQLServer name or SMO object representing the SQL Server to connect to. This can be a
collection and recieve pipeline input
 
.PARAMETER SqlCredential
PSCredential object to connect under. If not specified, currend Windows login will be used.
 
.PARAMETER Jobs
Auto-populated list of Jobs to apply changes to. Will accept a comma separated list or a string array.
 
.PARAMETER Exclude
Jobs to exclude
  
.PARAMETER TargetLogin
Specific login that you wish to check for ownership. This defaults to 'sa' or the sysadmin name if sa was renamed.
 
.PARAMETER WhatIf
Shows what would happen if the command were to run. No actions are actually performed.
 
.PARAMETER Confirm
Prompts you for confirmation before executing any changing operations within the command.
 
.LINK
https://dbatools.io/Set-DbaJobOwner
 
.EXAMPLE
Set-DbaJobOwner -SqlServer localhost
 
Sets SQL Agent Job owner to sa on all jobs where the owner does not match sa.
 
.EXAMPLE
Set-DbaJobOwner -SqlServer localhost -TargetLogin DOMAIN\account
 
Sets SQL Agent Job owner to sa on all jobs where the owner does not match 'DOMAIN\account'. Note
that TargetLogin must be a valid security principal that exists on the target server.
 
.EXAMPLE
Set-DbaJobOwner -SqlServer localhost -Job job1, job2
 
Sets SQL Agent Job owner to 'sa' on the job1 and job2 jobs if their current owner does not match 'sa'.
 
.EXAMPLE
'sqlserver','sql2016' | Set-DbaJobOwner
 
Sets SQL Agent Job owner to sa on all jobs where the owner does not match sa on both sqlserver and sql2016.
  
#>

[CmdletBinding(SupportsShouldProcess = $true)]
Param (
[parameter(Mandatory = $true, ValueFromPipeline = $true)]
[Alias("ServerInstance", "SqlInstance")]
[object[]]$SqlServer,
[object]$SqlCredential,
[string]$TargetLogin
)

DynamicParam { if ($SqlServer) { return Get-ParamSqlJobs -SqlServer $SqlServer[0] -SqlCredential $SourceSqlCredential } }

BEGIN
{
$jobs = $psboundparameters.Jobs
$exclude = $psboundparameters.Exclude
}

PROCESS
{
foreach ($servername in $sqlserver)
{
#connect to the instance
Write-Verbose "Connecting to $servername"
$server = Connect-SqlServer $servername -SqlCredential $SqlCredential

# dynamic sa name for orgs who have changed their sa name
if ($psboundparameters.TargetLogin.length -eq 0)
{
$TargetLogin = ($server.logins | Where-Object { $_.id -eq 1 }).Name
}

#Validate login
if (($server.Logins.Name) -notcontains $TargetLogin)
{
if ($sqlserver.count -eq 1)
{
throw "Invalid login: $TargetLogin"
}
else
{
Write-Warning "$TargetLogin is not a valid login on $servername. Moving on."
Continue
}
}

if ($server.logins[$TargetLogin].LoginType -eq 'WindowsGroup')
{
throw "$TargetLogin is a Windows Group and can not be a job owner."
}

#Get database list. If value for -Jobs is passed, massage to make it a string array.
#Otherwise, use all jobs on the instance where owner not equal to -TargetLogin
Write-Verbose "Gathering jobs to update"

if ($Jobs.Length -gt 0)
{
$jobcollection = $server.JobServer.Jobs | Where-Object { $_.OwnerLoginName -ne $TargetLogin -and $jobs -contains $_.Name }
}
else
{
$jobcollection = $server.JobServer.Jobs | Where-Object { $_.OwnerLoginName -ne $TargetLogin }
}

if ($Exclude.Length -gt 0)
{
$jobcollection = $jobcollection | Where-Object { $Exclude -notcontains $_.Name }
}

Write-Verbose "Updating $($jobcollection.Count) job(s)."
foreach ($j in $jobcollection)
{
$jobname = $j.name

If ($PSCmdlet.ShouldProcess($servername, "Setting job owner for $jobname to $TargetLogin"))
{
try
{
Write-Output "Setting job owner for $jobname to $TargetLogin on $servername"
#Set job owner to $TargetLogin (default 'sa')
$j.OwnerLoginName = $TargetLogin
$j.Alter()
}
catch
{
# write-exception writes the full exception to file
Write-Exception $_
throw $_
}
}
}
}
}

END
{
if ($jobcollection.count -eq 0)
{
Write-Output "Lookin' good! Nothing to do."
}

Write-Verbose "Closing connection"
$server.ConnectionContext.Disconnect()
}
}