community.general.statusio_maintenance module – Create maintenance windows for your status.io dashboard
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.statusio_maintenance
.
Synopsis
Creates a maintenance window for status.io
Deletes a maintenance window for status.io
Aliases: monitoring.statusio_maintenance
Parameters
Parameter |
Comments |
---|---|
If it affects all components and containers Choices:
|
|
Your unique API ID from status.io |
|
Your unique API Key from status.io |
|
Automatically start and end the maintenance window Choices:
|
|
The given name of your component (server name) |
|
The given name of your container (data center) |
|
Message describing the maintenance window Default: |
|
The maintenance id number when deleting a maintenance window |
|
Notify subscribers 1 hour before maintenance start time Choices:
|
|
Notify subscribers 24 hours before maintenance start time Choices:
|
|
Notify subscribers 72 hours before maintenance start time Choices:
|
|
Notify subscribers now Choices:
|
|
The length of time in UTC that the maintenance will run (starting from playbook runtime) Default: |
|
Date maintenance is expected to start (Month/Day/Year) (UTC) End Date is worked out from start_date + minutes |
|
Time maintenance is expected to start (Hour:Minutes) (UTC) End Time is worked out from start_time + minutes |
|
Desired state of the package. Choices:
|
|
Your unique StatusPage ID from status.io |
|
A descriptive title for the maintenance window Default: |
|
Status.io API URL. A private apiary can be used instead. Default: |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
You can use the apiary API url (http://docs.statusio.apiary.io/) to capture API traffic
Use start_date and start_time with minutes to set future maintenance window
Examples
- name: Create a maintenance window for 10 minutes on server1, with automation to stop the maintenance
community.general.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
- name: Create a maintenance window for 60 minutes on server1 and server2
community.general.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
delegate_to: localhost
- name: Create a future maintenance window for 24 hours to all hosts inside the Primary Data Center
community.general.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
- name: Delete a maintenance window
community.general.statusio_maintenance:
title: Remove a maintenance window
maintenance_id: 561f90faf74bc94a4700087b
statuspage: statuspage_id
api_id: api_id
api_key: api_key
state: absent