Модуль community.general.alerta_customer – Управление клиентами в Alerta

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: community.general.alerta_customer.

Новое в community.general 4.8.0

Обзор
Параметры
Атрибуты
См. также
Примеры
Возвращаемые значения

Обзор

Создание или удаление клиентов в Alerta с помощью REST API.

Параметры

Параметр	Комментарии
alerta_url строка / обязательно	Конечная точка API Alerta.
api_key строка	Токен доступа к API.
api_password строка	Пароль для API с использованием базовой аутентификации.
api_username строка	Имя пользователя для API с использованием базовой аутентификации.
customer строка / обязательно	Имя клиента.
match строка / обязательно	Пользователь для входа, соответствующий клиенту.
state строка	Следует ли клиент существовать или нет. И `customer` и `match` определяют клиента, который должен быть добавлен или удален. Варианты: `"absent"` `"present"` ← (по умолчанию)

Атрибуты

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

См. также

Документация API: Документация API Alerta

Примеры

- name: Create customer
  community.general.alerta_customer:
    alerta_url: https://alerta.example.com
    api_username: admin@example.com
    api_password: password
    customer: Developer
    match: dev@example.com

- name: Delete customer
  community.general.alerta_customer:
    alerta_url: https://alerta.example.com
    api_username: admin@example.com
    api_password: password
    customer: Developer
    match: dev@example.com
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
msg строка	Сообщение об успехе или ошибке. Возвращается: всегда Пример: `"Customer customer1 created"`
response словарь	Ответ от API. Возвращается: всегда

Авторы

Christian Wollinger (@cwollinger)

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

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