class VSphereAutomation::Appliance::TechpreviewMonitoringSnmpApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

disable(opts = {}) click to toggle source

Stop an enabled SNMP agent. @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|nil]

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

Stop an enabled SNMP agent. @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/techpreview_monitoring_snmp_api.rb, line 31
def disable_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TechpreviewMonitoringSnmpApi.disable ...'
  end
  # resource path
  local_var_path = '/appliance/techpreview/monitoring/snmp/disable'

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

Start a disabled SNMP agent. @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|nil]

# File lib/vsphere-automation-appliance/api/techpreview_monitoring_snmp_api.rb, line 66
def enable(opts = {})
  enable_with_http_info(opts)
  nil
end
enable_with_http_info(opts = {}) click to toggle source

Start a disabled SNMP agent. @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/techpreview_monitoring_snmp_api.rb, line 75
def enable_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TechpreviewMonitoringSnmpApi.enable ...'
  end
  # resource path
  local_var_path = '/appliance/techpreview/monitoring/snmp/enable'

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

Return an SNMP agent configuration. @param [Hash] opts the optional parameters @return [ApplianceTechpreviewMonitoringSnmpResult|VapiStdErrorsErrorError|]

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

Return an SNMP agent configuration. @api private @param [Hash] opts the optional parameters @return [Array<(ApplianceTechpreviewMonitoringSnmpResult|VapiStdErrorsErrorError|, Fixnum, Hash)>] data, response status code and response headers

# File lib/vsphere-automation-appliance/api/techpreview_monitoring_snmp_api.rb, line 119
def get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TechpreviewMonitoringSnmpApi.get ...'
  end
  # resource path
  local_var_path = '/appliance/techpreview/monitoring/snmp'

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

Generate localized keys for secure SNMPv3 communications. @param request_body @param [Hash] opts the optional parameters @return [ApplianceTechpreviewMonitoringSnmpHashResult|VapiStdErrorsErrorError|]

# File lib/vsphere-automation-appliance/api/techpreview_monitoring_snmp_api.rb, line 159
def hash(request_body, opts = {})
  data, _status_code, _headers = hash_with_http_info(request_body, opts)
  data
end
hash_with_http_info(request_body, opts = {}) click to toggle source

Generate localized keys for secure SNMPv3 communications. @api private @param request_body @param [Hash] opts the optional parameters @return [Array<(ApplianceTechpreviewMonitoringSnmpHashResult|VapiStdErrorsErrorError|, Fixnum, Hash)>] data, response status code and response headers

# File lib/vsphere-automation-appliance/api/techpreview_monitoring_snmp_api.rb, line 169
def hash_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TechpreviewMonitoringSnmpApi.hash ...'
  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 TechpreviewMonitoringSnmpApi.hash"
  end
  # resource path
  local_var_path = '/appliance/techpreview/monitoring/snmp/hash'

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

Get SNMP limits information. @param [Hash] opts the optional parameters @return [ApplianceTechpreviewMonitoringSnmpLimitsResult|VapiStdErrorsErrorError|]

# File lib/vsphere-automation-appliance/api/techpreview_monitoring_snmp_api.rb, line 214
def limits(opts = {})
  data, _status_code, _headers = limits_with_http_info(opts)
  data
end
limits_with_http_info(opts = {}) click to toggle source

Get SNMP limits information. @api private @param [Hash] opts the optional parameters @return [Array<(ApplianceTechpreviewMonitoringSnmpLimitsResult|VapiStdErrorsErrorError|, Fixnum, Hash)>] data, response status code and response headers

# File lib/vsphere-automation-appliance/api/techpreview_monitoring_snmp_api.rb, line 223
def limits_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TechpreviewMonitoringSnmpApi.limits ...'
  end
  # resource path
  local_var_path = '/appliance/techpreview/monitoring/snmp/limits'

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

Restore settings to factory defaults. @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|nil]

# File lib/vsphere-automation-appliance/api/techpreview_monitoring_snmp_api.rb, line 262
def reset(opts = {})
  reset_with_http_info(opts)
  nil
end
reset_with_http_info(opts = {}) click to toggle source

Restore settings to factory defaults. @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/techpreview_monitoring_snmp_api.rb, line 271
def reset_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TechpreviewMonitoringSnmpApi.reset ...'
  end
  # resource path
  local_var_path = '/appliance/techpreview/monitoring/snmp/reset'

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

Set SNMP configuration. @param request_body @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|nil]

# File lib/vsphere-automation-appliance/api/techpreview_monitoring_snmp_api.rb, line 307
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

Set SNMP configuration. @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/techpreview_monitoring_snmp_api.rb, line 317
def set_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TechpreviewMonitoringSnmpApi.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 TechpreviewMonitoringSnmpApi.set"
  end
  # resource path
  local_var_path = '/appliance/techpreview/monitoring/snmp'

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

Generate diagnostics report for snmp agent. @param [Hash] opts the optional parameters @return [ApplianceTechpreviewMonitoringSnmpStatsResult|VapiStdErrorsErrorError|]

# File lib/vsphere-automation-appliance/api/techpreview_monitoring_snmp_api.rb, line 358
def stats(opts = {})
  data, _status_code, _headers = stats_with_http_info(opts)
  data
end
stats_with_http_info(opts = {}) click to toggle source

Generate diagnostics report for snmp agent. @api private @param [Hash] opts the optional parameters @return [Array<(ApplianceTechpreviewMonitoringSnmpStatsResult|VapiStdErrorsErrorError|, Fixnum, Hash)>] data, response status code and response headers

# File lib/vsphere-automation-appliance/api/techpreview_monitoring_snmp_api.rb, line 367
def stats_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TechpreviewMonitoringSnmpApi.stats ...'
  end
  # resource path
  local_var_path = '/appliance/techpreview/monitoring/snmp/stats'

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

Send a warmStart notification to all configured traps and inform destinations (see RFC 3418). @param [Hash] opts the optional parameters @return [ApplianceTechpreviewMonitoringSnmpTestResult|VapiStdErrorsErrorError|]

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

Send a warmStart notification to all configured traps and inform destinations (see RFC 3418). @api private @param [Hash] opts the optional parameters @return [Array<(ApplianceTechpreviewMonitoringSnmpTestResult|VapiStdErrorsErrorError|, Fixnum, Hash)>] data, response status code and response headers

# File lib/vsphere-automation-appliance/api/techpreview_monitoring_snmp_api.rb, line 415
def test_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TechpreviewMonitoringSnmpApi.test ...'
  end
  # resource path
  local_var_path = '/appliance/techpreview/monitoring/snmp/test'

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