community.network.avi_ipaddrgroup модуль — Модуль для настройки объекта IpAddrGroup Avi RESTful

Примечание

Этот модуль является частью коллекции community.network (версия 5.0.3).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. Требования.

Для использования в playbook укажите: community.network.avi_ipaddrgroup.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Этот модуль используется для настройки объекта IpAddrGroup
Больше примеров можно найти на https://github.com/avinetworks/devops

Псевдонимы: network.avi.avi_ipaddrgroup

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

avisdk

Параметры

Параметр	Комментарии
addrs строка	Настройка IP адреса(ов).
api_context словарь	Контекст Avi API, содержащий текущий идентификатор сессии и CSRF-токен. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию.
api_version строка	Версия Avi API, которая будет использоваться для Avi API и объектов. По умолчанию: `"16.4.4"`
apic_epg_name строка	Заполнение IP-адресов из членов этой cisco apic epg.
avi_api_patch_op строка	Операция обновления для использования при использовании avi_api_update_method как patch. Варианты: `"add"` `"replace"` `"delete"`
avi_api_update_method строка	Метод обновления объекта по умолчанию — HTTP PUT. Установка в patch переопределит это поведение, чтобы использовать HTTP PATCH. Варианты: `"put"` ← (по умолчанию) `"patch"`
avi_credentials словарь	Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в Avi Controller.
api_version строка	Версия контроллера Avi По умолчанию: `"16.4.4"`
controller строка	IP-адрес или SQDN контроллера
csrftoken строка	CSRF-токен API контроллера Avi для повторного использования существующей сессии с идентификатором сессии По умолчанию: `""`
password строка	Пароль контроллера Avi
port строка	Порт контроллера Avi
session_id строка	Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken По умолчанию: `""`
tenant строка	Тенент контроллера Avi По умолчанию: `"admin"`
tenant_uuid строка	UUID тенента контроллера Avi По умолчанию: `""`
timeout строка	Таймаут запроса контроллера Avi По умолчанию: `300`
token строка	Токен API контроллера Avi По умолчанию: `""`
username строка	Имя пользователя контроллера Avi
avi_disable_session_cache_as_fact логический	Отключает кеширование информации о сессии avi в качестве факта. Варианты: `false` ← (по умолчанию) `true`
controller строка	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`
country_codes строка	Заполнение диапазонов IP-адресов из геобазы для этой страны.
description строка	Пользовательское описание объекта.
ip_ports строка	Настройка кортежей (ip-адрес, порт).

END_OF_DOCUMENT_MARKER

marathon_app_name string	Заполнить IP-адреса из задач этой marathon-приложения.
marathon_service_port string	Порт задачи, связанный с портом marathon-сервиса. Если у marathon-приложения несколько портов сервиса, это поле обязательно. В противном случае используется первый порт задачи.
name string / обязательно	Имя группы IP-адресов.
password string	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения `AVI_PASSWORD`.
prefixes string	Настройка префикса(ов) IP-адреса.
ranges string	Настройка диапазона(ов) IP-адресов.
state string	Состояние, которое должно быть применено к объекту. Варианты: `"absent"` `"present"` ← (по умолчанию)
tenant string	Имя арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `"admin"`
tenant_ref string	Ссылка на объект типа арендатор.
tenant_uuid string	UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `""`
url string	URL контроллера Avi объекта.
username string	Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения `AVI_USERNAME`.
uuid string	Uuid группы IP-адресов.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице 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)

Ссылки на коллекции

© 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_ipaddrgroup_module.html