community.network.avi_network – Модуль для настройки объекта сети Avi RESTful
Примечание
Этот плагин является частью коллекции community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Чтобы использовать его в книге задач, укажите: community.network.avi_network.
Обзор
- Этот модуль используется для настройки объекта сети
- больше примеров на 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 контроллера API Avi для повторного использования существующего сеанса с идентификатором сеанса | ||
| password строка | Пароль пользователя контроллера 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 логическое значение |
| Отключает кеширование информации о сеансе avi в качестве факта. | |
| cloud_ref строка | Ссылка на объект типа cloud. | ||
| configured_subnets строка | Список подсетей. | ||
| controller строка | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| dhcp_enabled логическое значение |
| Выберите схему управления IP-адресами для этой сети. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| exclude_discovered_subnets логическое значение |
| При выборе исключает все обнаруженные подсети в этой сети из рассмотрения для размещения виртуальной службы. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| ip6_autocfg_enabled логическое значение |
| Включить автоматическую настройку ipv6. Поле введено в 18.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| name строка / обязательный | Имя объекта. | ||
| password строка | Значение по умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | |
| state строка |
| Состояние, которое должно быть применено к сущности. | |
| synced_from_se логическое значение |
| Флаг логического значения для установки synced_from_se. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| tenant строка | Значение по умолчанию: "admin" | Имя тенента, используемое для всех вызовов API Avi и контекста объекта. | |
| tenant_ref строка | Ссылка на объект типа tenant. | ||
| tenant_uuid строка | Значение по умолчанию: "" | UUID тенента, используемого для всех вызовов API Avi и контекста объекта. | |
| url строка | URL-адрес контроллера Avi для объекта. | ||
| username строка | Значение по умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | |
| uuid строка | Уникальный идентификатор объекта. | ||
| vcenter_dvs логическое значение |
| Флаг логического значения для установки vcenter_dvs. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| vimgrnw_ref строка | Ссылка на объект типа vimgrnwruntime. | ||
| vrf_context_ref строка | Ссылка на объект типа vrfcontext. | ||
Примечания
Примечание
- Для получения дополнительной информации об использовании Ansible для управления устройствами сети Avi см. https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create Network object
community.network.avi_network:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_network
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменен | Объект сети (api/network) |
Авторы
- Гaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/avi_network_module.html