class VSphereAutomation::VCenter::DeploymentInstallApi
Attributes
Public Class Methods
# File lib/vsphere-automation-vcenter/api/deployment_install_api.rb, line 16 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Cancel the appliance installation that is in progress. @param [Hash] opts the optional parameters @return [|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|nil]
# File lib/vsphere-automation-vcenter/api/deployment_install_api.rb, line 22 def cancel(opts = {}) cancel_with_http_info(opts) nil end
Cancel the appliance installation that is in progress. @api private @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/vsphere-automation-vcenter/api/deployment_install_api.rb, line 31 def cancel_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DeploymentInstallApi.cancel ...' end # resource path local_var_path = '/vcenter/deployment/install?action=cancel' # 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: DeploymentInstallApi#cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Run sanity checks using the InstallSpec parameters passed. @param request_body @param [Hash] opts the optional parameters @return [VcenterDeploymentInstallCheckResult|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|]
# File lib/vsphere-automation-vcenter/api/deployment_install_api.rb, line 67 def check(request_body, opts = {}) data, _status_code, _headers = check_with_http_info(request_body, opts) data end
Run sanity checks using the InstallSpec parameters passed. @api private @param request_body @param [Hash] opts the optional parameters @return [Array<(VcenterDeploymentInstallCheckResult|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|, Fixnum, Hash)>] data, response status code and response headers
# File lib/vsphere-automation-vcenter/api/deployment_install_api.rb, line 77 def check_with_http_info(request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DeploymentInstallApi.check ...' 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 DeploymentInstallApi.check" end # resource path local_var_path = '/vcenter/deployment/install?action=check' # 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::VcenterDeploymentInstallCheckResult', '400' => 'VCenter::VapiStdErrorsNotAllowedInCurrentStateError', '401' => 'VCenter::VapiStdErrorsUnauthenticatedError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: DeploymentInstallApi#check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get the parameters used to configure the ongoing appliance installation. @param [Hash] opts the optional parameters @return [VcenterDeploymentInstallResult|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|]
# File lib/vsphere-automation-vcenter/api/deployment_install_api.rb, line 123 def get(opts = {}) data, _status_code, _headers = get_with_http_info(opts) data end
Get the parameters used to configure the ongoing appliance installation. @api private @param [Hash] opts the optional parameters @return [Array<(VcenterDeploymentInstallResult|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|, Fixnum, Hash)>] data, response status code and response headers
# File lib/vsphere-automation-vcenter/api/deployment_install_api.rb, line 132 def get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DeploymentInstallApi.get ...' end # resource path local_var_path = '/vcenter/deployment/install' # 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::VcenterDeploymentInstallResult', '400' => 'VCenter::VapiStdErrorsNotAllowedInCurrentStateError', '401' => 'VCenter::VapiStdErrorsUnauthenticatedError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: DeploymentInstallApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Start the appliance installation. @param request_body @param [Hash] opts the optional parameters @return [|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|nil]
# File lib/vsphere-automation-vcenter/api/deployment_install_api.rb, line 173 def start(request_body, opts = {}) start_with_http_info(request_body, opts) nil end
Start the appliance installation. @api private @param request_body @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/vsphere-automation-vcenter/api/deployment_install_api.rb, line 183 def start_with_http_info(request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DeploymentInstallApi.start ...' 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 DeploymentInstallApi.start" end # resource path local_var_path = '/vcenter/deployment/install?action=start' # 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) if @api_client.config.debugging @api_client.config.logger.debug "API called: DeploymentInstallApi#start\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end