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

Примечание

Этот плагин входит в коллекцию community.network (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.network.

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

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

Обзор

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

Требования

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

avisdk

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
api_context словарь			Контекст API Avi, включающий текущий идентификатор сеанса и токен CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс.
api_version строка		По умолчанию: "16.4.4"	Версия API Avi, используемая для Avi API и объектов.
app_cookie_persistence_profile строка			Указывает параметры профиля сохранения cookie-файлов приложения.
avi_api_patch_op строка		Варианты: add replace delete	Операция исправления, используемая при использовании avi_api_update_method в качестве исправления.
avi_api_update_method строка		Варианты: put ← patch	Метод по умолчанию для обновления объекта — HTTP PUT. Установка на patch переопределит это поведение, чтобы использовать HTTP PATCH.
avi_credentials словарь			Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi.
	api_version строка	По умолчанию: "16.4.4"	Версия контроллера Avi
	controller строка		IP-адрес или SQDN контроллера
	csrftoken строка		Токен csrf контроллера Avi API для повторного использования существующего сеанса с идентификатором сеанса
	password строка		Пароль контроллера Avi
	port строка		Порт контроллера Avi
	session_id строка		Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken
	tenant строка	По умолчанию: "admin"	Тенейнт контроллера Avi
	tenant_uuid строка		UUID тенейнта контроллера Avi
	timeout строка	По умолчанию: 300	Таймаут запроса контроллера Avi
	token строка		Токен API контроллера Avi
	username строка		Имя пользователя контроллера Avi
avi_disable_session_cache_as_fact логическое значение		Варианты: нет ← да	Отключает кэширование информации о сеансе avi как факта.
controller строка		По умолчанию: ""	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`.
description строка			Определяемое пользователем описание объекта.
hdr_persistence_profile строка			Указывает параметры пользовательского профиля сохранения заголовков HTTP.
http_cookie_persistence_profile строка			Указывает параметры профиля сохранения cookie-файлов HTTP.
ip_persistence_profile строка			Указывает параметры профиля сохранения IP-адреса клиента.
is_federated логическое значение		Варианты: нет да	Это поле описывает область репликации объекта. Если поле установлено в значение 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 строка		Варианты: отсутствует есть ←	Состояние, которое должно быть применено к сущности.
tenant строка		По умолчанию: "admin"	Имя тенейнта, используемого для всех вызовов API Avi и контекста объекта.
tenant_ref строка			Это ссылка на объект типа tenant.
tenant_uuid строка		По умолчанию: ""	UUID тенейнта, используемого для всех вызовов API Avi и контекста объекта.
url строка			URL контроллера Avi объекта.
username строка		По умолчанию: ""	Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды `AVI_USERNAME`.
uuid строка			Uuid профиля сохранения.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице 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)

Авторы

Гaurav Rastogi (@grastogi23) <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.10/collections/community/network/avi_applicationpersistenceprofile_module.html