community.network.avi_network модуль — Модуль для настройки объекта сети Avi RESTful
Примечание
Этот модуль является частью коллекции community.network (версия 5.0.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования в playbook укажите: community.network.avi_network.
Описание
- Этот модуль используется для настройки объекта сети
- Дополнительные примеры на https://github.com/avinetworks/devops
Псевдонимы: network.avi.avi_network
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
Параметр | Комментарии |
|---|---|
api_context словарь | Контекст Avi API, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию. |
api_version строка | Версия Avi API для использования с Avi API и объектами. По умолчанию: |
avi_api_patch_op строка | Операция исправления для использования при использовании avi_api_update_method как исправления. Варианты:
|
avi_api_update_method строка | Метод обновления объекта по умолчанию — HTTP PUT. Установка в режим исправления переопределит это поведение, чтобы использовать HTTP PATCH. Варианты:
|
avi_credentials словарь | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в систему контроллера Avi. |
|
api_version строка |
Версия контроллера Avi По умолчанию: |
|
controller строка |
IP-адрес или SQDN контроллера |
|
csrftoken строка |
Маркер API контроллера Avi csrftoken для повторного использования существующей сессии с идентификатором сессии По умолчанию: |
|
password строка |
Пароль контроллера Avi |
|
port строка |
Порт контроллера Avi |
|
session_id строка |
Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken По умолчанию: |
|
tenant строка |
Домен контроллера Avi По умолчанию: |
|
tenant_uuid строка |
UUID домена контроллера Avi По умолчанию: |
|
timeout строка |
Таймаут запроса контроллера Avi По умолчанию: |
|
token строка |
Токен API контроллера Avi По умолчанию: |
|
username строка |
Имя пользователя контроллера Avi |
avi_disable_session_cache_as_fact логический тип | Отключает кэширование информации о сессии avi в качестве факта. Варианты:
|
cloud_ref строка | Ссылка на объект типа облако. |
configured_subnets строка | Список подсетей. |
controller строка | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения |
dhcp_enabled логический тип | Выбор схемы управления IP-адресами для этой сети. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. Варианты:
|
exclude_discovered_subnets логический тип | При выборе исключает все обнаруженные подсети в этой сети из рассмотрения для размещения виртуальных служб. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. Варианты:
|
ip6_autocfg_enabled boolean | Включить автоматическую конфигурацию ipv6. Поле введено в 18.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. Варианты:
|
name string / обязательно | Имя объекта. |
password string | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды |
state string | Состояние, которое должно быть применено к сущности. Варианты:
|
synced_from_se boolean | Флаг boolean для установки synced_from_se. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. Варианты:
|
tenant string | Имя арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
tenant_ref string | Ссылка на объект типа арендатор. |
tenant_uuid string | UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
url string | URL контроллера Avi для объекта. |
username string | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная среды |
uuid string | Уникальный идентификатор объекта. |
vcenter_dvs boolean | Флаг boolean для установки vcenter_dvs. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. Варианты:
|
vimgrnw_ref string | Ссылка на объект типа vimgrnwruntime. |
vrf_context_ref string | Ссылка на объект типа vrfcontext. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице 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) Возвращается: success, changed |
Ссылки на сборку
© 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_network_module.html