Модуль community.general.pagerduty — Создание окон технического обслуживания PagerDuty

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: community.general.pagerduty.

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

Описание

Этот модуль позволяет создавать окна технического обслуживания PagerDuty

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

Доступ к API PagerDuty

Параметры

Параметр	Комментарии
desc строка	Краткое описание окна технического обслуживания. По умолчанию: `"Created by Ansible"`
hours строка	Продолжительность окна технического обслуживания в часах. По умолчанию: `"1"`
minutes строка	Продолжительность окна технического обслуживания в минутах (добавляется к часам). По умолчанию: `"0"`
name строка	Уникальный субдомен PagerDuty. Устаревшее значение. Не используется с API PagerDuty REST v2.
requester_id строка	ID пользователя, инициировавшего запрос. Требуется только при создании maintenance_window.
service aliases: services список / элементы=строка	Список идентификаторов служб PagerDuty, разделенных запятыми.
state строка / обязательный	Создать окно технического обслуживания или получить список активных окон. Варианты: `"running"` `"started"` `"ongoing"` `"absent"`
token строка / обязательный	Токен PagerDuty, сгенерированный на сайте PagerDuty. Используется для авторизации.
user строка	ID пользователя PagerDuty. Устаревшее значение. Используйте `token` для авторизации.
validate_certs булево	Если `false`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с самозаверенными сертификатами. Варианты: `false` `true` ← (по умолчанию)
window_id строка	ID окна технического обслуживания. Требуется только при отсутствии maintenance_window.

Атрибуты

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

Примеры

- name: List ongoing maintenance windows using a token
  community.general.pagerduty:
    name: companyabc
    token: xxxxxxxxxxxxxx
    state: ongoing

- name: Create a 1 hour maintenance window for service FOO123
  community.general.pagerduty:
    name: companyabc
    user: example@example.com
    token: yourtoken
    state: running
    service: FOO123

- name: Create a 5 minute maintenance window for service FOO123
  community.general.pagerduty:
    name: companyabc
    token: xxxxxxxxxxxxxx
    hours: 0
    minutes: 5
    state: running
    service: FOO123


- name: Create a 4 hour maintenance window for service FOO123 with the description "deployment"
  community.general.pagerduty:
    name: companyabc
    user: example@example.com
    state: running
    service: FOO123
    hours: 4
    desc: deployment
  register: pd_window

- name: Delete the previous maintenance window
  community.general.pagerduty:
    name: companyabc
    user: example@example.com
    state: absent
    window_id: '{{ pd_window.result.maintenance_window.id }}'

# Delete a maintenance window from a separate playbook than its creation,
# and if it is the only existing maintenance window
- name: Check
  community.general.pagerduty:
    requester_id: XXXXXXX
    token: yourtoken
    state: ongoing
  register: pd_window

- name: Delete
  community.general.pagerduty:
    requester_id: XXXXXXX
    token: yourtoken
    state: absent
    window_id: "{{ pd_window.result.maintenance_windows[0].id }}"

Авторы

Andrew Newdigate (@suprememoocow)
Dylan Silva (@thaumos)
Justin Johns
Bruce Pennypacker (@bpennypacker)

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

© 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/pagerduty_module.html