Class: VSphereAutomation::VCenter::VmHardwareSerialApi

Inherits:
Object
  • Object
show all
Defined in:
lib/vsphere-automation-vcenter/api/vm_hardware_serial_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VmHardwareSerialApi

Returns a new instance of VmHardwareSerialApi.



16
17
18
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_serial_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_serial_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#connect(vm, port, opts = {}) ⇒ |VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil

Connects a virtual serial port of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system. For a powered-off virtual machine, the Serial.update operation may be used to configure the virtual serial port to start in the connected state when the virtual machine is powered on.

Parameters:

  • vm —

    Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

  • port —

    Virtual serial port identifier. The parameter must be an identifier for the resource type: vcenter.vm.hardware.SerialPort.

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

    the optional parameters

Returns:



24
25
26
27
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_serial_api.rb', line 24

def connect(vm, port, opts = {})
  connect_with_http_info(vm, port, opts)
  nil
end

#connect_with_http_info(vm, port, opts = {}) ⇒ Array<(|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Connects a virtual serial port of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system. For a powered-off virtual machine, the Serial.update operation may be used to configure the virtual serial port to start in the connected state when the virtual machine is powered on.

Parameters:

  • vm —

    Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

  • port —

    Virtual serial port identifier. The parameter must be an identifier for the resource type: vcenter.vm.hardware.SerialPort.

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

    the optional parameters

Returns:



35
36
37
38
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
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_serial_api.rb', line 35

def connect_with_http_info(vm, port, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VmHardwareSerialApi.connect ...'
  end
  # verify the required parameter 'vm' is set
  if @api_client.config.client_side_validation && vm.nil?
    fail ArgumentError, "Missing the required parameter 'vm' when calling VmHardwareSerialApi.connect"
  end
  # verify the required parameter 'port' is set
  if @api_client.config.client_side_validation && port.nil?
    fail ArgumentError, "Missing the required parameter 'port' when calling VmHardwareSerialApi.connect"
  end
  # resource path
  local_var_path = '/vcenter/vm/{vm}/hardware/serial/{port}/connect'.sub('{' + 'vm' + '}', vm.to_s).sub('{' + 'port' + '}', port.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VmHardwareSerialApi#connect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create(vm, request_body, opts = {}) ⇒ VcenterVmHardwareSerialCreateResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|

Adds a virtual serial port to the virtual machine.

Parameters:

  • vm —

    Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

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

    the optional parameters

Returns:



80
81
82
83
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_serial_api.rb', line 80

def create(vm, request_body, opts = {})
  data, _status_code, _headers = create_with_http_info(vm, request_body, opts)
  data
end

#create_with_http_info(vm, request_body, opts = {}) ⇒ Array<(VcenterVmHardwareSerialCreateResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Adds a virtual serial port to the virtual machine.

Parameters:

  • vm —

    Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

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

    the optional parameters

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_serial_api.rb', line 91

def create_with_http_info(vm, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VmHardwareSerialApi.create ...'
  end
  # verify the required parameter 'vm' is set
  if @api_client.config.client_side_validation && vm.nil?
    fail ArgumentError, "Missing the required parameter 'vm' when calling VmHardwareSerialApi.create"
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling VmHardwareSerialApi.create"
  end
  # resource path
  local_var_path = '/vcenter/vm/{vm}/hardware/serial'.sub('{' + 'vm' + '}', vm.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request_body)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
	:return_type => {
	  '200' => 'VCenter::VcenterVmHardwareSerialCreateResult',
	  '400' => 'VCenter::VapiStdErrorsResourceInaccessibleError',
	  '401' => 'VCenter::VapiStdErrorsUnauthenticatedError',
	  '403' => 'VCenter::VapiStdErrorsUnauthorizedError',
	  '404' => 'VCenter::VapiStdErrorsNotFoundError',
	  '503' => 'VCenter::VapiStdErrorsServiceUnavailableError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VmHardwareSerialApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete(vm, port, opts = {}) ⇒ |VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil

Removes a virtual serial port from the virtual machine.

Parameters:

  • vm —

    Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

  • port —

    Virtual serial port identifier. The parameter must be an identifier for the resource type: vcenter.vm.hardware.SerialPort.

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

    the optional parameters

Returns:



146
147
148
149
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_serial_api.rb', line 146

def delete(vm, port, opts = {})
  delete_with_http_info(vm, port, opts)
  nil
end

#delete_with_http_info(vm, port, opts = {}) ⇒ Array<(|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Removes a virtual serial port from the virtual machine.

Parameters:

  • vm —

    Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

  • port —

    Virtual serial port identifier. The parameter must be an identifier for the resource type: vcenter.vm.hardware.SerialPort.

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

    the optional parameters

Returns:



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_serial_api.rb', line 157

def delete_with_http_info(vm, port, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VmHardwareSerialApi.delete ...'
  end
  # verify the required parameter 'vm' is set
  if @api_client.config.client_side_validation && vm.nil?
    fail ArgumentError, "Missing the required parameter 'vm' when calling VmHardwareSerialApi.delete"
  end
  # verify the required parameter 'port' is set
  if @api_client.config.client_side_validation && port.nil?
    fail ArgumentError, "Missing the required parameter 'port' when calling VmHardwareSerialApi.delete"
  end
  # resource path
  local_var_path = '/vcenter/vm/{vm}/hardware/serial/{port}'.sub('{' + 'vm' + '}', vm.to_s).sub('{' + 'port' + '}', port.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VmHardwareSerialApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#disconnect(vm, port, opts = {}) ⇒ |VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil

Disconnects a virtual serial port of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the serial port is not connected to its backing. For a powered-off virtual machine, the Serial.update operation may be used to configure the virtual serial port to start in the disconnected state when the virtual machine is powered on.

Parameters:

  • vm —

    Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

  • port —

    Virtual serial port identifier. The parameter must be an identifier for the resource type: vcenter.vm.hardware.SerialPort.

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

    the optional parameters

Returns:



202
203
204
205
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_serial_api.rb', line 202

def disconnect(vm, port, opts = {})
  disconnect_with_http_info(vm, port, opts)
  nil
end

#disconnect_with_http_info(vm, port, opts = {}) ⇒ Array<(|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Disconnects a virtual serial port of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the serial port is not connected to its backing. For a powered-off virtual machine, the Serial.update operation may be used to configure the virtual serial port to start in the disconnected state when the virtual machine is powered on.

Parameters:

  • vm —

    Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

  • port —

    Virtual serial port identifier. The parameter must be an identifier for the resource type: vcenter.vm.hardware.SerialPort.

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

    the optional parameters

Returns:



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
248
249
250
251
252
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_serial_api.rb', line 213

def disconnect_with_http_info(vm, port, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VmHardwareSerialApi.disconnect ...'
  end
  # verify the required parameter 'vm' is set
  if @api_client.config.client_side_validation && vm.nil?
    fail ArgumentError, "Missing the required parameter 'vm' when calling VmHardwareSerialApi.disconnect"
  end
  # verify the required parameter 'port' is set
  if @api_client.config.client_side_validation && port.nil?
    fail ArgumentError, "Missing the required parameter 'port' when calling VmHardwareSerialApi.disconnect"
  end
  # resource path
  local_var_path = '/vcenter/vm/{vm}/hardware/serial/{port}/disconnect'.sub('{' + 'vm' + '}', vm.to_s).sub('{' + 'port' + '}', port.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VmHardwareSerialApi#disconnect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get(vm, port, opts = {}) ⇒ VcenterVmHardwareSerialResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|

Returns information about a virtual serial port.

Parameters:

  • vm —

    Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

  • port —

    Virtual serial port identifier. The parameter must be an identifier for the resource type: vcenter.vm.hardware.SerialPort.

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

    the optional parameters

Returns:



258
259
260
261
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_serial_api.rb', line 258

def get(vm, port, opts = {})
  data, _status_code, _headers = get_with_http_info(vm, port, opts)
  data
end

#get_with_http_info(vm, port, opts = {}) ⇒ Array<(VcenterVmHardwareSerialResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns information about a virtual serial port.

Parameters:

  • vm —

    Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

  • port —

    Virtual serial port identifier. The parameter must be an identifier for the resource type: vcenter.vm.hardware.SerialPort.

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

    the optional parameters

Returns:



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
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_serial_api.rb', line 269

def get_with_http_info(vm, port, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VmHardwareSerialApi.get ...'
  end
  # verify the required parameter 'vm' is set
  if @api_client.config.client_side_validation && vm.nil?
    fail ArgumentError, "Missing the required parameter 'vm' when calling VmHardwareSerialApi.get"
  end
  # verify the required parameter 'port' is set
  if @api_client.config.client_side_validation && port.nil?
    fail ArgumentError, "Missing the required parameter 'port' when calling VmHardwareSerialApi.get"
  end
  # resource path
  local_var_path = '/vcenter/vm/{vm}/hardware/serial/{port}'.sub('{' + 'vm' + '}', vm.to_s).sub('{' + 'port' + '}', port.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
	:return_type => {
	  '200' => 'VCenter::VcenterVmHardwareSerialResult',
	  '400' => 'VCenter::VapiStdErrorsResourceInaccessibleError',
	  '401' => 'VCenter::VapiStdErrorsUnauthenticatedError',
	  '403' => 'VCenter::VapiStdErrorsUnauthorizedError',
	  '404' => 'VCenter::VapiStdErrorsNotFoundError',
	  '503' => 'VCenter::VapiStdErrorsServiceUnavailableError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VmHardwareSerialApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(vm, opts = {}) ⇒ VcenterVmHardwareSerialListResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|

Returns commonly used information about the virtual serial ports belonging to the virtual machine.

Parameters:

  • vm —

    Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

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

    the optional parameters

Returns:



321
322
323
324
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_serial_api.rb', line 321

def list(vm, opts = {})
  data, _status_code, _headers = list_with_http_info(vm, opts)
  data
end

#list_with_http_info(vm, opts = {}) ⇒ Array<(VcenterVmHardwareSerialListResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns commonly used information about the virtual serial ports belonging to the virtual machine.

Parameters:

  • vm —

    Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

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

    the optional parameters

Returns:



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

def list_with_http_info(vm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VmHardwareSerialApi.list ...'
  end
  # verify the required parameter 'vm' is set
  if @api_client.config.client_side_validation && vm.nil?
    fail ArgumentError, "Missing the required parameter 'vm' when calling VmHardwareSerialApi.list"
  end
  # resource path
  local_var_path = '/vcenter/vm/{vm}/hardware/serial'.sub('{' + 'vm' + '}', vm.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
	:return_type => {
	  '200' => 'VCenter::VcenterVmHardwareSerialListResult',
	  '400' => 'VCenter::VapiStdErrorsResourceInaccessibleError',
	  '401' => 'VCenter::VapiStdErrorsUnauthenticatedError',
	  '403' => 'VCenter::VapiStdErrorsUnauthorizedError',
	  '404' => 'VCenter::VapiStdErrorsNotFoundError',
	  '503' => 'VCenter::VapiStdErrorsServiceUnavailableError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VmHardwareSerialApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(vm, port, request_body, opts = {}) ⇒ |VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil

Updates the configuration of a virtual serial port.

Parameters:

  • vm —

    Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

  • port —

    Virtual serial port identifier. The parameter must be an identifier for the resource type: vcenter.vm.hardware.SerialPort.

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

    the optional parameters

Returns:



381
382
383
384
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_serial_api.rb', line 381

def update(vm, port, request_body, opts = {})
  update_with_http_info(vm, port, request_body, opts)
  nil
end

#update_with_http_info(vm, port, request_body, opts = {}) ⇒ Array<(|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Updates the configuration of a virtual serial port.

Parameters:

  • vm —

    Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

  • port —

    Virtual serial port identifier. The parameter must be an identifier for the resource type: vcenter.vm.hardware.SerialPort.

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

    the optional parameters

Returns:



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
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_serial_api.rb', line 393

def update_with_http_info(vm, port, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VmHardwareSerialApi.update ...'
  end
  # verify the required parameter 'vm' is set
  if @api_client.config.client_side_validation && vm.nil?
    fail ArgumentError, "Missing the required parameter 'vm' when calling VmHardwareSerialApi.update"
  end
  # verify the required parameter 'port' is set
  if @api_client.config.client_side_validation && port.nil?
    fail ArgumentError, "Missing the required parameter 'port' when calling VmHardwareSerialApi.update"
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling VmHardwareSerialApi.update"
  end
  # resource path
  local_var_path = '/vcenter/vm/{vm}/hardware/serial/{port}'.sub('{' + 'vm' + '}', vm.to_s).sub('{' + 'port' + '}', port.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request_body)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VmHardwareSerialApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end