Class: IbmCloudPower::PCloudPVMInstancesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PCloudPVMInstancesApi

Returns a new instance of PCloudPVMInstancesApi.



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

def api_client
  @api_client
end

Instance Method Details

#pcloud_pvminstances_action_post(cloud_instance_id, pvm_instance_id, body, opts = {}) ⇒ Object

Perform an action on a PVMInstance Corresponding actions are 'start', 'stop', 'reboot', 'immediate-shutdown', 'reset'

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (PVMInstanceAction) —

    Parameters for the desired action

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

    the optional parameters

Returns:

  • (Object) 


29
30
31
32
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 29

def pcloud_pvminstances_action_post(cloud_instance_id, pvm_instance_id, body, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_action_post_with_http_info(cloud_instance_id, pvm_instance_id, body, opts)
  data
end

#pcloud_pvminstances_action_post_with_http_info(cloud_instance_id, pvm_instance_id, body, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Perform an action on a PVMInstance Corresponding actions are 'start', 'stop', 'reboot', 'immediate-shutdown', 'reset'

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (PVMInstanceAction) —

    Parameters for the desired action

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 41

def pcloud_pvminstances_action_post_with_http_info(cloud_instance_id, pvm_instance_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_pvminstances_action_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 PCloudPVMInstancesApi.pcloud_pvminstances_action_post"
  end
  # verify the required parameter 'pvm_instance_id' is set
  if @api_client.config.client_side_validation && pvm_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'pvm_instance_id' when calling PCloudPVMInstancesApi.pcloud_pvminstances_action_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 PCloudPVMInstancesApi.pcloud_pvminstances_action_post"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/action'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{pvm_instance_id}', CGI.escape(pvm_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']) unless header_params['Accept']
  # 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] || 'Object'

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

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

#pcloud_pvminstances_capture_post(cloud_instance_id, pvm_instance_id, body, opts = {}) ⇒ Object

Capture a PVMInstance and create a deployable image This API is deprecated for /pcloud/v2/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/capture. >Note: Support for this API is available till Oct 2022.

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (PVMInstanceCapture) —

    Parameters for the capture PVMInstance

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

    the optional parameters

Returns:

  • (Object) 


109
110
111
112
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 109

def pcloud_pvminstances_capture_post(cloud_instance_id, pvm_instance_id, body, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_capture_post_with_http_info(cloud_instance_id, pvm_instance_id, body, opts)
  data
end

#pcloud_pvminstances_capture_post_with_http_info(cloud_instance_id, pvm_instance_id, body, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Capture a PVMInstance and create a deployable image This API is deprecated for /pcloud/v2/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/capture. >Note: Support for this API is available till Oct 2022.

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (PVMInstanceCapture) —

    Parameters for the capture PVMInstance

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 121

def pcloud_pvminstances_capture_post_with_http_info(cloud_instance_id, pvm_instance_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_pvminstances_capture_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 PCloudPVMInstancesApi.pcloud_pvminstances_capture_post"
  end
  # verify the required parameter 'pvm_instance_id' is set
  if @api_client.config.client_side_validation && pvm_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'pvm_instance_id' when calling PCloudPVMInstancesApi.pcloud_pvminstances_capture_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 PCloudPVMInstancesApi.pcloud_pvminstances_capture_post"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/capture'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{pvm_instance_id}', CGI.escape(pvm_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']) unless header_params['Accept']
  # 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] || 'Object'

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

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

#pcloud_pvminstances_console_get(cloud_instance_id, pvm_instance_id, opts = {}) ⇒ ConsoleLanguages

List all console languages

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

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

    the optional parameters

Returns:



187
188
189
190
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 187

def pcloud_pvminstances_console_get(cloud_instance_id, pvm_instance_id, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_console_get_with_http_info(cloud_instance_id, pvm_instance_id, opts)
  data
end

#pcloud_pvminstances_console_get_with_http_info(cloud_instance_id, pvm_instance_id, opts = {}) ⇒ Array<(ConsoleLanguages, Integer, Hash)>

List all console languages

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

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

    the optional parameters

Returns:

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

    ConsoleLanguages data, response status code and response headers



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 197

def pcloud_pvminstances_console_get_with_http_info(cloud_instance_id, pvm_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_pvminstances_console_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 PCloudPVMInstancesApi.pcloud_pvminstances_console_get"
  end
  # verify the required parameter 'pvm_instance_id' is set
  if @api_client.config.client_side_validation && pvm_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'pvm_instance_id' when calling PCloudPVMInstancesApi.pcloud_pvminstances_console_get"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/console'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{pvm_instance_id}', CGI.escape(pvm_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']) unless header_params['Accept']

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

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

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

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

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

#pcloud_pvminstances_console_post(cloud_instance_id, pvm_instance_id, opts = {}) ⇒ PVMInstanceConsole

Generate the noVNC Console URL

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

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

    the optional parameters

Returns:



254
255
256
257
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 254

def pcloud_pvminstances_console_post(cloud_instance_id, pvm_instance_id, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_console_post_with_http_info(cloud_instance_id, pvm_instance_id, opts)
  data
end

#pcloud_pvminstances_console_post_with_http_info(cloud_instance_id, pvm_instance_id, opts = {}) ⇒ Array<(PVMInstanceConsole, Integer, Hash)>

Generate the noVNC Console URL

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

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

    the optional parameters

Returns:

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

    PVMInstanceConsole data, response status code and response headers



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

def pcloud_pvminstances_console_post_with_http_info(cloud_instance_id, pvm_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_pvminstances_console_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 PCloudPVMInstancesApi.pcloud_pvminstances_console_post"
  end
  # verify the required parameter 'pvm_instance_id' is set
  if @api_client.config.client_side_validation && pvm_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'pvm_instance_id' when calling PCloudPVMInstancesApi.pcloud_pvminstances_console_post"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/console'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{pvm_instance_id}', CGI.escape(pvm_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']) unless header_params['Accept']

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

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

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

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

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

#pcloud_pvminstances_console_put(cloud_instance_id, pvm_instance_id, body, opts = {}) ⇒ ConsoleLanguage

Update PVMInstance console language code

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (ConsoleLanguage) —

    Parameters to update a PVMInstance console required codepage

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

    the optional parameters

Returns:



322
323
324
325
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 322

def pcloud_pvminstances_console_put(cloud_instance_id, pvm_instance_id, body, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_console_put_with_http_info(cloud_instance_id, pvm_instance_id, body, opts)
  data
end

#pcloud_pvminstances_console_put_with_http_info(cloud_instance_id, pvm_instance_id, body, opts = {}) ⇒ Array<(ConsoleLanguage, Integer, Hash)>

Update PVMInstance console language code

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (ConsoleLanguage) —

    Parameters to update a PVMInstance console required codepage

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

    the optional parameters

Returns:

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

    ConsoleLanguage data, response status code and response headers



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
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 333

def pcloud_pvminstances_console_put_with_http_info(cloud_instance_id, pvm_instance_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_pvminstances_console_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 PCloudPVMInstancesApi.pcloud_pvminstances_console_put"
  end
  # verify the required parameter 'pvm_instance_id' is set
  if @api_client.config.client_side_validation && pvm_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'pvm_instance_id' when calling PCloudPVMInstancesApi.pcloud_pvminstances_console_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 PCloudPVMInstancesApi.pcloud_pvminstances_console_put"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/console'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{pvm_instance_id}', CGI.escape(pvm_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']) unless header_params['Accept']
  # 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] || 'ConsoleLanguage'

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

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

#pcloud_pvminstances_delete(cloud_instance_id, pvm_instance_id, opts = {}) ⇒ Object

Delete a PCloud PVM Instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

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

    the optional parameters

Options Hash (opts):

  • :delete_data_volumes (Boolean) —

    Indicates if all data volumes attached to the PVMInstance should be deleted when deleting the PVMInstance. Shared data volumes will be deleted if there are no other PVMInstances attached.

  • :body (PVMInstanceDelete) —

    Parameters to delete a PVM Instance

Returns:

  • (Object) 


401
402
403
404
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 401

def pcloud_pvminstances_delete(cloud_instance_id, pvm_instance_id, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_delete_with_http_info(cloud_instance_id, pvm_instance_id, opts)
  data
end

#pcloud_pvminstances_delete_with_http_info(cloud_instance_id, pvm_instance_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete a PCloud PVM Instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

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

    the optional parameters

Options Hash (opts):

  • :delete_data_volumes (Boolean) —

    Indicates if all data volumes attached to the PVMInstance should be deleted when deleting the PVMInstance. Shared data volumes will be deleted if there are no other PVMInstances attached.

  • :body (PVMInstanceDelete) —

    Parameters to delete a PVM Instance

Returns:

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

    Object data, response status code and response headers



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

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(opts[:'body'])

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

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

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

#pcloud_pvminstances_get(cloud_instance_id, pvm_instance_id, opts = {}) ⇒ PVMInstance

Get a PVM Instance's current state or information

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

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

    the optional parameters

Returns:



476
477
478
479
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 476

def pcloud_pvminstances_get(cloud_instance_id, pvm_instance_id, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_get_with_http_info(cloud_instance_id, pvm_instance_id, opts)
  data
end

#pcloud_pvminstances_get_with_http_info(cloud_instance_id, pvm_instance_id, opts = {}) ⇒ Array<(PVMInstance, Integer, Hash)>

Get a PVM Instance's current state or information

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

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

    the optional parameters

Returns:

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

    PVMInstance data, response status code and response headers



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
531
532
533
534
535
536
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 486

def pcloud_pvminstances_get_with_http_info(cloud_instance_id, pvm_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_pvminstances_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 PCloudPVMInstancesApi.pcloud_pvminstances_get"
  end
  # verify the required parameter 'pvm_instance_id' is set
  if @api_client.config.client_side_validation && pvm_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'pvm_instance_id' when calling PCloudPVMInstancesApi.pcloud_pvminstances_get"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{pvm_instance_id}', CGI.escape(pvm_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']) unless header_params['Accept']

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

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

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

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

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

#pcloud_pvminstances_getall(cloud_instance_id, opts = {}) ⇒ PVMInstances

Get all the pvm instances for this cloud instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

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

    the optional parameters

Returns:



542
543
544
545
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 542

def pcloud_pvminstances_getall(cloud_instance_id, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_getall_with_http_info(cloud_instance_id, opts)
  data
end

#pcloud_pvminstances_getall_with_http_info(cloud_instance_id, opts = {}) ⇒ Array<(PVMInstances, Integer, Hash)>

Get all the pvm instances for this cloud instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

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

    the optional parameters

Returns:

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

    PVMInstances data, response status code and response headers



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

def pcloud_pvminstances_getall_with_http_info(cloud_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_pvminstances_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 PCloudPVMInstancesApi.pcloud_pvminstances_getall"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances'.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']) unless header_params['Accept']

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

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

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

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

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

#pcloud_pvminstances_networks_delete(cloud_instance_id, pvm_instance_id, network_id, opts = {}) ⇒ Object

Remove all Address of Network from a PVM Instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • network_id (String) —

    Network ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Object) 


606
607
608
609
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 606

def pcloud_pvminstances_networks_delete(cloud_instance_id, pvm_instance_id, network_id, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_networks_delete_with_http_info(cloud_instance_id, pvm_instance_id, network_id, opts)
  data
end

#pcloud_pvminstances_networks_delete_with_http_info(cloud_instance_id, pvm_instance_id, network_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Remove all Address of Network from a PVM Instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • network_id (String) —

    Network ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Object data, response status code and response headers



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
675
676
677
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 618

def pcloud_pvminstances_networks_delete_with_http_info(cloud_instance_id, pvm_instance_id, network_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_pvminstances_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 PCloudPVMInstancesApi.pcloud_pvminstances_networks_delete"
  end
  # verify the required parameter 'pvm_instance_id' is set
  if @api_client.config.client_side_validation && pvm_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'pvm_instance_id' when calling PCloudPVMInstancesApi.pcloud_pvminstances_networks_delete"
  end
  # verify the required parameter 'network_id' is set
  if @api_client.config.client_side_validation && network_id.nil?
    fail ArgumentError, "Missing the required parameter 'network_id' when calling PCloudPVMInstancesApi.pcloud_pvminstances_networks_delete"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks/{network_id}'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{pvm_instance_id}', CGI.escape(pvm_instance_id.to_s)).sub('{network_id}', CGI.escape(network_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']) unless header_params['Accept']
  # 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(opts[:'body'])

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

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

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

#pcloud_pvminstances_networks_get(cloud_instance_id, pvm_instance_id, network_id, opts = {}) ⇒ PVMInstanceNetworks

Get a PVM Instance's network information

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • network_id (String) —

    Network ID

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

    the optional parameters

Returns:



685
686
687
688
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 685

def pcloud_pvminstances_networks_get(cloud_instance_id, pvm_instance_id, network_id, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_networks_get_with_http_info(cloud_instance_id, pvm_instance_id, network_id, opts)
  data
end

#pcloud_pvminstances_networks_get_with_http_info(cloud_instance_id, pvm_instance_id, network_id, opts = {}) ⇒ Array<(PVMInstanceNetworks, Integer, Hash)>

Get a PVM Instance's network information

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • network_id (String) —

    Network ID

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

    the optional parameters

Returns:

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

    PVMInstanceNetworks data, response status code and response headers



696
697
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
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 696

def pcloud_pvminstances_networks_get_with_http_info(cloud_instance_id, pvm_instance_id, network_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_pvminstances_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 PCloudPVMInstancesApi.pcloud_pvminstances_networks_get"
  end
  # verify the required parameter 'pvm_instance_id' is set
  if @api_client.config.client_side_validation && pvm_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'pvm_instance_id' when calling PCloudPVMInstancesApi.pcloud_pvminstances_networks_get"
  end
  # verify the required parameter 'network_id' is set
  if @api_client.config.client_side_validation && network_id.nil?
    fail ArgumentError, "Missing the required parameter 'network_id' when calling PCloudPVMInstancesApi.pcloud_pvminstances_networks_get"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks/{network_id}'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{pvm_instance_id}', CGI.escape(pvm_instance_id.to_s)).sub('{network_id}', CGI.escape(network_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']) unless header_params['Accept']

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

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

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

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

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

#pcloud_pvminstances_networks_getall(cloud_instance_id, pvm_instance_id, opts = {}) ⇒ PVMInstanceNetworks

Get all networks for this PVM Instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

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

    the optional parameters

Returns:



757
758
759
760
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 757

def pcloud_pvminstances_networks_getall(cloud_instance_id, pvm_instance_id, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_networks_getall_with_http_info(cloud_instance_id, pvm_instance_id, opts)
  data
end

#pcloud_pvminstances_networks_getall_with_http_info(cloud_instance_id, pvm_instance_id, opts = {}) ⇒ Array<(PVMInstanceNetworks, Integer, Hash)>

Get all networks for this PVM Instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

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

    the optional parameters

Returns:

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

    PVMInstanceNetworks data, response status code and response headers



767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 767

def pcloud_pvminstances_networks_getall_with_http_info(cloud_instance_id, pvm_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_pvminstances_networks_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 PCloudPVMInstancesApi.pcloud_pvminstances_networks_getall"
  end
  # verify the required parameter 'pvm_instance_id' is set
  if @api_client.config.client_side_validation && pvm_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'pvm_instance_id' when calling PCloudPVMInstancesApi.pcloud_pvminstances_networks_getall"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{pvm_instance_id}', CGI.escape(pvm_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']) unless header_params['Accept']

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

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

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

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

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

#pcloud_pvminstances_networks_post(cloud_instance_id, pvm_instance_id, body, opts = {}) ⇒ PVMInstanceNetwork

Perform network addition

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (PVMInstanceAddNetwork) —

    Add network to PVM Instance parameters

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

    the optional parameters

Returns:



825
826
827
828
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 825

def pcloud_pvminstances_networks_post(cloud_instance_id, pvm_instance_id, body, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_networks_post_with_http_info(cloud_instance_id, pvm_instance_id, body, opts)
  data
end

#pcloud_pvminstances_networks_post_with_http_info(cloud_instance_id, pvm_instance_id, body, opts = {}) ⇒ Array<(PVMInstanceNetwork, Integer, Hash)>

Perform network addition

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (PVMInstanceAddNetwork) —

    Add network to PVM Instance parameters

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

    the optional parameters

Returns:

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

    PVMInstanceNetwork data, response status code and response headers



836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 836

def pcloud_pvminstances_networks_post_with_http_info(cloud_instance_id, pvm_instance_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_pvminstances_networks_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 PCloudPVMInstancesApi.pcloud_pvminstances_networks_post"
  end
  # verify the required parameter 'pvm_instance_id' is set
  if @api_client.config.client_side_validation && pvm_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'pvm_instance_id' when calling PCloudPVMInstancesApi.pcloud_pvminstances_networks_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 PCloudPVMInstancesApi.pcloud_pvminstances_networks_post"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{pvm_instance_id}', CGI.escape(pvm_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']) unless header_params['Accept']
  # 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] || 'PVMInstanceNetwork'

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

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

#pcloud_pvminstances_operations_post(cloud_instance_id, pvm_instance_id, body, opts = {}) ⇒ Object

Perform an operation on a PVMInstance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (PVMInstanceOperation) —

    Parameters for the desired operations

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

    the optional parameters

Returns:

  • (Object) 


903
904
905
906
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 903

def pcloud_pvminstances_operations_post(cloud_instance_id, pvm_instance_id, body, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_operations_post_with_http_info(cloud_instance_id, pvm_instance_id, body, opts)
  data
end

#pcloud_pvminstances_operations_post_with_http_info(cloud_instance_id, pvm_instance_id, body, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Perform an operation on a PVMInstance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (PVMInstanceOperation) —

    Parameters for the desired operations

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 914

def pcloud_pvminstances_operations_post_with_http_info(cloud_instance_id, pvm_instance_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_pvminstances_operations_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 PCloudPVMInstancesApi.pcloud_pvminstances_operations_post"
  end
  # verify the required parameter 'pvm_instance_id' is set
  if @api_client.config.client_side_validation && pvm_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'pvm_instance_id' when calling PCloudPVMInstancesApi.pcloud_pvminstances_operations_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 PCloudPVMInstancesApi.pcloud_pvminstances_operations_post"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/operations'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{pvm_instance_id}', CGI.escape(pvm_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']) unless header_params['Accept']
  # 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] || 'Object'

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

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

#pcloud_pvminstances_post(cloud_instance_id, body, opts = {}) ⇒ Array<PVMInstance>

Create a new Power VM Instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • body (PVMInstanceCreate) —

    Parameters for the creation of a new Power VM Instance

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

    the optional parameters

Options Hash (opts):

  • :skip_host_validation (Boolean) —

    Option to skip host validation on PVMInstance Create API

Returns:



981
982
983
984
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 981

def pcloud_pvminstances_post(cloud_instance_id, body, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_post_with_http_info(cloud_instance_id, body, opts)
  data
end

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

Create a new Power VM Instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • body (PVMInstanceCreate) —

    Parameters for the creation of a new Power VM Instance

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

    the optional parameters

Options Hash (opts):

  • :skip_host_validation (Boolean) —

    Option to skip host validation on PVMInstance Create API

Returns:

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

    Array data, response status code and response headers



992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 992

def pcloud_pvminstances_post_with_http_info(cloud_instance_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_pvminstances_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 PCloudPVMInstancesApi.pcloud_pvminstances_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 PCloudPVMInstancesApi.pcloud_pvminstances_post"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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] || 'Array<PVMInstance>'

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

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

#pcloud_pvminstances_put(cloud_instance_id, pvm_instance_id, body, opts = {}) ⇒ PVMInstanceUpdateResponse

Update a PCloud PVM Instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (PVMInstanceUpdate) —

    Parameters to update a PCloud PVM Instance

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

    the optional parameters

Returns:



1056
1057
1058
1059
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 1056

def pcloud_pvminstances_put(cloud_instance_id, pvm_instance_id, body, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_put_with_http_info(cloud_instance_id, pvm_instance_id, body, opts)
  data
end

#pcloud_pvminstances_put_with_http_info(cloud_instance_id, pvm_instance_id, body, opts = {}) ⇒ Array<(PVMInstanceUpdateResponse, Integer, Hash)>

Update a PCloud PVM Instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (PVMInstanceUpdate) —

    Parameters to update a PCloud PVM Instance

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

    the optional parameters

Returns:

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

    PVMInstanceUpdateResponse data, response status code and response headers



1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 1067

def pcloud_pvminstances_put_with_http_info(cloud_instance_id, pvm_instance_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_pvminstances_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 PCloudPVMInstancesApi.pcloud_pvminstances_put"
  end
  # verify the required parameter 'pvm_instance_id' is set
  if @api_client.config.client_side_validation && pvm_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'pvm_instance_id' when calling PCloudPVMInstancesApi.pcloud_pvminstances_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 PCloudPVMInstancesApi.pcloud_pvminstances_put"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{pvm_instance_id}', CGI.escape(pvm_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']) unless header_params['Accept']
  # 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] || 'PVMInstanceUpdateResponse'

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

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

#pcloud_pvminstances_snapshots_getall(cloud_instance_id, pvm_instance_id, opts = {}) ⇒ Snapshots

Get all snapshots for this PVM Instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

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

    the optional parameters

Returns:



1133
1134
1135
1136
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 1133

def pcloud_pvminstances_snapshots_getall(cloud_instance_id, pvm_instance_id, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_snapshots_getall_with_http_info(cloud_instance_id, pvm_instance_id, opts)
  data
end

#pcloud_pvminstances_snapshots_getall_with_http_info(cloud_instance_id, pvm_instance_id, opts = {}) ⇒ Array<(Snapshots, Integer, Hash)>

Get all snapshots for this PVM Instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

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

    the optional parameters

Returns:

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

    Snapshots data, response status code and response headers



1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 1143

def pcloud_pvminstances_snapshots_getall_with_http_info(cloud_instance_id, pvm_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_pvminstances_snapshots_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 PCloudPVMInstancesApi.pcloud_pvminstances_snapshots_getall"
  end
  # verify the required parameter 'pvm_instance_id' is set
  if @api_client.config.client_side_validation && pvm_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'pvm_instance_id' when calling PCloudPVMInstancesApi.pcloud_pvminstances_snapshots_getall"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/snapshots'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{pvm_instance_id}', CGI.escape(pvm_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']) unless header_params['Accept']

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

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

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

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

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

#pcloud_pvminstances_snapshots_post(cloud_instance_id, pvm_instance_id, body, opts = {}) ⇒ SnapshotCreateResponse

Create a PVM Instance snapshot

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (SnapshotCreate) —

    PVM Instance snapshot create parameters

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

    the optional parameters

Returns:



1201
1202
1203
1204
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 1201

def pcloud_pvminstances_snapshots_post(cloud_instance_id, pvm_instance_id, body, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_snapshots_post_with_http_info(cloud_instance_id, pvm_instance_id, body, opts)
  data
end

#pcloud_pvminstances_snapshots_post_with_http_info(cloud_instance_id, pvm_instance_id, body, opts = {}) ⇒ Array<(SnapshotCreateResponse, Integer, Hash)>

Create a PVM Instance snapshot

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (SnapshotCreate) —

    PVM Instance snapshot create parameters

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

    the optional parameters

Returns:

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

    SnapshotCreateResponse data, response status code and response headers



1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 1212

def pcloud_pvminstances_snapshots_post_with_http_info(cloud_instance_id, pvm_instance_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_pvminstances_snapshots_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 PCloudPVMInstancesApi.pcloud_pvminstances_snapshots_post"
  end
  # verify the required parameter 'pvm_instance_id' is set
  if @api_client.config.client_side_validation && pvm_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'pvm_instance_id' when calling PCloudPVMInstancesApi.pcloud_pvminstances_snapshots_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 PCloudPVMInstancesApi.pcloud_pvminstances_snapshots_post"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/snapshots'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{pvm_instance_id}', CGI.escape(pvm_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']) unless header_params['Accept']
  # 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] || 'SnapshotCreateResponse'

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

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

#pcloud_pvminstances_snapshots_restore_post(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts = {}) ⇒ Snapshot

Restore a PVM Instance snapshot

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • snapshot_id (String) —

    PVM Instance snapshot id

  • body (SnapshotRestore) —

    PVM Instance snapshot restore parameters

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

    the optional parameters

Options Hash (opts):

  • :restore_fail_action (String) —

    Action to take on a failed snapshot restore

Returns:



1281
1282
1283
1284
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 1281

def pcloud_pvminstances_snapshots_restore_post(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_snapshots_restore_post_with_http_info(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts)
  data
end

#pcloud_pvminstances_snapshots_restore_post_with_http_info(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts = {}) ⇒ Array<(Snapshot, Integer, Hash)>

Restore a PVM Instance snapshot

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • snapshot_id (String) —

    PVM Instance snapshot id

  • body (SnapshotRestore) —

    PVM Instance snapshot restore parameters

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

    the optional parameters

Options Hash (opts):

  • :restore_fail_action (String) —

    Action to take on a failed snapshot restore

Returns:

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

    Snapshot data, response status code and response headers



1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 1294

def pcloud_pvminstances_snapshots_restore_post_with_http_info(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_pvminstances_snapshots_restore_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 PCloudPVMInstancesApi.pcloud_pvminstances_snapshots_restore_post"
  end
  # verify the required parameter 'pvm_instance_id' is set
  if @api_client.config.client_side_validation && pvm_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'pvm_instance_id' when calling PCloudPVMInstancesApi.pcloud_pvminstances_snapshots_restore_post"
  end
  # verify the required parameter 'snapshot_id' is set
  if @api_client.config.client_side_validation && snapshot_id.nil?
    fail ArgumentError, "Missing the required parameter 'snapshot_id' when calling PCloudPVMInstancesApi.pcloud_pvminstances_snapshots_restore_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 PCloudPVMInstancesApi.pcloud_pvminstances_snapshots_restore_post"
  end
  allowable_values = ["retry", "rollback"]
  if @api_client.config.client_side_validation && opts[:'restore_fail_action'] && !allowable_values.include?(opts[:'restore_fail_action'])
    fail ArgumentError, "invalid value for \"restore_fail_action\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/snapshots/{snapshot_id}/restore'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{pvm_instance_id}', CGI.escape(pvm_instance_id.to_s)).sub('{snapshot_id}', CGI.escape(snapshot_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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] || 'Snapshot'

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

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

#pcloud_v2_pvminstances_capture_get(cloud_instance_id, pvm_instance_id, opts = {}) ⇒ Job

Get detail of last capture job

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

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

    the optional parameters

Returns:



1369
1370
1371
1372
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 1369

def pcloud_v2_pvminstances_capture_get(cloud_instance_id, pvm_instance_id, opts = {})
  data, _status_code, _headers = pcloud_v2_pvminstances_capture_get_with_http_info(cloud_instance_id, pvm_instance_id, opts)
  data
end

#pcloud_v2_pvminstances_capture_get_with_http_info(cloud_instance_id, pvm_instance_id, opts = {}) ⇒ Array<(Job, Integer, Hash)>

Get detail of last capture job

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

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

    the optional parameters

Returns:

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

    Job data, response status code and response headers



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

def pcloud_v2_pvminstances_capture_get_with_http_info(cloud_instance_id, pvm_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_v2_pvminstances_capture_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 PCloudPVMInstancesApi.pcloud_v2_pvminstances_capture_get"
  end
  # verify the required parameter 'pvm_instance_id' is set
  if @api_client.config.client_side_validation && pvm_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'pvm_instance_id' when calling PCloudPVMInstancesApi.pcloud_v2_pvminstances_capture_get"
  end
  # resource path
  local_var_path = '/pcloud/v2/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/capture'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{pvm_instance_id}', CGI.escape(pvm_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']) unless header_params['Accept']

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

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

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

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

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

#pcloud_v2_pvminstances_capture_post(cloud_instance_id, pvm_instance_id, body, opts = {}) ⇒ JobReference

Add a capture pvm-instance to the jobs queue

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (PVMInstanceCapture) —

    Parameters for the capture

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

    the optional parameters

Returns:



1437
1438
1439
1440
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 1437

def pcloud_v2_pvminstances_capture_post(cloud_instance_id, pvm_instance_id, body, opts = {})
  data, _status_code, _headers = pcloud_v2_pvminstances_capture_post_with_http_info(cloud_instance_id, pvm_instance_id, body, opts)
  data
end

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

Add a capture pvm-instance to the jobs queue

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (PVMInstanceCapture) —

    Parameters for the capture

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

    the optional parameters

Returns:

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

    JobReference data, response status code and response headers



1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 1448

def pcloud_v2_pvminstances_capture_post_with_http_info(cloud_instance_id, pvm_instance_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_v2_pvminstances_capture_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 PCloudPVMInstancesApi.pcloud_v2_pvminstances_capture_post"
  end
  # verify the required parameter 'pvm_instance_id' is set
  if @api_client.config.client_side_validation && pvm_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'pvm_instance_id' when calling PCloudPVMInstancesApi.pcloud_v2_pvminstances_capture_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 PCloudPVMInstancesApi.pcloud_v2_pvminstances_capture_post"
  end
  # resource path
  local_var_path = '/pcloud/v2/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/capture'.sub('{cloud_instance_id}', CGI.escape(cloud_instance_id.to_s)).sub('{pvm_instance_id}', CGI.escape(pvm_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']) unless header_params['Accept']
  # 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 => :"PCloudPVMInstancesApi.pcloud_v2_pvminstances_capture_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: PCloudPVMInstancesApi#pcloud_v2_pvminstances_capture_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#pcloud_v2_pvminstances_getall(cloud_instance_id, opts = {}) ⇒ PVMInstancesV2

Get all the pvm instances for this cloud instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

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

    the optional parameters

Returns:



1513
1514
1515
1516
 
# File 'lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb', line 1513

def pcloud_v2_pvminstances_getall(cloud_instance_id, opts = {})
  data, _status_code, _headers = pcloud_v2_pvminstances_getall_with_http_info(cloud_instance_id, opts)
  data
end

#pcloud_v2_pvminstances_getall_with_http_info(cloud_instance_id, opts = {}) ⇒ Array<(PVMInstancesV2, Integer, Hash)>

Get all the pvm instances for this cloud instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

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

    the optional parameters

Returns:

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

    PVMInstancesV2 data, response status code and response headers



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

def pcloud_v2_pvminstances_getall_with_http_info(cloud_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudPVMInstancesApi.pcloud_v2_pvminstances_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 PCloudPVMInstancesApi.pcloud_v2_pvminstances_getall"
  end
  # resource path
  local_var_path = '/pcloud/v2/cloud-instances/{cloud_instance_id}/pvm-instances'.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']) unless header_params['Accept']

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

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

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

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

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