class VSphereAutomation::VCenter::VchaClusterModeApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

get(opts = {}) click to toggle source

Retrieves the current mode of a VCHA cluster. @param [Hash] opts the optional parameters @return [VcenterVchaClusterModeResult|VapiStdErrorsErrorError|VapiStdErrorsUnauthorizedError|]

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

Retrieves the current mode of a VCHA cluster. @api private @param [Hash] opts the optional parameters @return [Array<(VcenterVchaClusterModeResult|VapiStdErrorsErrorError|VapiStdErrorsUnauthorizedError|, Fixnum, Hash)>] data, response status code and response headers

# File lib/vsphere-automation-vcenter/api/vcha_cluster_mode_api.rb, line 31
def get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VchaClusterModeApi.get ...'
  end
  # resource path
  local_var_path = '/vcenter/vcha/cluster/mode'

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

Manipulates the mode of a VCHA Cluster. Following mode transitions are allowed: enabled -> disabled - Allowed only in healthy and degraded states. enabled -> maintenance - Allowed only in healthy state. disabled -> enabled - Allowed only in healthy state. maintenance -> enabled - Allowed only in healthy state with all nodes are running the same version. maintenance -> disabled - Allowed only in healthy state with all nodes are running the same version. All other transitions are not allowed. VCHA Cluster configuration remains intact in any of the cluster modes. @param request_body @param [Hash] opts the optional parameters @return [VcenterVchaClusterModeSetTaskResult|VapiStdErrorsErrorError|VapiStdErrorsUnauthorizedError|]

# File lib/vsphere-automation-vcenter/api/vcha_cluster_mode_api.rb, line 72
def settask(request_body, opts = {})
  data, _status_code, _headers = settask_with_http_info(request_body, opts)
  data
end
settask_with_http_info(request_body, opts = {}) click to toggle source

Manipulates the mode of a VCHA Cluster. Following mode transitions are allowed: enabled -&gt; disabled - Allowed only in healthy and degraded states. enabled -&gt; maintenance - Allowed only in healthy state. disabled -&gt; enabled - Allowed only in healthy state. maintenance -&gt; enabled - Allowed only in healthy state with all nodes are running the same version. maintenance -&gt; disabled - Allowed only in healthy state with all nodes are running the same version. All other transitions are not allowed. VCHA Cluster configuration remains intact in any of the cluster modes. @api private @param request_body @param [Hash] opts the optional parameters @return [Array<(VcenterVchaClusterModeSetTaskResult|VapiStdErrorsErrorError|VapiStdErrorsUnauthorizedError|, Fixnum, Hash)>] data, response status code and response headers

# File lib/vsphere-automation-vcenter/api/vcha_cluster_mode_api.rb, line 82
def settask_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VchaClusterModeApi.settask ...'
  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 VchaClusterModeApi.settask"
  end
  # resource path
  local_var_path = '/vcenter/vcha/cluster/mode?vmw-task=true'

  # 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(:PUT, 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::VcenterVchaClusterModeSetTaskResult',
      '400' => 'VCenter::VapiStdErrorsErrorError',
      '403' => 'VCenter::VapiStdErrorsUnauthorizedError',
    })
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VchaClusterModeApi#settask\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end