Class: Falcon::SensorUpdatePolicies

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SensorUpdatePolicies

Returns a new instance of SensorUpdatePolicies.



36
37
38
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 36

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#create_sensor_update_policies(body, opts = {}) ⇒ SensorUpdateRespV1

Create Sensor Update Policies by specifying details about the policy to create

Parameters:

Returns:



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

def create_sensor_update_policies(body, opts = {})
  data, _status_code, _headers = create_sensor_update_policies_with_http_info(body, opts)
  data
end

#create_sensor_update_policies_v2(body, opts = {}) ⇒ SensorUpdateRespV2

Create Sensor Update Policies by specifying details about the policy to create with additional support for uninstall protection

Parameters:

Returns:



109
110
111
112
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 109

def create_sensor_update_policies_v2(body, opts = {})
  data, _status_code, _headers = create_sensor_update_policies_v2_with_http_info(body, opts)
  data
end

#create_sensor_update_policies_v2_with_http_info(body, opts = {}) ⇒ Array<(SensorUpdateRespV2, Integer, Hash)>

Create Sensor Update Policies by specifying details about the policy to create with additional support for uninstall protection

Parameters:

Returns:

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

    SensorUpdateRespV2 data, response status code and response headers



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 118

def create_sensor_update_policies_v2_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorUpdatePolicies.create_sensor_update_policies_v2 ...'
  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 SensorUpdatePolicies.create_sensor_update_policies_v2"
  end
  # resource path
  local_var_path = '/policy/entities/sensor-update/v2'

  # 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] || 'SensorUpdateRespV2'

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

  new_options = opts.merge(
    :operation => :"SensorUpdatePolicies.create_sensor_update_policies_v2",
    :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: SensorUpdatePolicies#create_sensor_update_policies_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_sensor_update_policies_with_http_info(body, opts = {}) ⇒ Array<(SensorUpdateRespV1, Integer, Hash)>

Create Sensor Update Policies by specifying details about the policy to create

Parameters:

Returns:

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

    SensorUpdateRespV1 data, response status code and response headers



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 52

def create_sensor_update_policies_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorUpdatePolicies.create_sensor_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 SensorUpdatePolicies.create_sensor_update_policies"
  end
  # resource path
  local_var_path = '/policy/entities/sensor-update/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] || 'SensorUpdateRespV1'

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

  new_options = opts.merge(
    :operation => :"SensorUpdatePolicies.create_sensor_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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SensorUpdatePolicies#create_sensor_update_policies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_sensor_update_policies(ids, opts = {}) ⇒ MsaQueryResponse

Delete a set of Sensor Update Policies by specifying their IDs

Parameters:

  • ids (Array<String>) —

    The IDs of the Sensor Update Policies to delete

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

    the optional parameters

Returns:



175
176
177
178
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 175

def delete_sensor_update_policies(ids, opts = {})
  data, _status_code, _headers = delete_sensor_update_policies_with_http_info(ids, opts)
  data
end

#delete_sensor_update_policies_with_http_info(ids, opts = {}) ⇒ Array<(MsaQueryResponse, Integer, Hash)>

Delete a set of Sensor Update Policies by specifying their IDs

Parameters:

  • ids (Array<String>) —

    The IDs of the Sensor Update Policies to delete

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

    the optional parameters

Returns:

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

    MsaQueryResponse data, response status code and response headers



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 184

def delete_sensor_update_policies_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorUpdatePolicies.delete_sensor_update_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 SensorUpdatePolicies.delete_sensor_update_policies"
  end
  # resource path
  local_var_path = '/policy/entities/sensor-update/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] || 'MsaQueryResponse'

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

  new_options = opts.merge(
    :operation => :"SensorUpdatePolicies.delete_sensor_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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SensorUpdatePolicies#delete_sensor_update_policies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sensor_update_policies(ids, opts = {}) ⇒ SensorUpdateRespV1

Retrieve a set of Sensor Update Policies by specifying their IDs

Parameters:

  • ids (Array<String>) —

    The IDs of the Sensor Update Policies to return

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

    the optional parameters

Returns:



237
238
239
240
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 237

def get_sensor_update_policies(ids, opts = {})
  data, _status_code, _headers = get_sensor_update_policies_with_http_info(ids, opts)
  data
end

#get_sensor_update_policies_v2(ids, opts = {}) ⇒ SensorUpdateRespV2

Retrieve a set of Sensor Update Policies with additional support for uninstall protection by specifying their IDs

Parameters:

  • ids (Array<String>) —

    The IDs of the Sensor Update Policies to return

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

    the optional parameters

Returns:



299
300
301
302
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 299

def get_sensor_update_policies_v2(ids, opts = {})
  data, _status_code, _headers = get_sensor_update_policies_v2_with_http_info(ids, opts)
  data
end

#get_sensor_update_policies_v2_with_http_info(ids, opts = {}) ⇒ Array<(SensorUpdateRespV2, Integer, Hash)>

Retrieve a set of Sensor Update Policies with additional support for uninstall protection by specifying their IDs

Parameters:

  • ids (Array<String>) —

    The IDs of the Sensor Update Policies to return

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

    the optional parameters

Returns:

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

    SensorUpdateRespV2 data, response status code and response headers



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
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
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 308

def get_sensor_update_policies_v2_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorUpdatePolicies.get_sensor_update_policies_v2 ...'
  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 SensorUpdatePolicies.get_sensor_update_policies_v2"
  end
  # resource path
  local_var_path = '/policy/entities/sensor-update/v2'

  # 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] || 'SensorUpdateRespV2'

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

  new_options = opts.merge(
    :operation => :"SensorUpdatePolicies.get_sensor_update_policies_v2",
    :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: SensorUpdatePolicies#get_sensor_update_policies_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sensor_update_policies_with_http_info(ids, opts = {}) ⇒ Array<(SensorUpdateRespV1, Integer, Hash)>

Retrieve a set of Sensor Update Policies by specifying their IDs

Parameters:

  • ids (Array<String>) —

    The IDs of the Sensor Update Policies to return

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

    the optional parameters

Returns:

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

    SensorUpdateRespV1 data, response status code and response headers



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 246

def get_sensor_update_policies_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorUpdatePolicies.get_sensor_update_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 SensorUpdatePolicies.get_sensor_update_policies"
  end
  # resource path
  local_var_path = '/policy/entities/sensor-update/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] || 'SensorUpdateRespV1'

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

  new_options = opts.merge(
    :operation => :"SensorUpdatePolicies.get_sensor_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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SensorUpdatePolicies#get_sensor_update_policies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#perform_sensor_update_policies_action(action_name, body, opts = {}) ⇒ SensorUpdateRespV1

Perform the specified action on the Sensor Update Policies specified in the request

Parameters:

  • action_name (String) —

    The action to perform

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

    the optional parameters

Returns:



362
363
364
365
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 362

def perform_sensor_update_policies_action(action_name, body, opts = {})
  data, _status_code, _headers = perform_sensor_update_policies_action_with_http_info(action_name, body, opts)
  data
end

#perform_sensor_update_policies_action_with_http_info(action_name, body, opts = {}) ⇒ Array<(SensorUpdateRespV1, Integer, Hash)>

Perform the specified action on the Sensor Update Policies specified in the request

Parameters:

  • action_name (String) —

    The action to perform

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

    the optional parameters

Returns:

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

    SensorUpdateRespV1 data, response status code and response headers



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
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
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 372

def perform_sensor_update_policies_action_with_http_info(action_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorUpdatePolicies.perform_sensor_update_policies_action ...'
  end
  # verify the required parameter 'action_name' is set
  if @api_client.config.client_side_validation && action_name.nil?
    fail ArgumentError, "Missing the required parameter 'action_name' when calling SensorUpdatePolicies.perform_sensor_update_policies_action"
  end
  # verify enum value
  allowable_values = ["add-host-group", "add-rule-group", "disable", "enable", "remove-host-group", "remove-rule-group"]
  if @api_client.config.client_side_validation && !allowable_values.include?(action_name)
    fail ArgumentError, "invalid value for \"action_name\", must be one of #{allowable_values}"
  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 SensorUpdatePolicies.perform_sensor_update_policies_action"
  end
  # resource path
  local_var_path = '/policy/entities/sensor-update-actions/v1'

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

  # 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] || 'SensorUpdateRespV1'

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

  new_options = opts.merge(
    :operation => :"SensorUpdatePolicies.perform_sensor_update_policies_action",
    :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: SensorUpdatePolicies#perform_sensor_update_policies_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_combined_sensor_update_builds(opts = {}) ⇒ SensorUpdateBuildsRespV1

Retrieve available builds for use with Sensor Update Policies

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :platform (String) —

    The platform to return builds for

  • :stage (Array<String>) —

    The stages to return builds for

Returns:



440
441
442
443
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 440

def query_combined_sensor_update_builds(opts = {})
  data, _status_code, _headers = query_combined_sensor_update_builds_with_http_info(opts)
  data
end

#query_combined_sensor_update_builds_with_http_info(opts = {}) ⇒ Array<(SensorUpdateBuildsRespV1, Integer, Hash)>

Retrieve available builds for use with Sensor Update Policies

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :platform (String) —

    The platform to return builds for

  • :stage (Array<String>) —

    The stages to return builds for

Returns:

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

    SensorUpdateBuildsRespV1 data, response status code and response headers



450
451
452
453
454
455
456
457
458
459
460
461
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
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 450

def query_combined_sensor_update_builds_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorUpdatePolicies.query_combined_sensor_update_builds ...'
  end
  allowable_values = ["linux", "linuxarm64", "mac", "windows", "zlinux"]
  if @api_client.config.client_side_validation && opts[:'platform'] && !allowable_values.include?(opts[:'platform'])
    fail ArgumentError, "invalid value for \"platform\", must be one of #{allowable_values}"
  end
  allowable_values = []
  if @api_client.config.client_side_validation && opts[:'stage'] && !opts[:'stage'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"stage\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/policy/combined/sensor-update-builds/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
  query_params[:'stage'] = @api_client.build_collection_param(opts[:'stage'], :csv) if !opts[:'stage'].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] || 'SensorUpdateBuildsRespV1'

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

  new_options = opts.merge(
    :operation => :"SensorUpdatePolicies.query_combined_sensor_update_builds",
    :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: SensorUpdatePolicies#query_combined_sensor_update_builds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_combined_sensor_update_kernels(opts = {}) ⇒ SensorUpdateKernelsRespV1

Retrieve kernel compatibility info for Sensor Update Builds

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results

  • :offset (Integer) —

    The offset to start retrieving records from

  • :limit (Integer) —

    The maximum records to return. [1-500]

Returns:



510
511
512
513
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 510

def query_combined_sensor_update_kernels(opts = {})
  data, _status_code, _headers = query_combined_sensor_update_kernels_with_http_info(opts)
  data
end

#query_combined_sensor_update_kernels_with_http_info(opts = {}) ⇒ Array<(SensorUpdateKernelsRespV1, Integer, Hash)>

Retrieve kernel compatibility info for Sensor Update Builds

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results

  • :offset (Integer) —

    The offset to start retrieving records from

  • :limit (Integer) —

    The maximum records to return. [1-500]

Returns:

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

    SensorUpdateKernelsRespV1 data, response status code and response headers



521
522
523
524
525
526
527
528
529
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
578
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 521

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

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

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

  # resource path
  local_var_path = '/policy/combined/sensor-update-kernels/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].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] || 'SensorUpdateKernelsRespV1'

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

  new_options = opts.merge(
    :operation => :"SensorUpdatePolicies.query_combined_sensor_update_kernels",
    :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: SensorUpdatePolicies#query_combined_sensor_update_kernels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_combined_sensor_update_policies(opts = {}) ⇒ SensorUpdateRespV1

Search for Sensor Update Policies in your environment by providing an FQL filter and paging details. Returns a set of Sensor Update Policies which match the filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results

  • :offset (Integer) —

    The offset to start retrieving records from

  • :limit (Integer) —

    The maximum records to return. [1-5000]

  • :sort (String) —

    The property to sort by

Returns:



587
588
589
590
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 587

def query_combined_sensor_update_policies(opts = {})
  data, _status_code, _headers = query_combined_sensor_update_policies_with_http_info(opts)
  data
end

#query_combined_sensor_update_policies_v2(opts = {}) ⇒ SensorUpdateRespV2

Search for Sensor Update Policies with additional support for uninstall protection in your environment by providing an FQL filter and paging details. Returns a set of Sensor Update Policies which match the filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results

  • :offset (Integer) —

    The offset to start retrieving records from

  • :limit (Integer) —

    The maximum records to return. [1-5000]

  • :sort (String) —

    The property to sort by

Returns:



670
671
672
673
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 670

def query_combined_sensor_update_policies_v2(opts = {})
  data, _status_code, _headers = query_combined_sensor_update_policies_v2_with_http_info(opts)
  data
end

#query_combined_sensor_update_policies_v2_with_http_info(opts = {}) ⇒ Array<(SensorUpdateRespV2, Integer, Hash)>

Search for Sensor Update Policies with additional support for uninstall protection in your environment by providing an FQL filter and paging details. Returns a set of Sensor Update Policies which match the filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results

  • :offset (Integer) —

    The offset to start retrieving records from

  • :limit (Integer) —

    The maximum records to return. [1-5000]

  • :sort (String) —

    The property to sort by

Returns:

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

    SensorUpdateRespV2 data, response status code and response headers



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
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
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 682

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

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

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

  allowable_values = ["created_by.asc", "created_by.desc", "created_timestamp.asc", "created_timestamp.desc", "enabled.asc", "enabled.desc", "modified_by.asc", "modified_by.desc", "modified_timestamp.asc", "modified_timestamp.desc", "name.asc", "name.desc", "platform_name.asc", "platform_name.desc", "precedence.asc", "precedence.desc"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/policy/combined/sensor-update/v2'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  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] || 'SensorUpdateRespV2'

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

  new_options = opts.merge(
    :operation => :"SensorUpdatePolicies.query_combined_sensor_update_policies_v2",
    :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: SensorUpdatePolicies#query_combined_sensor_update_policies_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_combined_sensor_update_policies_with_http_info(opts = {}) ⇒ Array<(SensorUpdateRespV1, Integer, Hash)>

Search for Sensor Update Policies in your environment by providing an FQL filter and paging details. Returns a set of Sensor Update Policies which match the filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results

  • :offset (Integer) —

    The offset to start retrieving records from

  • :limit (Integer) —

    The maximum records to return. [1-5000]

  • :sort (String) —

    The property to sort by

Returns:

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

    SensorUpdateRespV1 data, response status code and response headers



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
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 599

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

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

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

  allowable_values = ["created_by.asc", "created_by.desc", "created_timestamp.asc", "created_timestamp.desc", "enabled.asc", "enabled.desc", "modified_by.asc", "modified_by.desc", "modified_timestamp.asc", "modified_timestamp.desc", "name.asc", "name.desc", "platform_name.asc", "platform_name.desc", "precedence.asc", "precedence.desc"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/policy/combined/sensor-update/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  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] || 'SensorUpdateRespV1'

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

  new_options = opts.merge(
    :operation => :"SensorUpdatePolicies.query_combined_sensor_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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SensorUpdatePolicies#query_combined_sensor_update_policies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_combined_sensor_update_policy_members(opts = {}) ⇒ BasePolicyMembersRespV1

Search for members of a Sensor Update Policy in your environment by providing an FQL filter and paging details. Returns a set of host details which match the filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    The ID of the Sensor Update Policy to search for members of

  • :filter (String) —

    The filter expression that should be used to limit the results

  • :offset (Integer) —

    The offset to start retrieving records from

  • :limit (Integer) —

    The maximum records to return. [1-5000]

  • :sort (String) —

    The property to sort by

Returns:



754
755
756
757
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 754

def query_combined_sensor_update_policy_members(opts = {})
  data, _status_code, _headers = query_combined_sensor_update_policy_members_with_http_info(opts)
  data
end

#query_combined_sensor_update_policy_members_with_http_info(opts = {}) ⇒ Array<(BasePolicyMembersRespV1, Integer, Hash)>

Search for members of a Sensor Update Policy in your environment by providing an FQL filter and paging details. Returns a set of host details which match the filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    The ID of the Sensor Update Policy to search for members of

  • :filter (String) —

    The filter expression that should be used to limit the results

  • :offset (Integer) —

    The offset to start retrieving records from

  • :limit (Integer) —

    The maximum records to return. [1-5000]

  • :sort (String) —

    The property to sort by

Returns:

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

    BasePolicyMembersRespV1 data, response status code and response headers



767
768
769
770
771
772
773
774
775
776
777
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
826
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 767

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

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

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

  # resource path
  local_var_path = '/policy/combined/sensor-update-members/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  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] || 'BasePolicyMembersRespV1'

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

  new_options = opts.merge(
    :operation => :"SensorUpdatePolicies.query_combined_sensor_update_policy_members",
    :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: SensorUpdatePolicies#query_combined_sensor_update_policy_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_sensor_update_kernels_distinct(distinct_field, opts = {}) ⇒ MsaQueryResponse

Retrieve kernel compatibility info for Sensor Update Builds

Parameters:

  • distinct_field (String) —

    The field name to get distinct values for

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results

  • :offset (Integer) —

    The offset to start retrieving records from

  • :limit (Integer) —

    The maximum records to return. [1-500]

Returns:



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

def query_sensor_update_kernels_distinct(distinct_field, opts = {})
  data, _status_code, _headers = query_sensor_update_kernels_distinct_with_http_info(distinct_field, opts)
  data
end

#query_sensor_update_kernels_distinct_with_http_info(distinct_field, opts = {}) ⇒ Array<(MsaQueryResponse, Integer, Hash)>

Retrieve kernel compatibility info for Sensor Update Builds

Parameters:

  • distinct_field (String) —

    The field name to get distinct values for

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results

  • :offset (Integer) —

    The offset to start retrieving records from

  • :limit (Integer) —

    The maximum records to return. [1-500]

Returns:

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

    MsaQueryResponse data, response status code and response headers



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

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

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

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

  # resource path
  local_var_path = '/policy/queries/sensor-update-kernels/{distinct_field}/v1'.sub('{' + 'distinct_field' + '}', CGI.escape(distinct_field.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].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] || 'MsaQueryResponse'

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

  new_options = opts.merge(
    :operation => :"SensorUpdatePolicies.query_sensor_update_kernels_distinct",
    :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: SensorUpdatePolicies#query_sensor_update_kernels_distinct\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_sensor_update_policies(opts = {}) ⇒ MsaQueryResponse

Search for Sensor Update Policies in your environment by providing an FQL filter and paging details. Returns a set of Sensor Update Policy IDs which match the filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results

  • :offset (Integer) —

    The offset to start retrieving records from

  • :limit (Integer) —

    The maximum records to return. [1-5000]

  • :sort (String) —

    The property to sort by

Returns:



917
918
919
920
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 917

def query_sensor_update_policies(opts = {})
  data, _status_code, _headers = query_sensor_update_policies_with_http_info(opts)
  data
end

#query_sensor_update_policies_with_http_info(opts = {}) ⇒ Array<(MsaQueryResponse, Integer, Hash)>

Search for Sensor Update Policies in your environment by providing an FQL filter and paging details. Returns a set of Sensor Update Policy IDs which match the filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results

  • :offset (Integer) —

    The offset to start retrieving records from

  • :limit (Integer) —

    The maximum records to return. [1-5000]

  • :sort (String) —

    The property to sort by

Returns:

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

    MsaQueryResponse data, response status code and response headers



929
930
931
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
987
988
989
990
991
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 929

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

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

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

  allowable_values = ["created_by.asc", "created_by.desc", "created_timestamp.asc", "created_timestamp.desc", "enabled.asc", "enabled.desc", "modified_by.asc", "modified_by.desc", "modified_timestamp.asc", "modified_timestamp.desc", "name.asc", "name.desc", "platform_name.asc", "platform_name.desc", "precedence.asc", "precedence.desc"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/policy/queries/sensor-update/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  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] || 'MsaQueryResponse'

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

  new_options = opts.merge(
    :operation => :"SensorUpdatePolicies.query_sensor_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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SensorUpdatePolicies#query_sensor_update_policies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_sensor_update_policy_members(opts = {}) ⇒ MsaQueryResponse

Search for members of a Sensor Update Policy in your environment by providing an FQL filter and paging details. Returns a set of Agent IDs which match the filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    The ID of the Sensor Update Policy to search for members of

  • :filter (String) —

    The filter expression that should be used to limit the results

  • :offset (Integer) —

    The offset to start retrieving records from

  • :limit (Integer) —

    The maximum records to return. [1-5000]

  • :sort (String) —

    The property to sort by

Returns:



1001
1002
1003
1004
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 1001

def query_sensor_update_policy_members(opts = {})
  data, _status_code, _headers = query_sensor_update_policy_members_with_http_info(opts)
  data
end

#query_sensor_update_policy_members_with_http_info(opts = {}) ⇒ Array<(MsaQueryResponse, Integer, Hash)>

Search for members of a Sensor Update Policy in your environment by providing an FQL filter and paging details. Returns a set of Agent IDs which match the filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    The ID of the Sensor Update Policy to search for members of

  • :filter (String) —

    The filter expression that should be used to limit the results

  • :offset (Integer) —

    The offset to start retrieving records from

  • :limit (Integer) —

    The maximum records to return. [1-5000]

  • :sort (String) —

    The property to sort by

Returns:

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

    MsaQueryResponse data, response status code and response headers



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
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 1014

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

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

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

  # resource path
  local_var_path = '/policy/queries/sensor-update-members/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  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] || 'MsaQueryResponse'

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

  new_options = opts.merge(
    :operation => :"SensorUpdatePolicies.query_sensor_update_policy_members",
    :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: SensorUpdatePolicies#query_sensor_update_policy_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reveal_uninstall_token(body, opts = {}) ⇒ UninstallTokenRespV1

Reveals an uninstall token for a specific device. To retrieve the bulk maintenance token pass the value ‘MAINTENANCE’ as the value for ‘device_id’

Parameters:

Returns:



1079
1080
1081
1082
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 1079

def reveal_uninstall_token(body, opts = {})
  data, _status_code, _headers = reveal_uninstall_token_with_http_info(body, opts)
  data
end

#reveal_uninstall_token_with_http_info(body, opts = {}) ⇒ Array<(UninstallTokenRespV1, Integer, Hash)>

Reveals an uninstall token for a specific device. To retrieve the bulk maintenance token pass the value &#39;MAINTENANCE&#39; as the value for &#39;device_id&#39;

Parameters:

Returns:

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

    UninstallTokenRespV1 data, response status code and response headers



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
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 1088

def reveal_uninstall_token_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorUpdatePolicies.reveal_uninstall_token ...'
  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 SensorUpdatePolicies.reveal_uninstall_token"
  end
  # resource path
  local_var_path = '/policy/combined/reveal-uninstall-token/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] || 'UninstallTokenRespV1'

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

  new_options = opts.merge(
    :operation => :"SensorUpdatePolicies.reveal_uninstall_token",
    :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: SensorUpdatePolicies#reveal_uninstall_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_sensor_update_policies_precedence(body, opts = {}) ⇒ MsaQueryResponse

Sets the precedence of Sensor Update Policies based on the order of IDs specified in the request. The first ID specified will have the highest precedence and the last ID specified will have the lowest. You must specify all non-Default Policies for a platform when updating precedence

Parameters:

Returns:



1145
1146
1147
1148
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 1145

def set_sensor_update_policies_precedence(body, opts = {})
  data, _status_code, _headers = set_sensor_update_policies_precedence_with_http_info(body, opts)
  data
end

#set_sensor_update_policies_precedence_with_http_info(body, opts = {}) ⇒ Array<(MsaQueryResponse, Integer, Hash)>

Sets the precedence of Sensor Update Policies based on the order of IDs specified in the request. The first ID specified will have the highest precedence and the last ID specified will have the lowest. You must specify all non-Default Policies for a platform when updating precedence

Parameters:

Returns:

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

    MsaQueryResponse data, response status code and response headers



1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 1154

def set_sensor_update_policies_precedence_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorUpdatePolicies.set_sensor_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 SensorUpdatePolicies.set_sensor_update_policies_precedence"
  end
  # resource path
  local_var_path = '/policy/entities/sensor-update-precedence/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] || 'MsaQueryResponse'

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

  new_options = opts.merge(
    :operation => :"SensorUpdatePolicies.set_sensor_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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SensorUpdatePolicies#set_sensor_update_policies_precedence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_sensor_update_policies(body, opts = {}) ⇒ SensorUpdateRespV1

Update Sensor Update Policies by specifying the ID of the policy and details to update

Parameters:

Returns:



1211
1212
1213
1214
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 1211

def update_sensor_update_policies(body, opts = {})
  data, _status_code, _headers = update_sensor_update_policies_with_http_info(body, opts)
  data
end

#update_sensor_update_policies_v2(body, opts = {}) ⇒ SensorUpdateRespV2

Update Sensor Update Policies by specifying the ID of the policy and details to update with additional support for uninstall protection

Parameters:

Returns:



1277
1278
1279
1280
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 1277

def update_sensor_update_policies_v2(body, opts = {})
  data, _status_code, _headers = update_sensor_update_policies_v2_with_http_info(body, opts)
  data
end

#update_sensor_update_policies_v2_with_http_info(body, opts = {}) ⇒ Array<(SensorUpdateRespV2, Integer, Hash)>

Update Sensor Update Policies by specifying the ID of the policy and details to update with additional support for uninstall protection

Parameters:

Returns:

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

    SensorUpdateRespV2 data, response status code and response headers



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
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 1286

def update_sensor_update_policies_v2_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorUpdatePolicies.update_sensor_update_policies_v2 ...'
  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 SensorUpdatePolicies.update_sensor_update_policies_v2"
  end
  # resource path
  local_var_path = '/policy/entities/sensor-update/v2'

  # 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] || 'SensorUpdateRespV2'

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

  new_options = opts.merge(
    :operation => :"SensorUpdatePolicies.update_sensor_update_policies_v2",
    :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: SensorUpdatePolicies#update_sensor_update_policies_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_sensor_update_policies_with_http_info(body, opts = {}) ⇒ Array<(SensorUpdateRespV1, Integer, Hash)>

Update Sensor Update Policies by specifying the ID of the policy and details to update

Parameters:

Returns:

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

    SensorUpdateRespV1 data, response status code and response headers



1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
 
# File 'lib/crimson-falcon/api/sensor_update_policies.rb', line 1220

def update_sensor_update_policies_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorUpdatePolicies.update_sensor_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 SensorUpdatePolicies.update_sensor_update_policies"
  end
  # resource path
  local_var_path = '/policy/entities/sensor-update/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] || 'SensorUpdateRespV1'

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

  new_options = opts.merge(
    :operation => :"SensorUpdatePolicies.update_sensor_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: SensorUpdatePolicies#update_sensor_update_policies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end