Class: VSphereAutomation::VCenter::VmHardwareAdapterSataApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VmHardwareAdapterSataApi

Returns a new instance of VmHardwareAdapterSataApi.



16
17
18
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_adapter_sata_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_adapter_sata_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

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

Adds a virtual SATA adapter 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:



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

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<(VcenterVmHardwareAdapterSataCreateResult|VapiStdErrorsUnsupportedError|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 SATA adapter 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:



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
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_adapter_sata_api.rb', line 35

def create_with_http_info(vm, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VmHardwareAdapterSataApi.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 VmHardwareAdapterSataApi.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 VmHardwareAdapterSataApi.create"
  end
  # resource path
  local_var_path = '/vcenter/vm/{vm}/hardware/adapter/sata'.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::VcenterVmHardwareAdapterSataCreateResult',
	  '400' => 'VCenter::VapiStdErrorsUnsupportedError',
	  '401' => 'VCenter::VapiStdErrorsUnauthenticatedError',
	  '403' => 'VCenter::VapiStdErrorsUnauthorizedError',
	  '404' => 'VCenter::VapiStdErrorsNotFoundError',
	  '503' => 'VCenter::VapiStdErrorsServiceUnavailableError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VmHardwareAdapterSataApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Removes a virtual SATA adapter from the virtual machine.

Parameters:

  • vm —

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

  • adapter —

    Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: vcenter.vm.hardware.SataAdapter.

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

    the optional parameters

Returns:



90
91
92
93
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_adapter_sata_api.rb', line 90

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

#delete_with_http_info(vm, adapter, 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 SATA adapter from the virtual machine.

Parameters:

  • vm —

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

  • adapter —

    Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: vcenter.vm.hardware.SataAdapter.

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

    the optional parameters

Returns:



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_adapter_sata_api.rb', line 101

def delete_with_http_info(vm, adapter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VmHardwareAdapterSataApi.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 VmHardwareAdapterSataApi.delete"
  end
  # verify the required parameter 'adapter' is set
  if @api_client.config.client_side_validation && adapter.nil?
    fail ArgumentError, "Missing the required parameter 'adapter' when calling VmHardwareAdapterSataApi.delete"
  end
  # resource path
  local_var_path = '/vcenter/vm/{vm}/hardware/adapter/sata/{adapter}'.sub('{' + 'vm' + '}', vm.to_s).sub('{' + 'adapter' + '}', adapter.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: VmHardwareAdapterSataApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Returns information about a virtual SATA adapter.

Parameters:

  • vm —

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

  • adapter —

    Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: vcenter.vm.hardware.SataAdapter.

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

    the optional parameters

Returns:



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

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

#get_with_http_info(vm, adapter, opts = {}) ⇒ Array<(VcenterVmHardwareAdapterSataResult|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 SATA adapter.

Parameters:

  • vm —

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

  • adapter —

    Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: vcenter.vm.hardware.SataAdapter.

  • 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
197
198
199
200
201
202
203
204
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_adapter_sata_api.rb', line 157

def get_with_http_info(vm, adapter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VmHardwareAdapterSataApi.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 VmHardwareAdapterSataApi.get"
  end
  # verify the required parameter 'adapter' is set
  if @api_client.config.client_side_validation && adapter.nil?
    fail ArgumentError, "Missing the required parameter 'adapter' when calling VmHardwareAdapterSataApi.get"
  end
  # resource path
  local_var_path = '/vcenter/vm/{vm}/hardware/adapter/sata/{adapter}'.sub('{' + 'vm' + '}', vm.to_s).sub('{' + 'adapter' + '}', adapter.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::VcenterVmHardwareAdapterSataResult',
	  '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: VmHardwareAdapterSataApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Returns commonly used information about the virtual SATA adapters 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:



209
210
211
212
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_adapter_sata_api.rb', line 209

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

#list_with_http_info(vm, opts = {}) ⇒ Array<(VcenterVmHardwareAdapterSataListResult|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 SATA adapters 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:



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_adapter_sata_api.rb', line 219

def list_with_http_info(vm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VmHardwareAdapterSataApi.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 VmHardwareAdapterSataApi.list"
  end
  # resource path
  local_var_path = '/vcenter/vm/{vm}/hardware/adapter/sata'.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::VcenterVmHardwareAdapterSataListResult',
	  '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: VmHardwareAdapterSataApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end