avi_applicationpersistenceprofile – Модуль для настройки объекта ApplicationPersistenceProfile Avi RESTful
Обзор
- Этот модуль используется для настройки объекта 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. | ||
| api_version - | Значение по умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller - | IP-адрес или SQDN контроллера Avi | ||
| csrftoken - | Токен csrf API контроллера Avi для повторного использования существующей сессии с идентификатором сессии | ||
| 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 логическое добавлен в 2.6 |
| Отключает кеширование информации о сессии Avi в качестве факта. | |
| 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 - |
| Состояние, которое должно быть применено к сущности. | |
| tenant строка | Значение по умолчанию: "admin" | Имя арендатора, используемое для всех вызовов API Avi и контекста объекта. | |
| tenant_ref - | Это ссылка на объект типа арендатор. | ||
| 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 (@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.9/modules/avi_applicationpersistenceprofile_module.html
