avi_applicationpersistenceprofile - Модуль для настройки профиля сохранения состояния приложения Avi RESTful Object

Новое в версии 2.3.

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

Обзор

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

Требования

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

avisdk

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_context (добавлен в 2.5)		Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс.
api_version	Значение по умолчанию: 16.4.4	Версия API Avi, используемая для доступа к API Avi и объектам.
app_cookie_persistence_profile		Устанавливает параметры профиля сохранения состояния приложения для cookie.
avi_api_patch_op (добавлен в 2.5)	Варианты: add replace delete	Операция обновления для использования при применении avi_api_update_method как patch.
avi_api_update_method (добавлен в 2.5)	Варианты: put ← patch	Метод по умолчанию для обновления объекта - HTTP PUT. Установка значения в patch переопределяет это поведение, используя HTTP PATCH.
avi_credentials (добавлен в 2.5)		Словарь учетных данных Avi, который может использоваться вместо перечисления данных входа в контроллер Avi.
controller	Значение по умолчанию:	IP-адрес или имя хоста контроллера. Значение по умолчанию - переменная среды `AVI_CONTROLLER`.
description		Пользовательское описание объекта.
hdr_persistence_profile		Устанавливает параметры пользовательского профиля сохранения состояния HTTP-заголовков.
http_cookie_persistence_profile		Устанавливает параметры профиля сохранения состояния HTTP cookie.
ip_persistence_profile		Устанавливает параметры профиля сохранения состояния IP-адреса клиента.
is_federated (добавлен в 2.4)	Варианты: no yes	Это поле описывает область репликации объекта. Если поле установлено в false, объект виден в кластере контроллеров и связанных с ним служб-движках. Если поле установлено в true, объект реплицируется по всей федерации. Поле добавлено в 17.1.3. Значение по умолчанию, если не указано в API или модуле, контроллер Avi интерпретирует как False.
name обязательно		Наименование профиля сохранения состояния для удобства пользователя.
password	Значение по умолчанию:	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию - переменная среды `AVI_PASSWORD`.
persistence_type обязательно		Метод, используемый для сохранения состояния клиентов на одном и том же сервере на определённый период времени или сессию. Варианты перечисления - 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		Указывает поведение при помечании сервера сохранения состояния как нерабочего монитором работоспособности. Варианты перечисления - HM_DOWN_PICK_NEW_SERVER, HM_DOWN_ABORT_CONNECTION, HM_DOWN_CONTINUE_PERSISTENT_SERVER. Значение по умолчанию, если не указано в API или модуле, контроллер Avi интерпретирует как HM_DOWN_PICK_NEW_SERVER.
state	Варианты: absent present ←	Состояние, которое должно быть применено к сущности.
tenant	Значение по умолчанию: admin	Имя домена, используемого для всех вызовов API Avi и контекста объекта.
tenant_ref		Ссылка на объект типа домена.
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 an Application Persistence setting using http cookie.
  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 dict	успех, изменилось	Объект ApplicationPersistenceProfile (api/applicationpersistenceprofile)

Статус

Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантируется обратной совместимостью.

Автор

Гaurav Rastogi (grastogi@avinetworks.com)

Подсказка

Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/avi_applicationpersistenceprofile_module.html