Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

#!/usr/bin/python 

# -*- coding: utf-8 -*- 

# Copyright: (c) 2021, XLAB Steampunk <steampunk@xlab.si> 

# 

# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 

 

 

from __future__ import absolute_import, division, print_function 

 

__metaclass__ = type 

 

 

DOCUMENTATION = r""" 

module: change_request_info 

 

author: 

- Manca Bizjak (@mancabizjak) 

- Miha Dolinar (@mdolin) 

- Tadej Borovsak (@tadeboro) 

- Matej Pevec (@mysteriouswolf) 

short_description: List ServiceNow change requests 

description: 

- Retrieve information about ServiceNow change requests. 

- For more information, refer to the ServiceNow change management documentation at 

U(https://docs.servicenow.com/bundle/paris-it-service-management/page/product/change-management/concept/c_ITILChangeManagement.html). 

version_added: 1.0.0 

extends_documentation_fragment: 

- servicenow.itsm.instance 

- servicenow.itsm.sys_id.info 

- servicenow.itsm.number.info 

- servicenow.itsm.query 

- servicenow.itsm.change_request_mapping 

- servicenow.itsm.sysparm_display_value 

seealso: 

- module: servicenow.itsm.change_request 

""" 

 

EXAMPLES = r""" 

- name: Retrieve all change requests 

servicenow.itsm.change_request_info: 

register: result 

 

- name: Retrieve a specific change request by its sys_id 

servicenow.itsm.change_request_info: 

sys_id: 471bfbc7a9fe198101e77a3e10e5d47f 

register: result 

 

- name: Retrieve change requests by number 

servicenow.itsm.change_request_info: 

number: PRB0007601 

register: result 

 

- name: Retrieve change requests that contain SAP in its short description by using field query 

servicenow.itsm.change_request_info: 

query: 

- short_description: LIKE SAP 

register: result 

 

- name: Retrieve change requests that contain SAP in its short description by using field sysparm_query 

servicenow.itsm.change_request_info: 

sysparm_query: short_descriptionLIKESAP 

register: result 

 

- name: Retrieve new change requests assigned to abel.tuter or bertie.luby 

servicenow.itsm.change_request_info: 

query: 

- state: = new 

assigned_to: = abel.tuter 

- state: = new 

assigned_to: = bertie.luby 

""" 

 

RETURN = r""" 

records: 

description: 

- A list of change request records. 

returned: success 

type: list 

sample: 

- "active": "false" 

"activity_due": "" 

"additional_assignee_list": "" 

"approval": "approved" 

"approval_history": "" 

"approval_set": "" 

"assigned_to": "" 

"assignment_group": "d625dccec0a8016700a222a0f7900d06" 

"attachments": 

- "average_image_color": "" 

"chunk_size_bytes": "700000" 

"compressed": "true" 

"content_type": "text/plain" 

"download_link": "https://www.example.com/api/now/attachment/5f7d3c950706301022f9ffa08c1ed062/file" 

"file_name": "sample_file1.txt" 

"hash": "6f2b0dec698566114435a23f15dcac848a40e1fd3e0eda4afe24a663dda23f2e" 

"image_height": "" 

"image_width": "" 

"size_bytes": "210" 

"size_compressed": "206" 

"state": "pending" 

"sys_created_by": "admin" 

"sys_created_on": "2021-08-17 11:18:33" 

"sys_id": "5f7d3c950706301022f9ffa08c1ed062" 

"sys_mod_count": "0" 

"sys_tags": "" 

"sys_updated_by": "admin" 

"sys_updated_on": "2021-08-17 11:18:33" 

"table_name": "change_request" 

"table_sys_id": "3a7db0d50706301022f9ffa08c1ed092" 

"backout_plan": "" 

"business_duration": "" 

"business_service": "" 

"cab_date": "" 

"cab_delegate": "" 

"cab_recommendation": "" 

"cab_required": "false" 

"calendar_duration": "" 

"category": "Other" 

"change_plan": "" 

"close_code": "successful" 

"close_notes": "Completed successfully" 

"closed_at": "2015-07-06 18:18:53" 

"closed_by": "6816f79cc0a8016401c5a33be04be441" 

"cmdb_ci": "" 

"comments": "" 

"comments_and_work_notes": "" 

"company": "" 

"conflict_last_run": "" 

"conflict_status": "Not Run" 

"contact_type": "phone" 

"contract": "" 

"correlation_display": "" 

"correlation_id": "" 

"delivery_plan": "" 

"delivery_task": "" 

"description": "Decommission a server" 

"due_date": "" 

"end_date": "" 

"escalation": "0" 

"expected_start": "" 

"follow_up": "" 

"group_list": "" 

"impact": "3" 

"implementation_plan": "Implementation plan" 

"justification": "" 

"knowledge": "false" 

"location": "" 

"made_sla": "true" 

"number": "CHG0000023" 

"on_hold": "false" 

"on_hold_reason": "" 

"on_hold_task": "" 

"opened_at": "2015-07-06 18:17:21" 

"opened_by": "6816f79cc0a8016401c5a33be04be441" 

"order": "" 

"outside_maintenance_schedule": "false" 

"parent": "" 

"phase": "requested" 

"phase_state": "open" 

"priority": "4" 

"production_system": "false" 

"reason": "" 

"reassignment_count": "2" 

"requested_by": "6816f79cc0a8016401c5a33be04be441" 

"requested_by_date": "" 

"review_comments": "" 

"review_date": "" 

"review_status": "" 

"risk": "3" 

"risk_impact_analysis": "" 

"route_reason": "" 

"scope": "3" 

"service_offering": "" 

"short_description": "Decommission server" 

"sla_due": "" 

"start_date": "" 

"state": "3" 

"std_change_producer_version": "deb8544047810200e90d87e8dee490af" 

"sys_class_name": "change_request" 

"sys_created_by": "admin" 

"sys_created_on": "2015-07-06 18:17:22" 

"sys_domain": "global" 

"sys_domain_path": "/" 

"sys_id": "70ad699e47410200e90d87e8dee4907d" 

"sys_mod_count": "8" 

"sys_tags": "" 

"sys_updated_by": "admin" 

"sys_updated_on": "2015-07-06 18:18:53" 

"task_effective_number": "CHG0000023" 

"test_plan": "Test plan" 

"time_worked": "" 

"type": "standard" 

"unauthorized": "false" 

"universal_request": "" 

"upon_approval": "proceed" 

"upon_reject": "cancel" 

"urgency": "3" 

"user_input": "" 

"watch_list": "" 

"work_end": "2015-07-06 18:18:34" 

"work_notes": "" 

"work_notes_list": "" 

"work_start": "2015-07-06 18:17:41" 

""" 

 

from ansible.module_utils.basic import AnsibleModule 

 

from ..module_utils import arguments, attachment, client, errors, query, table, utils 

from ..module_utils.change_request import PAYLOAD_FIELDS_MAPPING 

from ..module_utils.utils import get_mapper 

 

 

def remap_params(query, table_client): 

query_load = [] 

 

for item in query: 

q = dict() 

for k, v in item.items(): 

if k == "type": 

q["chg_model"] = (v[0], v[1]) 

 

elif k == "hold_reason": 

q["on_hold_reason"] = (v[0], v[1]) 

 

elif k == "requested_by": 

user = table.find_user(table_client, v[1]) 

q["requested_by"] = (v[0], user["sys_id"]) 

 

elif k == "assignment_group": 

assignment_group = table.find_assignment_group(table_client, v[1]) 

q["assignment_group"] = (v[0], assignment_group["sys_id"]) 

 

elif k == "template": 

standard_change_template = table.find_standard_change_template( 

table_client, v[1] 

) 

q["std_change_producer_version"] = ( 

v[0], 

standard_change_template["sys_id"], 

) 

 

else: 

q[k] = v 

 

query_load.append(q) 

 

return query_load 

 

 

def sysparms_query(module, table_client, mapper): 

parsed, err = query.parse_query(module.params["query"]) 

if err: 

raise errors.ServiceNowError(err) 

 

remap_query = remap_params(parsed, table_client) 

 

return query.serialize_query(query.map_query_values(remap_query, mapper)) 

 

 

def run(module, table_client, attachment_client): 

mapper = get_mapper( 

module, 

"change_request_mapping", 

PAYLOAD_FIELDS_MAPPING, 

sysparm_display_value=module.params["sysparm_display_value"], 

) 

 

if module.params["query"]: 

query = { 

"sysparm_query": sysparms_query(module, table_client, mapper), 

"sysparm_display_value": module.params["sysparm_display_value"], 

} 

elif module.params["sysparm_query"]: 

query = {"sysparm_query": module.params["sysparm_query"]} 

else: 

query = utils.filter_dict( 

module.params, "sys_id", "number", "sysparm_display_value" 

) 

 

return [ 

dict( 

mapper.to_ansible(record), 

attachments=attachment_client.list_records( 

dict(table_name="change_request", table_sys_id=record["sys_id"]), 

), 

) 

for record in table_client.list_records("change_request", query) 

] 

 

 

def main(): 

module = AnsibleModule( 

supports_check_mode=True, 

argument_spec=dict( 

arguments.get_spec( 

"instance", 

"sys_id", 

"number", 

"query", 

"change_request_mapping", 

"sysparm_query", 

"sysparm_display_value", 

), 

), 

mutually_exclusive=[ 

("sys_id", "query"), 

("number", "query"), 

("sysparm_query", "query"), 

("sys_id", "sysparm_query"), 

("number", "sysparm_query"), 

], 

) 

 

try: 

snow_client = client.Client(**module.params["instance"]) 

table_client = table.TableClient(snow_client) 

attachment_client = attachment.AttachmentClient(snow_client) 

records = run(module, table_client, attachment_client) 

module.exit_json(changed=False, records=records) 

except errors.ServiceNowError as e: 

module.fail_json(msg=str(e)) 

 

 

if __name__ == "__main__": 

main()