community.network.avi_ipaddrgroup – Модуль для настройки объекта IpAddrGroup Avi RESTful
Примечание
Этот плагин входит в коллекцию community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в книге задач укажите: community.network.avi_ipaddrgroup.
Обзор
- Этот модуль используется для настройки объекта IpAddrGroup.
- Дополнительные примеры см. на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| addrs строка | Настройка IP-адреса(ов). | ||
| api_context словарь | Контекст API Avi, включающий текущий идентификатор сеанса и токен CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования с API Avi и объектами. | |
| apic_epg_name строка | Заполнение IP-адресов из членов этого cisco apic epg. | ||
| avi_api_patch_op строка |
| Операция исправления для использования при использовании avi_api_update_method как исправление. | |
| 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 в контроллере Avi | ||
| port строка | Порт контроллера Avi | ||
| session_id строка | Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с CSRF-токеном | ||
| tenant строка | По умолчанию: "admin" | Подписчик контроллера Avi | |
| tenant_uuid строка | UUID подписчика контроллера Avi | ||
| timeout строка | По умолчанию: 300 | Время ожидания запроса контроллера Avi | |
| token строка | Токен API контроллера Avi | ||
| username строка | Имя пользователя контроллера Avi | ||
| avi_disable_session_cache_as_fact логический тип |
| Отключает кеширование информации о сеансе Avi в качестве факта. | |
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| country_codes строка | Заполнение диапазонов IP-адресов из базы данных геоданных для этой страны. | ||
| description строка | Определяемая пользователем аннотация для объекта. | ||
| ip_ports строка | Настройка кортежей (IP-адрес, порт). | ||
| marathon_app_name строка | Заполнение IP-адресов из задач этой программы marathon. | ||
| marathon_service_port строка | Порт задачи, связанный с портом сервиса marathon. Если у приложения marathon несколько портов сервиса, это значение обязательно. В противном случае используется первый порт задачи. | ||
| name строка / обязательно | Имя группы IP-адресов. | ||
| password строка | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | |
| prefixes строка | Настройка префиксов IP-адресов. | ||
| ranges строка | Настройка диапазонов IP-адресов. | ||
| state строка |
| Состояние, которое должно быть применено к сущности. | |
| tenant строка | По умолчанию: "admin" | Имя подписчика, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_ref строка | Ссылка на объект типа подписчик. | ||
| tenant_uuid строка | По умолчанию: "" | UUID подписчика, используемого для всех вызовов API Avi и контекста объекта. | |
| url строка | URL контроллера Avi объекта. | ||
| username строка | По умолчанию: "" | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | |
| uuid строка | UUID группы IP-адресов. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Create an IP Address Group configuration
community.network.avi_ipaddrgroup:
controller: '{{ controller }}'
username: '{{ username }}'
password: '{{ password }}'
name: Client-Source-Block
prefixes:
- ip_addr:
addr: 10.0.0.0
type: V4
mask: 8
- ip_addr:
addr: 172.16.0.0
type: V4
mask: 12
- ip_addr:
addr: 192.168.0.0
type: V4
mask: 16
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успешно, изменилось | Объект IpAddrGroup (api/ipaddrgroup) |
Авторы
- Gaurav 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_ipaddrgroup_module.html
