class VSphereAutomation::Appliance::ShutdownApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/vsphere-automation-appliance/api/shutdown_api.rb, line 16
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

cancel(opts = {}) click to toggle source

Cancel pending shutdown action. @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|nil]

# File lib/vsphere-automation-appliance/api/shutdown_api.rb, line 22
def cancel(opts = {})
  cancel_with_http_info(opts)
  nil
end
cancel_with_http_info(opts = {}) click to toggle source

Cancel pending shutdown action. @api private @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsErrorError|nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/vsphere-automation-appliance/api/shutdown_api.rb, line 31
def cancel_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShutdownApi.cancel ...'
  end
  # resource path
  local_var_path = '/appliance/shutdown/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: ShutdownApi#cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get(opts = {}) click to toggle source

Get details about the pending shutdown action. @param [Hash] opts the optional parameters @return [ApplianceShutdownResult|VapiStdErrorsErrorError|]

# File lib/vsphere-automation-appliance/api/shutdown_api.rb, line 66
def get(opts = {})
  data, _status_code, _headers = get_with_http_info(opts)
  data
end
get_with_http_info(opts = {}) click to toggle source

Get details about the pending shutdown action. @api private @param [Hash] opts the optional parameters @return [Array<(ApplianceShutdownResult|VapiStdErrorsErrorError|, Fixnum, Hash)>] data, response status code and response headers

# File lib/vsphere-automation-appliance/api/shutdown_api.rb, line 75
def get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShutdownApi.get ...'
  end
  # resource path
  local_var_path = '/appliance/shutdown'

  # 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' => 'Appliance::ApplianceShutdownResult',
      '400' => 'Appliance::VapiStdErrorsErrorError',
    })
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShutdownApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
poweroff(request_body, opts = {}) click to toggle source

Power off the appliance. @param request_body @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|nil]

# File lib/vsphere-automation-appliance/api/shutdown_api.rb, line 115
def poweroff(request_body, opts = {})
  poweroff_with_http_info(request_body, opts)
  nil
end
poweroff_with_http_info(request_body, opts = {}) click to toggle source

Power off the appliance. @api private @param request_body @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsErrorError|nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/vsphere-automation-appliance/api/shutdown_api.rb, line 125
def poweroff_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShutdownApi.poweroff ...'
  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 ShutdownApi.poweroff"
  end
  # resource path
  local_var_path = '/appliance/shutdown/poweroff'

  # 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: ShutdownApi#poweroff\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
reboot(request_body, opts = {}) click to toggle source

Reboot the appliance. @param request_body @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|nil]

# File lib/vsphere-automation-appliance/api/shutdown_api.rb, line 167
def reboot(request_body, opts = {})
  reboot_with_http_info(request_body, opts)
  nil
end
reboot_with_http_info(request_body, opts = {}) click to toggle source

Reboot the appliance. @api private @param request_body @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsErrorError|nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/vsphere-automation-appliance/api/shutdown_api.rb, line 177
def reboot_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShutdownApi.reboot ...'
  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 ShutdownApi.reboot"
  end
  # resource path
  local_var_path = '/appliance/shutdown/reboot'

  # 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: ShutdownApi#reboot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end