avi_network – Модуль для настройки RESTful объекта Network Avi
Новая версия с 2.4.
Описание
- Этот модуль используется для настройки объекта Network
- больше примеров на 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 как patch. | |
| avi_api_update_method - добавлен в 2.5 |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка значения на patch переопределяет это поведение, чтобы использовать HTTP PATCH. | |
| avi_credentials словарь добавлен в 2.5 | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в Avi Controller. | ||
| api_version - | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller - | IP-адрес или SQDN контроллера Avi | ||
| 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 в качестве факта. | |
| cloud_ref - | Ссылка на объект типа cloud. | ||
| configured_subnets - | Список подсетей. | ||
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| dhcp_enabled логическое |
| Выберите схему управления IP-адресами для этой сети. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| exclude_discovered_subnets логическое |
| При выборе исключает все обнаруженные подсети в этой сети из рассмотрения для размещения виртуальной службы. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| ip6_autocfg_enabled логическое добавлен в 2.9 |
| Включить автоматическую настройку 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
avi_network:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_network
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | success, changed | Сеть (api/network) объект |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [предварительный просмотр]
- Этот модуль поддерживается сообществом 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_network_module.html