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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в плейбуке, укажите: 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	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или возможных изменениях в `check_mode`).

См. также

Документация 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/alerta_customer_module.html