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

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: community.network.avi_l4policyset.

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

Описание

Этот модуль используется для конфигурации объекта L4PolicySet
Дополнительные примеры см. на https://github.com/avinetworks/devops

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

Требования

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

avisdk

Параметры

Параметр	Комментарии
api_context словарь	Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию.
api_version строка	Версия API Avi, используемая для Avi API и объектов. По умолчанию: `"16.4.4"`
avi_api_patch_op строка	Операция исправления, используемая при использовании avi_api_update_method как исправления. Варианты: `"add"` `"replace"` `"delete"`
avi_api_update_method строка	Метод по умолчанию для обновления объекта — HTTP PUT. Установка в значение patch переопределит это поведение, чтобы использовать HTTP PATCH. Варианты: `"put"` ← (по умолчанию) `"patch"`
avi_credentials словарь	Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi.
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`
created_by строка	Имя создателя. Поле введено в 17.2.7.
description строка	Поле введено в 17.2.7.
is_internal_policy логическое	Поле введено в 17.2.7. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. Варианты: `false` `true`
l4_connection_policy строка	Политика, применяемая при настройке нового транспортного соединения. Поле введено в 17.2.7.

END_OF_DOCUMENT_MARKER

name строка / обязательно	Имя набора правил L4. Поле введено в версии 17.2.7.
password строка	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения `AVI_PASSWORD`.
state строка	Состояние, которое должно быть применено к сущности. Варианты: `"absent"` `"present"` ← (по умолчанию)
tenant строка	Имя арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `"admin"`
tenant_ref строка	Ссылка на объект типа арендатора. Поле введено в версии 17.2.7.
tenant_uuid строка	UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `""`
url строка	URL контроллера Avi для объекта.
username строка	Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения `AVI_USERNAME`.
uuid строка	Идентификатор набора правил L4. Поле введено в версии 17.2.7.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.

Примеры

- name: Example to create L4PolicySet object
  community.network.avi_l4policyset:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_l4policyset

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
obj словарь	Объект L4PolicySet (api/l4policyset) Возвращается: успех, изменено

Авторы

Chaitanya Deshpande (@chaitanyaavi)

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

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