community.general.statusio_maintenance module – Create maintenance windows for your status.io dashboard

Note

This module is part of the community.general collection (version 10.7.5).

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 or deletes a maintenance window for status.io.

Parameters

Parameter

Comments

all_infrastructure_affected

boolean

If it affects all components and containers.

Choices:

  • false ← (default)

  • true

api_id

string / required

Your unique API ID from status.io.

api_key

string / required

Your unique API Key from status.io.

automation

boolean

Automatically start and end the maintenance window.

Choices:

  • false ← (default)

  • true

components

aliases: component

list / elements=string

The given name of your component (server name).

containers

aliases: container

list / elements=string

The given name of your container (data center).

desc

string

Message describing the maintenance window.

Default: "Created by Ansible"

maintenance_id

string

The maintenance ID number when deleting a maintenance window.

maintenance_notify_1_hr

boolean

Notify subscribers 1 hour before maintenance start time.

Choices:

  • false ← (default)

  • true

maintenance_notify_24_hr

boolean

Notify subscribers 24 hours before maintenance start time.

Choices:

  • false ← (default)

  • true

maintenance_notify_72_hr

boolean

Notify subscribers 72 hours before maintenance start time.

Choices:

  • false ← (default)

  • true

maintenance_notify_now

boolean

Notify subscribers now.

Choices:

  • false ← (default)

  • true

minutes

integer

The length of time in UTC that the maintenance will run (starting from playbook runtime).

Default: 10

start_date

string

Date maintenance is expected to start (Month/Day/Year) (UTC).

End Date is worked out from start_date + minutes.

start_time

string

Time maintenance is expected to start (Hour:Minutes) (UTC).

End Time is worked out from start_time + minutes.

state

string

Desired state of the package.

Choices:

  • "present" ← (default)

  • "absent"

statuspage

string / required

Your unique StatusPage ID from status.io.

title

string

A descriptive title for the maintenance window.

Default: "A new maintenance window"

url

string

Status.io API URL. A private apiary can be used instead.

Default: "https://api.status.io"

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

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

Authors

  • Benjamin Copeland (@bhcopeland)