Class: IbmCloudPower::PCloudVPNConnectionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PCloudVPNConnectionsApi

Returns a new instance of PCloudVPNConnectionsApi.



19
20
21
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_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/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#pcloud_vpnconnections_delete(cloud_instance_id, vpn_connection_id, opts = {}) ⇒ JobReference

Delete VPN Connection Delete VPN Connection (by its identifier)

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • vpn_connection_id (String) —

    ID of a VPN connection

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 28

def pcloud_vpnconnections_delete(cloud_instance_id, vpn_connection_id, opts = {})
  data, _status_code, _headers = pcloud_vpnconnections_delete_with_http_info(cloud_instance_id, vpn_connection_id, opts)
  data
end

#pcloud_vpnconnections_delete_with_http_info(cloud_instance_id, vpn_connection_id, opts = {}) ⇒ Array<(JobReference, Integer, Hash)>

Delete VPN Connection Delete VPN Connection (by its identifier)

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • vpn_connection_id (String) —

    ID of a VPN connection

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

    the optional parameters

Returns:

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

    JobReference data, response status code and response headers



39
40
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/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 39

def pcloud_vpnconnections_delete_with_http_info(cloud_instance_id, vpn_connection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVPNConnectionsApi.pcloud_vpnconnections_delete ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_delete"
  end
  # verify the required parameter 'vpn_connection_id' is set
  if @api_client.config.client_side_validation && vpn_connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'vpn_connection_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_delete"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}'.sub('{' + 'cloud_instance_id' + '}', CGI.escape(cloud_instance_id.to_s)).sub('{' + 'vpn_connection_id' + '}', CGI.escape(vpn_connection_id.to_s))

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

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

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

#pcloud_vpnconnections_get(cloud_instance_id, vpn_connection_id, opts = {}) ⇒ VPNConnection

Get VPN Connection Get a VPN Connection

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • vpn_connection_id (String) —

    ID of a VPN connection

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

    the optional parameters

Returns:



97
98
99
100
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 97

def pcloud_vpnconnections_get(cloud_instance_id, vpn_connection_id, opts = {})
  data, _status_code, _headers = pcloud_vpnconnections_get_with_http_info(cloud_instance_id, vpn_connection_id, opts)
  data
end

#pcloud_vpnconnections_get_with_http_info(cloud_instance_id, vpn_connection_id, opts = {}) ⇒ Array<(VPNConnection, Integer, Hash)>

Get VPN Connection Get a VPN Connection

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • vpn_connection_id (String) —

    ID of a VPN connection

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

    the optional parameters

Returns:

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

    VPNConnection data, response status code and response headers



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
158
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 108

def pcloud_vpnconnections_get_with_http_info(cloud_instance_id, vpn_connection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVPNConnectionsApi.pcloud_vpnconnections_get ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_get"
  end
  # verify the required parameter 'vpn_connection_id' is set
  if @api_client.config.client_side_validation && vpn_connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'vpn_connection_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_get"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}'.sub('{' + 'cloud_instance_id' + '}', CGI.escape(cloud_instance_id.to_s)).sub('{' + 'vpn_connection_id' + '}', CGI.escape(vpn_connection_id.to_s))

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

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

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

#pcloud_vpnconnections_getall(cloud_instance_id, opts = {}) ⇒ VPNConnections

Get all VPN Connections Get all VPN Connections

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

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

    the optional parameters

Returns:



165
166
167
168
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 165

def pcloud_vpnconnections_getall(cloud_instance_id, opts = {})
  data, _status_code, _headers = pcloud_vpnconnections_getall_with_http_info(cloud_instance_id, opts)
  data
end

#pcloud_vpnconnections_getall_with_http_info(cloud_instance_id, opts = {}) ⇒ Array<(VPNConnections, Integer, Hash)>

Get all VPN Connections Get all VPN Connections

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

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

    the optional parameters

Returns:

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

    VPNConnections data, response status code and response headers



175
176
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
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 175

def pcloud_vpnconnections_getall_with_http_info(cloud_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVPNConnectionsApi.pcloud_vpnconnections_getall ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_getall"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections'.sub('{' + 'cloud_instance_id' + '}', CGI.escape(cloud_instance_id.to_s))

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

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

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

#pcloud_vpnconnections_networks_delete(cloud_instance_id, vpn_connection_id, body, opts = {}) ⇒ JobReference

Detach network Detach network from a specific VPN Connection

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • vpn_connection_id (String) —

    ID of a VPN connection

  • body (NetworkID) —

    network to detach

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

    the optional parameters

Returns:



230
231
232
233
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 230

def pcloud_vpnconnections_networks_delete(cloud_instance_id, vpn_connection_id, body, opts = {})
  data, _status_code, _headers = pcloud_vpnconnections_networks_delete_with_http_info(cloud_instance_id, vpn_connection_id, body, opts)
  data
end

#pcloud_vpnconnections_networks_delete_with_http_info(cloud_instance_id, vpn_connection_id, body, opts = {}) ⇒ Array<(JobReference, Integer, Hash)>

Detach network Detach network from a specific VPN Connection

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • vpn_connection_id (String) —

    ID of a VPN connection

  • body (NetworkID) —

    network to detach

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

    the optional parameters

Returns:

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

    JobReference data, response status code and response headers



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
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 242

def pcloud_vpnconnections_networks_delete_with_http_info(cloud_instance_id, vpn_connection_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVPNConnectionsApi.pcloud_vpnconnections_networks_delete ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_networks_delete"
  end
  # verify the required parameter 'vpn_connection_id' is set
  if @api_client.config.client_side_validation && vpn_connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'vpn_connection_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_networks_delete"
  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 PCloudVPNConnectionsApi.pcloud_vpnconnections_networks_delete"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}/networks'.sub('{' + 'cloud_instance_id' + '}', CGI.escape(cloud_instance_id.to_s)).sub('{' + 'vpn_connection_id' + '}', CGI.escape(vpn_connection_id.to_s))

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

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

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

#pcloud_vpnconnections_networks_get(cloud_instance_id, vpn_connection_id, opts = {}) ⇒ NetworkIDs

Get attached networks Get a list of network IDs attached to a VPN Connection

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • vpn_connection_id (String) —

    ID of a VPN connection

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

    the optional parameters

Returns:



309
310
311
312
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 309

def pcloud_vpnconnections_networks_get(cloud_instance_id, vpn_connection_id, opts = {})
  data, _status_code, _headers = pcloud_vpnconnections_networks_get_with_http_info(cloud_instance_id, vpn_connection_id, opts)
  data
end

#pcloud_vpnconnections_networks_get_with_http_info(cloud_instance_id, vpn_connection_id, opts = {}) ⇒ Array<(NetworkIDs, Integer, Hash)>

Get attached networks Get a list of network IDs attached to a VPN Connection

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • vpn_connection_id (String) —

    ID of a VPN connection

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

    the optional parameters

Returns:

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

    NetworkIDs data, response status code and response headers



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
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 320

def pcloud_vpnconnections_networks_get_with_http_info(cloud_instance_id, vpn_connection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVPNConnectionsApi.pcloud_vpnconnections_networks_get ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_networks_get"
  end
  # verify the required parameter 'vpn_connection_id' is set
  if @api_client.config.client_side_validation && vpn_connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'vpn_connection_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_networks_get"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}/networks'.sub('{' + 'cloud_instance_id' + '}', CGI.escape(cloud_instance_id.to_s)).sub('{' + 'vpn_connection_id' + '}', CGI.escape(vpn_connection_id.to_s))

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

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

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

#pcloud_vpnconnections_networks_put(cloud_instance_id, vpn_connection_id, body, opts = {}) ⇒ JobReference

Attach network Attach a network to a VPN Connection

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • vpn_connection_id (String) —

    ID of a VPN connection

  • body (NetworkID) —

    network to attach

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

    the optional parameters

Returns:



379
380
381
382
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 379

def pcloud_vpnconnections_networks_put(cloud_instance_id, vpn_connection_id, body, opts = {})
  data, _status_code, _headers = pcloud_vpnconnections_networks_put_with_http_info(cloud_instance_id, vpn_connection_id, body, opts)
  data
end

#pcloud_vpnconnections_networks_put_with_http_info(cloud_instance_id, vpn_connection_id, body, opts = {}) ⇒ Array<(JobReference, Integer, Hash)>

Attach network Attach a network to a VPN Connection

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • vpn_connection_id (String) —

    ID of a VPN connection

  • body (NetworkID) —

    network to attach

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

    the optional parameters

Returns:

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

    JobReference data, response status code and response headers



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

def pcloud_vpnconnections_networks_put_with_http_info(cloud_instance_id, vpn_connection_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVPNConnectionsApi.pcloud_vpnconnections_networks_put ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_networks_put"
  end
  # verify the required parameter 'vpn_connection_id' is set
  if @api_client.config.client_side_validation && vpn_connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'vpn_connection_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_networks_put"
  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 PCloudVPNConnectionsApi.pcloud_vpnconnections_networks_put"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}/networks'.sub('{' + 'cloud_instance_id' + '}', CGI.escape(cloud_instance_id.to_s)).sub('{' + 'vpn_connection_id' + '}', CGI.escape(vpn_connection_id.to_s))

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

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

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

#pcloud_vpnconnections_peersubnets_delete(cloud_instance_id, vpn_connection_id, body, opts = {}) ⇒ PeerSubnets

Detach Peer Subnet Detach peer subnet from a VPN Connection

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • vpn_connection_id (String) —

    ID of a VPN connection

  • body (PeerSubnetUpdate) —

    Peer subnet to detach

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

    the optional parameters

Returns:



459
460
461
462
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 459

def pcloud_vpnconnections_peersubnets_delete(cloud_instance_id, vpn_connection_id, body, opts = {})
  data, _status_code, _headers = pcloud_vpnconnections_peersubnets_delete_with_http_info(cloud_instance_id, vpn_connection_id, body, opts)
  data
end

#pcloud_vpnconnections_peersubnets_delete_with_http_info(cloud_instance_id, vpn_connection_id, body, opts = {}) ⇒ Array<(PeerSubnets, Integer, Hash)>

Detach Peer Subnet Detach peer subnet from a VPN Connection

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • vpn_connection_id (String) —

    ID of a VPN connection

  • body (PeerSubnetUpdate) —

    Peer subnet to detach

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

    the optional parameters

Returns:

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

    PeerSubnets data, response status code and response headers



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 471

def pcloud_vpnconnections_peersubnets_delete_with_http_info(cloud_instance_id, vpn_connection_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVPNConnectionsApi.pcloud_vpnconnections_peersubnets_delete ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_peersubnets_delete"
  end
  # verify the required parameter 'vpn_connection_id' is set
  if @api_client.config.client_side_validation && vpn_connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'vpn_connection_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_peersubnets_delete"
  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 PCloudVPNConnectionsApi.pcloud_vpnconnections_peersubnets_delete"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}/peer-subnets'.sub('{' + 'cloud_instance_id' + '}', CGI.escape(cloud_instance_id.to_s)).sub('{' + 'vpn_connection_id' + '}', CGI.escape(vpn_connection_id.to_s))

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

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

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

#pcloud_vpnconnections_peersubnets_get(cloud_instance_id, vpn_connection_id, opts = {}) ⇒ PeerSubnets

Get Peer Subnets Get a list of peer subnets attached to a specific VPN Connection

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • vpn_connection_id (String) —

    ID of a VPN connection

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

    the optional parameters

Returns:



538
539
540
541
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 538

def pcloud_vpnconnections_peersubnets_get(cloud_instance_id, vpn_connection_id, opts = {})
  data, _status_code, _headers = pcloud_vpnconnections_peersubnets_get_with_http_info(cloud_instance_id, vpn_connection_id, opts)
  data
end

#pcloud_vpnconnections_peersubnets_get_with_http_info(cloud_instance_id, vpn_connection_id, opts = {}) ⇒ Array<(PeerSubnets, Integer, Hash)>

Get Peer Subnets Get a list of peer subnets attached to a specific VPN Connection

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • vpn_connection_id (String) —

    ID of a VPN connection

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

    the optional parameters

Returns:

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

    PeerSubnets data, response status code and response headers



549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 549

def pcloud_vpnconnections_peersubnets_get_with_http_info(cloud_instance_id, vpn_connection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVPNConnectionsApi.pcloud_vpnconnections_peersubnets_get ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_peersubnets_get"
  end
  # verify the required parameter 'vpn_connection_id' is set
  if @api_client.config.client_side_validation && vpn_connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'vpn_connection_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_peersubnets_get"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}/peer-subnets'.sub('{' + 'cloud_instance_id' + '}', CGI.escape(cloud_instance_id.to_s)).sub('{' + 'vpn_connection_id' + '}', CGI.escape(vpn_connection_id.to_s))

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

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

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

#pcloud_vpnconnections_peersubnets_put(cloud_instance_id, vpn_connection_id, body, opts = {}) ⇒ PeerSubnets

Attach Peer Subnet Attach peer subnet to a VPN Connection

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • vpn_connection_id (String) —

    ID of a VPN connection

  • body (PeerSubnetUpdate) —

    peer subnet to attach

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

    the optional parameters

Returns:



608
609
610
611
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 608

def pcloud_vpnconnections_peersubnets_put(cloud_instance_id, vpn_connection_id, body, opts = {})
  data, _status_code, _headers = pcloud_vpnconnections_peersubnets_put_with_http_info(cloud_instance_id, vpn_connection_id, body, opts)
  data
end

#pcloud_vpnconnections_peersubnets_put_with_http_info(cloud_instance_id, vpn_connection_id, body, opts = {}) ⇒ Array<(PeerSubnets, Integer, Hash)>

Attach Peer Subnet Attach peer subnet to a VPN Connection

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • vpn_connection_id (String) —

    ID of a VPN connection

  • body (PeerSubnetUpdate) —

    peer subnet to attach

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

    the optional parameters

Returns:

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

    PeerSubnets data, response status code and response headers



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
675
676
677
678
679
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 620

def pcloud_vpnconnections_peersubnets_put_with_http_info(cloud_instance_id, vpn_connection_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVPNConnectionsApi.pcloud_vpnconnections_peersubnets_put ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_peersubnets_put"
  end
  # verify the required parameter 'vpn_connection_id' is set
  if @api_client.config.client_side_validation && vpn_connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'vpn_connection_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_peersubnets_put"
  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 PCloudVPNConnectionsApi.pcloud_vpnconnections_peersubnets_put"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}/peer-subnets'.sub('{' + 'cloud_instance_id' + '}', CGI.escape(cloud_instance_id.to_s)).sub('{' + 'vpn_connection_id' + '}', CGI.escape(vpn_connection_id.to_s))

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

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

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

#pcloud_vpnconnections_post(cloud_instance_id, body, opts = {}) ⇒ VPNConnectionCreateResponse

Create VPN Connection Create a new VPN Connection

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • body (VPNConnectionCreate) —

    VPN Connection object used for creation

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

    the optional parameters

Returns:



687
688
689
690
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 687

def pcloud_vpnconnections_post(cloud_instance_id, body, opts = {})
  data, _status_code, _headers = pcloud_vpnconnections_post_with_http_info(cloud_instance_id, body, opts)
  data
end

#pcloud_vpnconnections_post_with_http_info(cloud_instance_id, body, opts = {}) ⇒ Array<(VPNConnectionCreateResponse, Integer, Hash)>

Create VPN Connection Create a new VPN Connection

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • body (VPNConnectionCreate) —

    VPN Connection object used for creation

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

    the optional parameters

Returns:

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

    VPNConnectionCreateResponse data, response status code and response headers



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

def pcloud_vpnconnections_post_with_http_info(cloud_instance_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVPNConnectionsApi.pcloud_vpnconnections_post ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_post"
  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 PCloudVPNConnectionsApi.pcloud_vpnconnections_post"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections'.sub('{' + 'cloud_instance_id' + '}', CGI.escape(cloud_instance_id.to_s))

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

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

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

#pcloud_vpnconnections_put(cloud_instance_id, vpn_connection_id, body, opts = {}) ⇒ VPNConnection

Update VPN Connection update a VPN Connection (by its identifier)

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • vpn_connection_id (String) —

    ID of a VPN connection

  • body (Hash<String, Object>) —

    VPN Connection object used for update

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

    the optional parameters

Returns:



762
763
764
765
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 762

def pcloud_vpnconnections_put(cloud_instance_id, vpn_connection_id, body, opts = {})
  data, _status_code, _headers = pcloud_vpnconnections_put_with_http_info(cloud_instance_id, vpn_connection_id, body, opts)
  data
end

#pcloud_vpnconnections_put_with_http_info(cloud_instance_id, vpn_connection_id, body, opts = {}) ⇒ Array<(VPNConnection, Integer, Hash)>

Update VPN Connection update a VPN Connection (by its identifier)

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • vpn_connection_id (String) —

    ID of a VPN connection

  • body (Hash<String, Object>) —

    VPN Connection object used for update

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

    the optional parameters

Returns:

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

    VPNConnection data, response status code and response headers



774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
 
# File 'lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb', line 774

def pcloud_vpnconnections_put_with_http_info(cloud_instance_id, vpn_connection_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVPNConnectionsApi.pcloud_vpnconnections_put ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_put"
  end
  # verify the required parameter 'vpn_connection_id' is set
  if @api_client.config.client_side_validation && vpn_connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'vpn_connection_id' when calling PCloudVPNConnectionsApi.pcloud_vpnconnections_put"
  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 PCloudVPNConnectionsApi.pcloud_vpnconnections_put"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}'.sub('{' + 'cloud_instance_id' + '}', CGI.escape(cloud_instance_id.to_s)).sub('{' + 'vpn_connection_id' + '}', CGI.escape(vpn_connection_id.to_s))

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

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

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