avi_vrfcontext – Модуль для настройки объекта VrfContext Avi RESTful
Новое в версии 2.4.
Обзор
- Этот модуль используется для конфигурации объекта VrfContext.
- Дополнительные примеры по адресу https://github.com/avinetworks/devops
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь добавлен в 2.5 | Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования с API Avi и объектами. | |
| avi_api_patch_op - добавлен в 2.5 |
| Операция исправления, используемая при использовании avi_api_update_method как исправления. | |
| avi_api_update_method - добавлен в 2.5 |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка на patch переопределит это поведение, чтобы использовать HTTP PATCH. | |
| avi_credentials словарь добавлен в 2.5 | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. | ||
| api_version - | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller - | IP-адрес или SQDN контроллера | ||
| csrftoken - | CSRF-токен API контроллера Avi для повторного использования существующей сессии с идентификатором сессии | ||
| password - | Пароль пользователя Avi в контроллере Avi | ||
| port - | Порт контроллера Avi | ||
| session_id - | Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken | ||
| tenant - | По умолчанию: "admin" | Тенент контроллера Avi | |
| tenant_uuid - | UUID тенента контроллера Avi | ||
| timeout - | По умолчанию: 300 | Таймаут запроса контроллера Avi | |
| token - | Токен API контроллера Avi | ||
| username - | Имя пользователя контроллера Avi | ||
| avi_disable_session_cache_as_fact булево добавлен в 2.6 |
| Отключает кэширование информации о сессии Avi в качестве факта. | |
| bgp_profile - | Локальная и информация о peer BGP. | ||
| cloud_ref - | Ссылка на объект типа cloud. | ||
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER. | |
| debugvrfcontext - | Настройка флагов отладки для vrf. Поле введено в версии 17.1.1. | ||
| description - | Определение пользователем описания для объекта. | ||
| gateway_mon - | Настройка проверки работоспособности на основе пинга для шлюза в двигателях служб vrf. | ||
| internal_gateway_monitor - | Настройка проверки работоспособности на основе пинга для всех шлюзов по умолчанию в двигателях служб 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 см. по адресу https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create VrfContext object
avi_vrfcontext:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_vrfcontext
Значения возврата
Общие значения возврата документированы здесь, ниже перечислены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменение | Объект VrfContext (api/vrfcontext) |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.9/modules/avi_vrfcontext_module.html
