Class: Com::Vmware::Appliance::Techpreview::Monitoring::Snmp

Inherits:
VAPI::Bindings::VapiService
  • Object
show all
Defined in:
/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb

Overview

``Com::Vmware::Appliance::Techpreview::Monitoring::Snmp`` class provides methods SNMP agent operations.

Defined Under Namespace

Classes: SNMPAuthProto, SNMPConfig, SNMPConfigReadOnly, SNMPHashConfig, SNMPHashResults, SNMPLimits, SNMPPrivProto, SNMPRemoteUser, SNMPSecLevel, SNMPStats, SNMPTestResults, SNMPUser, SNMPv1TrapTarget, SNMPv3Notfication, SNMPv3Target

Instance Method Summary (collapse)

Constructor Details

- (Snmp) initialize(config)

Constructs a new instance.

Parameters:

  • config (VAPI::Bindings::StubConfig) —

    A hash with the api provider details. 



143
144
145
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 143

def initialize(config)
    super(config, @@service_info)
end

Instance Method Details

- (Void) disable

Stop an enabled SNMP agent.

Returns:

  • (Void)

Raises:



210
211
212
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 210

def disable()
    invoke_with_info(@@disable_info)
end

- (Void) enable

Start a disabled SNMP agent.

Returns:

  • (Void)

Raises:



163
164
165
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 163

def enable()
    invoke_with_info(@@enable_info)
end

- (Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPConfigReadOnly) get

Return an SNMP agent configuration.

Returns:

Raises:



200
201
202
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 200

def get()
    invoke_with_info(@@get_info)
end

- (Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPHashResults) hash(config)

Generate localized keys for secure SNMPv3 communications.

Parameters:

Returns:

Raises:



176
177
178
179
180
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 176

def hash(config)
    invoke_with_info(@@hash_info, {
        'config' => config,
    })
end

- (Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPLimits) limits

Get SNMP limits information.

Returns:

Raises:



189
190
191
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 189

def limits()
    invoke_with_info(@@limits_info)
end

- (Void) reset

Restore settings to factory defaults.

Returns:

  • (Void)

Raises:



153
154
155
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 153

def reset()
    invoke_with_info(@@reset_info)
end

- (Void) set(config)

Set SNMP configuration.

Parameters:

Returns:

  • (Void)

Raises:



222
223
224
225
226
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 222

def set(config)
    invoke_with_info(@@set_info, {
        'config' => config,
    })
end

- (Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPStats) stats

Generate diagnostics report for snmp agent.

Returns:

Raises:



246
247
248
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 246

def stats()
    invoke_with_info(@@stats_info)
end

- (Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPTestResults) test

Send a warmStart notification to all configured traps and inform destinations (see RFC 3418).

Returns:

Raises:



235
236
237
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 235

def test()
    invoke_with_info(@@test_info)
end