com.vmware.appliance.techpreview.monitoring

Interface Snmp

All Superinterfaces:

Service, SnmpTypes

All Known Implementing Classes:

SnmpStub

public interface Snmp
extends Service, SnmpTypes

Snmp interface provides methods SNMP agent operations.

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

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).

Method Detail

reset

void reset()

Restore settings to factory defaults.

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

Throws:

Error - Generic error

reset

void reset(InvocationConfig invocationConfig)

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.

Parameters:

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error

reset

void reset(AsyncCallback<Void> asyncCallback)

Restore settings to factory defaults.

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

Operation Errors:
Error - Generic error

Parameters:

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

reset

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

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

enable

void enable()

Start a disabled SNMP agent.

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

Throws:

Error - Generic error

enable

void enable(InvocationConfig invocationConfig)

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.

Parameters:

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error

enable

void enable(AsyncCallback<Void> asyncCallback)

Start a disabled SNMP agent.

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

Operation Errors:
Error - Generic error

Parameters:

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

enable

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

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

hash

SnmpTypes.SNMPHashResults hash(SnmpTypes.SNMPHashConfig config)

Generate localized keys for secure SNMPv3 communications.

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

Parameters:

config - SNMP hash configuration.

Returns:

SNMP hash result

Throws:

Error - Generic error

hash

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

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.

Parameters:

config - SNMP hash configuration.

invocationConfig - Configuration for the method invocation.

Returns:

SNMP hash result

Throws:

Error - Generic error

hash

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

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

Parameters:

config - SNMP hash configuration.

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

hash

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

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

Parameters:

config - SNMP hash configuration.

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

invocationConfig - Configuration for the method invocation.

limits

SnmpTypes.SNMPLimits limits()

Get SNMP limits information.

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

Returns:

SNMP limits structure

Throws:

Error - Generic error

limits

SnmpTypes.SNMPLimits limits(InvocationConfig invocationConfig)

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.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

SNMP limits structure

Throws:

Error - Generic error

limits

void limits(AsyncCallback<SnmpTypes.SNMPLimits> asyncCallback)

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

Parameters:

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

limits

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

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

SnmpTypes.SNMPConfigReadOnly get()

Return an SNMP agent configuration.

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

Returns:

SNMP config structure

Throws:

Error - Generic error

get

SnmpTypes.SNMPConfigReadOnly get(InvocationConfig invocationConfig)

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.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

SNMP config structure

Throws:

Error - Generic error

get

void get(AsyncCallback<SnmpTypes.SNMPConfigReadOnly> asyncCallback)

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

Parameters:

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

get

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

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

disable

void disable()

Stop an enabled SNMP agent.

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

Throws:

Error - Generic error

disable

void disable(InvocationConfig invocationConfig)

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.

Parameters:

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error

disable

void disable(AsyncCallback<Void> asyncCallback)

Stop an enabled SNMP agent.

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

Operation Errors:
Error - Generic error

Parameters:

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

disable

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

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

set

void set(SnmpTypes.SNMPConfig config)

Set SNMP configuration.

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

Parameters:

config - SNMP configuration.

Throws:

Error - Generic error

set

void set(SnmpTypes.SNMPConfig config,
       InvocationConfig invocationConfig)

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.

Parameters:

config - SNMP configuration.

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error

set

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

Set SNMP configuration.

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

Operation Errors:
Error - Generic error

Parameters:

config - SNMP configuration.

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

set

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

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

Parameters:

config - SNMP configuration.

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

invocationConfig - Configuration for the method invocation.

test

SnmpTypes.SNMPTestResults test()

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.

Returns:

SNMP test result

Throws:

Error - Generic error

test

SnmpTypes.SNMPTestResults test(InvocationConfig invocationConfig)

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.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

SNMP test result

Throws:

Error - Generic error

test

void test(AsyncCallback<SnmpTypes.SNMPTestResults> asyncCallback)

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

Parameters:

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

test

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

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

stats

SnmpTypes.SNMPStats stats()

Generate diagnostics report for snmp agent.

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

Returns:

SNMP stats

Throws:

Error - Generic error

stats

SnmpTypes.SNMPStats stats(InvocationConfig invocationConfig)

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.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

SNMP stats

Throws:

Error - Generic error

stats

void stats(AsyncCallback<SnmpTypes.SNMPStats> asyncCallback)

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

Parameters:

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

stats

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

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

Parameters:

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

invocationConfig - Configuration for the method invocation.