Class: Falcon::ItAutomation

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/api/it_automation.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ItAutomation

Returns a new instance of ItAutomation.



35
36
37
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 35

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



33
34
35
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 33

def api_client
  @api_client
end

Instance Method Details

#i_t_automation_cancel_task_execution(body, opts = {}) ⇒ ItautomationCancelTaskExecutionResponse

Cancel a task execution specified in the request

Parameters:

Returns:



42
43
44
45
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 42

def i_t_automation_cancel_task_execution(body, opts = {})
  data, _status_code, _headers = i_t_automation_cancel_task_execution_with_http_info(body, opts)
  data
end

#i_t_automation_cancel_task_execution_with_http_info(body, opts = {}) ⇒ Array<(ItautomationCancelTaskExecutionResponse, Integer, Hash)>

Cancel a task execution specified in the request

Parameters:

Returns:



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
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 51

def i_t_automation_cancel_task_execution_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_cancel_task_execution ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ItAutomation.i_t_automation_cancel_task_execution"
  end
  # resource path
  local_var_path = '/it-automation/entities/task-execution-cancel/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationCancelTaskExecutionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_cancel_task_execution",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_cancel_task_execution\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_combined_scheduled_tasks(opts = {}) ⇒ ItautomationGetScheduledTaskResponse

Returns full details of scheduled tasks matching the filter query parameter.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [created_by, created_time, end_time, group_ids, group_names, is_active, last_run, modified_by, modified_time, start_time, task_id, task_name, task_type] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [created_by, created_time, end_time, group_ids, group_names, last_run, modified_by, modified_time, start_time, task_id, task_name, task_type]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



111
112
113
114
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 111

def i_t_automation_combined_scheduled_tasks(opts = {})
  data, _status_code, _headers = i_t_automation_combined_scheduled_tasks_with_http_info(opts)
  data
end

#i_t_automation_combined_scheduled_tasks_with_http_info(opts = {}) ⇒ Array<(ItautomationGetScheduledTaskResponse, Integer, Hash)>

Returns full details of scheduled tasks matching the filter query parameter.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [created_by, created_time, end_time, group_ids, group_names, is_active, last_run, modified_by, modified_time, start_time, task_id, task_name, task_type] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [created_by, created_time, end_time, group_ids, group_names, last_run, modified_by, modified_time, start_time, task_id, task_name, task_type]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



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
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 123

def i_t_automation_combined_scheduled_tasks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_combined_scheduled_tasks ...'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling ItAutomation.i_t_automation_combined_scheduled_tasks, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_combined_scheduled_tasks, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_combined_scheduled_tasks, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/it-automation/combined/scheduled-tasks/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationGetScheduledTaskResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_combined_scheduled_tasks",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_combined_scheduled_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_create_policy(body, opts = {}) ⇒ ItautomationCreatePolicyResponse

Creates a new policy of the specified type. New policies are always added at the end of the precedence list for the provided policy type. After they are created, host groups can be assigned and policy precedence can be set.

Parameters:

  • body (ItautomationCreatePolicyRequest) —

    Create an existing policy. * &#x60;name&#x60; must be between 1 and 100 characters. * &#x60;description&#x60; can be between 0 and 500 characters. * &#x60;platform&#x60; must be one of &#x60;Windows&#x60;, &#x60;Linux&#x60;, or &#x60;Mac&#x60; * &#x60;config.execution.enable_script_execution&#x60; enables or disables script execution. * &#x60;config.execution.enable_python_execution&#x60; enables or disables Python execution. * &#x60;config.execution.enable_os_query&#x60; enables or disables OS Query. * &#x60;config.execution.execution_timeout&#x60; specifies the timeout value for executions. * &#x60;config.execution.execution_timeout_unit&#x60; must be one of &#x60;Hours&#x60; or &#x60;Minutes&#x60;. * &#x60;config.resources.cpu_throttle&#x60; specifies the CPU throttle value. * &#x60;config.resources.cpu_scheduling&#x60; sets priority to determine the order in which a query process will run on a host&#39;s CPU. * &#x60;config.resources.memory_pressure_level&#x60; sets memory pressure level to control system resource allocation during task execution. * &#x60;config.resources.memory_allocation&#x60; specifies the memory allocation value. * &#x60;config.resources.memory_allocation_unit&#x60; must be one of &#x60;MB&#x60; or &#x60;GB&#x60;. * &#x60;config.concurrency.concurrent_host_limit&#x60; specifies the maximum number of concurrent hosts. * &#x60;config.concurrency.concurrent_task_limit&#x60; specifies the maximum number of concurrent tasks. * &#x60;config.concurrency.concurrent_host_file_transfer_limit&#x60; specifies the maximum number of concurrent file transfers.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



188
189
190
191
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 188

def i_t_automation_create_policy(body, opts = {})
  data, _status_code, _headers = i_t_automation_create_policy_with_http_info(body, opts)
  data
end

#i_t_automation_create_policy_with_http_info(body, opts = {}) ⇒ Array<(ItautomationCreatePolicyResponse, Integer, Hash)>

Creates a new policy of the specified type. New policies are always added at the end of the precedence list for the provided policy type. After they are created, host groups can be assigned and policy precedence can be set.

Parameters:

  • body (ItautomationCreatePolicyRequest) —

    Create an existing policy. * &#x60;name&#x60; must be between 1 and 100 characters. * &#x60;description&#x60; can be between 0 and 500 characters. * &#x60;platform&#x60; must be one of &#x60;Windows&#x60;, &#x60;Linux&#x60;, or &#x60;Mac&#x60; * &#x60;config.execution.enable_script_execution&#x60; enables or disables script execution. * &#x60;config.execution.enable_python_execution&#x60; enables or disables Python execution. * &#x60;config.execution.enable_os_query&#x60; enables or disables OS Query. * &#x60;config.execution.execution_timeout&#x60; specifies the timeout value for executions. * &#x60;config.execution.execution_timeout_unit&#x60; must be one of &#x60;Hours&#x60; or &#x60;Minutes&#x60;. * &#x60;config.resources.cpu_throttle&#x60; specifies the CPU throttle value. * &#x60;config.resources.cpu_scheduling&#x60; sets priority to determine the order in which a query process will run on a host&#39;s CPU. * &#x60;config.resources.memory_pressure_level&#x60; sets memory pressure level to control system resource allocation during task execution. * &#x60;config.resources.memory_allocation&#x60; specifies the memory allocation value. * &#x60;config.resources.memory_allocation_unit&#x60; must be one of &#x60;MB&#x60; or &#x60;GB&#x60;. * &#x60;config.concurrency.concurrent_host_limit&#x60; specifies the maximum number of concurrent hosts. * &#x60;config.concurrency.concurrent_task_limit&#x60; specifies the maximum number of concurrent tasks. * &#x60;config.concurrency.concurrent_host_file_transfer_limit&#x60; specifies the maximum number of concurrent file transfers.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 198

def i_t_automation_create_policy_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_create_policy ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ItAutomation.i_t_automation_create_policy"
  end
  # resource path
  local_var_path = '/it-automation/entities/policies/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationCreatePolicyResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_create_policy",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_create_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_create_scheduled_task(body, opts = {}) ⇒ ItautomationCreateScheduledTaskResponse

Creates a scheduled task from the given request

Parameters:

Returns:



255
256
257
258
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 255

def i_t_automation_create_scheduled_task(body, opts = {})
  data, _status_code, _headers = i_t_automation_create_scheduled_task_with_http_info(body, opts)
  data
end

#i_t_automation_create_scheduled_task_with_http_info(body, opts = {}) ⇒ Array<(ItautomationCreateScheduledTaskResponse, Integer, Hash)>

Creates a scheduled task from the given request

Parameters:

Returns:



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
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 264

def i_t_automation_create_scheduled_task_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_create_scheduled_task ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ItAutomation.i_t_automation_create_scheduled_task"
  end
  # resource path
  local_var_path = '/it-automation/entities/scheduled-tasks/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationCreateScheduledTaskResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_create_scheduled_task",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_create_scheduled_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_create_task(body, opts = {}) ⇒ ItautomationCreateTaskResponse

Creates a task with details from the given request.

Parameters:

Returns:



321
322
323
324
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 321

def i_t_automation_create_task(body, opts = {})
  data, _status_code, _headers = i_t_automation_create_task_with_http_info(body, opts)
  data
end

#i_t_automation_create_task_group(body, opts = {}) ⇒ ItautomationCreateTaskGroupResponse

Creates a task group from the given request

Parameters:

Returns:



387
388
389
390
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 387

def i_t_automation_create_task_group(body, opts = {})
  data, _status_code, _headers = i_t_automation_create_task_group_with_http_info(body, opts)
  data
end

#i_t_automation_create_task_group_with_http_info(body, opts = {}) ⇒ Array<(ItautomationCreateTaskGroupResponse, Integer, Hash)>

Creates a task group from the given request

Parameters:

Returns:



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 396

def i_t_automation_create_task_group_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_create_task_group ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ItAutomation.i_t_automation_create_task_group"
  end
  # resource path
  local_var_path = '/it-automation/entities/task-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationCreateTaskGroupResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_create_task_group",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_create_task_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_create_task_with_http_info(body, opts = {}) ⇒ Array<(ItautomationCreateTaskResponse, Integer, Hash)>

Creates a task with details from the given request.

Parameters:

Returns:



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 330

def i_t_automation_create_task_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_create_task ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ItAutomation.i_t_automation_create_task"
  end
  # resource path
  local_var_path = '/it-automation/entities/tasks/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationCreateTaskResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_create_task",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_create_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_create_user_group(body, opts = {}) ⇒ ItautomationCreateUserGroupResponse

Creates a user group from the given request

Parameters:

Returns:



453
454
455
456
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 453

def i_t_automation_create_user_group(body, opts = {})
  data, _status_code, _headers = i_t_automation_create_user_group_with_http_info(body, opts)
  data
end

#i_t_automation_create_user_group_with_http_info(body, opts = {}) ⇒ Array<(ItautomationCreateUserGroupResponse, Integer, Hash)>

Creates a user group from the given request

Parameters:

Returns:



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 462

def i_t_automation_create_user_group_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_create_user_group ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ItAutomation.i_t_automation_create_user_group"
  end
  # resource path
  local_var_path = '/it-automation/entities/it-user-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationCreateUserGroupResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_create_user_group",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_create_user_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_delete_policy(ids, opts = {}) ⇒ ItautomationDeletePolicyResponse

Deletes 1 or more policies. Only disabled policies are allowed to be deleted.

Parameters:

  • ids (Array<String>) —

    list of task ids to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



520
521
522
523
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 520

def i_t_automation_delete_policy(ids, opts = {})
  data, _status_code, _headers = i_t_automation_delete_policy_with_http_info(ids, opts)
  data
end

#i_t_automation_delete_policy_with_http_info(ids, opts = {}) ⇒ Array<(ItautomationDeletePolicyResponse, Integer, Hash)>

Deletes 1 or more policies. Only disabled policies are allowed to be deleted.

Parameters:

  • ids (Array<String>) —

    list of task ids to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 530

def i_t_automation_delete_policy_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_delete_policy ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling ItAutomation.i_t_automation_delete_policy"
  end
  # resource path
  local_var_path = '/it-automation/entities/policies/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationDeletePolicyResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_delete_policy",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_delete_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_delete_scheduled_tasks(ids, opts = {}) ⇒ ItautomationDeleteScheduledTasksResponse

Delete one or more scheduled tasks by providing the scheduled tasks IDs

Parameters:

  • ids (Array<String>) —

    Comma separated values of scheduled task IDs to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



583
584
585
586
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 583

def i_t_automation_delete_scheduled_tasks(ids, opts = {})
  data, _status_code, _headers = i_t_automation_delete_scheduled_tasks_with_http_info(ids, opts)
  data
end

#i_t_automation_delete_scheduled_tasks_with_http_info(ids, opts = {}) ⇒ Array<(ItautomationDeleteScheduledTasksResponse, Integer, Hash)>

Delete one or more scheduled tasks by providing the scheduled tasks IDs

Parameters:

  • ids (Array<String>) —

    Comma separated values of scheduled task IDs to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 592

def i_t_automation_delete_scheduled_tasks_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_delete_scheduled_tasks ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling ItAutomation.i_t_automation_delete_scheduled_tasks"
  end
  # resource path
  local_var_path = '/it-automation/entities/scheduled-tasks/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationDeleteScheduledTasksResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_delete_scheduled_tasks",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_delete_scheduled_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_delete_task(ids, opts = {}) ⇒ ItautomationDeleteTaskResponse

Deletes tasks for each provided ID

Parameters:

  • ids (Array<String>) —

    IDs of tasks to delete. Use ITAutomationSearchTasks to fetch IDs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



645
646
647
648
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 645

def i_t_automation_delete_task(ids, opts = {})
  data, _status_code, _headers = i_t_automation_delete_task_with_http_info(ids, opts)
  data
end

#i_t_automation_delete_task_groups(ids, opts = {}) ⇒ ItautomationDeleteTaskGroupsResponse

Delete one or more task groups by providing the task group IDs

Parameters:

  • ids (Array<String>) —

    Comma separated values of task group IDs to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



707
708
709
710
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 707

def i_t_automation_delete_task_groups(ids, opts = {})
  data, _status_code, _headers = i_t_automation_delete_task_groups_with_http_info(ids, opts)
  data
end

#i_t_automation_delete_task_groups_with_http_info(ids, opts = {}) ⇒ Array<(ItautomationDeleteTaskGroupsResponse, Integer, Hash)>

Delete one or more task groups by providing the task group IDs

Parameters:

  • ids (Array<String>) —

    Comma separated values of task group IDs to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 716

def i_t_automation_delete_task_groups_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_delete_task_groups ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling ItAutomation.i_t_automation_delete_task_groups"
  end
  # resource path
  local_var_path = '/it-automation/entities/task-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationDeleteTaskGroupsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_delete_task_groups",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_delete_task_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_delete_task_with_http_info(ids, opts = {}) ⇒ Array<(ItautomationDeleteTaskResponse, Integer, Hash)>

Deletes tasks for each provided ID

Parameters:

  • ids (Array<String>) —

    IDs of tasks to delete. Use ITAutomationSearchTasks to fetch IDs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 654

def i_t_automation_delete_task_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_delete_task ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling ItAutomation.i_t_automation_delete_task"
  end
  # resource path
  local_var_path = '/it-automation/entities/tasks/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationDeleteTaskResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_delete_task",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_delete_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_delete_user_group(ids, opts = {}) ⇒ ItautomationDeleteUserGroupsResponse

Deletes user groups for each provided ids

Parameters:

  • ids (Array<String>) —

    Comma separated values of user group ids to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



769
770
771
772
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 769

def i_t_automation_delete_user_group(ids, opts = {})
  data, _status_code, _headers = i_t_automation_delete_user_group_with_http_info(ids, opts)
  data
end

#i_t_automation_delete_user_group_with_http_info(ids, opts = {}) ⇒ Array<(ItautomationDeleteUserGroupsResponse, Integer, Hash)>

Deletes user groups for each provided ids

Parameters:

  • ids (Array<String>) —

    Comma separated values of user group ids to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 778

def i_t_automation_delete_user_group_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_delete_user_group ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling ItAutomation.i_t_automation_delete_user_group"
  end
  # resource path
  local_var_path = '/it-automation/entities/it-user-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationDeleteUserGroupsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_delete_user_group",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_delete_user_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_get_associated_tasks(id, opts = {}) ⇒ ItautomationFileTaskAssociationResponse

Retrieve tasks associated with the provided file id

Parameters:

  • id (String) —

    The ID of the file to fetch associated tasks for

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [access_type, created_by, created_time, last_run_time, modified_by, modified_time, name, runs, task_type] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [name]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



835
836
837
838
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 835

def i_t_automation_get_associated_tasks(id, opts = {})
  data, _status_code, _headers = i_t_automation_get_associated_tasks_with_http_info(id, opts)
  data
end

#i_t_automation_get_associated_tasks_with_http_info(id, opts = {}) ⇒ Array<(ItautomationFileTaskAssociationResponse, Integer, Hash)>

Retrieve tasks associated with the provided file id

Parameters:

  • id (String) —

    The ID of the file to fetch associated tasks for

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [access_type, created_by, created_time, last_run_time, modified_by, modified_time, name, runs, task_type] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [name]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 848

def i_t_automation_get_associated_tasks_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_get_associated_tasks ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ItAutomation.i_t_automation_get_associated_tasks"
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling ItAutomation.i_t_automation_get_associated_tasks, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_get_associated_tasks, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_get_associated_tasks, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/it-automation/combined/associated-tasks/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationFileTaskAssociationResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_get_associated_tasks",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_get_associated_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_get_execution_results(id, opts = {}) ⇒ ItautomationTaskExecutionResultsResponse

Get the task execution results from an async search. Use the ITAutomationStartExecutionResultsSearch command to start the async search. You can retrieve the results again for up to 24 hours, after which they will be deleted.

Parameters:

  • id (String) —

    The Job ID to fetch. Use the value returned from &#x60;ITAutomationStartExecutionResultsSearch&#x60;

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The offset to start retrieving records from (default to 0)

  • :limit (Integer) —

    The maximum number of event results to return (default to 500)

  • :sort (String) —

    Sort results by one of the fields in the event results, either asc (ascending) or desc (descending) For example, to sort by hostname ascending: &#x60;hostname.asc&#x60;

Returns:



920
921
922
923
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 920

def i_t_automation_get_execution_results(id, opts = {})
  data, _status_code, _headers = i_t_automation_get_execution_results_with_http_info(id, opts)
  data
end

#i_t_automation_get_execution_results_search_status(id, opts = {}) ⇒ ItautomationSearchStatusResponse

Get the status of an async task execution results. Look for ‘is_pending: false` to know search is complete.

Parameters:

  • id (String) —

    Search Job ID to fetch. UseITAutomationStartExecutionResultsSearch to get the job id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



992
993
994
995
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 992

def i_t_automation_get_execution_results_search_status(id, opts = {})
  data, _status_code, _headers = i_t_automation_get_execution_results_search_status_with_http_info(id, opts)
  data
end

#i_t_automation_get_execution_results_search_status_with_http_info(id, opts = {}) ⇒ Array<(ItautomationSearchStatusResponse, Integer, Hash)>

Get the status of an async task execution results. Look for &#x60;is_pending: false&#x60; to know search is complete.

Parameters:

  • id (String) —

    Search Job ID to fetch. UseITAutomationStartExecutionResultsSearch to get the job id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1001

def i_t_automation_get_execution_results_search_status_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_get_execution_results_search_status ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ItAutomation.i_t_automation_get_execution_results_search_status"
  end
  # resource path
  local_var_path = '/it-automation/entities/task-execution-results-search/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationSearchStatusResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_get_execution_results_search_status",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_get_execution_results_search_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_get_execution_results_with_http_info(id, opts = {}) ⇒ Array<(ItautomationTaskExecutionResultsResponse, Integer, Hash)>

Get the task execution results from an async search. Use the ITAutomationStartExecutionResultsSearch command to start the async search. You can retrieve the results again for up to 24 hours, after which they will be deleted.

Parameters:

  • id (String) —

    The Job ID to fetch. Use the value returned from &#x60;ITAutomationStartExecutionResultsSearch&#x60;

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The offset to start retrieving records from (default to 0)

  • :limit (Integer) —

    The maximum number of event results to return (default to 500)

  • :sort (String) —

    Sort results by one of the fields in the event results, either asc (ascending) or desc (descending) For example, to sort by hostname ascending: &#x60;hostname.asc&#x60;

Returns:



932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 932

def i_t_automation_get_execution_results_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_get_execution_results ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ItAutomation.i_t_automation_get_execution_results"
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling ItAutomation.i_t_automation_get_execution_results, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/it-automation/entities/task-execution-results/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationTaskExecutionResultsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_get_execution_results",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_get_execution_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_get_policies(ids, opts = {}) ⇒ ItautomationPoliciesAPIResponse

Retrieves the configuration for 1 or more policies. The configuration of each policy that match the provided id will be returned.

Parameters:

  • ids (Array<String>) —

    One or more (up to 500) policy ids in the form of &#x60;ids&#x3D;ID1&amp;ids&#x3D;ID2&#x60;

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1055
1056
1057
1058
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1055

def i_t_automation_get_policies(ids, opts = {})
  data, _status_code, _headers = i_t_automation_get_policies_with_http_info(ids, opts)
  data
end

#i_t_automation_get_policies_with_http_info(ids, opts = {}) ⇒ Array<(ItautomationPoliciesAPIResponse, Integer, Hash)>

Retrieves the configuration for 1 or more policies. The configuration of each policy that match the provided id will be returned.

Parameters:

  • ids (Array<String>) —

    One or more (up to 500) policy ids in the form of &#x60;ids&#x3D;ID1&amp;ids&#x3D;ID2&#x60;

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1065

def i_t_automation_get_policies_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_get_policies ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling ItAutomation.i_t_automation_get_policies"
  end
  # resource path
  local_var_path = '/it-automation/entities/policies/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationPoliciesAPIResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_get_policies",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_get_policies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_get_scheduled_tasks(ids, opts = {}) ⇒ ItautomationGetScheduledTaskResponse

Returns scheduled tasks for each provided id

Parameters:

  • ids (Array<String>) —

    Scheduled task IDs to fetch. Use ITAutomationSearchScheduledTasks to fetch scheduled task IDs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1118
1119
1120
1121
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1118

def i_t_automation_get_scheduled_tasks(ids, opts = {})
  data, _status_code, _headers = i_t_automation_get_scheduled_tasks_with_http_info(ids, opts)
  data
end

#i_t_automation_get_scheduled_tasks_with_http_info(ids, opts = {}) ⇒ Array<(ItautomationGetScheduledTaskResponse, Integer, Hash)>

Returns scheduled tasks for each provided id

Parameters:

  • ids (Array<String>) —

    Scheduled task IDs to fetch. Use ITAutomationSearchScheduledTasks to fetch scheduled task IDs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1127

def i_t_automation_get_scheduled_tasks_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_get_scheduled_tasks ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling ItAutomation.i_t_automation_get_scheduled_tasks"
  end
  # resource path
  local_var_path = '/it-automation/entities/scheduled-tasks/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationGetScheduledTaskResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_get_scheduled_tasks",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_get_scheduled_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_get_task_execution(ids, opts = {}) ⇒ ItautomationGetTaskExecutionResponse

Get the task execution for the provided task execution IDs

Parameters:

  • ids (Array<String>) —

    Task execution IDs to fetch. Use ITAutomationSearchTaskExecutions to get the execution id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1180
1181
1182
1183
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1180

def i_t_automation_get_task_execution(ids, opts = {})
  data, _status_code, _headers = i_t_automation_get_task_execution_with_http_info(ids, opts)
  data
end

#i_t_automation_get_task_execution_host_status(ids, opts = {}) ⇒ ItautomationGetTaskExecutionHostStatusResponse

Get the status of host executions by providing the execution IDs

Parameters:

  • ids (Array<String>) —

    Task execution IDs to get statuses for. Use ITAutomationSearchTaskExecutions to fetch execution IDs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [end_time, start_time, status, total_results] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [end_time, start_time, status, total_results]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



1246
1247
1248
1249
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1246

def i_t_automation_get_task_execution_host_status(ids, opts = {})
  data, _status_code, _headers = i_t_automation_get_task_execution_host_status_with_http_info(ids, opts)
  data
end

#i_t_automation_get_task_execution_host_status_with_http_info(ids, opts = {}) ⇒ Array<(ItautomationGetTaskExecutionHostStatusResponse, Integer, Hash)>

Get the status of host executions by providing the execution IDs

Parameters:

  • ids (Array<String>) —

    Task execution IDs to get statuses for. Use ITAutomationSearchTaskExecutions to fetch execution IDs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [end_time, start_time, status, total_results] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [end_time, start_time, status, total_results]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1259

def i_t_automation_get_task_execution_host_status_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_get_task_execution_host_status ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling ItAutomation.i_t_automation_get_task_execution_host_status"
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling ItAutomation.i_t_automation_get_task_execution_host_status, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_get_task_execution_host_status, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_get_task_execution_host_status, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/it-automation/entities/task-execution-host-status/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationGetTaskExecutionHostStatusResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_get_task_execution_host_status",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_get_task_execution_host_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_get_task_execution_with_http_info(ids, opts = {}) ⇒ Array<(ItautomationGetTaskExecutionResponse, Integer, Hash)>

Get the task execution for the provided task execution IDs

Parameters:

  • ids (Array<String>) —

    Task execution IDs to fetch. Use ITAutomationSearchTaskExecutions to get the execution id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1189

def i_t_automation_get_task_execution_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_get_task_execution ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling ItAutomation.i_t_automation_get_task_execution"
  end
  # resource path
  local_var_path = '/it-automation/entities/task-executions/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationGetTaskExecutionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_get_task_execution",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_get_task_execution\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_get_task_executions_by_query(opts = {}) ⇒ ItautomationGetTaskExecutionResponse

Returns the list of task executions (and their details) matching the filter query parameter. This endpoint will return the same output as if you ran ITAutomationSearchTaskExecutions and ITAutomationGetTaskExecution

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [end_time, run_by, run_type, start_time, status, task_id, task_name, task_type] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [end_time, run_by, run_type, start_time, status, task_id, task_name, task_type]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



1331
1332
1333
1334
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1331

def i_t_automation_get_task_executions_by_query(opts = {})
  data, _status_code, _headers = i_t_automation_get_task_executions_by_query_with_http_info(opts)
  data
end

#i_t_automation_get_task_executions_by_query_with_http_info(opts = {}) ⇒ Array<(ItautomationGetTaskExecutionResponse, Integer, Hash)>

Returns the list of task executions (and their details) matching the filter query parameter. This endpoint will return the same output as if you ran ITAutomationSearchTaskExecutions and ITAutomationGetTaskExecution

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [end_time, run_by, run_type, start_time, status, task_id, task_name, task_type] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [end_time, run_by, run_type, start_time, status, task_id, task_name, task_type]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1343

def i_t_automation_get_task_executions_by_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_get_task_executions_by_query ...'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling ItAutomation.i_t_automation_get_task_executions_by_query, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_get_task_executions_by_query, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_get_task_executions_by_query, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/it-automation/combined/task-executions/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationGetTaskExecutionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_get_task_executions_by_query",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_get_task_executions_by_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_get_task_groups(ids, opts = {}) ⇒ ItautomationGetTaskGroupsResponse

Returns task groups for each provided id

Parameters:

  • ids (Array<String>) —

    Comma separated values of task group ids to fetch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1407
1408
1409
1410
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1407

def i_t_automation_get_task_groups(ids, opts = {})
  data, _status_code, _headers = i_t_automation_get_task_groups_with_http_info(ids, opts)
  data
end

#i_t_automation_get_task_groups_by_query(opts = {}) ⇒ ItautomationGetTaskGroupsResponse

Returns full details of task groups matching the filter query parameter. Can be used in place of calling ITAutomationSearchTaskGroups then ITAutomationGetTaskGroups.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [access_type, created_by, created_time, modified_by, modified_time, name] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [access_type, created_by, created_time, modified_by, modified_time, name]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



1473
1474
1475
1476
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1473

def i_t_automation_get_task_groups_by_query(opts = {})
  data, _status_code, _headers = i_t_automation_get_task_groups_by_query_with_http_info(opts)
  data
end

#i_t_automation_get_task_groups_by_query_with_http_info(opts = {}) ⇒ Array<(ItautomationGetTaskGroupsResponse, Integer, Hash)>

Returns full details of task groups matching the filter query parameter. Can be used in place of calling ITAutomationSearchTaskGroups then ITAutomationGetTaskGroups.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [access_type, created_by, created_time, modified_by, modified_time, name] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [access_type, created_by, created_time, modified_by, modified_time, name]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1486

def i_t_automation_get_task_groups_by_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_get_task_groups_by_query ...'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling ItAutomation.i_t_automation_get_task_groups_by_query, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_get_task_groups_by_query, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_get_task_groups_by_query, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/it-automation/combined/task-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationGetTaskGroupsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_get_task_groups_by_query",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_get_task_groups_by_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_get_task_groups_with_http_info(ids, opts = {}) ⇒ Array<(ItautomationGetTaskGroupsResponse, Integer, Hash)>

Returns task groups for each provided id

Parameters:

  • ids (Array<String>) —

    Comma separated values of task group ids to fetch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1416

def i_t_automation_get_task_groups_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_get_task_groups ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling ItAutomation.i_t_automation_get_task_groups"
  end
  # resource path
  local_var_path = '/it-automation/entities/task-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationGetTaskGroupsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_get_task_groups",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_get_task_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_get_tasks(ids, opts = {}) ⇒ ItautomationGetTaskResponse

Returns tasks for each provided ID

Parameters:

  • ids (Array<String>) —

    IDs of tasks to fetch. Use ITAutomationSearchTasks to fetch IDs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1550
1551
1552
1553
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1550

def i_t_automation_get_tasks(ids, opts = {})
  data, _status_code, _headers = i_t_automation_get_tasks_with_http_info(ids, opts)
  data
end

#i_t_automation_get_tasks_by_query(opts = {}) ⇒ ItautomationGetTaskResponse

Returns full details of tasks matching the filter query parameter.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [access_type, created_by, created_time, last_run_time, modified_by, modified_time, name, runs, task_type] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [access_type, created_by, created_time, last_run_time, modified_by, modified_time, name, runs, task_type]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



1615
1616
1617
1618
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1615

def i_t_automation_get_tasks_by_query(opts = {})
  data, _status_code, _headers = i_t_automation_get_tasks_by_query_with_http_info(opts)
  data
end

#i_t_automation_get_tasks_by_query_with_http_info(opts = {}) ⇒ Array<(ItautomationGetTaskResponse, Integer, Hash)>

Returns full details of tasks matching the filter query parameter.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [access_type, created_by, created_time, last_run_time, modified_by, modified_time, name, runs, task_type] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [access_type, created_by, created_time, last_run_time, modified_by, modified_time, name, runs, task_type]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:

  • (Array<(ItautomationGetTaskResponse, Integer, Hash)>) —

    ItautomationGetTaskResponse data, response status code and response headers



1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1627

def i_t_automation_get_tasks_by_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_get_tasks_by_query ...'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling ItAutomation.i_t_automation_get_tasks_by_query, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_get_tasks_by_query, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_get_tasks_by_query, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/it-automation/combined/tasks/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationGetTaskResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_get_tasks_by_query",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_get_tasks_by_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_get_tasks_with_http_info(ids, opts = {}) ⇒ Array<(ItautomationGetTaskResponse, Integer, Hash)>

Returns tasks for each provided ID

Parameters:

  • ids (Array<String>) —

    IDs of tasks to fetch. Use ITAutomationSearchTasks to fetch IDs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ItautomationGetTaskResponse, Integer, Hash)>) —

    ItautomationGetTaskResponse data, response status code and response headers



1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1559

def i_t_automation_get_tasks_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_get_tasks ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling ItAutomation.i_t_automation_get_tasks"
  end
  # resource path
  local_var_path = '/it-automation/entities/tasks/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationGetTaskResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_get_tasks",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_get_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_get_user_group(ids, opts = {}) ⇒ ItautomationGetUserGroupsResponse

Returns user groups for each provided id

Parameters:

  • ids (Array<String>) —

    Comma separated values of user group ids to fetch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1691
1692
1693
1694
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1691

def i_t_automation_get_user_group(ids, opts = {})
  data, _status_code, _headers = i_t_automation_get_user_group_with_http_info(ids, opts)
  data
end

#i_t_automation_get_user_group_with_http_info(ids, opts = {}) ⇒ Array<(ItautomationGetUserGroupsResponse, Integer, Hash)>

Returns user groups for each provided id

Parameters:

  • ids (Array<String>) —

    Comma separated values of user group ids to fetch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1700

def i_t_automation_get_user_group_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_get_user_group ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling ItAutomation.i_t_automation_get_user_group"
  end
  # resource path
  local_var_path = '/it-automation/entities/it-user-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationGetUserGroupsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_get_user_group",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_get_user_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_query_policies(platform, opts = {}) ⇒ ItautomationQueryPolicyResponse

Returns the list of policy ids matching the filter query parameter.

Parameters:

  • platform (String) —

    The platform of policies to retrieve

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The offset to start retrieving records from. Defaults to 0 if not specified.

  • :limit (Integer) —

    The maximum number of ids to return. Defaults to 100 if not specified. The maximum number of results that can be returned in a single call is 500.

  • :sort (String) —

    Sort the returned ids based on one of the following properties: &#x60;precedence&#x60;, &#x60;created_timestamp&#x60; or &#x60;modified_timestamp&#x60; Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending); for example: &#x60;precedence|asc&#x60;.

Returns:



1756
1757
1758
1759
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1756

def i_t_automation_query_policies(platform, opts = {})
  data, _status_code, _headers = i_t_automation_query_policies_with_http_info(platform, opts)
  data
end

#i_t_automation_query_policies_with_http_info(platform, opts = {}) ⇒ Array<(ItautomationQueryPolicyResponse, Integer, Hash)>

Returns the list of policy ids matching the filter query parameter.

Parameters:

  • platform (String) —

    The platform of policies to retrieve

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The offset to start retrieving records from. Defaults to 0 if not specified.

  • :limit (Integer) —

    The maximum number of ids to return. Defaults to 100 if not specified. The maximum number of results that can be returned in a single call is 500.

  • :sort (String) —

    Sort the returned ids based on one of the following properties: &#x60;precedence&#x60;, &#x60;created_timestamp&#x60; or &#x60;modified_timestamp&#x60; Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending); for example: &#x60;precedence|asc&#x60;.

Returns:



1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1768

def i_t_automation_query_policies_with_http_info(platform, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_query_policies ...'
  end
  # verify the required parameter 'platform' is set
  if @api_client.config.client_side_validation && platform.nil?
    fail ArgumentError, "Missing the required parameter 'platform' when calling ItAutomation.i_t_automation_query_policies"
  end
  # verify enum value
  allowable_values = ["Windows", "Mac", "Linux"]
  if @api_client.config.client_side_validation && !allowable_values.include?(platform)
    fail ArgumentError, "invalid value for \"platform\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling ItAutomation.i_t_automation_query_policies, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/it-automation/queries/policies/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'platform'] = platform
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationQueryPolicyResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_query_policies",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_query_policies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_rerun_task_execution(body, opts = {}) ⇒ ItautomationRerunTaskExecutionResponse

Rerun the task execution specified in the request

Parameters:

Returns:



1833
1834
1835
1836
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1833

def i_t_automation_rerun_task_execution(body, opts = {})
  data, _status_code, _headers = i_t_automation_rerun_task_execution_with_http_info(body, opts)
  data
end

#i_t_automation_rerun_task_execution_with_http_info(body, opts = {}) ⇒ Array<(ItautomationRerunTaskExecutionResponse, Integer, Hash)>

Rerun the task execution specified in the request

Parameters:

Returns:



1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1842

def i_t_automation_rerun_task_execution_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_rerun_task_execution ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ItAutomation.i_t_automation_rerun_task_execution"
  end
  # resource path
  local_var_path = '/it-automation/entities/task-execution-rerun/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationRerunTaskExecutionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_rerun_task_execution",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_rerun_task_execution\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_run_live_query(body, opts = {}) ⇒ ItautomationStartTaskExecutionResponse

Starts a new task execution from the provided query data in the request and returns the initiated task executions

Parameters:

Returns:



1899
1900
1901
1902
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1899

def i_t_automation_run_live_query(body, opts = {})
  data, _status_code, _headers = i_t_automation_run_live_query_with_http_info(body, opts)
  data
end

#i_t_automation_run_live_query_with_http_info(body, opts = {}) ⇒ Array<(ItautomationStartTaskExecutionResponse, Integer, Hash)>

Starts a new task execution from the provided query data in the request and returns the initiated task executions

Parameters:

Returns:



1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1908

def i_t_automation_run_live_query_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_run_live_query ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ItAutomation.i_t_automation_run_live_query"
  end
  # resource path
  local_var_path = '/it-automation/entities/live-query-execution/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationStartTaskExecutionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_run_live_query",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_run_live_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_search_scheduled_tasks(opts = {}) ⇒ ItautomationSearchScheduledTaskResponse

Returns the list of scheduled task IDs matching the filter query parameter Can be used together with the entities endpoint to retrieve full information on queries

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [created_by, created_time, end_time, group_ids, group_names, is_active, last_run, modified_by, modified_time, start_time, task_id, task_name, task_type] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [created_by, created_time, end_time, group_ids, group_names, last_run, modified_by, modified_time, start_time, task_id, task_name, task_type]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



1969
1970
1971
1972
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1969

def i_t_automation_search_scheduled_tasks(opts = {})
  data, _status_code, _headers = i_t_automation_search_scheduled_tasks_with_http_info(opts)
  data
end

#i_t_automation_search_scheduled_tasks_with_http_info(opts = {}) ⇒ Array<(ItautomationSearchScheduledTaskResponse, Integer, Hash)>

Returns the list of scheduled task IDs matching the filter query parameter Can be used together with the entities endpoint to retrieve full information on queries

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [created_by, created_time, end_time, group_ids, group_names, is_active, last_run, modified_by, modified_time, start_time, task_id, task_name, task_type] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [created_by, created_time, end_time, group_ids, group_names, last_run, modified_by, modified_time, start_time, task_id, task_name, task_type]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 1982

def i_t_automation_search_scheduled_tasks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_search_scheduled_tasks ...'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling ItAutomation.i_t_automation_search_scheduled_tasks, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_search_scheduled_tasks, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_search_scheduled_tasks, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/it-automation/queries/scheduled-tasks/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationSearchScheduledTaskResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_search_scheduled_tasks",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_search_scheduled_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_search_task_executions(opts = {}) ⇒ ItautomationSearchTaskExecutionResponse

Returns the list of task execution IDs matching the filter query parameter. Can be used together with the entities endpoint to retrieve full information on executions

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [end_time, run_by, run_type, start_time, status, task_id, task_name, task_type] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [end_time, run_by, run_type, start_time, status, task_id, task_name, task_type]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



2049
2050
2051
2052
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2049

def i_t_automation_search_task_executions(opts = {})
  data, _status_code, _headers = i_t_automation_search_task_executions_with_http_info(opts)
  data
end

#i_t_automation_search_task_executions_with_http_info(opts = {}) ⇒ Array<(ItautomationSearchTaskExecutionResponse, Integer, Hash)>

Returns the list of task execution IDs matching the filter query parameter. Can be used together with the entities endpoint to retrieve full information on executions

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [end_time, run_by, run_type, start_time, status, task_id, task_name, task_type] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [end_time, run_by, run_type, start_time, status, task_id, task_name, task_type]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2061

def i_t_automation_search_task_executions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_search_task_executions ...'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling ItAutomation.i_t_automation_search_task_executions, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_search_task_executions, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_search_task_executions, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/it-automation/queries/task-executions/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationSearchTaskExecutionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_search_task_executions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_search_task_executions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_search_task_groups(opts = {}) ⇒ ItautomationSearchTaskGroupsResponse

Returns the list of task group ids matching the filter query parameter Can be used together with the entities endpoint to retrieve full information on task groups.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [access_type, created_by, created_time, modified_by, modified_time, name] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [access_type, created_by, created_time, modified_by, modified_time, name]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



2129
2130
2131
2132
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2129

def i_t_automation_search_task_groups(opts = {})
  data, _status_code, _headers = i_t_automation_search_task_groups_with_http_info(opts)
  data
end

#i_t_automation_search_task_groups_with_http_info(opts = {}) ⇒ Array<(ItautomationSearchTaskGroupsResponse, Integer, Hash)>

Returns the list of task group ids matching the filter query parameter Can be used together with the entities endpoint to retrieve full information on task groups.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [access_type, created_by, created_time, modified_by, modified_time, name] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [access_type, created_by, created_time, modified_by, modified_time, name]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2142

def i_t_automation_search_task_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_search_task_groups ...'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling ItAutomation.i_t_automation_search_task_groups, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_search_task_groups, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_search_task_groups, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/it-automation/queries/task-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationSearchTaskGroupsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_search_task_groups",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_search_task_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_search_tasks(opts = {}) ⇒ ItautomationSearchTaskResponse

Returns the list of task IDs matching the filter query parameter.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [access_type, created_by, created_time, last_run_time, modified_by, modified_time, name, runs, task_type] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [access_type, created_by, created_time, last_run_time, modified_by, modified_time, name, runs, task_type]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



2209
2210
2211
2212
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2209

def i_t_automation_search_tasks(opts = {})
  data, _status_code, _headers = i_t_automation_search_tasks_with_http_info(opts)
  data
end

#i_t_automation_search_tasks_with_http_info(opts = {}) ⇒ Array<(ItautomationSearchTaskResponse, Integer, Hash)>

Returns the list of task IDs matching the filter query parameter.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [access_type, created_by, created_time, last_run_time, modified_by, modified_time, name, runs, task_type] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [access_type, created_by, created_time, last_run_time, modified_by, modified_time, name, runs, task_type]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2221

def i_t_automation_search_tasks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_search_tasks ...'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling ItAutomation.i_t_automation_search_tasks, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_search_tasks, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_search_tasks, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/it-automation/queries/tasks/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationSearchTaskResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_search_tasks",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_search_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_search_user_group(opts = {}) ⇒ ItautomationSearchUserGroupsResponse

Returns the list of user group ids matching the filter query parameter. It can be used together with the entities endpoint to retrieve full information on user groups

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [created_by, created_time, description, modified_by, modified_time, name] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [created_by, created_time, modified_by, modified_time, name]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



2288
2289
2290
2291
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2288

def i_t_automation_search_user_group(opts = {})
  data, _status_code, _headers = i_t_automation_search_user_group_with_http_info(opts)
  data
end

#i_t_automation_search_user_group_with_http_info(opts = {}) ⇒ Array<(ItautomationSearchUserGroupsResponse, Integer, Hash)>

Returns the list of user group ids matching the filter query parameter. It can be used together with the entities endpoint to retrieve full information on user groups

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results. Allowed filter fields: [created_by, created_time, description, modified_by, modified_time, name] Example: example_string_field:&#39;example@example.com&#39;+example_date_field:&gt;&#x3D;&#39;2024-08-27T03:21:32Z&#39;

  • :sort (String) —

    The sort expression that should be used to sort the results. Allowed sort fields: [created_by, created_time, modified_by, modified_time, name]. Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). Example: example_field|asc

  • :offset (Integer) —

    Starting index for record retrieval. Example: 100 (default to 0)

  • :limit (Integer) —

    The maximum records to return. Example: 50 (default to 100)

Returns:



2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2300

def i_t_automation_search_user_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_search_user_group ...'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling ItAutomation.i_t_automation_search_user_group, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_search_user_group, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ItAutomation.i_t_automation_search_user_group, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/it-automation/queries/it-user-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationSearchUserGroupsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_search_user_group",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_search_user_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_start_execution_results_search(body, opts = {}) ⇒ ItautomationSearchStatusResponse

Starts an async task execution results search. Poll ITAutomationGetExecutionResultsSearchStatus to check if the search is complete. You must retrieve the results using ITAutomationGetExecutionResults within 30 seconds of completion, or the job will be deleted.

Parameters:

Returns:



2364
2365
2366
2367
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2364

def i_t_automation_start_execution_results_search(body, opts = {})
  data, _status_code, _headers = i_t_automation_start_execution_results_search_with_http_info(body, opts)
  data
end

#i_t_automation_start_execution_results_search_with_http_info(body, opts = {}) ⇒ Array<(ItautomationSearchStatusResponse, Integer, Hash)>

Starts an async task execution results search. Poll ITAutomationGetExecutionResultsSearchStatus to check if the search is complete. You must retrieve the results using ITAutomationGetExecutionResults within 30 seconds of completion, or the job will be deleted.

Parameters:

Returns:



2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2373

def i_t_automation_start_execution_results_search_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_start_execution_results_search ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ItAutomation.i_t_automation_start_execution_results_search"
  end
  # resource path
  local_var_path = '/it-automation/entities/task-execution-results-search/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationSearchStatusResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_start_execution_results_search",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_start_execution_results_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_start_task_execution(body, opts = {}) ⇒ ItautomationStartTaskExecutionResponse

Starts a new task execution from an existing task provided in the request and returns the initiated task executions

Parameters:

Returns:



2430
2431
2432
2433
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2430

def i_t_automation_start_task_execution(body, opts = {})
  data, _status_code, _headers = i_t_automation_start_task_execution_with_http_info(body, opts)
  data
end

#i_t_automation_start_task_execution_with_http_info(body, opts = {}) ⇒ Array<(ItautomationStartTaskExecutionResponse, Integer, Hash)>

Starts a new task execution from an existing task provided in the request and returns the initiated task executions

Parameters:

Returns:



2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2439

def i_t_automation_start_task_execution_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_start_task_execution ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ItAutomation.i_t_automation_start_task_execution"
  end
  # resource path
  local_var_path = '/it-automation/entities/task-executions/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationStartTaskExecutionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_start_task_execution",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_start_task_execution\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_update_policies(body, opts = {}) ⇒ ItautomationUpdatePolicyResponse

Updates a new policy of the specified type. Updates multiple fields for a policy.

Parameters:

  • body (ItautomationUpdatePolicyRequest) —

    Update an existing policy. * &#x60;id&#x60; is required and must be a valid policy ID representing the policy to be updated. * &#x60;name&#x60; must be between 1 and 100 characters. * &#x60;description&#x60; can be between 0 and 500 characters. * &#x60;is_enabled&#x60; controls whether the policy is active. * &#x60;config.execution.enable_script_execution&#x60; enables or disables script execution. * &#x60;config.execution.enable_python_execution&#x60; enables or disables Python execution. * &#x60;config.execution.enable_os_query&#x60; enables or disables OS Query. * &#x60;config.execution.execution_timeout&#x60; specifies the timeout value for executions. * &#x60;config.execution.execution_timeout_unit&#x60; must be one of &#x60;Hours&#x60; or &#x60;Minutes&#x60;. * &#x60;config.resources.cpu_throttle&#x60; specifies the CPU throttle value. * &#x60;config.resources.cpu_scheduling&#x60; sets priority to determine the order in which a query process will run on a host&#39;s CPU. * &#x60;config.resources.memory_pressure_level&#x60; sets memory pressure level to control system resource allocation during task execution. * &#x60;config.resources.memory_allocation&#x60; specifies the memory allocation value. * &#x60;config.resources.memory_allocation_unit&#x60; must be one of &#x60;MB&#x60; or &#x60;GB&#x60;. * &#x60;config.concurrency.concurrent_host_limit&#x60; specifies the maximum number of concurrent hosts. * &#x60;config.concurrency.concurrent_task_limit&#x60; specifies the maximum number of concurrent tasks. * &#x60;config.concurrency.concurrent_host_file_transfer_limit&#x60; specifies the maximum number of concurrent file transfers.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2497
2498
2499
2500
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2497

def i_t_automation_update_policies(body, opts = {})
  data, _status_code, _headers = i_t_automation_update_policies_with_http_info(body, opts)
  data
end

#i_t_automation_update_policies_precedence(platform, body, opts = {}) ⇒ ItautomationUpdatePoliciesPrecedenceResponse

Updates the policy precedence for all policies of a specific platform. Requests that do not represent all ids of the provided policy platform will not be processed.

Parameters:

  • platform (String) —

    The policy platform for which to set the precedence order, must be one of &#x60;Windows&#x60;, &#x60;Linux&#x60; or &#x60;Mac&#x60;.

  • body (ItautomationUpdatePoliciesPrecedenceRequest) —

    Precedence of the policies for the provided platform

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2566
2567
2568
2569
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2566

def i_t_automation_update_policies_precedence(platform, body, opts = {})
  data, _status_code, _headers = i_t_automation_update_policies_precedence_with_http_info(platform, body, opts)
  data
end

#i_t_automation_update_policies_precedence_with_http_info(platform, body, opts = {}) ⇒ Array<(ItautomationUpdatePoliciesPrecedenceResponse, Integer, Hash)>

Updates the policy precedence for all policies of a specific platform. Requests that do not represent all ids of the provided policy platform will not be processed.

Parameters:

  • platform (String) —

    The policy platform for which to set the precedence order, must be one of &#x60;Windows&#x60;, &#x60;Linux&#x60; or &#x60;Mac&#x60;.

  • body (ItautomationUpdatePoliciesPrecedenceRequest) —

    Precedence of the policies for the provided platform

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2577

def i_t_automation_update_policies_precedence_with_http_info(platform, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_update_policies_precedence ...'
  end
  # verify the required parameter 'platform' is set
  if @api_client.config.client_side_validation && platform.nil?
    fail ArgumentError, "Missing the required parameter 'platform' when calling ItAutomation.i_t_automation_update_policies_precedence"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ItAutomation.i_t_automation_update_policies_precedence"
  end
  # resource path
  local_var_path = '/it-automation/entities/policies-precedence/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'platform'] = platform

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationUpdatePoliciesPrecedenceResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_update_policies_precedence",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_update_policies_precedence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_update_policies_with_http_info(body, opts = {}) ⇒ Array<(ItautomationUpdatePolicyResponse, Integer, Hash)>

Updates a new policy of the specified type. Updates multiple fields for a policy.

Parameters:

  • body (ItautomationUpdatePolicyRequest) —

    Update an existing policy. * &#x60;id&#x60; is required and must be a valid policy ID representing the policy to be updated. * &#x60;name&#x60; must be between 1 and 100 characters. * &#x60;description&#x60; can be between 0 and 500 characters. * &#x60;is_enabled&#x60; controls whether the policy is active. * &#x60;config.execution.enable_script_execution&#x60; enables or disables script execution. * &#x60;config.execution.enable_python_execution&#x60; enables or disables Python execution. * &#x60;config.execution.enable_os_query&#x60; enables or disables OS Query. * &#x60;config.execution.execution_timeout&#x60; specifies the timeout value for executions. * &#x60;config.execution.execution_timeout_unit&#x60; must be one of &#x60;Hours&#x60; or &#x60;Minutes&#x60;. * &#x60;config.resources.cpu_throttle&#x60; specifies the CPU throttle value. * &#x60;config.resources.cpu_scheduling&#x60; sets priority to determine the order in which a query process will run on a host&#39;s CPU. * &#x60;config.resources.memory_pressure_level&#x60; sets memory pressure level to control system resource allocation during task execution. * &#x60;config.resources.memory_allocation&#x60; specifies the memory allocation value. * &#x60;config.resources.memory_allocation_unit&#x60; must be one of &#x60;MB&#x60; or &#x60;GB&#x60;. * &#x60;config.concurrency.concurrent_host_limit&#x60; specifies the maximum number of concurrent hosts. * &#x60;config.concurrency.concurrent_task_limit&#x60; specifies the maximum number of concurrent tasks. * &#x60;config.concurrency.concurrent_host_file_transfer_limit&#x60; specifies the maximum number of concurrent file transfers.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2507

def i_t_automation_update_policies_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_update_policies ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ItAutomation.i_t_automation_update_policies"
  end
  # resource path
  local_var_path = '/it-automation/entities/policies/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationUpdatePolicyResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_update_policies",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_update_policies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_update_policy_host_groups(body, opts = {}) ⇒ ItautomationUpdatePolicyResponse

Manage host groups assigned to a policy. Manage host groups assigned to a policy.

Parameters:

Returns:



2640
2641
2642
2643
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2640

def i_t_automation_update_policy_host_groups(body, opts = {})
  data, _status_code, _headers = i_t_automation_update_policy_host_groups_with_http_info(body, opts)
  data
end

#i_t_automation_update_policy_host_groups_with_http_info(body, opts = {}) ⇒ Array<(ItautomationUpdatePolicyResponse, Integer, Hash)>

Manage host groups assigned to a policy. Manage host groups assigned to a policy.

Parameters:

Returns:



2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2650

def i_t_automation_update_policy_host_groups_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_update_policy_host_groups ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ItAutomation.i_t_automation_update_policy_host_groups"
  end
  # resource path
  local_var_path = '/it-automation/entities/policies-host-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationUpdatePolicyResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_update_policy_host_groups",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_update_policy_host_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_update_scheduled_task(id, body, opts = {}) ⇒ ItautomationUpdateScheduledTasksResponse

Update an existing scheduled task with the supplied info

Parameters:

Returns:



2708
2709
2710
2711
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2708

def i_t_automation_update_scheduled_task(id, body, opts = {})
  data, _status_code, _headers = i_t_automation_update_scheduled_task_with_http_info(id, body, opts)
  data
end

#i_t_automation_update_scheduled_task_with_http_info(id, body, opts = {}) ⇒ Array<(ItautomationUpdateScheduledTasksResponse, Integer, Hash)>

Update an existing scheduled task with the supplied info

Parameters:

Returns:



2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2718

def i_t_automation_update_scheduled_task_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_update_scheduled_task ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ItAutomation.i_t_automation_update_scheduled_task"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ItAutomation.i_t_automation_update_scheduled_task"
  end
  # resource path
  local_var_path = '/it-automation/entities/scheduled-tasks/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationUpdateScheduledTasksResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_update_scheduled_task",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_update_scheduled_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_update_task(id, body, opts = {}) ⇒ ItautomationUpdateTaskResponse

Update a task with details from the given request.

Parameters:

  • id (String) —

    ID of the task to update. Use ITAutomationSearchTasks to fetch IDs

  • body (ItautomationUpdateTaskRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2781
2782
2783
2784
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2781

def i_t_automation_update_task(id, body, opts = {})
  data, _status_code, _headers = i_t_automation_update_task_with_http_info(id, body, opts)
  data
end

#i_t_automation_update_task_group(id, body, opts = {}) ⇒ ItautomationUpdateTaskGroupResponse

Update a task group for a given id

Parameters:

Returns:



2854
2855
2856
2857
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2854

def i_t_automation_update_task_group(id, body, opts = {})
  data, _status_code, _headers = i_t_automation_update_task_group_with_http_info(id, body, opts)
  data
end

#i_t_automation_update_task_group_with_http_info(id, body, opts = {}) ⇒ Array<(ItautomationUpdateTaskGroupResponse, Integer, Hash)>

Update a task group for a given id

Parameters:

Returns:



2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2864

def i_t_automation_update_task_group_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_update_task_group ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ItAutomation.i_t_automation_update_task_group"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ItAutomation.i_t_automation_update_task_group"
  end
  # resource path
  local_var_path = '/it-automation/entities/task-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationUpdateTaskGroupResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_update_task_group",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_update_task_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_update_task_with_http_info(id, body, opts = {}) ⇒ Array<(ItautomationUpdateTaskResponse, Integer, Hash)>

Update a task with details from the given request.

Parameters:

  • id (String) —

    ID of the task to update. Use ITAutomationSearchTasks to fetch IDs

  • body (ItautomationUpdateTaskRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2791

def i_t_automation_update_task_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_update_task ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ItAutomation.i_t_automation_update_task"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ItAutomation.i_t_automation_update_task"
  end
  # resource path
  local_var_path = '/it-automation/entities/tasks/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationUpdateTaskResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_update_task",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_update_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_t_automation_update_user_group(id, body, opts = {}) ⇒ ItautomationUpdateUserGroupResponse

Update a user group for a given id

Parameters:

Returns:



2927
2928
2929
2930
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2927

def i_t_automation_update_user_group(id, body, opts = {})
  data, _status_code, _headers = i_t_automation_update_user_group_with_http_info(id, body, opts)
  data
end

#i_t_automation_update_user_group_with_http_info(id, body, opts = {}) ⇒ Array<(ItautomationUpdateUserGroupResponse, Integer, Hash)>

Update a user group for a given id

Parameters:

Returns:



2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
 
# File 'lib/crimson-falcon/api/it_automation.rb', line 2937

def i_t_automation_update_user_group_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItAutomation.i_t_automation_update_user_group ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ItAutomation.i_t_automation_update_user_group"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ItAutomation.i_t_automation_update_user_group"
  end
  # resource path
  local_var_path = '/it-automation/entities/it-user-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ItautomationUpdateUserGroupResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ItAutomation.i_t_automation_update_user_group",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItAutomation#i_t_automation_update_user_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end