Class: Falcon::FirewallManagementApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FirewallManagementApi

Returns a new instance of FirewallManagementApi.



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

def api_client
  @api_client
end

Instance Method Details

#aggregate_events(body, opts = {}) ⇒ FwmgrApiAggregatesResponse

Aggregate events for customer

Parameters:

Returns:



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

def aggregate_events(body, opts = {})
  data, _status_code, _headers = aggregate_events_with_http_info(body, opts)
  data
end

#aggregate_events_with_http_info(body, opts = {}) ⇒ Array<(FwmgrApiAggregatesResponse, Integer, Hash)>

Aggregate events for customer

Parameters:

Returns:

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

    FwmgrApiAggregatesResponse 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/firewall_management_api.rb', line 52

def aggregate_events_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.aggregate_events ...'
  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 FirewallManagementApi.aggregate_events"
  end
  # resource path
  local_var_path = '/fwmgr/aggregates/events/GET/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] || 'FwmgrApiAggregatesResponse'

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

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

#aggregate_policy_rules(body, opts = {}) ⇒ FwmgrApiAggregatesResponse

Aggregate rules within a policy for customer

Parameters:

Returns:



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

def aggregate_policy_rules(body, opts = {})
  data, _status_code, _headers = aggregate_policy_rules_with_http_info(body, opts)
  data
end

#aggregate_policy_rules_with_http_info(body, opts = {}) ⇒ Array<(FwmgrApiAggregatesResponse, Integer, Hash)>

Aggregate rules within a policy for customer

Parameters:

Returns:

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

    FwmgrApiAggregatesResponse 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/firewall_management_api.rb', line 118

def aggregate_policy_rules_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.aggregate_policy_rules ...'
  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 FirewallManagementApi.aggregate_policy_rules"
  end
  # resource path
  local_var_path = '/fwmgr/aggregates/policy-rules/GET/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] || 'FwmgrApiAggregatesResponse'

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

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

#aggregate_rule_groups(body, opts = {}) ⇒ FwmgrApiAggregatesResponse

Aggregate rule groups for customer

Parameters:

Returns:



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

def aggregate_rule_groups(body, opts = {})
  data, _status_code, _headers = aggregate_rule_groups_with_http_info(body, opts)
  data
end

#aggregate_rule_groups_with_http_info(body, opts = {}) ⇒ Array<(FwmgrApiAggregatesResponse, Integer, Hash)>

Aggregate rule groups for customer

Parameters:

Returns:

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

    FwmgrApiAggregatesResponse 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
232
233
234
235
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 184

def aggregate_rule_groups_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.aggregate_rule_groups ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling FirewallManagementApi.aggregate_rule_groups"
  end
  # resource path
  local_var_path = '/fwmgr/aggregates/rule-groups/GET/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] || 'FwmgrApiAggregatesResponse'

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

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

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

#aggregate_rules(body, opts = {}) ⇒ FwmgrApiAggregatesResponse

Aggregate rules for customer

Parameters:

Returns:



241
242
243
244
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 241

def aggregate_rules(body, opts = {})
  data, _status_code, _headers = aggregate_rules_with_http_info(body, opts)
  data
end

#aggregate_rules_with_http_info(body, opts = {}) ⇒ Array<(FwmgrApiAggregatesResponse, Integer, Hash)>

Aggregate rules for customer

Parameters:

Returns:

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

    FwmgrApiAggregatesResponse data, response status code and response headers



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

def aggregate_rules_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.aggregate_rules ...'
  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 FirewallManagementApi.aggregate_rules"
  end
  # resource path
  local_var_path = '/fwmgr/aggregates/rules/GET/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] || 'FwmgrApiAggregatesResponse'

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

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

#create_network_locations(body, opts = {}) ⇒ FwmgrApiNetworkLocationsResponse

Create new network locations provided, and return the ID.

Parameters:

Options Hash (opts):

  • :clone_id (String) —

    A network location ID from which to copy location. If this is provided then the body of the request is ignored.

  • :add_fw_rules (Boolean) —

    A boolean to determine whether the cloned location needs to be added to the same firewall rules that original location is added to.

  • :comment (String) —

    Audit log comment for this action

Returns:



310
311
312
313
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 310

def create_network_locations(body, opts = {})
  data, _status_code, _headers = create_network_locations_with_http_info(body, opts)
  data
end

#create_network_locations_with_http_info(body, opts = {}) ⇒ Array<(FwmgrApiNetworkLocationsResponse, Integer, Hash)>

Create new network locations provided, and return the ID.

Parameters:

Options Hash (opts):

  • :clone_id (String) —

    A network location ID from which to copy location. If this is provided then the body of the request is ignored.

  • :add_fw_rules (Boolean) —

    A boolean to determine whether the cloned location needs to be added to the same firewall rules that original location is added to.

  • :comment (String) —

    Audit log comment for this action

Returns:



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
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 322

def create_network_locations_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.create_network_locations ...'
  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 FirewallManagementApi.create_network_locations"
  end
  # resource path
  local_var_path = '/fwmgr/entities/network-locations/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'clone_id'] = opts[:'clone_id'] if !opts[:'clone_id'].nil?
  query_params[:'add_fw_rules'] = opts[:'add_fw_rules'] if !opts[:'add_fw_rules'].nil?
  query_params[:'comment'] = opts[:'comment'] if !opts[:'comment'].nil?

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

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

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

#create_rule_group(body, opts = {}) ⇒ FwmgrApiQueryResponse

Create new rule group on a platform for a customer with a name and description, and return the ID

Parameters:

Options Hash (opts):

  • :clone_id (String) —

    A rule group ID from which to copy rules. If this is provided then the &#39;rules&#39; property of the body is ignored.

  • :library (String) —

    If this flag is set to true then the rules will be cloned from the clone_id from the CrowdStrike Firewal Rule Groups Library.

  • :comment (String) —

    Audit log comment for this action

Returns:



385
386
387
388
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 385

def create_rule_group(body, opts = {})
  data, _status_code, _headers = create_rule_group_with_http_info(body, opts)
  data
end

#create_rule_group_validation(body, opts = {}) ⇒ FwmgrMsaspecQueryResponse

Validates the request of creating a new rule group on a platform for a customer with a name and description

Parameters:

Options Hash (opts):

  • :clone_id (String) —

    A rule group ID from which to copy rules. If this is provided then the &#39;rules&#39; property of the body is ignored.

  • :library (String) —

    If this flag is set to true then the rules will be cloned from the clone_id from the CrowdStrike Firewall Rule Groups Library.

  • :comment (String) —

    Audit log comment for this action

Returns:



460
461
462
463
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 460

def create_rule_group_validation(body, opts = {})
  data, _status_code, _headers = create_rule_group_validation_with_http_info(body, opts)
  data
end

#create_rule_group_validation_with_http_info(body, opts = {}) ⇒ Array<(FwmgrMsaspecQueryResponse, Integer, Hash)>

Validates the request of creating a new rule group on a platform for a customer with a name and description

Parameters:

Options Hash (opts):

  • :clone_id (String) —

    A rule group ID from which to copy rules. If this is provided then the &#39;rules&#39; property of the body is ignored.

  • :library (String) —

    If this flag is set to true then the rules will be cloned from the clone_id from the CrowdStrike Firewall Rule Groups Library.

  • :comment (String) —

    Audit log comment for this action

Returns:

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

    FwmgrMsaspecQueryResponse data, response status code and response headers



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

def create_rule_group_validation_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.create_rule_group_validation ...'
  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 FirewallManagementApi.create_rule_group_validation"
  end
  # resource path
  local_var_path = '/fwmgr/entities/rule-groups/validation/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'clone_id'] = opts[:'clone_id'] if !opts[:'clone_id'].nil?
  query_params[:'library'] = opts[:'library'] if !opts[:'library'].nil?
  query_params[:'comment'] = opts[:'comment'] if !opts[:'comment'].nil?

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

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

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

#create_rule_group_with_http_info(body, opts = {}) ⇒ Array<(FwmgrApiQueryResponse, Integer, Hash)>

Create new rule group on a platform for a customer with a name and description, and return the ID

Parameters:

Options Hash (opts):

  • :clone_id (String) —

    A rule group ID from which to copy rules. If this is provided then the &#39;rules&#39; property of the body is ignored.

  • :library (String) —

    If this flag is set to true then the rules will be cloned from the clone_id from the CrowdStrike Firewal Rule Groups Library.

  • :comment (String) —

    Audit log comment for this action

Returns:

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

    FwmgrApiQueryResponse data, response status code and response headers



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

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'clone_id'] = opts[:'clone_id'] if !opts[:'clone_id'].nil?
  query_params[:'library'] = opts[:'library'] if !opts[:'library'].nil?
  query_params[:'comment'] = opts[:'comment'] if !opts[:'comment'].nil?

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

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

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

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

#delete_network_locations(ids, opts = {}) ⇒ FwmgrMsaspecQueryResponse

Delete network location entities by ID.

Parameters:

  • ids (Array<String>) —

    The IDs of the network locations to be deleted

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

    the optional parameters

Returns:



532
533
534
535
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 532

def delete_network_locations(ids, opts = {})
  data, _status_code, _headers = delete_network_locations_with_http_info(ids, opts)
  data
end

#delete_network_locations_with_http_info(ids, opts = {}) ⇒ Array<(FwmgrMsaspecQueryResponse, Integer, Hash)>

Delete network location entities by ID.

Parameters:

  • ids (Array<String>) —

    The IDs of the network locations to be deleted

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

    the optional parameters

Returns:

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

    FwmgrMsaspecQueryResponse data, response status code and response headers



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
579
580
581
582
583
584
585
586
587
588
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 541

def delete_network_locations_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.delete_network_locations ...'
  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 FirewallManagementApi.delete_network_locations"
  end
  # resource path
  local_var_path = '/fwmgr/entities/network-locations/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] || 'FwmgrMsaspecQueryResponse'

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

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

#delete_rule_groups(ids, opts = {}) ⇒ FwmgrApiQueryResponse

Delete rule group entities by ID

Parameters:

  • ids (Array<String>) —

    The IDs of the rule groups to be deleted

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

    the optional parameters

Options Hash (opts):

  • :comment (String) —

    Audit log comment for this action

Returns:



595
596
597
598
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 595

def delete_rule_groups(ids, opts = {})
  data, _status_code, _headers = delete_rule_groups_with_http_info(ids, opts)
  data
end

#delete_rule_groups_with_http_info(ids, opts = {}) ⇒ Array<(FwmgrApiQueryResponse, Integer, Hash)>

Delete rule group entities by ID

Parameters:

  • ids (Array<String>) —

    The IDs of the rule groups to be deleted

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

    the optional parameters

Options Hash (opts):

  • :comment (String) —

    Audit log comment for this action

Returns:

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

    FwmgrApiQueryResponse data, response status code and response headers



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

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)
  query_params[:'comment'] = opts[:'comment'] if !opts[:'comment'].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] || 'FwmgrApiQueryResponse'

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

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

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

#get_events(ids, opts = {}) ⇒ FwmgrApiEventsResponse

Get events entities by ID and optionally version

Parameters:

  • ids (Array<String>) —

    The events to retrieve, identified by ID

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

    the optional parameters

Returns:



659
660
661
662
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 659

def get_events(ids, opts = {})
  data, _status_code, _headers = get_events_with_http_info(ids, opts)
  data
end

#get_events_with_http_info(ids, opts = {}) ⇒ Array<(FwmgrApiEventsResponse, Integer, Hash)>

Get events entities by ID and optionally version

Parameters:

  • ids (Array<String>) —

    The events to retrieve, identified by ID

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

    the optional parameters

Returns:

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

    FwmgrApiEventsResponse data, response status code and response headers



668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 668

def get_events_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.get_events ...'
  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 FirewallManagementApi.get_events"
  end
  # resource path
  local_var_path = '/fwmgr/entities/events/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] || 'FwmgrApiEventsResponse'

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

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

#get_firewall_fields(ids, opts = {}) ⇒ FwmgrApiFirewallFieldsResponse

Get the firewall field specifications by ID

Parameters:

  • ids (Array<String>) —

    The IDs of the rule types to retrieve

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

    the optional parameters

Returns:



721
722
723
724
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 721

def get_firewall_fields(ids, opts = {})
  data, _status_code, _headers = get_firewall_fields_with_http_info(ids, opts)
  data
end

#get_firewall_fields_with_http_info(ids, opts = {}) ⇒ Array<(FwmgrApiFirewallFieldsResponse, Integer, Hash)>

Get the firewall field specifications by ID

Parameters:

  • ids (Array<String>) —

    The IDs of the rule types to retrieve

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

    the optional parameters

Returns:



730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 730

def get_firewall_fields_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.get_firewall_fields ...'
  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 FirewallManagementApi.get_firewall_fields"
  end
  # resource path
  local_var_path = '/fwmgr/entities/firewall-fields/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] || 'FwmgrApiFirewallFieldsResponse'

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

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

#get_network_locations(ids, opts = {}) ⇒ FwmgrApiNetworkLocationSummariesResponse

Get a summary of network locations entities by ID This endpoint returns a summary of network locations that includes name, description, enabled/disabled status, a count of associated rules etc

Parameters:

  • ids (Array<String>) —

    The events to retrieve, identified by ID

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

    the optional parameters

Returns:



784
785
786
787
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 784

def get_network_locations(ids, opts = {})
  data, _status_code, _headers = get_network_locations_with_http_info(ids, opts)
  data
end

#get_network_locations_details(ids, opts = {}) ⇒ FwmgrApiNetworkLocationsResponse

Get network locations entities by ID This endpoint returns the complete network locations objects that includes all the network location conditions.

Parameters:

  • ids (Array<String>) —

    The events to retrieve, identified by ID

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

    the optional parameters

Returns:



848
849
850
851
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 848

def get_network_locations_details(ids, opts = {})
  data, _status_code, _headers = get_network_locations_details_with_http_info(ids, opts)
  data
end

#get_network_locations_details_with_http_info(ids, opts = {}) ⇒ Array<(FwmgrApiNetworkLocationsResponse, Integer, Hash)>

Get network locations entities by ID This endpoint returns the complete network locations objects that includes all the network location conditions.

Parameters:

  • ids (Array<String>) —

    The events to retrieve, identified by ID

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

    the optional parameters

Returns:



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

def get_network_locations_details_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.get_network_locations_details ...'
  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 FirewallManagementApi.get_network_locations_details"
  end
  # resource path
  local_var_path = '/fwmgr/entities/network-locations-details/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] || 'FwmgrApiNetworkLocationsResponse'

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

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

#get_network_locations_with_http_info(ids, opts = {}) ⇒ Array<(FwmgrApiNetworkLocationSummariesResponse, Integer, Hash)>

Get a summary of network locations entities by ID This endpoint returns a summary of network locations that includes name, description, enabled/disabled status, a count of associated rules etc

Parameters:

  • ids (Array<String>) —

    The events to retrieve, identified by ID

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

    the optional parameters

Returns:



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
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 794

def get_network_locations_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.get_network_locations ...'
  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 FirewallManagementApi.get_network_locations"
  end
  # resource path
  local_var_path = '/fwmgr/entities/network-locations/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] || 'FwmgrApiNetworkLocationSummariesResponse'

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

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

#get_platforms(ids, opts = {}) ⇒ FwmgrApiPlatformsResponse

Get platforms by ID, e.g., windows or mac or droid

Parameters:

  • ids (Array<String>) —

    The IDs of the platforms to retrieve

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

    the optional parameters

Returns:



911
912
913
914
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 911

def get_platforms(ids, opts = {})
  data, _status_code, _headers = get_platforms_with_http_info(ids, opts)
  data
end

#get_platforms_with_http_info(ids, opts = {}) ⇒ Array<(FwmgrApiPlatformsResponse, Integer, Hash)>

Get platforms by ID, e.g., windows or mac or droid

Parameters:

  • ids (Array<String>) —

    The IDs of the platforms to retrieve

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

    the optional parameters

Returns:

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

    FwmgrApiPlatformsResponse data, response status code and response headers



920
921
922
923
924
925
926
927
928
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
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 920

def get_platforms_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.get_platforms ...'
  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 FirewallManagementApi.get_platforms"
  end
  # resource path
  local_var_path = '/fwmgr/entities/platforms/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] || 'FwmgrApiPlatformsResponse'

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

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

#get_policy_containers(ids, opts = {}) ⇒ FwmgrApiPolicyContainersResponse

Get policy container entities by policy ID

Parameters:

  • ids (Array<String>) —

    The policy container(s) to retrieve, identified by policy ID

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

    the optional parameters

Returns:



973
974
975
976
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 973

def get_policy_containers(ids, opts = {})
  data, _status_code, _headers = get_policy_containers_with_http_info(ids, opts)
  data
end

#get_policy_containers_with_http_info(ids, opts = {}) ⇒ Array<(FwmgrApiPolicyContainersResponse, Integer, Hash)>

Get policy container entities by policy ID

Parameters:

  • ids (Array<String>) —

    The policy container(s) to retrieve, identified by policy ID

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

    the optional parameters

Returns:



982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 982

def get_policy_containers_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.get_policy_containers ...'
  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 FirewallManagementApi.get_policy_containers"
  end
  # resource path
  local_var_path = '/fwmgr/entities/policies/v1'

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

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

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

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

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

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

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

#get_rule_groups(ids, opts = {}) ⇒ FwmgrApiRuleGroupsResponse

Get rule group entities by ID. These groups do not contain their rule entites, just the rule IDs in precedence order.

Parameters:

  • ids (Array<String>) —

    The IDs of the rule groups to retrieve

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

    the optional parameters

Returns:



1035
1036
1037
1038
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1035

def get_rule_groups(ids, opts = {})
  data, _status_code, _headers = get_rule_groups_with_http_info(ids, opts)
  data
end

#get_rule_groups_with_http_info(ids, opts = {}) ⇒ Array<(FwmgrApiRuleGroupsResponse, Integer, Hash)>

Get rule group entities by ID. These groups do not contain their rule entites, just the rule IDs in precedence order.

Parameters:

  • ids (Array<String>) —

    The IDs of the rule groups to retrieve

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

    the optional parameters

Returns:

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

    FwmgrApiRuleGroupsResponse data, response status code and response headers



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
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1044

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

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

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

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

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

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

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

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

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

#get_rules(ids, opts = {}) ⇒ FwmgrApiRulesResponse

Get rule entities by ID (64-bit unsigned int as decimal string) or Family ID (32-character hexadecimal string)

Parameters:

  • ids (Array<String>) —

    The rules to retrieve, identified by ID

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

    the optional parameters

Returns:



1097
1098
1099
1100
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1097

def get_rules(ids, opts = {})
  data, _status_code, _headers = get_rules_with_http_info(ids, opts)
  data
end

#get_rules_with_http_info(ids, opts = {}) ⇒ Array<(FwmgrApiRulesResponse, Integer, Hash)>

Get rule entities by ID (64-bit unsigned int as decimal string) or Family ID (32-character hexadecimal string)

Parameters:

  • ids (Array<String>) —

    The rules to retrieve, identified by ID

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

    the optional parameters

Returns:

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

    FwmgrApiRulesResponse data, response status code and response headers



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
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1106

def get_rules_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.get_rules ...'
  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 FirewallManagementApi.get_rules"
  end
  # resource path
  local_var_path = '/fwmgr/entities/rules/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] || 'FwmgrApiRulesResponse'

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

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

#query_events(opts = {}) ⇒ FwmgrApiQueryResponse

Find all event IDs matching the query with filter

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    Possible order by fields:

  • :filter (String) —

    FQL query specifying the filter parameters. Filter term criteria: enabled, platform, name, description, etc TODO. Filter range criteria: created_on, modified_on; use any common date format, such as &#39;2010-05-15T14:55:21.892315096Z&#39;.

  • :q (String) —

    Match query criteria, which includes all the filter string fields, plus TODO

  • :offset (String) —

    Starting index of overall result set from which to return ids.

  • :after (String) —

    A pagination token used with the &#x60;limit&#x60; parameter to manage pagination of results. On your first request, don&#39;t provide an &#x60;after&#x60; token. On subsequent requests, provide the &#x60;after&#x60; token from the previous response to continue from that place in the results.

  • :limit (Integer) —

    Number of ids to return.

Returns:



1164
1165
1166
1167
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1164

def query_events(opts = {})
  data, _status_code, _headers = query_events_with_http_info(opts)
  data
end

#query_events_with_http_info(opts = {}) ⇒ Array<(FwmgrApiQueryResponse, Integer, Hash)>

Find all event IDs matching the query with filter

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    Possible order by fields:

  • :filter (String) —

    FQL query specifying the filter parameters. Filter term criteria: enabled, platform, name, description, etc TODO. Filter range criteria: created_on, modified_on; use any common date format, such as &#39;2010-05-15T14:55:21.892315096Z&#39;.

  • :q (String) —

    Match query criteria, which includes all the filter string fields, plus TODO

  • :offset (String) —

    Starting index of overall result set from which to return ids.

  • :after (String) —

    A pagination token used with the &#x60;limit&#x60; parameter to manage pagination of results. On your first request, don&#39;t provide an &#x60;after&#x60; token. On subsequent requests, provide the &#x60;after&#x60; token from the previous response to continue from that place in the results.

  • :limit (Integer) —

    Number of ids to return.

Returns:

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

    FwmgrApiQueryResponse data, response status code and response headers



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
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1178

def query_events_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.query_events ...'
  end
  # resource path
  local_var_path = '/fwmgr/queries/events/v1'

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

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

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

#query_firewall_fields(opts = {}) ⇒ FwmgrMsaspecQueryResponse

Get the firewall field specification IDs for the provided platform

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :platform_id (String) —

    Get fields configuration for this platform

  • :offset (String) —

    Starting index of overall result set from which to return ids.

  • :limit (Integer) —

    Number of ids to return.

Returns:



1234
1235
1236
1237
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1234

def query_firewall_fields(opts = {})
  data, _status_code, _headers = query_firewall_fields_with_http_info(opts)
  data
end

#query_firewall_fields_with_http_info(opts = {}) ⇒ Array<(FwmgrMsaspecQueryResponse, Integer, Hash)>

Get the firewall field specification IDs for the provided platform

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :platform_id (String) —

    Get fields configuration for this platform

  • :offset (String) —

    Starting index of overall result set from which to return ids.

  • :limit (Integer) —

    Number of ids to return.

Returns:

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

    FwmgrMsaspecQueryResponse data, response status code and response headers



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
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1245

def query_firewall_fields_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.query_firewall_fields ...'
  end
  # resource path
  local_var_path = '/fwmgr/queries/firewall-fields/v1'

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

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

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

#query_network_locations(opts = {}) ⇒ FwmgrApiQueryResponse

Get a list of network location IDs This endpoint returns a list of network location IDs based of query parameter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    Possible order by fields:

  • :filter (String) —

    FQL query specifying the filter parameters. Filter term criteria: name

  • :q (String) —

    Match query criteria, which includes all the filter string fields

  • :offset (String) —

    Starting index of overall result set from which to return ids.

  • :after (String) —

    A pagination token used with the &#x60;limit&#x60; parameter to manage pagination of results. On your first request, don&#39;t provide an &#x60;after&#x60; token. On subsequent requests, provide the &#x60;after&#x60; token from the previous response to continue from that place in the results.

  • :limit (Integer) —

    Number of ids to return.

Returns:



1302
1303
1304
1305
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1302

def query_network_locations(opts = {})
  data, _status_code, _headers = query_network_locations_with_http_info(opts)
  data
end

#query_network_locations_with_http_info(opts = {}) ⇒ Array<(FwmgrApiQueryResponse, Integer, Hash)>

Get a list of network location IDs This endpoint returns a list of network location IDs based of query parameter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    Possible order by fields:

  • :filter (String) —

    FQL query specifying the filter parameters. Filter term criteria: name

  • :q (String) —

    Match query criteria, which includes all the filter string fields

  • :offset (String) —

    Starting index of overall result set from which to return ids.

  • :after (String) —

    A pagination token used with the &#x60;limit&#x60; parameter to manage pagination of results. On your first request, don&#39;t provide an &#x60;after&#x60; token. On subsequent requests, provide the &#x60;after&#x60; token from the previous response to continue from that place in the results.

  • :limit (Integer) —

    Number of ids to return.

Returns:

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

    FwmgrApiQueryResponse data, response status code and response headers



1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1317

def query_network_locations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.query_network_locations ...'
  end
  # resource path
  local_var_path = '/fwmgr/queries/network-locations/v1'

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

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

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

#query_platforms(opts = {}) ⇒ FwmgrMsaspecQueryResponse

Get the list of platform names

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

    Starting index of overall result set from which to return ids.

  • :limit (Integer) —

    Number of ids to return.

Returns:



1372
1373
1374
1375
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1372

def query_platforms(opts = {})
  data, _status_code, _headers = query_platforms_with_http_info(opts)
  data
end

#query_platforms_with_http_info(opts = {}) ⇒ Array<(FwmgrMsaspecQueryResponse, Integer, Hash)>

Get the list of platform names

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

    Starting index of overall result set from which to return ids.

  • :limit (Integer) —

    Number of ids to return.

Returns:

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

    FwmgrMsaspecQueryResponse data, response status code and response headers



1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1382

def query_platforms_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.query_platforms ...'
  end
  # resource path
  local_var_path = '/fwmgr/queries/platforms/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  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] || 'FwmgrMsaspecQueryResponse'

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

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

#query_policy_rules(opts = {}) ⇒ FwmgrApiQueryResponse

Find all firewall rule IDs matching the query with filter, and return them in precedence order

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    The ID of the policy container within which to query

  • :sort (String) —

    Possible order by fields:

  • :filter (String) —

    FQL query specifying the filter parameters. Filter term criteria: enabled, platform, name, description, etc TODO. Filter range criteria: created_on, modified_on; use any common date format, such as &#39;2010-05-15T14:55:21.892315096Z&#39;.

  • :q (String) —

    Match query criteria, which includes all the filter string fields, plus TODO

  • :offset (String) —

    Starting index of overall result set from which to return ids.

  • :limit (Integer) —

    Number of ids to return.

Returns:



1437
1438
1439
1440
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1437

def query_policy_rules(opts = {})
  data, _status_code, _headers = query_policy_rules_with_http_info(opts)
  data
end

#query_policy_rules_with_http_info(opts = {}) ⇒ Array<(FwmgrApiQueryResponse, Integer, Hash)>

Find all firewall rule IDs matching the query with filter, and return them in precedence order

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    The ID of the policy container within which to query

  • :sort (String) —

    Possible order by fields:

  • :filter (String) —

    FQL query specifying the filter parameters. Filter term criteria: enabled, platform, name, description, etc TODO. Filter range criteria: created_on, modified_on; use any common date format, such as &#39;2010-05-15T14:55:21.892315096Z&#39;.

  • :q (String) —

    Match query criteria, which includes all the filter string fields, plus TODO

  • :offset (String) —

    Starting index of overall result set from which to return ids.

  • :limit (Integer) —

    Number of ids to return.

Returns:

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

    FwmgrApiQueryResponse data, response status code and response headers



1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1451

def query_policy_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.query_policy_rules ...'
  end
  # resource path
  local_var_path = '/fwmgr/queries/policy-rules/v1'

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

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

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

#query_rule_groups(opts = {}) ⇒ FwmgrApiQueryResponse

Find all rule group IDs matching the query with filter

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    Possible order by fields:

  • :filter (String) —

    FQL query specifying the filter parameters. Filter term criteria: enabled, platform, name, description, etc TODO. Filter range criteria: created_on, modified_on; use any common date format, such as &#39;2010-05-15T14:55:21.892315096Z&#39;.

  • :q (String) —

    Match query criteria, which includes all the filter string fields, plus TODO

  • :offset (String) —

    Starting index of overall result set from which to return ids.

  • :after (String) —

    A pagination token used with the &#x60;limit&#x60; parameter to manage pagination of results. On your first request, don&#39;t provide an &#x60;after&#x60; token. On subsequent requests, provide the &#x60;after&#x60; token from the previous response to continue from that place in the results.

  • :limit (Integer) —

    Number of ids to return.

Returns:



1510
1511
1512
1513
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1510

def query_rule_groups(opts = {})
  data, _status_code, _headers = query_rule_groups_with_http_info(opts)
  data
end

#query_rule_groups_with_http_info(opts = {}) ⇒ Array<(FwmgrApiQueryResponse, Integer, Hash)>

Find all rule group IDs matching the query with filter

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    Possible order by fields:

  • :filter (String) —

    FQL query specifying the filter parameters. Filter term criteria: enabled, platform, name, description, etc TODO. Filter range criteria: created_on, modified_on; use any common date format, such as &#39;2010-05-15T14:55:21.892315096Z&#39;.

  • :q (String) —

    Match query criteria, which includes all the filter string fields, plus TODO

  • :offset (String) —

    Starting index of overall result set from which to return ids.

  • :after (String) —

    A pagination token used with the &#x60;limit&#x60; parameter to manage pagination of results. On your first request, don&#39;t provide an &#x60;after&#x60; token. On subsequent requests, provide the &#x60;after&#x60; token from the previous response to continue from that place in the results.

  • :limit (Integer) —

    Number of ids to return.

Returns:

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

    FwmgrApiQueryResponse data, response status code and response headers



1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1524

def query_rule_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.query_rule_groups ...'
  end
  # resource path
  local_var_path = '/fwmgr/queries/rule-groups/v1'

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

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

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

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

#query_rules(opts = {}) ⇒ FwmgrApiQueryResponse

Find all rule IDs matching the query with filter

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    Possible order by fields:

  • :filter (String) —

    FQL query specifying the filter parameters. Filter term criteria: enabled, platform, name, description, etc TODO. Filter range criteria: created_on, modified_on; use any common date format, such as &#39;2010-05-15T14:55:21.892315096Z&#39;.

  • :q (String) —

    Match query criteria, which includes all the filter string fields, plus TODO

  • :offset (String) —

    Starting index of overall result set from which to return ids.

  • :after (String) —

    A pagination token used with the &#x60;limit&#x60; parameter to manage pagination of results. On your first request, don&#39;t provide an &#x60;after&#x60; token. On subsequent requests, provide the &#x60;after&#x60; token from the previous response to continue from that place in the results.

  • :limit (Integer) —

    Number of ids to return.

Returns:



1583
1584
1585
1586
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1583

def query_rules(opts = {})
  data, _status_code, _headers = query_rules_with_http_info(opts)
  data
end

#query_rules_with_http_info(opts = {}) ⇒ Array<(FwmgrApiQueryResponse, Integer, Hash)>

Find all rule IDs matching the query with filter

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    Possible order by fields:

  • :filter (String) —

    FQL query specifying the filter parameters. Filter term criteria: enabled, platform, name, description, etc TODO. Filter range criteria: created_on, modified_on; use any common date format, such as &#39;2010-05-15T14:55:21.892315096Z&#39;.

  • :q (String) —

    Match query criteria, which includes all the filter string fields, plus TODO

  • :offset (String) —

    Starting index of overall result set from which to return ids.

  • :after (String) —

    A pagination token used with the &#x60;limit&#x60; parameter to manage pagination of results. On your first request, don&#39;t provide an &#x60;after&#x60; token. On subsequent requests, provide the &#x60;after&#x60; token from the previous response to continue from that place in the results.

  • :limit (Integer) —

    Number of ids to return.

Returns:

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

    FwmgrApiQueryResponse data, response status code and response headers



1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1597

def query_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.query_rules ...'
  end
  # resource path
  local_var_path = '/fwmgr/queries/rules/v1'

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

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

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

#update_network_locations(body, opts = {}) ⇒ FwmgrMsaspecQueryResponse

Updates the network locations provided, and return the ID.

Parameters:

Options Hash (opts):

  • :comment (String) —

    Audit log comment for this action

Returns:



1652
1653
1654
1655
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1652

def update_network_locations(body, opts = {})
  data, _status_code, _headers = update_network_locations_with_http_info(body, opts)
  data
end

#update_network_locations_metadata(body, opts = {}) ⇒ FwmgrMsaspecQueryResponse

Updates the network locations metadata such as polling_intervals for the cid

Parameters:

Options Hash (opts):

  • :comment (String) —

    Audit log comment for this action

Returns:



1721
1722
1723
1724
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1721

def update_network_locations_metadata(body, opts = {})
  data, _status_code, _headers = update_network_locations_metadata_with_http_info(body, opts)
  data
end

#update_network_locations_metadata_with_http_info(body, opts = {}) ⇒ Array<(FwmgrMsaspecQueryResponse, Integer, Hash)>

Updates the network locations metadata such as polling_intervals for the cid

Parameters:

Options Hash (opts):

  • :comment (String) —

    Audit log comment for this action

Returns:

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

    FwmgrMsaspecQueryResponse data, response status code and response headers



1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1731

def update_network_locations_metadata_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.update_network_locations_metadata ...'
  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 FirewallManagementApi.update_network_locations_metadata"
  end
  # resource path
  local_var_path = '/fwmgr/entities/network-locations-metadata/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'comment'] = opts[:'comment'] if !opts[:'comment'].nil?

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

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

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

#update_network_locations_precedence(body, opts = {}) ⇒ FwmgrMsaspecQueryResponse

Updates the network locations precedence according to the list of ids provided.

Parameters:

Options Hash (opts):

  • :comment (String) —

    Audit log comment for this action

Returns:



1790
1791
1792
1793
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1790

def update_network_locations_precedence(body, opts = {})
  data, _status_code, _headers = update_network_locations_precedence_with_http_info(body, opts)
  data
end

#update_network_locations_precedence_with_http_info(body, opts = {}) ⇒ Array<(FwmgrMsaspecQueryResponse, Integer, Hash)>

Updates the network locations precedence according to the list of ids provided.

Parameters:

Options Hash (opts):

  • :comment (String) —

    Audit log comment for this action

Returns:

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

    FwmgrMsaspecQueryResponse data, response status code and response headers



1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1800

def update_network_locations_precedence_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.update_network_locations_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 FirewallManagementApi.update_network_locations_precedence"
  end
  # resource path
  local_var_path = '/fwmgr/entities/network-locations-precedence/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'comment'] = opts[:'comment'] if !opts[:'comment'].nil?

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

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

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

#update_network_locations_with_http_info(body, opts = {}) ⇒ Array<(FwmgrMsaspecQueryResponse, Integer, Hash)>

Updates the network locations provided, and return the ID.

Parameters:

Options Hash (opts):

  • :comment (String) —

    Audit log comment for this action

Returns:

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

    FwmgrMsaspecQueryResponse data, response status code and response headers



1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1662

def update_network_locations_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.update_network_locations ...'
  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 FirewallManagementApi.update_network_locations"
  end
  # resource path
  local_var_path = '/fwmgr/entities/network-locations/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'comment'] = opts[:'comment'] if !opts[:'comment'].nil?

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

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

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

#update_policy_container(body, opts = {}) ⇒ FwmgrMsaspecResponseFields

Update an identified policy container, including local logging functionality.

Parameters:

Returns:



1858
1859
1860
1861
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1858

def update_policy_container(body, opts = {})
  data, _status_code, _headers = update_policy_container_with_http_info(body, opts)
  data
end

#update_policy_container_v1(body, opts = {}) ⇒ FwmgrMsaspecResponseFields

Update an identified policy container. WARNING: This endpoint is deprecated in favor of v2, using this endpoint could disable your local logging setting.

Parameters:

Returns:



1924
1925
1926
1927
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1924

def update_policy_container_v1(body, opts = {})
  data, _status_code, _headers = update_policy_container_v1_with_http_info(body, opts)
  data
end

#update_policy_container_v1_with_http_info(body, opts = {}) ⇒ Array<(FwmgrMsaspecResponseFields, Integer, Hash)>

Update an identified policy container. WARNING: This endpoint is deprecated in favor of v2, using this endpoint could disable your local logging setting.

Parameters:

Returns:

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

    FwmgrMsaspecResponseFields data, response status code and response headers



1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1933

def update_policy_container_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.update_policy_container_v1 ...'
  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 FirewallManagementApi.update_policy_container_v1"
  end
  # resource path
  local_var_path = '/fwmgr/entities/policies/v1'

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

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

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

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

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

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

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

#update_policy_container_with_http_info(body, opts = {}) ⇒ Array<(FwmgrMsaspecResponseFields, Integer, Hash)>

Update an identified policy container, including local logging functionality.

Parameters:

Returns:

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

    FwmgrMsaspecResponseFields data, response status code and response headers



1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1867

def update_policy_container_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.update_policy_container ...'
  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 FirewallManagementApi.update_policy_container"
  end
  # resource path
  local_var_path = '/fwmgr/entities/policies/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] || 'FwmgrMsaspecResponseFields'

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

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

#update_rule_group(body, opts = {}) ⇒ FwmgrApiQueryResponse

Update name, description, or enabled status of a rule group, or create, edit, delete, or reorder rules

Parameters:

Options Hash (opts):

  • :comment (String) —

    Audit log comment for this action

Returns:



1991
1992
1993
1994
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 1991

def update_rule_group(body, opts = {})
  data, _status_code, _headers = update_rule_group_with_http_info(body, opts)
  data
end

#update_rule_group_validation(body, opts = {}) ⇒ FwmgrMsaspecQueryResponse

Validates the request of updating name, description, or enabled status of a rule group, or create, edit, delete, or reorder rules

Parameters:

Options Hash (opts):

  • :comment (String) —

    Audit log comment for this action

Returns:



2060
2061
2062
2063
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 2060

def update_rule_group_validation(body, opts = {})
  data, _status_code, _headers = update_rule_group_validation_with_http_info(body, opts)
  data
end

#update_rule_group_validation_with_http_info(body, opts = {}) ⇒ Array<(FwmgrMsaspecQueryResponse, Integer, Hash)>

Validates the request of updating name, description, or enabled status of a rule group, or create, edit, delete, or reorder rules

Parameters:

Options Hash (opts):

  • :comment (String) —

    Audit log comment for this action

Returns:

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

    FwmgrMsaspecQueryResponse data, response status code and response headers



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

def update_rule_group_validation_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.update_rule_group_validation ...'
  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 FirewallManagementApi.update_rule_group_validation"
  end
  # resource path
  local_var_path = '/fwmgr/entities/rule-groups/validation/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'comment'] = opts[:'comment'] if !opts[:'comment'].nil?

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

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

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

#update_rule_group_with_http_info(body, opts = {}) ⇒ Array<(FwmgrApiQueryResponse, Integer, Hash)>

Update name, description, or enabled status of a rule group, or create, edit, delete, or reorder rules

Parameters:

Options Hash (opts):

  • :comment (String) —

    Audit log comment for this action

Returns:

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

    FwmgrApiQueryResponse data, response status code and response headers



2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 2001

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'comment'] = opts[:'comment'] if !opts[:'comment'].nil?

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

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

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

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

#upsert_network_locations(body, opts = {}) ⇒ FwmgrMsaspecQueryResponse

Updates the network locations provided, and return the ID.

Parameters:

Options Hash (opts):

  • :comment (String) —

    Audit log comment for this action

Returns:



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

def upsert_network_locations(body, opts = {})
  data, _status_code, _headers = upsert_network_locations_with_http_info(body, opts)
  data
end

#upsert_network_locations_with_http_info(body, opts = {}) ⇒ Array<(FwmgrMsaspecQueryResponse, Integer, Hash)>

Updates the network locations provided, and return the ID.

Parameters:

Options Hash (opts):

  • :comment (String) —

    Audit log comment for this action

Returns:

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

    FwmgrMsaspecQueryResponse data, response status code and response headers



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

def upsert_network_locations_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.upsert_network_locations ...'
  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 FirewallManagementApi.upsert_network_locations"
  end
  # resource path
  local_var_path = '/fwmgr/entities/network-locations/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'comment'] = opts[:'comment'] if !opts[:'comment'].nil?

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

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

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

#validate_filepath_pattern(body, opts = {}) ⇒ FwmgrApiValidateFilepathResponse

Validates that the test pattern matches the executable filepath glob pattern.

Parameters:

Returns:



2197
2198
2199
2200
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 2197

def validate_filepath_pattern(body, opts = {})
  data, _status_code, _headers = validate_filepath_pattern_with_http_info(body, opts)
  data
end

#validate_filepath_pattern_with_http_info(body, opts = {}) ⇒ Array<(FwmgrApiValidateFilepathResponse, Integer, Hash)>

Validates that the test pattern matches the executable filepath glob pattern.

Parameters:

Returns:



2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
 
# File 'lib/crimson-falcon/api/firewall_management_api.rb', line 2206

def validate_filepath_pattern_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FirewallManagementApi.validate_filepath_pattern ...'
  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 FirewallManagementApi.validate_filepath_pattern"
  end
  # resource path
  local_var_path = '/fwmgr/entities/rules/validate-filepath/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] || 'FwmgrApiValidateFilepathResponse'

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

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