Class: DatadogAPIClient::V2::NetworkDeviceMonitoringAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/network_device_monitoring_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ NetworkDeviceMonitoringAPI 



22
23
24
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#get_device(device_id, opts = {}) ⇒ Object

Get the device details.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 29

def get_device(device_id, opts = {})
  data, _status_code, _headers = get_device_with_http_info(device_id, opts)
  data
end

#get_device_with_http_info(device_id, opts = {}) ⇒ Array<(GetDeviceResponse, Integer, Hash)>

Get the device details.

Get the device details.



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 41

def get_device_with_http_info(device_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkDeviceMonitoringAPI.get_device ...'
  end
  # verify the required parameter 'device_id' is set
  if @api_client.config.client_side_validation && device_id.nil?
    fail ArgumentError, "Missing the required parameter 'device_id' when calling NetworkDeviceMonitoringAPI.get_device"
  end
  # resource path
  local_var_path = '/api/v2/ndm/devices/{device_id}'.sub('{device_id}', CGI.escape(device_id.to_s).gsub('%2F', '/'))

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

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_device,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#get_interfaces(device_id, opts = {}) ⇒ Object

Get the list of interfaces of the device.

See Also:



94
95
96
97
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 94

def get_interfaces(device_id, opts = {})
  data, _status_code, _headers = get_interfaces_with_http_info(device_id, opts)
  data
end

#get_interfaces_with_http_info(device_id, opts = {}) ⇒ Array<(GetInterfacesResponse, Integer, Hash)>

Get the list of interfaces of the device.

Get the list of interfaces of the device.

Options Hash (opts):

  • :get_ip_addresses (Boolean) —

    Whether to get the IP addresses of the interfaces.



107
108
109
110
111
112
113
114
115
116
117
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
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 107

def get_interfaces_with_http_info(device_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkDeviceMonitoringAPI.get_interfaces ...'
  end
  # verify the required parameter 'device_id' is set
  if @api_client.config.client_side_validation && device_id.nil?
    fail ArgumentError, "Missing the required parameter 'device_id' when calling NetworkDeviceMonitoringAPI.get_interfaces"
  end
  # resource path
  local_var_path = '/api/v2/ndm/interfaces'

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_interfaces,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#list_device_user_tags(device_id, opts = {}) ⇒ Object

Get the list of tags for a device.

See Also:



252
253
254
255
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 252

def list_device_user_tags(device_id, opts = {})
  data, _status_code, _headers = list_device_user_tags_with_http_info(device_id, opts)
  data
end

#list_device_user_tags_with_http_info(device_id, opts = {}) ⇒ Array<(ListTagsResponse, Integer, Hash)>

Get the list of tags for a device.

Get the list of tags for a device.



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 264

def list_device_user_tags_with_http_info(device_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkDeviceMonitoringAPI.list_device_user_tags ...'
  end
  # verify the required parameter 'device_id' is set
  if @api_client.config.client_side_validation && device_id.nil?
    fail ArgumentError, "Missing the required parameter 'device_id' when calling NetworkDeviceMonitoringAPI.list_device_user_tags"
  end
  # resource path
  local_var_path = '/api/v2/ndm/tags/devices/{device_id}'.sub('{device_id}', CGI.escape(device_id.to_s).gsub('%2F', '/'))

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

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_device_user_tags,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#list_devices(opts = {}) ⇒ Object

Get the list of devices.

See Also:



162
163
164
165
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 162

def list_devices(opts = {})
  data, _status_code, _headers = list_devices_with_http_info(opts)
  data
end

#list_devices_with_http_info(opts = {}) ⇒ Array<(ListDevicesResponse, Integer, Hash)>

Get the list of devices.

Get the list of devices.

Options Hash (opts):

  • :page_size (Integer) —

    Size for a given page. The maximum allowed value is 500. Defaults to 50.

  • :page_number (Integer) —

    Specific page number to return. Defaults to 0.

  • :sort (String) —

    The field to sort the devices by. Defaults to name.

  • :filter_tag (String) —

    Filter devices by tag.



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

def list_devices_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkDeviceMonitoringAPI.list_devices ...'
  end
  # resource path
  local_var_path = '/api/v2/ndm/devices'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'filter[tag]'] = opts[:'filter_tag'] if !opts[:'filter_tag'].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] || 'ListDevicesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_devices,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#list_devices_with_pagination(opts = {}) {|DevicesListData| ... } ⇒ Object

Get the list of devices.

Provide a paginated version of #list_devices, returning all items.

To use it you need to use a block: list_devices_with_pagination { |item| p item }

Yields:



234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 234

def list_devices_with_pagination(opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(opts, "page_size", 50)
    @api_client.set_attribute_from_path(api_version, opts, "page_size", Integer, page_size)
    @api_client.set_attribute_from_path(api_version, opts, "page_number", Integer, 0)
    while true do
        response = list_devices(opts)
        @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "data").length < page_size
          break
        end
        @api_client.set_attribute_from_path(api_version, opts, "page_number", Integer, @api_client.get_attribute_from_path(opts, "page_number", 0) + 1)
    end
end

#list_interface_user_tags(interface_id, opts = {}) ⇒ Object

List tags for an interface.

See Also:



317
318
319
320
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 317

def list_interface_user_tags(interface_id, opts = {})
  data, _status_code, _headers = list_interface_user_tags_with_http_info(interface_id, opts)
  data
end

#list_interface_user_tags_with_http_info(interface_id, opts = {}) ⇒ Array<(ListInterfaceTagsResponse, Integer, Hash)>

List tags for an interface.

Returns the tags associated with the specified interface.



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
377
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 329

def list_interface_user_tags_with_http_info(interface_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkDeviceMonitoringAPI.list_interface_user_tags ...'
  end
  # verify the required parameter 'interface_id' is set
  if @api_client.config.client_side_validation && interface_id.nil?
    fail ArgumentError, "Missing the required parameter 'interface_id' when calling NetworkDeviceMonitoringAPI.list_interface_user_tags"
  end
  # resource path
  local_var_path = '/api/v2/ndm/tags/interfaces/{interface_id}'.sub('{interface_id}', CGI.escape(interface_id.to_s).gsub('%2F', '/'))

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

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_interface_user_tags,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#update_device_user_tags(device_id, body, opts = {}) ⇒ Object

Update the tags for a device.

See Also:



382
383
384
385
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 382

def update_device_user_tags(device_id, body, opts = {})
  data, _status_code, _headers = update_device_user_tags_with_http_info(device_id, body, opts)
  data
end

#update_device_user_tags_with_http_info(device_id, body, opts = {}) ⇒ Array<(ListTagsResponse, Integer, Hash)>

Update the tags for a device.

Update the tags for a device.



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

def update_device_user_tags_with_http_info(device_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkDeviceMonitoringAPI.update_device_user_tags ...'
  end
  # verify the required parameter 'device_id' is set
  if @api_client.config.client_side_validation && device_id.nil?
    fail ArgumentError, "Missing the required parameter 'device_id' when calling NetworkDeviceMonitoringAPI.update_device_user_tags"
  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 NetworkDeviceMonitoringAPI.update_device_user_tags"
  end
  # resource path
  local_var_path = '/api/v2/ndm/tags/devices/{device_id}'.sub('{device_id}', CGI.escape(device_id.to_s).gsub('%2F', '/'))

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_device_user_tags,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#update_interface_user_tags(interface_id, body, opts = {}) ⇒ Object

Update the tags for an interface.

See Also:



454
455
456
457
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 454

def update_interface_user_tags(interface_id, body, opts = {})
  data, _status_code, _headers = update_interface_user_tags_with_http_info(interface_id, body, opts)
  data
end

#update_interface_user_tags_with_http_info(interface_id, body, opts = {}) ⇒ Array<(ListInterfaceTagsResponse, Integer, Hash)>

Update the tags for an interface.

Updates the tags associated with the specified interface.



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 467

def update_interface_user_tags_with_http_info(interface_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkDeviceMonitoringAPI.update_interface_user_tags ...'
  end
  # verify the required parameter 'interface_id' is set
  if @api_client.config.client_side_validation && interface_id.nil?
    fail ArgumentError, "Missing the required parameter 'interface_id' when calling NetworkDeviceMonitoringAPI.update_interface_user_tags"
  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 NetworkDeviceMonitoringAPI.update_interface_user_tags"
  end
  # resource path
  local_var_path = '/api/v2/ndm/tags/interfaces/{interface_id}'.sub('{interface_id}', CGI.escape(interface_id.to_s).gsub('%2F', '/'))

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_interface_user_tags,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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