community.general.statusio_maintenance модуль — Создание окон технического обслуживания для вашей панели мониторинга status.io

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.general.statusio_maintenance.

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

Описание

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

Параметры

Параметр	Комментарии
all_infrastructure_affected boolean	Влияет ли это на все компоненты и контейнеры Варианты: `false` ← (default) `true`
api_id string / required	Ваш уникальный API ID от status.io
api_key string / required	Ваш уникальный API Key от status.io
automation boolean	Автоматически запускать и завершать окно технического обслуживания Варианты: `false` ← (default) `true`
components aliases: component list / elements=string	Заданное имя вашего компонента (имя сервера)
containers aliases: container list / elements=string	Заданное имя вашего контейнера (дата-центр)
desc string	Сообщение, описывающее окно технического обслуживания Значение по умолчанию: `"Created by Ansible"`
maintenance_id string	Номер идентификатора технического обслуживания при удалении окна технического обслуживания
maintenance_notify_1_hr boolean	Уведомлять подписчиков за 1 час до начала технического обслуживания Варианты: `false` ← (default) `true`
maintenance_notify_24_hr boolean	Уведомлять подписчиков за 24 часа до начала технического обслуживания Варианты: `false` ← (default) `true`
maintenance_notify_72_hr boolean	Уведомлять подписчиков за 72 часа до начала технического обслуживания Варианты: `false` ← (default) `true`
maintenance_notify_now boolean	Уведомлять подписчиков сейчас Варианты: `false` ← (default) `true`
minutes integer	Продолжительность в UTC, в течение которой будет выполняться техническое обслуживание (начиная с времени выполнения playbook) Значение по умолчанию: `10`
start_date string	Дата начала технического обслуживания (Месяц/День/Год) (UTC) Конечная дата рассчитывается из start_date + minutes
start_time string	Время начала технического обслуживания (Час:Минуты) (UTC) Конечное время рассчитывается из start_time + minutes
state string	Требуемое состояние пакета. Варианты: `"present"` ← (default) `"absent"`
statuspage string / required	Ваш уникальный 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`).

Примечания

Примечание

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

Примеры

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/statusio_maintenance_module.html