Class: Falcon::DeviceControlPolicies

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DeviceControlPolicies

Returns a new instance of DeviceControlPolicies.



36
37
38
 
# File 'lib/crimson-falcon/api/device_control_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/device_control_policies.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#create_device_control_policies(body, opts = {}) ⇒ DeviceControlRespV2

Create Device Control Policies by specifying details about the policy to create

Parameters:

Returns:



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

def create_device_control_policies(body, opts = {})
  data, _status_code, _headers = create_device_control_policies_with_http_info(body, opts)
  data
end

#create_device_control_policies_with_http_info(body, opts = {}) ⇒ Array<(DeviceControlRespV2, Integer, Hash)>

Create Device Control Policies by specifying details about the policy to create

Parameters:

Returns:

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

    DeviceControlRespV2 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/device_control_policies.rb', line 52

def create_device_control_policies_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeviceControlPolicies.create_device_control_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 DeviceControlPolicies.create_device_control_policies"
  end
  # resource path
  local_var_path = '/policy/entities/device-control/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] || 'DeviceControlRespV2'

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

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

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

Delete a set of Device Control Policies by specifying their IDs

Parameters:

  • ids (Array<String>) —

    The IDs of the Device Control Policies to delete

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

    the optional parameters

Returns:



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

def delete_device_control_policies(ids, opts = {})
  data, _status_code, _headers = delete_device_control_policies_with_http_info(ids, opts)
  data
end

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

Delete a set of Device Control Policies by specifying their IDs

Parameters:

  • ids (Array<String>) —

    The IDs of the Device Control Policies to delete

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

    the optional parameters

Returns:

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

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

def delete_device_control_policies_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeviceControlPolicies.delete_device_control_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 DeviceControlPolicies.delete_device_control_policies"
  end
  # resource path
  local_var_path = '/policy/entities/device-control/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 => :"DeviceControlPolicies.delete_device_control_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: DeviceControlPolicies#delete_device_control_policies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_default_device_control_policies(opts = {}) ⇒ DeviceControlRespV1

Retrieve the configuration for a Default Device Control Policy

Parameters:

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

    the optional parameters

Returns:



170
171
172
173
 
# File 'lib/crimson-falcon/api/device_control_policies.rb', line 170

def get_default_device_control_policies(opts = {})
  data, _status_code, _headers = get_default_device_control_policies_with_http_info(opts)
  data
end

#get_default_device_control_policies_with_http_info(opts = {}) ⇒ Array<(DeviceControlRespV1, Integer, Hash)>

Retrieve the configuration for a Default Device Control Policy

Parameters:

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

    the optional parameters

Returns:

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

    DeviceControlRespV1 data, response status code and response headers



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/crimson-falcon/api/device_control_policies.rb', line 178

def get_default_device_control_policies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeviceControlPolicies.get_default_device_control_policies ...'
  end
  # resource path
  local_var_path = '/policy/entities/default-device-control/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'])

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

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

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

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

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

#get_device_control_policies(ids, opts = {}) ⇒ DeviceControlRespV1

Retrieve a set of Device Control Policies by specifying their IDs

Parameters:

  • ids (Array<String>) —

    The IDs of the Device Control Policies to return

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

    the optional parameters

Returns:



226
227
228
229
 
# File 'lib/crimson-falcon/api/device_control_policies.rb', line 226

def get_device_control_policies(ids, opts = {})
  data, _status_code, _headers = get_device_control_policies_with_http_info(ids, opts)
  data
end

#get_device_control_policies_with_http_info(ids, opts = {}) ⇒ Array<(DeviceControlRespV1, Integer, Hash)>

Retrieve a set of Device Control Policies by specifying their IDs

Parameters:

  • ids (Array<String>) —

    The IDs of the Device Control Policies to return

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

    the optional parameters

Returns:

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

    DeviceControlRespV1 data, response status code and response headers



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/crimson-falcon/api/device_control_policies.rb', line 235

def get_device_control_policies_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeviceControlPolicies.get_device_control_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 DeviceControlPolicies.get_device_control_policies"
  end
  # resource path
  local_var_path = '/policy/entities/device-control/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] || 'DeviceControlRespV1'

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

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

#perform_device_control_policies_action(action_name, body, opts = {}) ⇒ DeviceControlRespV1

Perform the specified action on the Device Control Policies specified in the request

Parameters:

  • action_name (String) —

    The action to perform

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

    the optional parameters

Returns:



289
290
291
292
 
# File 'lib/crimson-falcon/api/device_control_policies.rb', line 289

def perform_device_control_policies_action(action_name, body, opts = {})
  data, _status_code, _headers = perform_device_control_policies_action_with_http_info(action_name, body, opts)
  data
end

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

Perform the specified action on the Device Control Policies specified in the request

Parameters:

  • action_name (String) —

    The action to perform

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

    the optional parameters

Returns:

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

    DeviceControlRespV1 data, response status code and response headers



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
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
356
357
358
359
360
 
# File 'lib/crimson-falcon/api/device_control_policies.rb', line 299

def perform_device_control_policies_action_with_http_info(action_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeviceControlPolicies.perform_device_control_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 DeviceControlPolicies.perform_device_control_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 DeviceControlPolicies.perform_device_control_policies_action"
  end
  # resource path
  local_var_path = '/policy/entities/device-control-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] || 'DeviceControlRespV1'

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

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

#query_combined_device_control_policies(opts = {}) ⇒ DeviceControlRespV1

Search for Device Control Policies in your environment by providing an FQL filter and paging details. Returns a set of Device Control 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:



369
370
371
372
 
# File 'lib/crimson-falcon/api/device_control_policies.rb', line 369

def query_combined_device_control_policies(opts = {})
  data, _status_code, _headers = query_combined_device_control_policies_with_http_info(opts)
  data
end

#query_combined_device_control_policies_with_http_info(opts = {}) ⇒ Array<(DeviceControlRespV1, Integer, Hash)>

Search for Device Control Policies in your environment by providing an FQL filter and paging details. Returns a set of Device Control 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<(DeviceControlRespV1, Integer, Hash)>) —

    DeviceControlRespV1 data, response status code and response headers



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
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/crimson-falcon/api/device_control_policies.rb', line 381

def query_combined_device_control_policies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeviceControlPolicies.query_combined_device_control_policies ...'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling DeviceControlPolicies.query_combined_device_control_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 DeviceControlPolicies.query_combined_device_control_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 DeviceControlPolicies.query_combined_device_control_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/device-control/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] || 'DeviceControlRespV1'

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

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

#query_combined_device_control_policy_members(opts = {}) ⇒ BasePolicyMembersRespV1

Search for members of a Device Control 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 Device Control 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:



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

def query_combined_device_control_policy_members(opts = {})
  data, _status_code, _headers = query_combined_device_control_policy_members_with_http_info(opts)
  data
end

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

Search for members of a Device Control 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 Device Control 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



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
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/crimson-falcon/api/device_control_policies.rb', line 466

def query_combined_device_control_policy_members_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeviceControlPolicies.query_combined_device_control_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 DeviceControlPolicies.query_combined_device_control_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 DeviceControlPolicies.query_combined_device_control_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 DeviceControlPolicies.query_combined_device_control_policy_members, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/policy/combined/device-control-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 => :"DeviceControlPolicies.query_combined_device_control_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: DeviceControlPolicies#query_combined_device_control_policy_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_device_control_policies(opts = {}) ⇒ MsaQueryResponse

Search for Device Control Policies in your environment by providing an FQL filter and paging details. Returns a set of Device Control 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:



534
535
536
537
 
# File 'lib/crimson-falcon/api/device_control_policies.rb', line 534

def query_device_control_policies(opts = {})
  data, _status_code, _headers = query_device_control_policies_with_http_info(opts)
  data
end

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

Search for Device Control Policies in your environment by providing an FQL filter and paging details. Returns a set of Device Control 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



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
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/crimson-falcon/api/device_control_policies.rb', line 546

def query_device_control_policies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeviceControlPolicies.query_device_control_policies ...'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling DeviceControlPolicies.query_device_control_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 DeviceControlPolicies.query_device_control_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 DeviceControlPolicies.query_device_control_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/device-control/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 => :"DeviceControlPolicies.query_device_control_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: DeviceControlPolicies#query_device_control_policies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_device_control_policy_members(opts = {}) ⇒ MsaQueryResponse

Search for members of a Device Control 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 Device Control 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:



618
619
620
621
 
# File 'lib/crimson-falcon/api/device_control_policies.rb', line 618

def query_device_control_policy_members(opts = {})
  data, _status_code, _headers = query_device_control_policy_members_with_http_info(opts)
  data
end

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

Search for members of a Device Control 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 Device Control 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



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

def query_device_control_policy_members_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeviceControlPolicies.query_device_control_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 DeviceControlPolicies.query_device_control_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 DeviceControlPolicies.query_device_control_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 DeviceControlPolicies.query_device_control_policy_members, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/policy/queries/device-control-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 => :"DeviceControlPolicies.query_device_control_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: DeviceControlPolicies#query_device_control_policy_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Sets the precedence of Device Control 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:



696
697
698
699
 
# File 'lib/crimson-falcon/api/device_control_policies.rb', line 696

def set_device_control_policies_precedence(body, opts = {})
  data, _status_code, _headers = set_device_control_policies_precedence_with_http_info(body, opts)
  data
end

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

Sets the precedence of Device Control 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



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
745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'lib/crimson-falcon/api/device_control_policies.rb', line 705

def set_device_control_policies_precedence_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeviceControlPolicies.set_device_control_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 DeviceControlPolicies.set_device_control_policies_precedence"
  end
  # resource path
  local_var_path = '/policy/entities/device-control-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 => :"DeviceControlPolicies.set_device_control_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: DeviceControlPolicies#set_device_control_policies_precedence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_default_device_control_policies(body, opts = {}) ⇒ DeviceControlRespV1

Update the configuration for a Default Device Control Policy

Parameters:

Returns:



762
763
764
765
 
# File 'lib/crimson-falcon/api/device_control_policies.rb', line 762

def update_default_device_control_policies(body, opts = {})
  data, _status_code, _headers = update_default_device_control_policies_with_http_info(body, opts)
  data
end

#update_default_device_control_policies_with_http_info(body, opts = {}) ⇒ Array<(DeviceControlRespV1, Integer, Hash)>

Update the configuration for a Default Device Control Policy

Parameters:

Returns:

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

    DeviceControlRespV1 data, response status code and response headers



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

def update_default_device_control_policies_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeviceControlPolicies.update_default_device_control_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 DeviceControlPolicies.update_default_device_control_policies"
  end
  # resource path
  local_var_path = '/policy/entities/default-device-control/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] || 'DeviceControlRespV1'

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

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

#update_device_control_policies(body, opts = {}) ⇒ DeviceControlRespV1

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

Parameters:

Returns:



828
829
830
831
 
# File 'lib/crimson-falcon/api/device_control_policies.rb', line 828

def update_device_control_policies(body, opts = {})
  data, _status_code, _headers = update_device_control_policies_with_http_info(body, opts)
  data
end

#update_device_control_policies_with_http_info(body, opts = {}) ⇒ Array<(DeviceControlRespV1, Integer, Hash)>

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

Parameters:

Returns:

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

    DeviceControlRespV1 data, response status code and response headers



837
838
839
840
841
842
843
844
845
846
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
 
# File 'lib/crimson-falcon/api/device_control_policies.rb', line 837

def update_device_control_policies_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeviceControlPolicies.update_device_control_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 DeviceControlPolicies.update_device_control_policies"
  end
  # resource path
  local_var_path = '/policy/entities/device-control/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] || 'DeviceControlRespV1'

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

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