Table of contents

• Introduction
• License
• Requirements

• Installation

  • From Pypi
  • From source

• User guide

  • Get help
  • Daemon and service control
  • SNMP user management
  • Configuration file encryption and decryption

• Agent configuration file
• Agent authentication data
• Contributions
• Release note

Dell EMC Unity SNMP Off-Array Agent is a python-based application running outside of Unity system. It provides a easy-to-use CLI tool for management purpose and a daemon to handle the incoming SNMP queries.

Any SNMP client can communicate with this agent to retrieve the storage information via SNMP protocol. Currently the SNMP trap is not supported by this agent.

The Unity is the first product supported by this agent. Here are the features:

• Support SNMPv2c and SNMPv3 protocol.
• Support multiple storage systems management.
• Platform independent, both Windows and Linux are supported.
• Capability to deploy and install without internet access.
• Encrypt/Decrypt the configure file of the agent.

Apache License 2.0

• Python 2.7 or Python 3.4 and above.
• Linux/Windows.

Install via pip is recommended way to deploy the snmpagent-unity.

pip install snmpagent-unity

If latest code is preferred, User can clone this repository and install from source.

git clone http://github.com/emc-openstack/snmpagent-unity
cd snmpagent-unity
python setup.py install

After installation, a command line tool snmpagent-unity will be installed under /usr/local/bin/ (Linux) or <python installation path>\Scripts\ (Windows)

• Get general help

snmpagent-unity --help

Print out the help manual to list all subcommands.

• Get help for specific command

snmpagent-unity <CMD> --help

Print out the help manual of a specific <CMD>. <CMD> supports add-user, update-user, delete-user, create-community, delete-community, list-users, encrypt, decrypt, start, stop, restart.

• Start a daemon

snmpagent-unity start --conf_file <file_path>

Start a SNMP agent with the specified configuration file <file_path>. This command will return error if the daemon is already running. For the configuration file, you can refer to Agent configuration file

• Restart a running daemon

snmpagent-unity restart

Restart a SNMP agent. An error will occur if not running daemon found.

• Stop a running daemon

snmpagent-unity stop

When running in docker, it has to be run in foreground, cli allows this

snmpagent-unity run --conf_file <file_path>

Start a SNMP agent in the foreground with the specified configuration file <file_path>.

docker run -v /path/to/config.conf:/app/config.conf -p 11161:11161/udp fctninc/snmp-unity-agent:latest run --conf_file /app/config.conf

• Create a SNMP v2 community

snmpagent-unity create-community --name <community_name>

• Delete a SNMP v2 community

snmpagent-unity delete-community --name <community_name>

• Create a SNMP v3 user

snmpagent-unity add-user --name <user_name> --auth <auth_protocol> --auth_key <auth_password> [--priv <privacy_protocol>] [--priv_key <priv_password>]

Create a SNMPv3 user with user name, authentication protocol, authentication password, privacy protocol and privacy password.

Authentication Protocols supported are:

• MD5
• SHA

Privacy Protocols supported are:

• DES
• AES

• Update a SNMP v3 user

snmpagent-unity update-user --name <user_name> --auth <new_auth_protocol> --auth_key <new_auth_password> [--priv <new_priv_protocol>] [--priv_key <new_priv_password>]

Change privacy protocol and privacy password if provided.

• Delete a SNMP v3 user

snmpagent-unity delete-user --name <user_name>

• List all users

snmpagent-unity list-users

List all SNMP users, including v2c and v3. But for SNMPv3 user, the authentication password and privacy password are encrypted. Sample output of the command list-users:

SNMP Version 2 Community Access:
public
    Version:    SNMP Version 2c
    Community:  public

SNMP Version 3 Users:
for_update
    Version:            SNMP Version 3
    Security Level:     Authentication
    Auth Protocol:      MD5
    Auth Key:           ******
    Privacy Protocol:   -
    Privacy Key:        -

• Encrypt a configuration file

snmpagent-unity encrypt --conf_file <file_path>

Encrypt the specified configuration file. The password of the Unity system is encrypted if it is pain text.

• Decrypt a configuration file

snmpagent-unity decrypt --conf_file <file_path>

Decrypt the specified configuration file. The password of the Unity system is decrypted if it is encrypted.

In an agent configuration file, a fixed section [DEFAULT] is required for global settings.

Following options can be configured under [DEFAULT]:

# Host IP address for listening by the agent
agent_ip=0.0.0.0
# Logging level of the agent
# Supported log level: debug, info, warning, error, critical
log_level=info
# Log file, can be relative or absolute file path
log_file=snmpagent-unity.log
# Max size in bytes before log rotation
log_file_maxbytes=104857600
# Max log file count
log_file_count=10

The agent also supports varying amount of Unity systems in one agent file, here is the configuration for two unity systems:

[unity-1]
# Port for servicing the SNMP requests
agent_port=11161
# System model, unity is the only supported model for now
model=unity
# Unity Management IP address
mgmt_ip=10.10.10.1
# Unity User login
user=admin
# Unity User password
password=password
# Cache interval before fetching new stats From Unity system.
# Consider setting it to a appropriate value in second for aspects of
# performance and timeliness
# Please set a smaller value than metric query interval (60s)
# so the metric info can be calculated correctly
cache_interval=30

[unity-2]
agent_port=11162
model=unity
mgmt_ip=10.10.10.2
user=admin
password=password
cache_interval=30

User can configure multiple sections for different system, be aware that each section should have a unique section name(like unity-1 and unity-2 in above example).

Restart is required for any change in configration file to take effect.

For a complete example, please check out the agent configuration file agent.conf

The Unity SNMP agent stores the encrypted access data under the home of user running the agent. Usually it's %USERPROFILE%\.snmpagent-unity\ on Windows, $HOME/.snmpagent-unity/ on Linux.

Simply fork this repo and send PR for your code change(also tests to cover your change), remember to give a title and description of your PR. We are willing to enhance this project with you :).

v0.1.0: First release of snmpagent-unity