модуль community.general.pagerduty — создание окон обслуживания PagerDuty
Примечание
Этот модуль входит в коллекцию community.general (версия 12.6.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты; подробнее см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: community.general.pagerduty.
Краткое описание
- Этот модуль позволяет создавать окна обслуживания PagerDuty.
Требования
Следующие требования должны быть выполнены на узле, где выполняется этот модуль.
- Доступ к API PagerDuty
Параметры
Параметр | Комментарии |
|---|---|
desc строка | Краткое описание окна обслуживания. По умолчанию: |
hours строка | Продолжительность окна обслуживания в часах. По умолчанию: |
minutes строка | Продолжительность окна обслуживания в минутах (добавляется к часам). По умолчанию: |
name строка | Уникальный поддомен PagerDuty. Устарел. Не используется с REST API PagerDuty версии 2. |
requester_id строка | ID пользователя, отправляющего запрос. Требуется только при создании maintenance_window. |
service псевдонимы: services список / элементы=строка | Список ID служб PagerDuty, разделённых запятыми. |
state строка / обязательный | Создать окно обслуживания или получить список текущих окон. Варианты:
|
token строка / обязательный | Токен PagerDuty, созданный на сайте PagerDuty. Используется для авторизации. |
user строка | ID пользователя PagerDuty. Устарел. Для авторизации используйте |
validate_certs логический | Если значение Варианты:
|
window_id строка | ID окна обслуживания. Требуется только при отсутствии maintenance_window. |
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: нет | Можно выполнять в режиме |
diff_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 }}"
Ссылки на коллекцию
© 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/pagerduty_module.html
