Class: IbmCloudPower::PCloudVirtualSerialNumberApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PCloudVirtualSerialNumberApi

Returns a new instance of PCloudVirtualSerialNumberApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Unassign Virtual Serial Number from a 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):

Returns:

  • (Object) 


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

def pcloud_pvminstances_virtualserialnumber_delete(cloud_instance_id, pvm_instance_id, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_virtualserialnumber_delete_with_http_info(cloud_instance_id, pvm_instance_id, opts)
  data
end

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

Unassign Virtual Serial Number from a 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):

Returns:

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

    Object 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
90
91
92
93
94
 
# File 'lib/ibm_cloud_power/api/p_cloud_virtual_serial_number_api.rb', line 39

def pcloud_pvminstances_virtualserialnumber_delete_with_http_info(cloud_instance_id, pvm_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVirtualSerialNumberApi.pcloud_pvminstances_virtualserialnumber_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 PCloudVirtualSerialNumberApi.pcloud_pvminstances_virtualserialnumber_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 PCloudVirtualSerialNumberApi.pcloud_pvminstances_virtualserialnumber_delete"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/virtual-serial-number'.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(opts[:'body'])

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

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

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

#pcloud_pvminstances_virtualserialnumber_get(cloud_instance_id, pvm_instance_id, opts = {}) ⇒ VirtualSerialNumber

Get a PVM Instance's Virtual Serial Number 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:



101
102
103
104
 
# File 'lib/ibm_cloud_power/api/p_cloud_virtual_serial_number_api.rb', line 101

def pcloud_pvminstances_virtualserialnumber_get(cloud_instance_id, pvm_instance_id, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_virtualserialnumber_get_with_http_info(cloud_instance_id, pvm_instance_id, opts)
  data
end

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

Get a PVM Instance's Virtual Serial Number 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<(VirtualSerialNumber, Integer, Hash)>) —

    VirtualSerialNumber data, response status code and response headers



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
159
160
161
 
# File 'lib/ibm_cloud_power/api/p_cloud_virtual_serial_number_api.rb', line 111

def pcloud_pvminstances_virtualserialnumber_get_with_http_info(cloud_instance_id, pvm_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVirtualSerialNumberApi.pcloud_pvminstances_virtualserialnumber_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 PCloudVirtualSerialNumberApi.pcloud_pvminstances_virtualserialnumber_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 PCloudVirtualSerialNumberApi.pcloud_pvminstances_virtualserialnumber_get"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/virtual-serial-number'.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] || 'VirtualSerialNumber'

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

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

#pcloud_pvminstances_virtualserialnumber_post(cloud_instance_id, pvm_instance_id, body, opts = {}) ⇒ VirtualSerialNumber

Assign Virtual Serial Number to a PVM Instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (AddServerVirtualSerialNumber) —

    Parameters to assign Virtual Serial Number to a PVM Instance

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

    the optional parameters

Returns:



169
170
171
172
 
# File 'lib/ibm_cloud_power/api/p_cloud_virtual_serial_number_api.rb', line 169

def pcloud_pvminstances_virtualserialnumber_post(cloud_instance_id, pvm_instance_id, body, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_virtualserialnumber_post_with_http_info(cloud_instance_id, pvm_instance_id, body, opts)
  data
end

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

Assign Virtual Serial Number to a PVM Instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (AddServerVirtualSerialNumber) —

    Parameters to assign Virtual Serial Number to a PVM Instance

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

    the optional parameters

Returns:

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

    VirtualSerialNumber data, response status code and response headers



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/ibm_cloud_power/api/p_cloud_virtual_serial_number_api.rb', line 180

def pcloud_pvminstances_virtualserialnumber_post_with_http_info(cloud_instance_id, pvm_instance_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVirtualSerialNumberApi.pcloud_pvminstances_virtualserialnumber_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 PCloudVirtualSerialNumberApi.pcloud_pvminstances_virtualserialnumber_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 PCloudVirtualSerialNumberApi.pcloud_pvminstances_virtualserialnumber_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 PCloudVirtualSerialNumberApi.pcloud_pvminstances_virtualserialnumber_post"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/virtual-serial-number'.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] || 'VirtualSerialNumber'

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

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

#pcloud_pvminstances_virtualserialnumber_put(cloud_instance_id, pvm_instance_id, body, opts = {}) ⇒ VirtualSerialNumber

Update a Virtual Serial Number

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (UpdateServerVirtualSerialNumber) —

    Parameters to update a Virtual Serial Number description

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

    the optional parameters

Returns:



247
248
249
250
 
# File 'lib/ibm_cloud_power/api/p_cloud_virtual_serial_number_api.rb', line 247

def pcloud_pvminstances_virtualserialnumber_put(cloud_instance_id, pvm_instance_id, body, opts = {})
  data, _status_code, _headers = pcloud_pvminstances_virtualserialnumber_put_with_http_info(cloud_instance_id, pvm_instance_id, body, opts)
  data
end

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

Update a Virtual Serial Number

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • pvm_instance_id (String) —

    PCloud PVM Instance ID

  • body (UpdateServerVirtualSerialNumber) —

    Parameters to update a Virtual Serial Number description

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

    the optional parameters

Returns:

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

    VirtualSerialNumber data, response status code and response headers



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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/ibm_cloud_power/api/p_cloud_virtual_serial_number_api.rb', line 258

def pcloud_pvminstances_virtualserialnumber_put_with_http_info(cloud_instance_id, pvm_instance_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVirtualSerialNumberApi.pcloud_pvminstances_virtualserialnumber_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 PCloudVirtualSerialNumberApi.pcloud_pvminstances_virtualserialnumber_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 PCloudVirtualSerialNumberApi.pcloud_pvminstances_virtualserialnumber_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 PCloudVirtualSerialNumberApi.pcloud_pvminstances_virtualserialnumber_put"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/virtual-serial-number'.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] || 'VirtualSerialNumber'

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

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

#pcloud_virtualserialnumber_delete(virtual_serial_number, opts = {}) ⇒ Object

Unreserve a retained Virtual Serial Number

Parameters:

  • virtual_serial_number (String) —

    Virtual Serial Number

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

    the optional parameters

Returns:

  • (Object) 


323
324
325
326
 
# File 'lib/ibm_cloud_power/api/p_cloud_virtual_serial_number_api.rb', line 323

def pcloud_virtualserialnumber_delete(virtual_serial_number, opts = {})
  data, _status_code, _headers = pcloud_virtualserialnumber_delete_with_http_info(virtual_serial_number, opts)
  data
end

#pcloud_virtualserialnumber_delete_with_http_info(virtual_serial_number, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Unreserve a retained Virtual Serial Number

Parameters:

  • virtual_serial_number (String) —

    Virtual Serial Number

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/ibm_cloud_power/api/p_cloud_virtual_serial_number_api.rb', line 332

def pcloud_virtualserialnumber_delete_with_http_info(virtual_serial_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVirtualSerialNumberApi.pcloud_virtualserialnumber_delete ...'
  end
  # verify the required parameter 'virtual_serial_number' is set
  if @api_client.config.client_side_validation && virtual_serial_number.nil?
    fail ArgumentError, "Missing the required parameter 'virtual_serial_number' when calling PCloudVirtualSerialNumberApi.pcloud_virtualserialnumber_delete"
  end
  # resource path
  local_var_path = '/v1/virtual-serial-number/{virtual_serial_number}'.sub('{virtual_serial_number}', CGI.escape(virtual_serial_number.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] || 'Object'

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

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

#pcloud_virtualserialnumber_get(virtual_serial_number, opts = {}) ⇒ VirtualSerialNumber

Get information for a Virtual Serial Number

Parameters:

  • virtual_serial_number (String) —

    Virtual Serial Number

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

    the optional parameters

Returns:



384
385
386
387
 
# File 'lib/ibm_cloud_power/api/p_cloud_virtual_serial_number_api.rb', line 384

def pcloud_virtualserialnumber_get(virtual_serial_number, opts = {})
  data, _status_code, _headers = pcloud_virtualserialnumber_get_with_http_info(virtual_serial_number, opts)
  data
end

#pcloud_virtualserialnumber_get_with_http_info(virtual_serial_number, opts = {}) ⇒ Array<(VirtualSerialNumber, Integer, Hash)>

Get information for a Virtual Serial Number

Parameters:

  • virtual_serial_number (String) —

    Virtual Serial Number

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

    the optional parameters

Returns:

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

    VirtualSerialNumber data, response status code and response headers



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

def pcloud_virtualserialnumber_get_with_http_info(virtual_serial_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVirtualSerialNumberApi.pcloud_virtualserialnumber_get ...'
  end
  # verify the required parameter 'virtual_serial_number' is set
  if @api_client.config.client_side_validation && virtual_serial_number.nil?
    fail ArgumentError, "Missing the required parameter 'virtual_serial_number' when calling PCloudVirtualSerialNumberApi.pcloud_virtualserialnumber_get"
  end
  # resource path
  local_var_path = '/v1/virtual-serial-number/{virtual_serial_number}'.sub('{virtual_serial_number}', CGI.escape(virtual_serial_number.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] || 'VirtualSerialNumber'

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

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

#pcloud_virtualserialnumber_getall(opts = {}) ⇒ Array<VirtualSerialNumber>

List all utilized and retained VSNs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pvm_instance_id (String) —

    PVM Instance ID

Returns:



445
446
447
448
 
# File 'lib/ibm_cloud_power/api/p_cloud_virtual_serial_number_api.rb', line 445

def pcloud_virtualserialnumber_getall(opts = {})
  data, _status_code, _headers = pcloud_virtualserialnumber_getall_with_http_info(opts)
  data
end

#pcloud_virtualserialnumber_getall_with_http_info(opts = {}) ⇒ Array<(Array<VirtualSerialNumber>, Integer, Hash)>

List all utilized and retained VSNs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pvm_instance_id (String) —

    PVM Instance ID

Returns:

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

    Array data, response status code and response headers



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/ibm_cloud_power/api/p_cloud_virtual_serial_number_api.rb', line 454

def pcloud_virtualserialnumber_getall_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVirtualSerialNumberApi.pcloud_virtualserialnumber_getall ...'
  end
  # resource path
  local_var_path = '/v1/virtual-serial-number'

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<VirtualSerialNumber>'

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

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

#pcloud_virtualserialnumber_put(virtual_serial_number, body, opts = {}) ⇒ GetServerVirtualSerialNumber

Update Description of a Reserved Virtual Serial Number

Parameters:

  • virtual_serial_number (String) —

    Virtual Serial Number

  • body (UpdateVirtualSerialNumber) —

    Parameters to edit description of a reserved Virtual Serial Number

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

    the optional parameters

Returns:



504
505
506
507
 
# File 'lib/ibm_cloud_power/api/p_cloud_virtual_serial_number_api.rb', line 504

def pcloud_virtualserialnumber_put(virtual_serial_number, body, opts = {})
  data, _status_code, _headers = pcloud_virtualserialnumber_put_with_http_info(virtual_serial_number, body, opts)
  data
end

#pcloud_virtualserialnumber_put_with_http_info(virtual_serial_number, body, opts = {}) ⇒ Array<(GetServerVirtualSerialNumber, Integer, Hash)>

Update Description of a Reserved Virtual Serial Number

Parameters:

  • virtual_serial_number (String) —

    Virtual Serial Number

  • body (UpdateVirtualSerialNumber) —

    Parameters to edit description of a reserved Virtual Serial Number

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

    the optional parameters

Returns:



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

def pcloud_virtualserialnumber_put_with_http_info(virtual_serial_number, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVirtualSerialNumberApi.pcloud_virtualserialnumber_put ...'
  end
  # verify the required parameter 'virtual_serial_number' is set
  if @api_client.config.client_side_validation && virtual_serial_number.nil?
    fail ArgumentError, "Missing the required parameter 'virtual_serial_number' when calling PCloudVirtualSerialNumberApi.pcloud_virtualserialnumber_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 PCloudVirtualSerialNumberApi.pcloud_virtualserialnumber_put"
  end
  # resource path
  local_var_path = '/v1/virtual-serial-number/{virtual_serial_number}'.sub('{virtual_serial_number}', CGI.escape(virtual_serial_number.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] || 'GetServerVirtualSerialNumber'

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

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

#pcloud_virtualserialnumber_softwaretiers_getall(opts = {}) ⇒ Array<SupportedSoftwareTier>

List supported software tiers (IBMi licensing)

Parameters:

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

    the optional parameters

Returns:



574
575
576
577
 
# File 'lib/ibm_cloud_power/api/p_cloud_virtual_serial_number_api.rb', line 574

def pcloud_virtualserialnumber_softwaretiers_getall(opts = {})
  data, _status_code, _headers = pcloud_virtualserialnumber_softwaretiers_getall_with_http_info(opts)
  data
end

#pcloud_virtualserialnumber_softwaretiers_getall_with_http_info(opts = {}) ⇒ Array<(Array<SupportedSoftwareTier>, Integer, Hash)>

List supported software tiers (IBMi licensing)

Parameters:

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

    the optional parameters

Returns:

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

    Array data, response status code and response headers



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/ibm_cloud_power/api/p_cloud_virtual_serial_number_api.rb', line 582

def pcloud_virtualserialnumber_softwaretiers_getall_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVirtualSerialNumberApi.pcloud_virtualserialnumber_softwaretiers_getall ...'
  end
  # resource path
  local_var_path = '/v1/virtual-serial-number/software-tiers'

  # 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] || 'Array<SupportedSoftwareTier>'

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

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