com.vmware.appliance.techpreview.monitoring

Class SnmpStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.appliance.techpreview.monitoring.SnmpStub

All Implemented Interfaces:

Snmp, SnmpTypes, Service

public class SnmpStub
extends com.vmware.vapi.internal.bindings.Stub
implements Snmp

Remote stub implementation of the Snmp API service.

WARNING: Internal API, subject to change in future versions.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.techpreview.monitoring.SnmpTypes

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

Constructor Summary

Constructors

Constructor and Description
SnmpStub(ApiProvider apiProvider, StubConfigurationBase config)

Method Summary

Methods

Modifier and Type	Method and Description
void	disable() Stop an enabled SNMP agent.
void	disable(AsyncCallback<Void> asyncCallback) Stop an enabled SNMP agent.
void	disable(AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Stop an enabled SNMP agent.
void	disable(InvocationConfig invocationConfig) Stop an enabled SNMP agent.
void	enable() Start a disabled SNMP agent.
void	enable(AsyncCallback<Void> asyncCallback) Start a disabled SNMP agent.
void	enable(AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Start a disabled SNMP agent.
void	enable(InvocationConfig invocationConfig) Start a disabled SNMP agent.
SnmpTypes.SNMPConfigReadOnly	get() Return an SNMP agent configuration.
void	get(AsyncCallback<SnmpTypes.SNMPConfigReadOnly> asyncCallback) Return an SNMP agent configuration.
void	get(AsyncCallback<SnmpTypes.SNMPConfigReadOnly> asyncCallback, InvocationConfig invocationConfig) Return an SNMP agent configuration.
SnmpTypes.SNMPConfigReadOnly	get(InvocationConfig invocationConfig) Return an SNMP agent configuration.
SnmpTypes.SNMPHashResults	hash(SnmpTypes.SNMPHashConfig config) Generate localized keys for secure SNMPv3 communications.
void	hash(SnmpTypes.SNMPHashConfig config, AsyncCallback<SnmpTypes.SNMPHashResults> asyncCallback) Generate localized keys for secure SNMPv3 communications.
void	hash(SnmpTypes.SNMPHashConfig config, AsyncCallback<SnmpTypes.SNMPHashResults> asyncCallback, InvocationConfig invocationConfig) Generate localized keys for secure SNMPv3 communications.
SnmpTypes.SNMPHashResults	hash(SnmpTypes.SNMPHashConfig config, InvocationConfig invocationConfig) Generate localized keys for secure SNMPv3 communications.
SnmpTypes.SNMPLimits	limits() Get SNMP limits information.
void	limits(AsyncCallback<SnmpTypes.SNMPLimits> asyncCallback) Get SNMP limits information.
void	limits(AsyncCallback<SnmpTypes.SNMPLimits> asyncCallback, InvocationConfig invocationConfig) Get SNMP limits information.
SnmpTypes.SNMPLimits	limits(InvocationConfig invocationConfig) Get SNMP limits information.
void	reset() Restore settings to factory defaults.
void	reset(AsyncCallback<Void> asyncCallback) Restore settings to factory defaults.
void	reset(AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Restore settings to factory defaults.
void	reset(InvocationConfig invocationConfig) Restore settings to factory defaults.
void	set(SnmpTypes.SNMPConfig config) Set SNMP configuration.
void	set(SnmpTypes.SNMPConfig config, AsyncCallback<Void> asyncCallback) Set SNMP configuration.
void	set(SnmpTypes.SNMPConfig config, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Set SNMP configuration.
void	set(SnmpTypes.SNMPConfig config, InvocationConfig invocationConfig) Set SNMP configuration.
SnmpTypes.SNMPStats	stats() Generate diagnostics report for snmp agent.
void	stats(AsyncCallback<SnmpTypes.SNMPStats> asyncCallback) Generate diagnostics report for snmp agent.
void	stats(AsyncCallback<SnmpTypes.SNMPStats> asyncCallback, InvocationConfig invocationConfig) Generate diagnostics report for snmp agent.
SnmpTypes.SNMPStats	stats(InvocationConfig invocationConfig) Generate diagnostics report for snmp agent.
SnmpTypes.SNMPTestResults	test() Send a warmStart notification to all configured traps and inform destinations (see RFC 3418).
void	test(AsyncCallback<SnmpTypes.SNMPTestResults> asyncCallback) Send a warmStart notification to all configured traps and inform destinations (see RFC 3418).
void	test(AsyncCallback<SnmpTypes.SNMPTestResults> asyncCallback, InvocationConfig invocationConfig) Send a warmStart notification to all configured traps and inform destinations (see RFC 3418).
SnmpTypes.SNMPTestResults	test(InvocationConfig invocationConfig) Send a warmStart notification to all configured traps and inform destinations (see RFC 3418).

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SnmpStub

public SnmpStub(ApiProvider apiProvider,
        StubConfigurationBase config)

Method Detail

reset

public void reset()

Description copied from interface: Snmp

Restore settings to factory defaults.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

reset in interface Snmp

reset

public void reset(InvocationConfig invocationConfig)

Description copied from interface: Snmp

Restore settings to factory defaults.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

reset in interface Snmp

Parameters:

invocationConfig - Configuration for the method invocation.

reset

public void reset(AsyncCallback<Void> asyncCallback)

Description copied from interface: Snmp

Restore settings to factory defaults.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - Generic error

Specified by:

reset in interface Snmp

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

reset

public void reset(AsyncCallback<Void> asyncCallback,
         InvocationConfig invocationConfig)

Description copied from interface: Snmp

Restore settings to factory defaults.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - Generic error

Specified by:

reset in interface Snmp

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

enable

public void enable()

Description copied from interface: Snmp

Start a disabled SNMP agent.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

enable in interface Snmp

enable

public void enable(InvocationConfig invocationConfig)

Description copied from interface: Snmp

Start a disabled SNMP agent.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

enable in interface Snmp

Parameters:

invocationConfig - Configuration for the method invocation.

enable

public void enable(AsyncCallback<Void> asyncCallback)

Description copied from interface: Snmp

Start a disabled SNMP agent.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - Generic error

Specified by:

enable in interface Snmp

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

enable

public void enable(AsyncCallback<Void> asyncCallback,
          InvocationConfig invocationConfig)

Description copied from interface: Snmp

Start a disabled SNMP agent.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - Generic error

Specified by:

enable in interface Snmp

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

hash

public SnmpTypes.SNMPHashResults hash(SnmpTypes.SNMPHashConfig config)

Description copied from interface: Snmp

Generate localized keys for secure SNMPv3 communications.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

hash in interface Snmp

Parameters:

config - SNMP hash configuration.

Returns:

SNMP hash result

hash

public SnmpTypes.SNMPHashResults hash(SnmpTypes.SNMPHashConfig config,
                             InvocationConfig invocationConfig)

Description copied from interface: Snmp

Generate localized keys for secure SNMPv3 communications.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

hash in interface Snmp

Parameters:

config - SNMP hash configuration.

invocationConfig - Configuration for the method invocation.

Returns:

SNMP hash result

hash

public void hash(SnmpTypes.SNMPHashConfig config,
        AsyncCallback<SnmpTypes.SNMPHashResults> asyncCallback)

Description copied from interface: Snmp

Generate localized keys for secure SNMPv3 communications.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
SNMP hash result

Operation Errors:
Error - Generic error

Specified by:

hash in interface Snmp

Parameters:

config - SNMP hash configuration.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

hash

public void hash(SnmpTypes.SNMPHashConfig config,
        AsyncCallback<SnmpTypes.SNMPHashResults> asyncCallback,
        InvocationConfig invocationConfig)

Description copied from interface: Snmp

Generate localized keys for secure SNMPv3 communications.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
SNMP hash result

Operation Errors:
Error - Generic error

Specified by:

hash in interface Snmp

Parameters:

config - SNMP hash configuration.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

limits

public SnmpTypes.SNMPLimits limits()

Description copied from interface: Snmp

Get SNMP limits information.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

limits in interface Snmp

Returns:

SNMP limits structure

limits

public SnmpTypes.SNMPLimits limits(InvocationConfig invocationConfig)

Description copied from interface: Snmp

Get SNMP limits information.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

limits in interface Snmp

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

SNMP limits structure

limits

public void limits(AsyncCallback<SnmpTypes.SNMPLimits> asyncCallback)

Description copied from interface: Snmp

Get SNMP limits information.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
SNMP limits structure

Operation Errors:
Error - Generic error

Specified by:

limits in interface Snmp

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

limits

public void limits(AsyncCallback<SnmpTypes.SNMPLimits> asyncCallback,
          InvocationConfig invocationConfig)

Description copied from interface: Snmp

Get SNMP limits information.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
SNMP limits structure

Operation Errors:
Error - Generic error

Specified by:

limits in interface Snmp

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

public SnmpTypes.SNMPConfigReadOnly get()

Description copied from interface: Snmp

Return an SNMP agent configuration.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

get in interface Snmp

Returns:

SNMP config structure

get

public SnmpTypes.SNMPConfigReadOnly get(InvocationConfig invocationConfig)

Description copied from interface: Snmp

Return an SNMP agent configuration.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

get in interface Snmp

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

SNMP config structure

get

public void get(AsyncCallback<SnmpTypes.SNMPConfigReadOnly> asyncCallback)

Description copied from interface: Snmp

Return an SNMP agent configuration.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
SNMP config structure

Operation Errors:
Error - Generic error

Specified by:

get in interface Snmp

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

public void get(AsyncCallback<SnmpTypes.SNMPConfigReadOnly> asyncCallback,
       InvocationConfig invocationConfig)

Description copied from interface: Snmp

Return an SNMP agent configuration.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
SNMP config structure

Operation Errors:
Error - Generic error

Specified by:

get in interface Snmp

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

disable

public void disable()

Description copied from interface: Snmp

Stop an enabled SNMP agent.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

disable in interface Snmp

disable

public void disable(InvocationConfig invocationConfig)

Description copied from interface: Snmp

Stop an enabled SNMP agent.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

disable in interface Snmp

Parameters:

invocationConfig - Configuration for the method invocation.

disable

public void disable(AsyncCallback<Void> asyncCallback)

Description copied from interface: Snmp

Stop an enabled SNMP agent.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - Generic error

Specified by:

disable in interface Snmp

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

disable

public void disable(AsyncCallback<Void> asyncCallback,
           InvocationConfig invocationConfig)

Description copied from interface: Snmp

Stop an enabled SNMP agent.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - Generic error

Specified by:

disable in interface Snmp

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

set

public void set(SnmpTypes.SNMPConfig config)

Description copied from interface: Snmp

Set SNMP configuration.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

set in interface Snmp

Parameters:

config - SNMP configuration.

set

public void set(SnmpTypes.SNMPConfig config,
       InvocationConfig invocationConfig)

Description copied from interface: Snmp

Set SNMP configuration.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

set in interface Snmp

Parameters:

config - SNMP configuration.

invocationConfig - Configuration for the method invocation.

set

public void set(SnmpTypes.SNMPConfig config,
       AsyncCallback<Void> asyncCallback)

Description copied from interface: Snmp

Set SNMP configuration.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - Generic error

Specified by:

set in interface Snmp

Parameters:

config - SNMP configuration.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

set

public void set(SnmpTypes.SNMPConfig config,
       AsyncCallback<Void> asyncCallback,
       InvocationConfig invocationConfig)

Description copied from interface: Snmp

Set SNMP configuration.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - Generic error

Specified by:

set in interface Snmp

Parameters:

config - SNMP configuration.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

test

public SnmpTypes.SNMPTestResults test()

Description copied from interface: Snmp

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

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

test in interface Snmp

Returns:

SNMP test result

test

public SnmpTypes.SNMPTestResults test(InvocationConfig invocationConfig)

Description copied from interface: Snmp

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

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

test in interface Snmp

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

SNMP test result

test

public void test(AsyncCallback<SnmpTypes.SNMPTestResults> asyncCallback)

Description copied from interface: Snmp

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

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
SNMP test result

Operation Errors:
Error - Generic error

Specified by:

test in interface Snmp

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

test

public void test(AsyncCallback<SnmpTypes.SNMPTestResults> asyncCallback,
        InvocationConfig invocationConfig)

Description copied from interface: Snmp

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

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
SNMP test result

Operation Errors:
Error - Generic error

Specified by:

test in interface Snmp

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

stats

public SnmpTypes.SNMPStats stats()

Description copied from interface: Snmp

Generate diagnostics report for snmp agent.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

stats in interface Snmp

Returns:

SNMP stats

stats

public SnmpTypes.SNMPStats stats(InvocationConfig invocationConfig)

Description copied from interface: Snmp

Generate diagnostics report for snmp agent.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

stats in interface Snmp

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

SNMP stats

stats

public void stats(AsyncCallback<SnmpTypes.SNMPStats> asyncCallback)

Description copied from interface: Snmp

Generate diagnostics report for snmp agent.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
SNMP stats

Operation Errors:
Error - Generic error

Specified by:

stats in interface Snmp

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

stats

public void stats(AsyncCallback<SnmpTypes.SNMPStats> asyncCallback,
         InvocationConfig invocationConfig)

Description copied from interface: Snmp

Generate diagnostics report for snmp agent.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
SNMP stats

Operation Errors:
Error - Generic error

Specified by:

stats in interface Snmp

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.