VMware

Snmp Namespace

Snmp namespace provides commands SNMP agent operations.

List of commands:



Reset Command

dcli com vmware appliance techpreview monitoring snmp reset

Description

Restore settings to factory defaults.

Example

dcli com vmware appliance techpreview monitoring snmp reset


Enable Command

dcli com vmware appliance techpreview monitoring snmp enable

Description

Start a disabled SNMP agent.

Example

dcli com vmware appliance techpreview monitoring snmp enable


Hash Command

dcli com vmware appliance techpreview monitoring snmp hash

Description

Generate localized keys for secure SNMPv3 communications.

Options

Option Name Type Required Description
auth‑hash string Yes Provide filename to secret for authentication hash, use in set --users (required secret)
priv‑hash string Yes Provide filename to secret for privacy hash, use in set --users (secret)
raw‑secret bool Yes Make --auth_path and --priv_path flags read raw secret from command line instead of file.

Example

dcli com vmware appliance techpreview monitoring snmp hash --auth-hash testString --priv-hash testString --raw-secret test


Limits Command

dcli com vmware appliance techpreview monitoring snmp limits

Description

Get SNMP limits information.

Example

dcli com vmware appliance techpreview monitoring snmp limits


Get Command

dcli com vmware appliance techpreview monitoring snmp get

Description

Return an SNMP agent configuration.

Example

dcli com vmware appliance techpreview monitoring snmp get


Disable Command

dcli com vmware appliance techpreview monitoring snmp disable

Description

Stop an enabled SNMP agent.

Example

dcli com vmware appliance techpreview monitoring snmp disable


Set Command

dcli com vmware appliance techpreview monitoring snmp set

Description

Set SNMP configuration.

Options

Option Name Type Required Description
authentication string Yes Set the default authentication protocol. Values can be none, MD5, or SHA1. Valid values are: {none, SHA1, MD5}
communities string Yes Set up to ten communities, each of no more than 64 characters long. The format is: community1[,community2,...]. This setting overwrites any previous settings.
engineid string Yes Set SNMPv3 engine ID. The engine ID must contain 5 to 32 hexadecimal characters. "0x" and colon (:) are removed from the ID.
loglevel string Yes System Agent syslog logging level: debug|info|warning|error.
notraps string Yes Comma-separated list of trap OIDs (object identifiers) for traps not to be sent by the agent. Use 'reset' to clear the setting.
port int Yes Set up a UDP port which the SNMP agent uses to listen on for polling requests. The default UDP port is 161.
privacy string Yes Set the default privacy protocol. Values: none or AES128. Valid values are: {AES128, none}
remoteusers string Yes Set up to five inform user IDs. The format is: user/auth-proto/-|auth-hash/priv-proto/-|priv-hash/engine-id[,...]. Here, user must be maximum 32 characters long; auth-proto is none, MD5 or SHA1; priv-proto is none or AES; '-' indicates no hash; engine-id is a hexadecimal string '0x0-9a-f' and must be up to 32 characters long.
syscontact string Yes System contact string as presented in sysContact.0. Up to 255 characters long.
syslocation string Yes System location string as presented in sysLocation.0. Up to 255 characters long.
targets string Yes Set up to three targets to which to send SNMPv1 traps. The format is: ip-or-hostname[@port]/community[,...]. The default port is UDP 162. This setting overwrites any previous settings.
users string Yes Set up to five local users. The format is: user/-|auth-hash/-|priv-hash/model[,...]. Here user is maximum 32 characters long; '-' indicates no hash; model is one of none, auth or priv.
v3targets string Yes Set up to three SNMPv3 notification targets. Format is: ip-or-hostname[@port]/remote-user/security-level/trap|inform[,...].

Example

dcli com vmware appliance techpreview monitoring snmp set --authentication test --communities testString --engineid testString --loglevel testString --notraps testString --port test --privacy test --remoteusers testString --syscontact testString --syslocation testString --targets testString --users testString --v3targets testString


Test Command

dcli com vmware appliance techpreview monitoring snmp test

Description

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

Example

dcli com vmware appliance techpreview monitoring snmp test


Stats Command

dcli com vmware appliance techpreview monitoring snmp stats

Description

Generate diagnostics report for snmp agent.

Example

dcli com vmware appliance techpreview monitoring snmp stats