New in version 2.2.
Creates a maintenance window for status.io Deletes a maintenance window for status.io
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| all_infrastructure_affected | no | If it affects all components and containers |
||
| api_id | yes | Your unique API ID from status.io |
||
| api_key | yes | Your unique API Key from status.io |
||
| automation | no | Automatically start and end the maintenance window |
||
| components | no | None |
The given name of your component (server name) aliases: component
|
|
| containers | no | None |
The given name of your container (data center) aliases: container
|
|
| desc | no | Created by Ansible | Message describing the maintenance window |
|
| maintenance_id | no | None | The maintenance id number when deleting a maintenance window |
|
| maintenance_notify_1_hr | no | Notify subscribers 1 hour before maintenance start time |
||
| maintenance_notify_24_hr | no | Notify subscribers 24 hours before maintenance start time |
||
| maintenance_notify_72_hr | no | Notify subscribers 72 hours before maintenance start time |
||
| maintenance_notify_now | no | Notify subscribers now |
||
| minutes | no | 10 | The length of time in UTC that the maintenance will run (starting from playbook runtime) |
|
| start_date | no | None |
Date maintenance is expected to start (Month/Day/Year) (UTC)
End Date is worked out from start_date + minutes
|
|
| start_time | no | None |
Time maintenance is expected to start (Hour:Minutes) (UTC)
End Time is worked out from start_time + minutes
|
|
| state | no | present |
| Desired state of the package. |
| statuspage | yes | Your unique StatusPage ID from status.io |
||
| title | no | A new maintenance window | A descriptive title for the maintenance window |
|
| url | no | https://api.status.io | Status.io API URL. A private apiary can be used instead. |
# Create a maintenance window for 10 minutes on server1.example.com, with
automation to stop the maintenance.
- statusio_maintenance:
title: "Router Upgrade from ansible"
desc: "Performing a Router Upgrade"
components: "server1.example.com"
api_id: "api_id"
api_key: "api_key"
statuspage: "statuspage_id"
maintenance_notify_1_hr: true
automation: true
# Create a maintenance window for 60 minutes on multiple hosts
- name: "Create maintenance window for server1 and server2"
local_action:
module: statusio_maintenance
title: "Routine maintenance"
desc: "Some security updates"
components:
- "server1.example.com"
- "server2.example.com"
minutes: "60"
api_id: "api_id"
api_key: "api_key"
statuspage: "statuspage_id"
maintenance_notify_1_hr: true
automation: true
# Create a future maintenance window for 24 hours to all hosts inside the
# Primary Data Center
- statusio_maintenance:
title: Data center downtime
desc: Performing a Upgrade to our data center
components: "Primary Data Center"
api_id: "api_id"
api_key: "api_key"
statuspage: "statuspage_id"
start_date: "01/01/2016"
start_time: "12:00"
minutes: 1440
# Delete a maintenance window
- statusio_maintenance:
title: "Remove a maintenance window"
maintenance_id: "561f90faf74bc94a4700087b"
statuspage: "statuspage_id"
api_id: "api_id"
api_key: "api_key"
state: absent
Note
You can use the apiary API url (http://docs.statusio.apiary.io/) to capture API traffic
Note
Use start_date and start_time with minutes to set future maintenance window
For more information on what this means please read Extras Modules
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.
© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/statusio_maintenance_module.html