Модуль community.general.statusio_maintenance – создание окон обслуживания для панели status.io

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в плейбуке, укажите: community.general.statusio_maintenance.

Краткое описание
Параметры
Атрибуты
Примечания
Примеры

Краткое описание

Создаёт или удаляет окно обслуживания для status.io.

Параметры

Параметр	Комментарии
all_infrastructure_affected boolean	Затрагивает ли это все компоненты и контейнеры. Возможные значения: `false` ← (по умолчанию) `true`
api_id string / обязательный	Ваш уникальный API ID на status.io.
api_key string / обязательный	Ваш уникальный API Key на status.io.
automation boolean	Автоматически начинать и завершать окно обслуживания. Возможные значения: `false` ← (по умолчанию) `true`
components псевдонимы: component list / элементы=string	Указанное имя компонента (имя сервера).
containers псевдонимы: container list / элементы=string	Указанное имя контейнера (центра обработки данных).
desc string	Сообщение с описанием окна обслуживания. По умолчанию: `"Created by Ansible"`
maintenance_id string	Идентификатор обслуживания для удаления окна обслуживания.
maintenance_notify_1_hr boolean	Уведомить подписчиков за 1 час до начала обслуживания. Возможные значения: `false` ← (по умолчанию) `true`
maintenance_notify_24_hr boolean	Уведомить подписчиков за 24 часа до начала обслуживания. Возможные значения: `false` ← (по умолчанию) `true`
maintenance_notify_72_hr boolean	Уведомить подписчиков за 72 часа до начала обслуживания. Возможные значения: `false` ← (по умолчанию) `true`
maintenance_notify_now boolean	Уведомить подписчиков сейчас. Возможные значения: `false` ← (по умолчанию) `true`
minutes integer	Продолжительность окна обслуживания (начиная с момента запуска плейбука). По умолчанию: `10`
start_date string	Дата предполагаемого начала обслуживания (месяц/день/год) (UTC). Дата окончания рассчитывается на основе `start_date` + `minutes`.
start_time string	Время предполагаемого начала обслуживания (часы:минуты) (UTC). Время окончания рассчитывается на основе `start_time` + `minutes`.
state string	Требуемое состояние пакета. Возможные значения: `"present"` ← (по умолчанию) `"absent"`
statuspage string / обязательный	Ваш уникальный StatusPage ID на status.io.
title string	Понятное название окна обслуживания. По умолчанию: `"A new maintenance window"`
url string	URL API Status.io. Вместо него можно использовать приватный apiary. По умолчанию: `"https://api.status.io"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или о том, что может потребоваться изменить в `check_mode`).

Примечания

Примечание

Для перехвата трафика API можно использовать URL API apiary (http://docs.statusio.apiary.io/).
Для задания будущего окна обслуживания используйте start_date и start_time вместе с minutes.

Примеры

- 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

Авторы

Benjamin Copeland (@bhcopeland)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/statusio_maintenance_module.html