forked from Snow-Shell/servicenow-powershell
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathPSServiceNow-Tables.psm1
274 lines (231 loc) · 10.2 KB
/
PSServiceNow-Tables.psm1
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
function Get-ServiceNowTable
{
[OutputType([Array])]
Param
(
# Name of the table we're querying (e.g. incidents)
[parameter(ParameterSetName='SpecifyConnectionFields', mandatory=$false)]
[parameter(ParameterSetName='UseConnectionObject')]
[parameter(ParameterSetName='SetGlobalAuth')]
[string]$Table,
# sysparm_query param in the format of a ServiceNow encoded query string (see http://wiki.servicenow.com/index.php?title=Encoded_Query_Strings)
[parameter(ParameterSetName='SpecifyConnectionFields', mandatory=$false)]
[parameter(ParameterSetName='UseConnectionObject')]
[parameter(ParameterSetName='SetGlobalAuth')]
[string]$Query,
# Maximum number of records to return
[parameter(ParameterSetName='SpecifyConnectionFields', mandatory=$false)]
[parameter(ParameterSetName='UseConnectionObject')]
[parameter(ParameterSetName='SetGlobalAuth')]
[int]$Limit=10,
# Whether or not to show human readable display values instead of machine values
[parameter(ParameterSetName='SpecifyConnectionFields', mandatory=$false)]
[parameter(ParameterSetName='UseConnectionObject')]
[parameter(ParameterSetName='SetGlobalAuth')]
[ValidateSet("true","false", "all")]
[string]$DisplayValues='false',
# Credential used to authenticate to ServiceNow
[Parameter(ParameterSetName='SpecifyConnectionFields', Mandatory=$True)]
[ValidateNotNullOrEmpty()]
[PSCredential]
$ServiceNowCredential,
# The URL for the ServiceNow instance being used
[Parameter(ParameterSetName='SpecifyConnectionFields', Mandatory=$True)]
[ValidateNotNullOrEmpty()]
[string]
$ServiceNowURL,
#Azure Automation Connection object containing username, password, and URL for the ServiceNow instance
[Parameter(ParameterSetName='UseConnectionObject', Mandatory=$True)]
[ValidateNotNullOrEmpty()]
[Hashtable]
$Connection
)
#Get credential and ServiceNow REST URL
if ($Connection -ne $null)
{
$SecurePassword = ConvertTo-SecureString $Connection.Password -AsPlainText -Force
$ServiceNowCredential = New-Object System.Management.Automation.PSCredential ($Connection.Username, $SecurePassword)
$ServiceNowURL = 'https://' + $Connection.ServiceNowUri + '/api/now/v1'
}
elseif ($ServiceNowCredential -ne $null -and $ServiceNowURL -ne $null)
{
$ServiceNowURL = 'https://' + $ServiceNowURL + '/api/now/v1'
}
elseif((Test-ServiceNowAuthIsSet))
{
$ServiceNowCredential = $Global:ServiceNowCredentials
$ServiceNowURL = $global:ServiceNowRESTURL
}
else
{
throw "Exception: You must do one of the following to authenticate: `n 1. Call the Set-ServiceNowAuth cmdlet `n 2. Pass in an Azure Automation connection object `n 3. Pass in an endpoint and credential"
}
# Populate the query
$Body = @{'sysparm_limit'=$Limit;'sysparm_display_value'=$DisplayValues}
if($Query){
$Body.sysparm_query = $Query
}
$Body
# Fire and return
$Uri = $ServiceNowURL + "/table/$Table"
return (Invoke-RestMethod -Uri $Uri -Credential $ServiceNowCredential -Body $Body -ContentType "application/json").result
}
function New-ServiceNowTableEntry{
Param
(
# Name of the table we're inserting into (e.g. incidents)
[parameter(mandatory=$true)]
[parameter(ParameterSetName='SpecifyConnectionFields')]
[parameter(ParameterSetName='UseConnectionObject')]
[parameter(ParameterSetName='SetGlobalAuth')]
[string]$Table,
# Hashtable of values to use as the record's properties
[parameter(mandatory=$false)]
[parameter(ParameterSetName='SpecifyConnectionFields')]
[parameter(ParameterSetName='UseConnectionObject')]
[parameter(ParameterSetName='SetGlobalAuth')]
[hashtable]$Values,
# Credential used to authenticate to ServiceNow
[Parameter(ParameterSetName='SpecifyConnectionFields', Mandatory=$True)]
[ValidateNotNullOrEmpty()]
[PSCredential]
$ServiceNowCredential,
# The URL for the ServiceNow instance being used
[Parameter(ParameterSetName='SpecifyConnectionFields', Mandatory=$True)]
[ValidateNotNullOrEmpty()]
[string]
$ServiceNowURL,
#Azure Automation Connection object containing username, password, and URL for the ServiceNow instance
[Parameter(ParameterSetName='UseConnectionObject', Mandatory=$True)]
[ValidateNotNullOrEmpty()]
[Hashtable]
$Connection
)
#Get credential and ServiceNow REST URL
if ($Connection -ne $null)
{
$SecurePassword = ConvertTo-SecureString $Connection.Password -AsPlainText -Force
$ServiceNowCredential = New-Object System.Management.Automation.PSCredential ($Connection.Username, $SecurePassword)
$ServiceNowURL = 'https://' + $Connection.ServiceNowUri + '/api/now/v1'
}
elseif ($ServiceNowCredential -ne $null -and $ServiceNowURL -ne $null)
{
$ServiceNowURL = 'https://' + $ServiceNowURL + '/api/now/v1'
}
elseif((Test-ServiceNowAuthIsSet))
{
$ServiceNowCredential = $Global:ServiceNowCredentials
$ServiceNowURL = $global:ServiceNowRESTURL
}
else
{
throw "Exception: You must do one of the following to authenticate: `n 1. Call the Set-ServiceNowAuth cmdlet `n 2. Pass in an Azure Automation connection object `n 3. Pass in an endpoint and credential"
}
$Body = $Values | ConvertTo-Json;
#Convert to UTF8 array to support special chars such as the danish "æ","ø","å"
$utf8Bytes = [System.Text.Encoding]::UTf8.GetBytes($Body)
# Fire and return
$Uri = $ServiceNowURL + "/table/$Table"
return (Invoke-RestMethod -Uri $uri -Method Post -Credential $ServiceNowCredential -Body $utf8Bytes -ContentType "application/json" -UseBasicParsing).result
}
<#
.COMMENT
Untested
#>
function Remove-ServiceNowTableEntry{
[CmdletBinding(ConfirmImpact='High')]
Param(
# sys_id of the entry we're deleting
[parameter(mandatory=$true)]
[parameter(ParameterSetName='SpecifyConnectionFields')]
[parameter(ParameterSetName='UseConnectionObject')]
[parameter(ParameterSetName='SetGlobalAuth')]
[string]$SysId,
# Table containing the entry we're deleting
[parameter(mandatory=$true)]
[parameter(ParameterSetName='SpecifyConnectionFields')]
[parameter(ParameterSetName='UseConnectionObject')]
[parameter(ParameterSetName='SetGlobalAuth')]
[string]$Table,
# Credential used to authenticate to ServiceNow
[Parameter(ParameterSetName='SpecifyConnectionFields', Mandatory=$True)]
[ValidateNotNullOrEmpty()]
[PSCredential]
$ServiceNowCredential,
# The URL for the ServiceNow instance being used
[Parameter(ParameterSetName='SpecifyConnectionFields', Mandatory=$True)]
[ValidateNotNullOrEmpty()]
[string]
$ServiceNowURL,
#Azure Automation Connection object containing username, password, and URL for the ServiceNow instance
[Parameter(ParameterSetName='UseConnectionObject', Mandatory=$True)]
[ValidateNotNullOrEmpty()]
[Hashtable]
$Connection
)
#Get credential and ServiceNow REST URL
if ($Connection -ne $null)
{
$ConnectionInfo = Get-ConnectionInfo -Connection $Connection
}
elseif ($ServiceNowCredential -ne $null -and $ServiceNowURL -ne $null)
{
$ConnectionInfo = Get-ConnectionInfo -ServiceNowCredential $ServiceNowCredential -ServiceNowURL $ServiceNowURL
}
else
{
$ConnectionInfo = Get-ConnectionInfo -UseGlobalAuth $true
}
# Fire and return
$Uri = $ConnectionInfo["URL"] + "/table/$Table/$SysID"
return (Invoke-RestMethod -Uri $uri -Method Delete -Credential $ConnectionInfo["Credential"] -Body $Body -ContentType "application/json" -UseBasicParsing).result
}
function Get-ConnectionInfo
{
[OutputType([HashTable])]
param (
# Credential used to authenticate to ServiceNow
[Parameter(ParameterSetName='SpecifyConnectionFields', Mandatory=$True)]
[ValidateNotNullOrEmpty()]
[PSCredential]
$ServiceNowCredential,
# The URL for the ServiceNow instance being used
[Parameter(ParameterSetName='SpecifyConnectionFields', Mandatory=$True)]
[ValidateNotNullOrEmpty()]
[string]
$ServiceNowURL,
#Azure Automation Connection object containing username, password, and URL for the ServiceNow instance
[Parameter(ParameterSetName='UseConnectionObject', Mandatory=$True)]
[ValidateNotNullOrEmpty()]
[Hashtable]
$Connection,
[Parameter(ParameterSetName='SetGlobalAuth', Mandatory=$True)]
[ValidateNotNullOrEmpty()]
[Bool]
$UseGlobalAuth
)
#Get credential and ServiceNow REST URL
if ($Connection -ne $null)
{
$SecurePassword = ConvertTo-SecureString $Connection.Password -AsPlainText -Force
$ServiceNowCredential = New-Object System.Management.Automation.PSCredential ($Connection.Username, $SecurePassword)
$ServiceNowURL = 'https://' + $Connection.ServiceNowUri + '/api/now/v1'
}
elseif ($ServiceNowCredential -ne $null -and $ServiceNowURL -ne $null)
{
$ServiceNowURL = 'https://' + $ServiceNowURL + '/api/now/v1'
}
elseif((Test-ServiceNowAuthIsSet))
{
$ServiceNowCredential = $Global:ServiceNowCredentials
$ServiceNowURL = $global:ServiceNowRESTURL
}
else
{
throw "Exception: You must do one of the following to authenticate: `n 1. Call the Set-ServiceNowAuth cmdlet `n 2. Pass in an Azure Automation connection object `n 3. Pass in an endpoint and credential"
}
$Connectioninfo = @{}
$ConnectionInfo.Add("Credential", $ServiceNowCredential)
$Connectioninfo.Add("URL", $ServiceNowURL)
return $Connectioninfo
}