Class: Job

Inherits:
BsaSoapBase show all
Defined in:
lib/bl_soap/job.rb

Overview

Does not support Schedule manipulation, makes no sense in BRPM situation Does not support ACL or permission manipulation, makes no sense in BRPM situation Does not support Bulk property configuration Does not support Moving or Copy of Jobs Does not support Removing properties

Constant Summary

Constants inherited from BsaSoapBase

BsaSoapBase::CLI_SERVICE, BsaSoapBase::CLI_WSDL, BsaSoapBase::DEFAULT_AUTH_TYPE, BsaSoapBase::HTTP_READ_TIMEOUT, BsaSoapBase::LOGIN_SERVICE, BsaSoapBase::LOGIN_WSDL, BsaSoapBase::ROLE_SERVICE, BsaSoapBase::ROLE_WSDL

Instance Method Summary collapse

Methods inherited from BsaSoapBase

#execute_cli_with_attachments, #execute_cli_with_param_list, #get_all_servers, #get_cli_return_value, #initialize, #validate_cli_option_hash_string_values, #validate_cli_options_hash, #validate_cli_result, #validate_servers

Constructor Details

This class inherits a constructor from BsaSoapBase

Instance Method Details

#add_target_component_group(options = {}) ⇒ Object 



7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/bl_soap/job.rb', line 7

def add_target_component_group(options = {})
	validate_cli_options_hash([:job_key, :group_name], options)
	db_key_result = execute_cli_with_param_list(self.class, "addTargetComponentGroup",
		[
			options[:job_key],		# Handle of the job to be updated
			options[:group_name]	# Name of the component server group
		])
	db_key = get_cli_return_value(db_key_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#add_target_group(options = {}) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/bl_soap/job.rb', line 19

def add_target_group(options = {})
	validate_cli_options_hash([:job_key, :group_name], options)
	db_key_result = execute_cli_with_param_list(self.class, "addTargetGroup",
		[
			options[:job_key],		# Handle of the job to be updated
			options[:group_name]	# Name of the server group
		])
	db_key = get_cli_return_value(db_key_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#add_target_groups(options = {}) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/bl_soap/job.rb', line 31

def add_target_groups(options = {})
	validate_cli_options_hash([:job_key, :group_names], options)
	db_key_result = execute_cli_with_param_list(self.class, "addTargetGroups",
		[
			options[:job_key],		# Handle of the job to be updated
			options[:group_names]	# Name of the groups to add (comma separated list)
		])
	db_key = get_cli_return_value(db_key_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#add_target_server(options = {}) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/bl_soap/job.rb', line 43

def add_target_server(options = {})
	validate_cli_options_hash([:job_key, :server_name], options)
	db_key_result = execute_cli_with_param_list(self.class, "addTargetServer",
		[
			options[:job_key],		# Handle of the job to be updated
			options[:server_name]	# Name of the server to add
		])
	db_key = get_cli_return_value(db_key_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#add_target_servers(options = {}) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/bl_soap/job.rb', line 55

def add_target_servers(options = {})
	validate_cli_options_hash([:job_key, :server_names], options)
	db_key_result = execute_cli_with_param_list(self.class, "addTargetServers",
		[
			options[:job_key],		# Handle of the job to be updated
			options[:server_names]	# Name of the servers to add (comma separated list)
		])
	db_key = get_cli_return_value(db_key_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#clear_target_group(options = {}) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/bl_soap/job.rb', line 67

def clear_target_group(options = {})
	validate_cli_options_hash([:job_key, :group_name], options)
	db_key_result = execute_cli_with_param_list(self.class, "clearTargetGroup",
		[
			options[:job_key],		# Handle of the job to be updated
			options[:group_name]	# Name of the server group
		])
	db_key = get_cli_return_value(db_key_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#clear_target_groups(options = {}) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
 
# File 'lib/bl_soap/job.rb', line 79

def clear_target_groups(options = {})
	validate_cli_options_hash([:job_key], options)
	db_key_result = execute_cli_with_param_list(self.class, "clearTargetGroups",
		[
			options[:job_key]	# Handle of the job to be updated
		])
	db_key = get_cli_return_value(db_key_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#clear_target_server(options = {}) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/bl_soap/job.rb', line 90

def clear_target_server(options = {})
	validate_cli_options_hash([:job_key, :server_name], options)
	db_key_result = execute_cli_with_param_list(self.class, "clearTargetServer",
		[
			options[:job_key],		# Handle of the job to be updated
			options[:server_name]	# Name of the server to add
		])
	db_key = get_cli_return_value(db_key_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#clear_target_servers(options = {}) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/bl_soap/job.rb', line 102

def clear_target_servers(options = {})
	validate_cli_options_hash([:job_key], options)
	db_key_result = execute_cli_with_param_list(self.class, "clearTargetServers",
		[
			options[:job_key]	# Handle of the job to be updated
		])
	db_key = get_cli_return_value(db_key_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#create_approval(options = {}) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/bl_soap/job.rb', line 113

def create_approval(options = {})
	validate_cli_options_hash([:approval_type, :change_type, :impact_id, :risk_level], options)
	integer_result = execute_cli_with_param_list(self.class, "createApproval",
		[
			options[:approval_type],	# The approval type
			options[:change_type],		# The change type
			options[:comments] || "",	# A string that appears in the change summary (if approval_type = 5, change can be "")
			options[:impact_id],		# The impact id
			options[:risk_level],		# The risk level
			options[:change_id] || "",	# The change id from the change management system (only if approval_type = 5) 
			options[:task_id] || ""		# The task id from the change management system ( only if approval_type = 5)
		])
		integer_value = get_cli_return_value(integer_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#execute(options = {}) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
 
# File 'lib/bl_soap/job.rb', line 130

def execute(options = {})
	validate_cli_options_hash([:job_key], options)
	void_result = execute_cli_with_param_list(self.class, "execute",
		[
			options[:job_key]	# Handle of the job to be updated
		])
	void_value = get_cli_return_value(void_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#execute_against_component_groups(options = {}) ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/bl_soap/job.rb', line 141

def execute_against_component_groups(options = {})
	validate_cli_options_hash([:job_key, :group_names], options)
	integer_result = execute_cli_with_param_list(self.class, "executeAgainstComponentGroups",
		[
			options[:job_key],		# Handle of the job to be updated
			options[:group_names]	# Name of component group(s) - comma-separated list of group names
		])
	integer_value = get_cli_return_value(integer_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#execute_against_component_groups_for_run_id(options = {}) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/bl_soap/job.rb', line 153

def execute_against_component_groups_for_run_id(options = {})
	validate_cli_options_hash([:job_key, :group_names], options)
	job_run_key_result = execute_cli_with_param_list(self.class, "executeAgainstComponentGroupsForRunID",
		[
			options[:job_key],		# Handle of the job to be updated
			options[:group_names]	# Name of component group(s) - comma-separated list of group names
		])
	job_run_key = get_cli_return_value(job_run_key_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#execute_against_failed_target(options = {}) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/bl_soap/job.rb', line 165

def execute_against_failed_target(options = {})
	validate_cli_options_hash([:job_key, :filter_type], options)
	integer_result = execute_cli_with_param_list(self.class, "executeAgainstFailedTarget",
		[
			options[:job_key],		# Handle of the job to be updated
			options[:filter_type]	# The failure level of the targets you want to execute against
		])
	integer_value = get_cli_return_value(integer_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#execute_against_server_groups(options = {}) ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/bl_soap/job.rb', line 177

def execute_against_server_groups(options = {})
	validate_cli_options_hash([:job_key, :server_groups], options)
	integer_result = execute_cli_with_param_list(self.class, "executeAgainstServerGroups",
		[
			options[:job_key],		# Handle of the job to be updated
			options[:server_groups]	# Name of server group(s) - comma-separated list of group names
		])
	integer_value = get_cli_return_value(integer_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#execute_against_server_groups_for_run_id(options = {}) ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/bl_soap/job.rb', line 189

def execute_against_server_groups_for_run_id(options = {})
	validate_cli_options_hash([:job_key, :server_groups], options)
	job_run_key_result = execute_cli_with_param_list(self.class, "executeAgainstServerGroupsForRunID",
		[
			options[:job_key],		# Handle of the job to be updated
			options[:server_groups]	# Name of server group(s) - comma-separated list of group names
		])
	job_run_key = get_cli_return_value(job_run_key_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#execute_against_servers(options = {}) ⇒ Object 



201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/bl_soap/job.rb', line 201

def execute_against_servers(options = {})
	validate_cli_options_hash([:job_key, :server_names], options)
	integer_result = execute_cli_with_param_list(self.class, "executeAgainstServers",
		[
			options[:job_key],		# Handle of the job to be updated
			options[:server_names]	# Name of server group(s) - comma-separated list of group names
		])
	integer_value = get_cli_return_value(integer_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#execute_against_servers_for_run_id(options = {}) ⇒ Object 



213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/bl_soap/job.rb', line 213

def execute_against_servers_for_run_id(options = {})
	validate_cli_options_hash([:job_key, :server_names], options)
	job_run_key_result = execute_cli_with_param_list(self.class, "executeAgainstServersForRunID",
		[
			options[:job_key],		# Handle of the job to be updated
			options[:server_names]	# Name of server group(s) - comma-separated list of group names
		])
	job_run_key = get_cli_return_value(job_run_key_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#execute_job_and_wait(options = {}) ⇒ Object 



225
226
227
228
229
230
231
232
233
234
 
# File 'lib/bl_soap/job.rb', line 225

def execute_job_and_wait(options = {})
	validate_cli_options_hash([:job_key], options)
	job_run_key_result = execute_cli_with_param_list(self.class, "executeJobAndWait",
		[
			options[:job_key]	# Handle of the job to be updated
		])
	job_run_key = get_cli_return_value(job_run_key_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#execute_job_and_wait_for_run_id(options = {}) ⇒ Object 



236
237
238
239
240
241
242
243
244
245
 
# File 'lib/bl_soap/job.rb', line 236

def execute_job_and_wait_for_run_id(options = {})
	validate_cli_options_hash([:job_key], options)
	job_run_key_result = execute_cli_with_param_list(self.class, "executeJobAndWaitForRunID",
		[
			options[:job_key]	# Handle of the job to be updated
		])
	job_run_key = get_cli_return_value(job_run_key_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#execute_job_with_approval_and_wait_for_run_id(options = {}) ⇒ Object 



247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/bl_soap/job.rb', line 247

def execute_job_with_approval_and_wait_for_run_id(options = {})
	validate_cli_options_hash([:job_key, :approval_id], options)
	job_run_key_result = execute_cli_with_param_list(self.class, "executeJobWithApprovalAndWaitForRunID",
		[
			options[:job_key],		# Handle of the job to be updated
			options[:approval_id]	# Approval id
		])
	job_run_key = get_cli_return_value(job_run_key_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#execute_with_approval(options = {}) ⇒ Object 



259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/bl_soap/job.rb', line 259

def execute_with_approval(options = {})
	validate_cli_options_hash([:job_key, :approval_id], options)
	void_result = execute_cli_with_param_list(self.class, "executeJobWithApprovalAndWaitForRunID",
		[
			options[:job_key],		# Handle of the job to be updated
			options[:approval_id]	# Approval id
		])
	void_value = get_cli_return_value(void_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#get_group_id(options = {}) ⇒ Object 



271
272
273
274
275
276
277
278
279
280
 
# File 'lib/bl_soap/job.rb', line 271

def get_group_id(options = {})
	validate_cli_options_hash([:job_key], options)
	integer_result = execute_cli_with_param_list(self.class, "getGroupId",
		[
			options[:job_key]	# Handle of the job to be updated
		])
	integer_value = get_cli_return_value(integer_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#get_job_name_by_db_key(options = {}) ⇒ Object 



282
283
284
285
286
287
288
289
290
291
 
# File 'lib/bl_soap/job.rb', line 282

def get_job_name_by_db_key(options = {})
	validate_cli_options_hash([:job_db_key], options)
	string_result = execute_cli_with_param_list(self.class, "getJobNameByDBKey",
		[
			options[:job_db_key]	# Handle of the job
		])
	string_value = get_cli_return_value(string_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#get_last_job_db_key_by_job_id(options = {}) ⇒ Object 



293
294
295
296
297
298
299
300
301
302
 
# File 'lib/bl_soap/job.rb', line 293

def get_last_job_db_key_by_job_id(options = {})
	validate_cli_options_hash([:job_id], options)
	db_key_result = execute_cli_with_param_list(self.class, "getLastJobDBKeyByJobId",
		[
			options[:job_id]	# Handle of the job
		])
	db_key = get_cli_return_value(db_key_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#get_target_servers(options = {}) ⇒ Object 



304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/bl_soap/job.rb', line 304

def get_target_servers(options = {})
	validate_cli_options_hash([:job_key, :server_state], options)
	list_result = execute_cli_with_param_list(self.class, "getTargetServers",
		[
			options[:job_key],		# Handle of the job
			options[:server_state]	# desired server states
		])
	list_value = get_cli_return_value(list_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#get_targets(options = {}) ⇒ Object 



316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/bl_soap/job.rb', line 316

def get_targets(options = {})
	validate_cli_options_hash([:job_key, :taret_types], options)
	list_result = execute_cli_with_param_list(self.class, "getTargets",
		[
			options[:job_key],		# Handle of the job
			options[:target_types]	# desired target types
		])
	list_value = get_cli_return_value(list_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#list_all_by_group(options = {}) ⇒ Object 



328
329
330
331
332
333
334
335
336
337
 
# File 'lib/bl_soap/job.rb', line 328

def list_all_by_group(options = {})
	validate_cli_options_hash([:group_name], options)
	string_result = execute_cli_with_param_list(self.class, "listAllByGroup",
		[
			options[:group_name]	# Fully qualified group name
		])
	string_value = get_cli_return_value(string_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#set_max_parallelism(options = {}) ⇒ Object 



339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/bl_soap/job.rb', line 339

def set_max_parallelism(options = {})
	validate_cli_options_hash([:job_key, :parallelism], options)
	db_key_result = execute_cli_with_param_list(self.class, "setMaxParallelism",
		[
			options[:job_key],		# Handle of the job
			options[:parallelism]	# max parallelism
		])
	db_key = get_cli_return_value(db_key_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end

#set_property_value(options = {}) ⇒ Object 



351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/bl_soap/job.rb', line 351

def set_property_value(options = {})
	validate_cli_options_hash([:object_key, :property_name, :value_as_string], options)
	job_id_result = execute_cli_with_param_list(self.class, "getTargets",
		[
			options[:object_key],		# DBKey of the job
			options[:property_name],	# property name
			options[:value_as_string]	# property value
		])
	job_id = get_cli_return_value(job_id_result)
rescue => exception
	raise "#{self.class} Exception: #{exception.to_s}"
end