VSphereAutomation::Appliance::UpdateApi

All URIs are relative to https://<vcenter>/rest

Method	HTTP request	Description
cancel	POST /appliance/update	Request the cancellation the update operation that is currently in progress.
get	GET /appliance/update	Gets the current status of the appliance update.

cancel

cancel(action)

Request the cancellation the update operation that is currently in progress.

Example

# load the gem
require 'vsphere-automation-appliance'
# setup authorization
VSphereAutomation::Configuration.new.tap do |config|
  # Configure API key authorization: api_key
  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
end

api_instance = VSphereAutomation::Appliance::UpdateApi.new
action = 'action_example' # String | action=cancel

begin
  #Request the cancellation the update operation that is currently in progress.
  api_instance.cancel(action)
rescue VSphereAutomation::ApiError => e
  puts "Exception when calling UpdateApi->cancel: #{e}"
end

Parameters

Name	Type	Description	Notes
action	String	action=cancel

Return type

nil (empty response body)

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

get

ApplianceUpdateResult get

Gets the current status of the appliance update.

Example

# load the gem
require 'vsphere-automation-appliance'
# setup authorization
VSphereAutomation::Configuration.new.tap do |config|
  # Configure API key authorization: api_key
  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
end

api_instance = VSphereAutomation::Appliance::UpdateApi.new

begin
  #Gets the current status of the appliance update.
  result = api_instance.get
  p result
rescue VSphereAutomation::ApiError => e
  puts "Exception when calling UpdateApi->get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

ApplianceUpdateResult

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json