community.network.avi_alertscriptconfig модуль – Модуль для настройки объекта AlertScriptConfig Avi RESTful

Примечание

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

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

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

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

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Этот модуль используется для настройки объекта AlertScriptConfig
дополнительные примеры по адресу https://github.com/avinetworks/devops

Псевдонимы: network.avi.avi_alertscriptconfig

Требования

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

avisdk

Параметры

Параметр	Комментарии
action_script строка	Пользовательский скрипт действия оповещения. Дополнительную информацию см. на сайте kb.avinetworks.com.
api_context словарь	Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс.
api_version строка	Версия API Avi для использования с API Avi и объектами. По умолчанию: `"16.4.4"`
avi_api_patch_op строка	Операция исправления, используемая при использовании avi_api_update_method как исправление. Варианты: `"add"` `"replace"` `"delete"`
avi_api_update_method строка	Метод по умолчанию для обновления объекта — HTTP PUT. Установка на исправление переопределит это поведение, чтобы использовать HTTP PATCH. Варианты: `"put"` ← (по умолчанию) `"patch"`
avi_credentials словарь	Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi.
api_version строка	Версия контроллера Avi По умолчанию: `"16.4.4"`
controller строка	IP-адрес или SQDN контроллера
csrftoken строка	Токен csrf API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса По умолчанию: `""`
password строка	Пароль пользователя Avi в контроллере Avi
port строка	Порт контроллера Avi
session_id строка	Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken По умолчанию: `""`
tenant строка	Домен контроллера Avi По умолчанию: `"admin"`
tenant_uuid строка	Уникальный идентификатор домена контроллера Avi По умолчанию: `""`
timeout строка	Тайм-аут запроса контроллера Avi По умолчанию: `300`
token строка	Токен API контроллера Avi По умолчанию: `""`
username строка	Имя пользователя контроллера Avi
avi_disable_session_cache_as_fact логический	Отключает кеширование информации о сеансе Avi в качестве факта. Варианты: `false` ← (по умолчанию) `true`
controller строка	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`.
name строка / обязательно	Наглядное имя скрипта.
password строка	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`.
state строка	Состояние, которое должно быть применено к сущности. Варианты: `"absent"` `"present"` ← (по умолчанию)

END_OF_DOCUMENT_MARKER

tenant string	Имя используемого для всех вызовов API Avi и контекста объекта арендатора. По умолчанию: `"admin"`
tenant_ref string	Ссылка на объект типа арендатора.
tenant_uuid string	UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `""`
url string	URL контроллера Avi для объекта.
username string	Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения `AVI_USERNAME`.
uuid string	Уникальный идентификатор объекта.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице https://www.ansible.com/ansible-avi-networks.

Примеры

- name: Create Alert Script to perform AWS server autoscaling
  community.network.avi_alertscriptconfig:
    username: '{{ username }}'
    controller: '{{ controller }}'
    password: '{{ password }}'
    action_script: "echo Hello"
    name: AWS-Launch-Script
    tenant_ref: Demo

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

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

Ключ	Описание
obj dictionary	Объект AlertScriptConfig (api/alertscriptconfig) Возвращаемое значение: success, changed

Авторы

Gaurav Rastogi (@grastogi23)

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

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