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

Примечание

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

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

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

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

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

Обзор

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

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

Требования

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

avisdk

Параметры

Параметр	Комментарии
api_context словарь	Контекст Avi API, включающий текущий ID сессии и CSRF-токен. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию.
api_version строка	Версия Avi API для использования с Avi API и объектами. По умолчанию: `"16.4.4"`
app_cookie_persistence_profile строка	Указывает параметры профиля сохранения приложения с cookie.
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, который можно использовать вместо перечисления данных входа в контроллер 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`.
description строка	Определяемая пользователем строка описания объекта.
hdr_persistence_profile строка	Указывает параметры пользовательского профиля сохранения HTTP-заголовков.
http_cookie_persistence_profile строка	Указывает параметры профиля сохранения HTTP-cookie.

ip_persistence_profile string	Указывает параметры профиля сохранения IP-адреса клиента.
is_federated boolean	Это поле описывает область репликации объекта. Если поле установлено в false, то объект виден в кластере контроллера и его связанных сервисных узлах. Если поле установлено в true, то объект реплицируется по всей федерации. Поле добавлено в 17.1.3. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. Варианты: `false` `true`
name string / обязательно	Напоминательное имя для профиля сохранения.
password string	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию - переменная окружения `AVI_PASSWORD`.
persistence_type string / обязательно	Метод, используемый для сохранения клиентов на том же сервере на определенный период времени или на протяжении всей сессии. Варианты перечисления - PERSISTENCE_TYPE_CLIENT_IP_ADDRESS, PERSISTENCE_TYPE_HTTP_COOKIE, PERSISTENCE_TYPE_TLS, PERSISTENCE_TYPE_CLIENT_IPV6_ADDRESS, PERSISTENCE_TYPE_CUSTOM_HTTP_HEADER, PERSISTENCE_TYPE_APP_COOKIE, PERSISTENCE_TYPE_GSLB_SITE. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как PERSISTENCE_TYPE_CLIENT_IP_ADDRESS.
server_hm_down_recovery string	Определяет поведение при пометке постоянного сервера как неисправного монитором состояния. Варианты перечисления - HM_DOWN_PICK_NEW_SERVER, HM_DOWN_ABORT_CONNECTION, HM_DOWN_CONTINUE_PERSISTENT_SERVER. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как HM_DOWN_PICK_NEW_SERVER.
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 профиля сохранения.

Примечания

Примечание

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

Примеры

- name: Create an Application Persistence setting using http cookie.
  community.network.avi_applicationpersistenceprofile:
    controller: '{{ controller }}'
    username: '{{ username }}'
    password: '{{ password }}'
    http_cookie_persistence_profile:
      always_send_cookie: false
      cookie_name: My-HTTP
      key:
      - aes_key: ShYGZdMks8j6Bpvm2sCvaXWzvXms2Z9ob+TTjRy46lQ=
        name: c1276819-550c-4adf-912d-59efa5fd7269
      - aes_key: OGsyVk84VCtyMENFOW0rMnRXVnNrb0RzdG5mT29oamJRb0dlbHZVSjR1az0=
        name: a080de57-77c3-4580-a3ea-e7a6493c14fd
      - aes_key: UVN0cU9HWmFUM2xOUzBVcmVXaHFXbnBLVUUxMU1VSktSVU5HWjJOWmVFMTBUMUV4UmxsNk4xQmFZejA9
        name: 60478846-33c6-484d-868d-bbc324fce4a5
      timeout: 15
    name: My-HTTP-Cookie
    persistence_type: PERSISTENCE_TYPE_HTTP_COOKIE
    server_hm_down_recovery: HM_DOWN_PICK_NEW_SERVER
    tenant_ref: Demo

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

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

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

Авторы

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