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

Примечание

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

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

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

Для использования в книге задач укажите: community.network.avi_networkprofile.

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

Описание

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

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

Требования

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

avisdk

Параметры

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

END_OF_DOCUMENT_MARKER

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

Примечания

Примечание

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

Примеры

- name: Create a network profile for an UDP application
  community.network.avi_networkprofile:
    controller: '{{ controller }}'
    username: '{{ username }}'
    password: '{{ password }}'
    name: System-UDP-Fast-Path
    profile:
      type: PROTOCOL_TYPE_UDP_FAST_PATH
      udp_fast_path_profile:
        per_pkt_loadbalance: false
        session_idle_timeout: 10
        snat: true
    tenant_ref: admin

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

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

Ключ	Описание
obj словарь	Объект NetworkProfile (api/networkprofile) Возвращаемое значение: success, changed

Авторы

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_networkprofile_module.html