Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.network.avi_snmptrapprofile.

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

Обзор

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

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

Требования

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

  • avisdk

Параметры

Параметр

Комментарии

api_context

словарь

Контекст Avi API, включающий текущий идентификатор сеанса и токен CSRF.

Это позволяет пользователю выполнить одно входное действие и повторно использовать сеанс.

api_version

строка

Версия Avi API, используемая для взаимодействия с Avi API и объектами.

По умолчанию: "16.4.4"

avi_api_patch_op

строка

Операция обновления, используемая при применении avi_api_update_method как patch.

Выбор:

  • "add"
  • "replace"
  • "delete"

avi_api_update_method

строка

Метод обновления объекта по умолчанию — HTTP PUT.

Установка в patch переопределит это поведение, используя 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

строка

UUID тенента контроллера Avi

По умолчанию: ""

timeout

строка

Таймаут запроса контроллера Avi

По умолчанию: 300

token

строка

Токен API контроллера Avi

По умолчанию: ""

username

строка

Имя пользователя контроллера Avi

avi_disable_session_cache_as_fact

логическое

Отключает кэширование информации о сеансе Avi в качестве факта.

Выбор:

  • false ← (по умолчанию)
  • true

controller

строка

IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER

name

строка / обязательно

Наглядное имя конфигурации snmp trap.

password

строка

Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD

state

строка

Состояние, которое должно быть применено к сущности.

Выбор:

  • "absent"
  • "present" ← (по умолчанию)
END_OF_DOCUMENT_MARKER

tenant

string

Имя используемого для всех вызовов API Avi и контекста объекта клиента.

По умолчанию: "admin"

tenant_ref

string

Ссылка на объект типа tenant.

tenant_uuid

string

UUID клиента, используемого для всех вызовов API Avi и контекста объекта.

По умолчанию: ""

trap_servers

string

IP-адрес или имя хоста сервера назначения SNMP-ловушки.

url

string

URL контроллера Avi для объекта.

username

string

Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME.

uuid

string

UUID объекта профиля SNMP-ловушки.

Примечания

Примечание

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

Примеры

- name: Example to create SnmpTrapProfile object
  community.network.avi_snmptrapprofile:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_snmptrapprofile

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

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

Ключ

Описание

obj

словарь

Объект SnmpTrapProfile (api/snmptrapprofile)

Возвращается при: успехе, изменении

Авторы

  • 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_snmptrapprofile_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API