community.network.avi_vrfcontext – Модуль для настройки объекта VrfContext Avi RESTful
Примечание
Этот плагин входит в коллекцию community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Чтобы использовать его в плейбуке, укажите: community.network.avi_vrfcontext.
Обзор
- Этот модуль используется для настройки объекта VrfContext.
- Дополнительные примеры см. на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь | Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования с API Avi и объектами. | |
| avi_api_patch_op строка |
| Операция патча для использования при использовании avi_api_update_method как patch. | |
| avi_api_update_method строка |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка на patch переопределит это поведение, чтобы использовать HTTP PATCH. | |
| avi_credentials словарь | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в Avi контроллер. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или SQDN контроллера | ||
| csrftoken строка | Токен csrf контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса | ||
| password строка | Пароль пользователя Avi в контроллере Avi | ||
| port строка | Порт контроллера Avi | ||
| session_id строка | Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с токеном csrf | ||
| tenant строка | По умолчанию: "admin" | Тенант контроллера Avi | |
| tenant_uuid строка | Уникальный идентификатор UUID (tenant) контроллера Avi | ||
| timeout строка | По умолчанию: 300 | Время ожидания запроса контроллера Avi | |
| token строка | Токен API контроллера Avi | ||
| username строка | Имя пользователя для доступа к контроллеру Avi | ||
| avi_disable_session_cache_as_fact логическое |
| Отключает кеширование информации о сеансе avi в качестве факта. | |
| bgp_profile строка | Информация о локальном и peer BGP. | ||
| cloud_ref строка | Ссылка на объект типа cloud. | ||
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER. | |
| debugvrfcontext строка | Настройка флагов отладки для vrf. Поле добавлено в 17.1.1. | ||
| description строка | Определяемая пользователем строка описания объекта. | ||
| gateway_mon строка | Настройка проверки времени ожидания на основе ping для шлюза в сетевых шлюзах vrf. | ||
| internal_gateway_monitor строка | Настройка проверки времени ожидания на основе ping для всех шлюзов по умолчанию в сетевых шлюзах vrf. Поле добавлено в 17.1.1. | ||
| name строка / обязательно | Имя объекта. | ||
| password строка | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения AVI_PASSWORD. | |
| state строка |
| Состояние, которое должно быть применено к сущности. | |
| static_routes строка | Список статических маршрутов. | ||
| system_default логическое |
| Логический флаг для установки system_default. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| tenant строка | По умолчанию: "admin" | Имя тенанта, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_ref строка | Ссылка на объект типа tenant. | ||
| tenant_uuid строка | По умолчанию: "" | UUID тенанта, используемого для всех вызовов API Avi и контекста объекта. | |
| url строка | URL контроллера Avi для объекта. | ||
| username строка | По умолчанию: "" | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME. | |
| uuid строка | Уникальный идентификатор объекта. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create VrfContext object
community.network.avi_vrfcontext:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_vrfcontext
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменилось | Объект VrfContext (api/vrfcontext) |
Авторы
- Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/avi_vrfcontext_module.html
