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 |
| Операция обновления для использования при использовании avi_api_update_method как patch. |
| avi_api_update_method - добавлен в 2.5 |
| Метод по умолчанию для обновления объекта — 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 boolean добавлен в 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 - |
| Состояние, которое должно быть применено к сущности. |
| 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.
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) |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Gaurav 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.7/modules/avi_applicationpersistenceprofile_module.html