diff options
| author | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-20 12:27:03 -0500 |
|---|---|---|
| committer | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-20 12:27:03 -0500 |
| commit | b899d9451dd6f9bc4c2c0b58d6972d3c77dd5d7b (patch) | |
| tree | a4bd4f5c78b8652e87d8a2fea746d4a0ec83b0ef /roles/snmp | |
| parent | f29466033dd249f995797b177c944d16253409e5 (diff) | |
| download | selfhosted-b899d9451dd6f9bc4c2c0b58d6972d3c77dd5d7b.tar.gz selfhosted-b899d9451dd6f9bc4c2c0b58d6972d3c77dd5d7b.zip | |
snmp: add docs
Diffstat (limited to 'roles/snmp')
| -rw-r--r-- | roles/snmp/README.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/roles/snmp/README.md b/roles/snmp/README.md new file mode 100644 index 0000000..8a13fbd --- /dev/null +++ b/roles/snmp/README.md @@ -0,0 +1,50 @@ +SNMP +==== + +Description +----------- + +The `snmp` role installs [net-snmp](http://www.net-snmp.org/) and adds +SNMPv3 user accounts. + +Variables +--------- + +This role **accepts** the following variables: + +Variable | Default | Description +-------------------|-------------------------------------------------|------------ +`snmp_location` | `unknown` | SNMP location string +`snmp_contact` | `root@{{ email_domain }}` | SNMP email contact +`snmp_force_users` | no | Re-create SNMPv3 users even if they already exist +`snmp_v3_users` | nagios user (see [defaults](defaults/main.yml)) | SNMPv3 user accounts (see [format](#snmp_v3_users) below) + +### snmp\_v3\_users + +The `snmp_v3_users` variable specifies the SNMPv3 users to create. It should +contain a list of dictionaries of the following format: + +Key | Default | Description +------------|------------|------------ +`name` | | SNMPv3 username +`auth_pass` | | SNMPv3 authentication password +`priv_pass` | | SNMPv3 privacy password + +Usage +----- + +Example playbook: + +````yaml +- name: configure SNMP + hosts: all + roles: + - role: snmp + vars: + snmp_location: my datacenter + snmp_contact: sysadmins@example.com + snmp_v3_users: + - name: nagios + auth_pass: s3cret + priv_pass: hunter2 +```` |