Class: Ionoscloud::LanApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ionoscloud/api/lan_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LanApi

Returns a new instance of LanApi.



19
20
21
 
# File 'lib/ionoscloud/api/lan_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/ionoscloud/api/lan_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#datacenters_lans_delete(datacenter_id, lan_id, opts = {}) ⇒ Object

Delete a Lan. Removes the specific Lan

Parameters:

  • datacenter_id (String) —

    The unique ID of the datacenter

  • lan_id (String) —

    The unique ID of the LAN

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines) (default to true)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:

  • (Object) 


31
32
33
34
 
# File 'lib/ionoscloud/api/lan_api.rb', line 31

def datacenters_lans_delete(datacenter_id, lan_id, opts = {})
  data, _status_code, _headers = datacenters_lans_delete_with_http_info(datacenter_id, lan_id, opts)
  data
end

#datacenters_lans_delete_with_http_info(datacenter_id, lan_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete a Lan. Removes the specific Lan

Parameters:

  • datacenter_id (String) —

    The unique ID of the datacenter

  • lan_id (String) —

    The unique ID of the LAN

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:

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

    Object data, response status code and response headers



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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/ionoscloud/api/lan_api.rb', line 45

def datacenters_lans_delete_with_http_info(datacenter_id, lan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LanApi.datacenters_lans_delete ...'
  end
  # verify the required parameter 'datacenter_id' is set
  if @api_client.config.client_side_validation && datacenter_id.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LanApi.datacenters_lans_delete"
  end
  # verify the required parameter 'lan_id' is set
  if @api_client.config.client_side_validation && lan_id.nil?
    fail ArgumentError, "Missing the required parameter 'lan_id' when calling LanApi.datacenters_lans_delete"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_delete, must be smaller than or equal to 10.'
  end

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

  # resource path
  local_var_path = '/datacenters/{datacenterId}/lans/{lanId}'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'lanId' + '}', CGI.escape(lan_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

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

#datacenters_lans_find_by_id(datacenter_id, lan_id, opts = {}) ⇒ Lan

Retrieve a Lan Retrieves the attributes of a given LAN

Parameters:

  • datacenter_id (String) —

    The unique ID of the datacenter

  • lan_id (String) —

    The unique ID of the LAN

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines) (default to true)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:



117
118
119
120
 
# File 'lib/ionoscloud/api/lan_api.rb', line 117

def datacenters_lans_find_by_id(datacenter_id, lan_id, opts = {})
  data, _status_code, _headers = datacenters_lans_find_by_id_with_http_info(datacenter_id, lan_id, opts)
  data
end

#datacenters_lans_find_by_id_with_http_info(datacenter_id, lan_id, opts = {}) ⇒ Array<(Lan, Integer, Hash)>

Retrieve a Lan Retrieves the attributes of a given LAN

Parameters:

  • datacenter_id (String) —

    The unique ID of the datacenter

  • lan_id (String) —

    The unique ID of the LAN

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:

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

    Lan data, response status code and response headers



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/ionoscloud/api/lan_api.rb', line 131

def datacenters_lans_find_by_id_with_http_info(datacenter_id, lan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LanApi.datacenters_lans_find_by_id ...'
  end
  # verify the required parameter 'datacenter_id' is set
  if @api_client.config.client_side_validation && datacenter_id.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LanApi.datacenters_lans_find_by_id"
  end
  # verify the required parameter 'lan_id' is set
  if @api_client.config.client_side_validation && lan_id.nil?
    fail ArgumentError, "Missing the required parameter 'lan_id' when calling LanApi.datacenters_lans_find_by_id"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_find_by_id, must be smaller than or equal to 10.'
  end

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

  # resource path
  local_var_path = '/datacenters/{datacenterId}/lans/{lanId}'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'lanId' + '}', CGI.escape(lan_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

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

#datacenters_lans_get(datacenter_id, opts = {}) ⇒ Lans

List Lans Retrieve a list of LANs within the datacenter

Parameters:

  • datacenter_id (String) —

    The unique ID of the datacenter

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines) (default to true)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

  • :offset (Integer) —

    the first element (of the total list of elements) to include in the response (use together with &lt;code&gt;limit&lt;/code&gt; for pagination) (default to 0)

  • :limit (Integer) —

    the maximum number of elements to return (use together with &lt;code&gt;offset&lt;/code&gt; for pagination) (default to 1000)

Returns:



204
205
206
207
 
# File 'lib/ionoscloud/api/lan_api.rb', line 204

def datacenters_lans_get(datacenter_id, opts = {})
  data, _status_code, _headers = datacenters_lans_get_with_http_info(datacenter_id, opts)
  data
end

#datacenters_lans_get_with_http_info(datacenter_id, opts = {}) ⇒ Array<(Lans, Integer, Hash)>

List Lans Retrieve a list of LANs within the datacenter

Parameters:

  • datacenter_id (String) —

    The unique ID of the datacenter

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

  • :offset (Integer) —

    the first element (of the total list of elements) to include in the response (use together with &lt;code&gt;limit&lt;/code&gt; for pagination)

  • :limit (Integer) —

    the maximum number of elements to return (use together with &lt;code&gt;offset&lt;/code&gt; for pagination)

Returns:

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

    Lans data, response status code and response headers



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
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
 
# File 'lib/ionoscloud/api/lan_api.rb', line 219

def datacenters_lans_get_with_http_info(datacenter_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LanApi.datacenters_lans_get ...'
  end
  # verify the required parameter 'datacenter_id' is set
  if @api_client.config.client_side_validation && datacenter_id.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LanApi.datacenters_lans_get"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_get, must be smaller than or equal to 10.'
  end

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

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

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

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

  # resource path
  local_var_path = '/datacenters/{datacenterId}/lans'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].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'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

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

#datacenters_lans_nics_find_by_id(datacenter_id, lan_id, nic_id, opts = {}) ⇒ Nic

Retrieve a nic attached to lan This will retrieve the properties of an attached nic.

Parameters:

  • datacenter_id (String) —

    The unique ID of the datacenter

  • lan_id (String) —

    The unique ID of the LAN

  • nic_id (String) —

    The unique ID of the NIC

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines) (default to true)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:



302
303
304
305
 
# File 'lib/ionoscloud/api/lan_api.rb', line 302

def datacenters_lans_nics_find_by_id(datacenter_id, lan_id, nic_id, opts = {})
  data, _status_code, _headers = datacenters_lans_nics_find_by_id_with_http_info(datacenter_id, lan_id, nic_id, opts)
  data
end

#datacenters_lans_nics_find_by_id_with_http_info(datacenter_id, lan_id, nic_id, opts = {}) ⇒ Array<(Nic, Integer, Hash)>

Retrieve a nic attached to lan This will retrieve the properties of an attached nic.

Parameters:

  • datacenter_id (String) —

    The unique ID of the datacenter

  • lan_id (String) —

    The unique ID of the LAN

  • nic_id (String) —

    The unique ID of the NIC

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:

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

    Nic data, response status code and response headers



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/ionoscloud/api/lan_api.rb', line 317

def datacenters_lans_nics_find_by_id_with_http_info(datacenter_id, lan_id, nic_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LanApi.datacenters_lans_nics_find_by_id ...'
  end
  # verify the required parameter 'datacenter_id' is set
  if @api_client.config.client_side_validation && datacenter_id.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LanApi.datacenters_lans_nics_find_by_id"
  end
  # verify the required parameter 'lan_id' is set
  if @api_client.config.client_side_validation && lan_id.nil?
    fail ArgumentError, "Missing the required parameter 'lan_id' when calling LanApi.datacenters_lans_nics_find_by_id"
  end
  # verify the required parameter 'nic_id' is set
  if @api_client.config.client_side_validation && nic_id.nil?
    fail ArgumentError, "Missing the required parameter 'nic_id' when calling LanApi.datacenters_lans_nics_find_by_id"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_nics_find_by_id, must be smaller than or equal to 10.'
  end

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

  # resource path
  local_var_path = '/datacenters/{datacenterId}/lans/{lanId}/nics/{nicId}'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'lanId' + '}', CGI.escape(lan_id.to_s)).sub('{' + 'nicId' + '}', CGI.escape(nic_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

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

#datacenters_lans_nics_get(datacenter_id, lan_id, opts = {}) ⇒ LanNics

List Lan Members You can retrieve a list of nics attached to a lan

Parameters:

  • datacenter_id (String) —

    The unique ID of the datacenter

  • lan_id (String) —

    The unique ID of the LAN

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines) (default to true)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

  • :offset (Integer) —

    the first element (of the total list of elements) to include in the response (use together with &lt;code&gt;limit&lt;/code&gt; for pagination) (default to 0)

  • :limit (Integer) —

    the maximum number of elements to return (use together with &lt;code&gt;offset&lt;/code&gt; for pagination) (default to 1000)

Returns:



395
396
397
398
 
# File 'lib/ionoscloud/api/lan_api.rb', line 395

def datacenters_lans_nics_get(datacenter_id, lan_id, opts = {})
  data, _status_code, _headers = datacenters_lans_nics_get_with_http_info(datacenter_id, lan_id, opts)
  data
end

#datacenters_lans_nics_get_with_http_info(datacenter_id, lan_id, opts = {}) ⇒ Array<(LanNics, Integer, Hash)>

List Lan Members You can retrieve a list of nics attached to a lan

Parameters:

  • datacenter_id (String) —

    The unique ID of the datacenter

  • lan_id (String) —

    The unique ID of the LAN

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

  • :offset (Integer) —

    the first element (of the total list of elements) to include in the response (use together with &lt;code&gt;limit&lt;/code&gt; for pagination)

  • :limit (Integer) —

    the maximum number of elements to return (use together with &lt;code&gt;offset&lt;/code&gt; for pagination)

Returns:

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

    LanNics data, response status code and response headers



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
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/ionoscloud/api/lan_api.rb', line 411

def datacenters_lans_nics_get_with_http_info(datacenter_id, lan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LanApi.datacenters_lans_nics_get ...'
  end
  # verify the required parameter 'datacenter_id' is set
  if @api_client.config.client_side_validation && datacenter_id.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LanApi.datacenters_lans_nics_get"
  end
  # verify the required parameter 'lan_id' is set
  if @api_client.config.client_side_validation && lan_id.nil?
    fail ArgumentError, "Missing the required parameter 'lan_id' when calling LanApi.datacenters_lans_nics_get"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_nics_get, must be smaller than or equal to 10.'
  end

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

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

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

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

  # resource path
  local_var_path = '/datacenters/{datacenterId}/lans/{lanId}/nics'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'lanId' + '}', CGI.escape(lan_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].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'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

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

#datacenters_lans_nics_post(datacenter_id, lan_id, nic, opts = {}) ⇒ Nic

Attach a nic This will attach a pre-existing nic to a lan.

Parameters:

  • datacenter_id (String) —

    The unique ID of the datacenter

  • lan_id (String) —

    The unique ID of the LAN

  • nic (Nic) —

    Nic to be attached

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines) (default to true)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:



498
499
500
501
 
# File 'lib/ionoscloud/api/lan_api.rb', line 498

def datacenters_lans_nics_post(datacenter_id, lan_id, nic, opts = {})
  data, _status_code, _headers = datacenters_lans_nics_post_with_http_info(datacenter_id, lan_id, nic, opts)
  data
end

#datacenters_lans_nics_post_with_http_info(datacenter_id, lan_id, nic, opts = {}) ⇒ Array<(Nic, Integer, Hash)>

Attach a nic This will attach a pre-existing nic to a lan.

Parameters:

  • datacenter_id (String) —

    The unique ID of the datacenter

  • lan_id (String) —

    The unique ID of the LAN

  • nic (Nic) —

    Nic to be attached

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:

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

    Nic data, response status code and response headers



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/ionoscloud/api/lan_api.rb', line 513

def datacenters_lans_nics_post_with_http_info(datacenter_id, lan_id, nic, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LanApi.datacenters_lans_nics_post ...'
  end
  # verify the required parameter 'datacenter_id' is set
  if @api_client.config.client_side_validation && datacenter_id.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LanApi.datacenters_lans_nics_post"
  end
  # verify the required parameter 'lan_id' is set
  if @api_client.config.client_side_validation && lan_id.nil?
    fail ArgumentError, "Missing the required parameter 'lan_id' when calling LanApi.datacenters_lans_nics_post"
  end
  # verify the required parameter 'nic' is set
  if @api_client.config.client_side_validation && nic.nil?
    fail ArgumentError, "Missing the required parameter 'nic' when calling LanApi.datacenters_lans_nics_post"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_nics_post, must be smaller than or equal to 10.'
  end

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

  # resource path
  local_var_path = '/datacenters/{datacenterId}/lans/{lanId}/nics'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'lanId' + '}', CGI.escape(lan_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

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

#datacenters_lans_patch(datacenter_id, lan_id, lan, opts = {}) ⇒ Lan

Partially modify a Lan You can use update attributes of a resource

Parameters:

  • datacenter_id (String) —

    The unique ID of the datacenter

  • lan_id (String) —

    The unique ID of the LAN

  • lan (LanProperties) —

    Modified Lan

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines) (default to true)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:



592
593
594
595
 
# File 'lib/ionoscloud/api/lan_api.rb', line 592

def datacenters_lans_patch(datacenter_id, lan_id, lan, opts = {})
  data, _status_code, _headers = datacenters_lans_patch_with_http_info(datacenter_id, lan_id, lan, opts)
  data
end

#datacenters_lans_patch_with_http_info(datacenter_id, lan_id, lan, opts = {}) ⇒ Array<(Lan, Integer, Hash)>

Partially modify a Lan You can use update attributes of a resource

Parameters:

  • datacenter_id (String) —

    The unique ID of the datacenter

  • lan_id (String) —

    The unique ID of the LAN

  • lan (LanProperties) —

    Modified Lan

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:

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

    Lan data, response status code and response headers



607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
 
# File 'lib/ionoscloud/api/lan_api.rb', line 607

def datacenters_lans_patch_with_http_info(datacenter_id, lan_id, lan, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LanApi.datacenters_lans_patch ...'
  end
  # verify the required parameter 'datacenter_id' is set
  if @api_client.config.client_side_validation && datacenter_id.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LanApi.datacenters_lans_patch"
  end
  # verify the required parameter 'lan_id' is set
  if @api_client.config.client_side_validation && lan_id.nil?
    fail ArgumentError, "Missing the required parameter 'lan_id' when calling LanApi.datacenters_lans_patch"
  end
  # verify the required parameter 'lan' is set
  if @api_client.config.client_side_validation && lan.nil?
    fail ArgumentError, "Missing the required parameter 'lan' when calling LanApi.datacenters_lans_patch"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_patch, must be smaller than or equal to 10.'
  end

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

  # resource path
  local_var_path = '/datacenters/{datacenterId}/lans/{lanId}'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'lanId' + '}', CGI.escape(lan_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

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

#datacenters_lans_post(datacenter_id, lan, opts = {}) ⇒ LanPost

Create a Lan Creates a LAN within the datacenter

Parameters:

  • datacenter_id (String) —

    The unique ID of the datacenter

  • lan (LanPost) —

    Lan to be created

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines) (default to true)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:



685
686
687
688
 
# File 'lib/ionoscloud/api/lan_api.rb', line 685

def datacenters_lans_post(datacenter_id, lan, opts = {})
  data, _status_code, _headers = datacenters_lans_post_with_http_info(datacenter_id, lan, opts)
  data
end

#datacenters_lans_post_with_http_info(datacenter_id, lan, opts = {}) ⇒ Array<(LanPost, Integer, Hash)>

Create a Lan Creates a LAN within the datacenter

Parameters:

  • datacenter_id (String) —

    The unique ID of the datacenter

  • lan (LanPost) —

    Lan to be created

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:

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

    LanPost data, response status code and response headers



699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
 
# File 'lib/ionoscloud/api/lan_api.rb', line 699

def datacenters_lans_post_with_http_info(datacenter_id, lan, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LanApi.datacenters_lans_post ...'
  end
  # verify the required parameter 'datacenter_id' is set
  if @api_client.config.client_side_validation && datacenter_id.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LanApi.datacenters_lans_post"
  end
  # verify the required parameter 'lan' is set
  if @api_client.config.client_side_validation && lan.nil?
    fail ArgumentError, "Missing the required parameter 'lan' when calling LanApi.datacenters_lans_post"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_post, must be smaller than or equal to 10.'
  end

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

  # resource path
  local_var_path = '/datacenters/{datacenterId}/lans'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

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

#datacenters_lans_put(datacenter_id, lan_id, lan, opts = {}) ⇒ Lan

Modify a Lan You can use update attributes of a resource

Parameters:

  • datacenter_id (String) —

    The unique ID of the datacenter

  • lan_id (String) —

    The unique ID of the LAN

  • lan (Lan) —

    Modified Lan

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines) (default to true)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:



774
775
776
777
 
# File 'lib/ionoscloud/api/lan_api.rb', line 774

def datacenters_lans_put(datacenter_id, lan_id, lan, opts = {})
  data, _status_code, _headers = datacenters_lans_put_with_http_info(datacenter_id, lan_id, lan, opts)
  data
end

#datacenters_lans_put_with_http_info(datacenter_id, lan_id, lan, opts = {}) ⇒ Array<(Lan, Integer, Hash)>

Modify a Lan You can use update attributes of a resource

Parameters:

  • datacenter_id (String) —

    The unique ID of the datacenter

  • lan_id (String) —

    The unique ID of the LAN

  • lan (Lan) —

    Modified Lan

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:

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

    Lan data, response status code and response headers



789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
 
# File 'lib/ionoscloud/api/lan_api.rb', line 789

def datacenters_lans_put_with_http_info(datacenter_id, lan_id, lan, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LanApi.datacenters_lans_put ...'
  end
  # verify the required parameter 'datacenter_id' is set
  if @api_client.config.client_side_validation && datacenter_id.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LanApi.datacenters_lans_put"
  end
  # verify the required parameter 'lan_id' is set
  if @api_client.config.client_side_validation && lan_id.nil?
    fail ArgumentError, "Missing the required parameter 'lan_id' when calling LanApi.datacenters_lans_put"
  end
  # verify the required parameter 'lan' is set
  if @api_client.config.client_side_validation && lan.nil?
    fail ArgumentError, "Missing the required parameter 'lan' when calling LanApi.datacenters_lans_put"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_put, must be smaller than or equal to 10.'
  end

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

  # resource path
  local_var_path = '/datacenters/{datacenterId}/lans/{lanId}'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'lanId' + '}', CGI.escape(lan_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

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