avi_applicationpersistenceprofile - Модуль для настройки объекта ApplicationPersistenceProfile Avi RESTful
Новая версия 2.3.
Обзор
- Этот модуль используется для настройки объекта ApplicationPersistenceProfile.
- Больше примеров на https://github.com/avinetworks/devops
Требования (к хосту, на котором выполняется модуль)
- avisdk
Параметры
| параметр | обязателен | по умолчанию | допустимые значения | комментарии |
|---|---|---|---|---|
| api_version | нет | Версия API Avi для использования с Avi API и объектами. | ||
| app_cookie_persistence_profile | нет | Указывает параметры профиля сохранения состояния приложения. | ||
| controller | нет | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | ||
| description | нет | Пользовательское описание объекта. | ||
| hdr_persistence_profile | нет | Указывает параметры пользовательского профиля сохранения состояния HTTP-заголовков. | ||
| http_cookie_persistence_profile | нет | Указывает параметры профиля сохранения состояния HTTP-cookie. | ||
| ip_persistence_profile | нет | Указывает параметры профиля сохранения состояния IP-адреса клиента. | ||
| is_federated (добавлен в 2.4)
| нет | Этот параметр описывает область действия репликации объекта. Если значение равно 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 | нет | present |
| Состояние, которое должно быть применено к сущности. |
| tenant | нет | admin | Имя клиента, используемое во всех вызовах API Avi и контексте объекта. | |
| tenant_ref | нет | Ссылка на объект типа клиент. | ||
| tenant_uuid | нет | UUID клиента, используемого во всех вызовах API Avi и контексте объекта. | ||
| url | нет | URL контроллера Avi объекта. | ||
| username | нет | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | ||
| uuid | нет | Uuid профиля сохранения состояния. |
Примеры
- name: Create an Application Persistence setting using http cookie.
avi_applicationpersistenceprofile:
controller: ''
username: ''
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) | успех, изменено | dict |
Статус
Этот модуль помечен как предварительный просмотр, что означает отсутствие гарантии обратной совместимости интерфейса.
Для помощи в разработке модулей, если это необходимо, см. Информация о сообществе и внесение вклада, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/avi_applicationpersistenceprofile_module.html
