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

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.network.avi_trafficcloneprofile.

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

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

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

Требования

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

avisdk

Параметры

Параметр	Комментарии
api_context словарь	Контекст API Avi, включающий текущий идентификатор сессии и CSRF-токен. Это позволяет пользователю выполнить единый вход и повторно использовать сессию.
api_version строка	Версия API Avi для использования с API Avi и объектами. По умолчанию: `"16.4.4"`
avi_api_patch_op строка	Операция обновления (patch) для использования при применении avi_api_update_method как patch. Варианты: `"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 в контроллере 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`
clone_servers строка	Поле введено в 17.1.1.
cloud_ref строка	Ссылка на объект типа cloud. Поле введено в 17.1.1.
controller строка	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`
name строка / обязательно	Имя профиля клона трафика. Поле введено в 17.1.1.
password строка	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`

END_OF_DOCUMENT_MARKER

preserve_client_ip boolean	Указывает, нужно ли сохранять IP-адрес клиента при клонировании на пункт назначения. Поле введено в версии 17.1.1. Значение по умолчанию, если не указано в API или модуле, Avi Controller интерпретирует как False. Варианты: `false` `true`
state string	Состояние, которое должно быть применено к объекту. Варианты: `"absent"` `"present"` ← (по умолчанию)
tenant string	Имя клиента, используемого для всех вызовов Avi API и контекста объекта. По умолчанию: `"admin"`
tenant_ref string	Ссылка на объект типа клиент. Поле введено в версии 17.1.1.
tenant_uuid string	UUID клиента, используемого для всех вызовов Avi API и контекста объекта. По умолчанию: `""`
url string	URL контроллера Avi для объекта.
username string	Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения `AVI_USERNAME`.
uuid string	UUID профиля клонирования трафика. Поле введено в версии 17.1.1.

Примечания

Примечание

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

Примеры

- name: Example to create TrafficCloneProfile object
  community.network.avi_trafficcloneprofile:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_trafficcloneprofile

Возвращаемые значения

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

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

Авторы

Гaurav 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_trafficcloneprofile_module.html