class VSphereAutomation::Appliance::LoggingForwardingApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

get(opts = {}) click to toggle source

Returns the configuration for forwarding log messages to remote logging servers. @param [Hash] opts the optional parameters @return [ApplianceLoggingForwardingResult|]

# File lib/vsphere-automation-appliance/api/logging_forwarding_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

Returns the configuration for forwarding log messages to remote logging servers. @api private @param [Hash] opts the optional parameters @return [Array<(ApplianceLoggingForwardingResult|, Fixnum, Hash)>] data, response status code and response headers

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

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

Sets the configuration for forwarding log messages to remote log servers. @param request_body @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|nil]

# File lib/vsphere-automation-appliance/api/logging_forwarding_api.rb, line 70
def set(request_body, opts = {})
  set_with_http_info(request_body, opts)
  nil
end
set_with_http_info(request_body, opts = {}) click to toggle source

Sets the configuration for forwarding log messages to remote log servers. @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/logging_forwarding_api.rb, line 80
def set_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingForwardingApi.set ...'
  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 LoggingForwardingApi.set"
  end
  # resource path
  local_var_path = '/appliance/logging/forwarding'

  # 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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingForwardingApi#set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
test(opts = {}) click to toggle source

Validates the current log forwarding configuration by checking the liveness of the remote machine and optionally sending a test diagnostic log message from the appliance to all configured logging servers to allow manual end-to-end validation. The message that is sent is: "This is a diagnostic log test message from vCenter Server." @param [Hash] opts the optional parameters @option opts [ApplianceLoggingForwardingTest] :request_body @return [ApplianceLoggingForwardingTestResult|]

# File lib/vsphere-automation-appliance/api/logging_forwarding_api.rb, line 122
def test(opts = {})
  data, _status_code, _headers = test_with_http_info(opts)
  data
end
test_with_http_info(opts = {}) click to toggle source

Validates the current log forwarding configuration by checking the liveness of the remote machine and optionally sending a test diagnostic log message from the appliance to all configured logging servers to allow manual end-to-end validation. The message that is sent is: "This is a diagnostic log test message from vCenter Server.&quot; @api private @param [Hash] opts the optional parameters @option opts [ApplianceLoggingForwardingTest] :request_body @return [Array<(ApplianceLoggingForwardingTestResult|, Fixnum, Hash)>] data, response status code and response headers

# File lib/vsphere-automation-appliance/api/logging_forwarding_api.rb, line 132
def test_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingForwardingApi.test ...'
  end
  # resource path
  local_var_path = '/appliance/logging/forwarding?action=test'

  # 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,
    :return_type => {
      '200' => 'Appliance::ApplianceLoggingForwardingTestResult',
    })
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingForwardingApi#test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end