Let’s see what’s available in the Ansible module library, out of the box:
+| apt_repository | +apt | +assemble | +
| authorized_key | +command | +copy | +
| easy_install | +facter | +fetch | +
| file | +get_url | +git | +
| group | +mount | +mysql_db | +
| mysql_user | +nagios | +ohai | +
| ping | +pip | +postgresql_db | +
| postgresql_user | +raw | +service | +
| setup | +shell | +supervisorctl | +
| template | +user | +virt | +
| yum | ++ | + |
@@ -990,7 +1044,7 @@ finally fall back to using the MySQL default login of ‘root’ with no
New in version 0.6.
Adds or removes a user from a MySQL database.
@@ -1067,8 +1121,215 @@ finally fall back to using the MySQL default login of ‘root’ with no action: mysql_user login_user=root login_password=123456 name=sally state=absentPerform common tasks in Nagios related to downtime and notifications.
+The Nagios module has two basic functions: scheduling downtime and +toggling alerts for services or hosts.
+The following parameters are common to all actions in the nagios +module:
+| parameter | +required | +default | +comments | +
|---|---|---|---|
| action | +yes | ++ | one of: ‘downtime’, ‘enable_alerts’/’disable_alerts’, or +‘silence’/’unsilence’ | +
| host | +yes | ++ | host to operate on in nagios | +
| cmdfile | +no | +/var/spool/nagios/cmd/nagios.cmd | +path to the nagios command file (FIFO pipe) | +
The following parameters may be used with the downtime action:
+| parameter | +required | +default | +comments | +
|---|---|---|---|
| author | +no | +Ansible | +author to leave downtime comments as | +
| minutes | +no | +30 | +minutes to schedule downtime for | +
| services | +no | ++ | what to manage downtime/alerts for. separate multiple services +with commas. +service is an alias for services | +
The following parameter must be used with the enable_alerts and disable_alerts actions:
+| parameter | +required | +default | +comments | +
|---|---|---|---|
| services | +no | ++ | what to manage downtime/alerts for. separate multiple services +with commas. +service is an alias for services | +
Note
+The silence and unsilence actions have no additional +parameters that may be used with them.
+All actions require the host parameter to be given explicitly. In +playbooks you can use the $inventory_hostname variable to refer to +the host the playbook is currently running on.
+You can specify multiple services at once by separating them with +commas, .e.g., services=httpd,nfs,puppet.
+When specifying what service to handle there is a special keyword, +host, which will handle alerts/downtime for the host itself, +e.g., service=host. This keyword may not be given with other +services at the same time. Handling alerts/downtime for a host does +not affect alerts/downtime for any of the services running on it.
+Examples of Scheduling Downtime in Playbooks:
+---
+- hosts: webservers
+ user: root
+ tasks:
+ - name: set 30 minutes of apache downtime
+ action: nagios action=downtime minutes=15 service=httpd host=$inventory_hostname
+ delegate_to: nagios.example.com
+
+ - name: schedule an hour of HOST downtime
+ action: nagios action=downtime minutes=60 service=host host=$inventory_hostname
+ delegate_to: nagios.example.com
+
+ # Use the default of 30 minutes
+ # Schedule downtime for three services at once
+ - name: schedule downtime for a few services
+ action: nagios action=downtime services=frob,foobar,qeuz host=$inventory_hostname
+ delegate_to: nagios.example.com
+And from the command line:
+$ ansible nagios.example.com -m nagios -a "action=downtime minutes=15 service=httpd host=server01.example.com"
+$ ansible nagios.example.com -m nagios -a "action=downtime minutes=60 service=host host=server01.example.com"
+$ ansible nagios.example.com -m nagios -a "action=downtime services=frob,foobar,qeuz host=server01.example.com"
+Examples of handling specific host/service alerts in Playbooks:
+---
+- hosts: webservers
+ user: root
+ tasks:
+ - name: enable SMART disk alerts
+ action: nagios action=enable_alerts service=smart host=$inventory_hostname
+ delegate_to: nagios.example.com
+
+ # Note that you can disable multiple at once
+ - name: disable httpd alerts
+ action: nagios action=disable_alerts service=httpd,nfs host=$inventory_hostname
+ delegate_to: nagios.example.com
+
+ # And disabling HOST alerts
+ - name: disable HOST alerts
+ action: nagios action=disable_alerts service=host host=$inventory_hostname
+ delegate_to: nagios.example.com
+And from the command line:
+$ ansible nagios.example.com -m nagios -a "action=enable_alerts service=smart host=server01.example.com"
+$ ansible nagios.example.com -m nagios -a "action=disable_alerts service=httpd,nfs host=server01.example.com"
+$ ansible nagios.example.com -m nagios -a "action=disable_alerts service=host host=server01.example.com"
+Examples of Silencing all host/service alerts in Playbooks:
+---
+- hosts: webservers
+ user: root
+ tasks:
+ - name: silence ALL alerts
+ action: nagios action=silence host=$inventory_hostname
+ delegate_to: nagios.example.com
+
+ - name: unsilence all alerts
+ action: nagios action=unsilence host=$inventory_hostname
+ delegate_to: nagios.example.com
+And from the command line:
+$ ansible nagios.example.com -m nagios -a "action=silence host=server01.example.com"
+$ ansible nagios.example.com -m nagios -a "action=unsilence host=server01.example.com"
+Optional Configuration
+If your nagios cmdfile is not /var/spool/nagios/cmd/nagios.cmd +you can configure ansible (on your nagios server) to use the correct +one by making a file called /etc/ansible/modules/nagios.conf that +looks like this:
+[main]
+cmdfile = /path/to/your/nagios.cmd
+Or, use the cmdfile parameter to set it explicitly.
+Troubleshooting Tips
+The nagios module may not operate for you out of the box. The most +likely problem is with your cmdfile permissions/paths. You will +receive this error if that is the case:
+{"msg": "unable to write to nagios command file", "failed": true, "cmdfile": "/var/spool/nagios/cmd/nagios.cmd"}
+Steps to correct this:
+Similar to the facter module, this returns JSON inventory data. Ohai data is a bit more verbose and nested than facter.
Requires that ‘ohai’ be installed on the remote end.
@@ -1079,7 +1340,7 @@ Ohai data is a bit more verbose and nested than facter.A trivial test module, this module always returns ‘pong’ on successful contact. It does not make sense in playbooks, but is useful from /usr/bin/ansible:
@@ -1087,7 +1348,7 @@ from /usr/bin/ansible:New in version 0.7.
Manages Python library dependencies.
@@ -1145,7 +1406,7 @@ pip requirements=/srv/webapps/my_app/src/requirements.txt virtualenv=/srv/webappNew in version 0.6.
Add or remove PostgreSQL databases from a remote host.
@@ -1192,6 +1453,11 @@ host before using this module.New in version 0.6.
-Add or remove PostgreSQL users (roles) from a remote host, and grant the users -access to an existing database.
+Add or remove PostgreSQL users (roles) from a remote host and, optionally, grant the users +access to an existing database or tables.
The default authentication assumes that you are either logging in as or sudo’ing to the postgres account on the host.
This module uses psycopg2, a Python PostgreSQL database adapter. You must @@ -1243,9 +1509,19 @@ host before using this module.
The fundamental function of the module is to create, or delete, roles from a PostgreSQL cluster. +Privilege assignment, or removal, is an optional step, which works on one database at a time. +This allows for the module to be called several times in the same module to modify the permissions on +different databases, or to grant permissions to already existing users.
+A user cannot be removed untill all the privileges have been stripped from the user. In such situation, +if the module tries to remove the user it will fail. To avoid this from happening the fail_on_user option +signals the module to try to remove the user, but if not possible keep going; the module will report if changes +happened and separately if the user was removed or not.
+Example privileges string format:
++INSERT,UPDATE/table:SELECT/anothertable:ALL
Example action from Ansible Playbooks:
-postgresql_user db=acme user=django password=ceec4eif7ya
+- name: Create django user and grant access to database and products table
+ postgresql_user db=acme user=django password=ceec4eif7ya privs=CONNECT/products:ALL
+
+- name: Remove test user privileges from acme
+ postgresql_user db=acme user=test privs=ALL/products:ALL state=absent fail_on_user=no
+- name: Remove test user from test database and the cluster
+ postgresql_user db=test user=test privs=ALL state=absent
Executes a low-down and dirty SSH command, not going through the module subsystem.
This is useful and should only be done in two cases. The first case is installing python-simplejson on older (python 2.4 and before) hosts that need it as a dependency @@ -1289,7 +1582,7 @@ for this module.
Controls services on remote machines.