class VSphereAutomation::VCenter::VmHardwareApi
Attributes
Public Class Methods
# File lib/vsphere-automation-vcenter/api/vm_hardware_api.rb, line 16 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Returns the virtual hardware settings of a virtual machine. @param vm Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. @param [Hash] opts the optional parameters @return [VcenterVmHardwareResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|]
# File lib/vsphere-automation-vcenter/api/vm_hardware_api.rb, line 23 def get(vm, opts = {}) data, _status_code, _headers = get_with_http_info(vm, opts) data end
Returns the virtual hardware settings of a virtual machine. @api private @param vm Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. @param [Hash] opts the optional parameters @return [Array<(VcenterVmHardwareResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|, Fixnum, Hash)>] data, response status code and response headers
# File lib/vsphere-automation-vcenter/api/vm_hardware_api.rb, line 33 def get_with_http_info(vm, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: VmHardwareApi.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 VmHardwareApi.get" end # resource path local_var_path = '/vcenter/vm/{vm}/hardware'.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::VcenterVmHardwareResult', '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: VmHardwareApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates the virtual hardware settings of a virtual machine. @param vm Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. @param request_body @param [Hash] opts the optional parameters @return [|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil]
# File lib/vsphere-automation-vcenter/api/vm_hardware_api.rb, line 82 def update(vm, request_body, opts = {}) update_with_http_info(vm, request_body, opts) nil end
Updates the virtual hardware settings of a virtual machine. @api private @param vm Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. @param request_body @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/vsphere-automation-vcenter/api/vm_hardware_api.rb, line 93 def update_with_http_info(vm, request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: VmHardwareApi.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 VmHardwareApi.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 VmHardwareApi.update" end # resource path local_var_path = '/vcenter/vm/{vm}/hardware'.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(: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: VmHardwareApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Upgrades the virtual machine to a newer virtual hardware version. @param vm Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. @param [Hash] opts the optional parameters @option opts [VcenterVmHardwareUpgrade] :request_body @return [|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil]
# File lib/vsphere-automation-vcenter/api/vm_hardware_api.rb, line 140 def upgrade(vm, opts = {}) upgrade_with_http_info(vm, opts) nil end
Upgrades the virtual machine to a newer virtual hardware version. @api private @param vm Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. @param [Hash] opts the optional parameters @option opts [VcenterVmHardwareUpgrade] :request_body @return [Array<(|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/vsphere-automation-vcenter/api/vm_hardware_api.rb, line 151 def upgrade_with_http_info(vm, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: VmHardwareApi.upgrade ...' 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 VmHardwareApi.upgrade" end # resource path local_var_path = '/vcenter/vm/{vm}/hardware/action/upgrade'.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(opts[:'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) if @api_client.config.debugging @api_client.config.logger.debug "API called: VmHardwareApi#upgrade\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end