avi_controllerproperties – Модуль для настройки ControllerProperties Avi RESTful Объекта
Новая версия 2.4.
Описание
- Этот модуль используется для настройки объекта ControllerProperties
- больше примеров по адресу https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| allow_ip_forwarding boolean |
| Поле добавлено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| allow_unauthenticated_apis boolean |
| Разрешить доступ без авторизации для специальных API. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| allow_unauthenticated_nodes boolean |
| Флаг Boolean для установки allow_unauthenticated_nodes. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| api_context dictionary добавлено в 2.5 | Контекст API Avi, который включает текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. | ||
| api_idle_timeout - | Допустимые значения: 0-1440. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 15. | ||
| api_perf_logging_threshold - добавлено в 2.9 | Порог для регистрации времени запроса в журнале portal_performance.log и заголовке ответа server-timing. Любой этап, занимающий более 1% от порога, будет включён в заголовок server-timing. Поле добавлено в 18.1.4, 18.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 10000. | ||
| api_version string | Значение по умолчанию: "16.4.4" | Версия API Avi для использования с API Avi и объектами. | |
| appviewx_compat_mode boolean |
| Экспорт конфигурации в режиме совместимости appviewx. Поле добавлено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| attach_ip_retry_interval - | Количество attach_ip_retry_interval. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 360. | ||
| attach_ip_retry_limit - | Количество attach_ip_retry_limit. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 4. | ||
| avi_api_patch_op - добавлено в 2.5 |
| Операция исправления, которую нужно использовать при использовании avi_api_update_method как patch. | |
| avi_api_update_method - добавлено в 2.5 |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение, чтобы использовать HTTP PATCH. | |
| avi_credentials dictionary добавлено в 2.5 | Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в контроллер Avi. | ||
| api_version - | Значение по умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller - | IP-адрес или FQDN контроллера. | ||
| csrftoken - | Маркер csrftoken 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 boolean добавлено в 2.6 |
| Отключает кэширование информации о сеансе Avi в качестве факта. | |
| bm_use_ansible boolean добавлено в 2.5 |
| Использование ansible для создания SE в baremetal. Поле добавлено в 17.2.2. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| cleanup_expired_authtoken_timeout_period - добавлено в 2.9 | Период для очистки истекших токенов авторизации. Поле добавлено в 18.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60. | ||
| cleanup_sessions_timeout_period - добавлено в 2.9 | Период для очистки сеансов. Поле добавлено в 18.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60. | ||
| cloud_reconcile boolean добавлено в 2.9 |
| Включить/выключить периодическую согласовку для всех облаков. Поле добавлено в 17.2.14, 18.1.5, 18.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| cluster_ip_gratuitous_arp_period - | Период для работы arp gratuitous cluster ip. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60. | ||
| consistency_check_timeout_period - добавлено в 2.9 | Период для проверки согласованности. Поле добавлено в 18.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60. | ||
| controller string | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| crashed_se_reboot - | Количество crashed_se_reboot. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 900. | ||
| dead_se_detection_timer - | Количество dead_se_detection_timer. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 360. | ||
| dns_refresh_period - | Период обновления пула и работы dns gslb. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 60. | ||
| dummy - | Количество dummy. | ||
| enable_api_sharding boolean added in 2.9 |
| Этот параметр позволяет лидеру контроллера фрагментировать запросы API к последователям (если таковые имеются). Поле введено в 18.1.5, 18.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как True. | |
| enable_memory_balancer boolean added in 2.6 |
| Включение/выключение балансировщика памяти. Поле введено в 17.2.8. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как True. | |
| fatal_error_lease_time - | Количество fatal_error_lease_time. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 120. | ||
| max_dead_se_in_grp - | Количество max_dead_se_in_grp. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 1. | ||
| max_pcap_per_tenant - | Максимальное количество файлов pcap, хранящихся на одного клиента. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 4. | ||
| max_seq_attach_ip_failures - added in 2.5 | Максимальное количество последовательных сбоев при подключении IP-адреса, которые останавливают размещение. Поле введено в 17.2.2. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 3. | ||
| max_seq_vnic_failures - | Количество max_seq_vnic_failures. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 3. | ||
| password string | Значение по умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | |
| persistence_key_rotate_period - | Период для работы по вращению ключей приложения. Допустимые значения — от 1 до 1051200. Специальные значения — 0 — 'отключено'. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 0. | ||
| portal_token - added in 2.4 | Токен, используемый для загрузки технической поддержки на портал. Поле введено в 16.4.6,17.1.2. | ||
| process_locked_useraccounts_timeout_period - added in 2.9 | Период для обработки заблокированных учетных записей пользователей. Поле введено в 18.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 1. | ||
| process_pki_profile_timeout_period - added in 2.9 | Период для обработки профилей pki. Поле введено в 18.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 1440. | ||
| query_host_fail - | Количество query_host_fail. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 180. | ||
| safenet_hsm_version - added in 2.5 | Версия установленного пакета safenet на контроллере. Поле введено в 16.5.2,17.2.3. | ||
| se_create_timeout - | Количество се_create_timeout. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 900. | ||
| se_failover_attempt_interval - | Интервал между попытками переключения на се. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 300. | ||
| se_from_marketplace - added in 2.9 | Этот параметр определяет, будет ли се развернут из облачного маркета или будет создан контроллером. Настройка применима только при выборе лицензии byol. Варианты перечисления — MARKETPLACE, IMAGE. Поле введено в 18.1.4, 18.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как IMAGE. | ||
| se_offline_del - | Количество se_offline_del. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 172000. | ||
| se_vnic_cooldown - | Количество se_vnic_cooldown. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 120. | ||
| secure_channel_cleanup_timeout - | Период для очистки канала безопасности. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 60. | ||
| secure_channel_controller_token_timeout - | Количество secure_channel_controller_token_timeout. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 60. | ||
| secure_channel_se_token_timeout - | Количество secure_channel_se_token_timeout. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 60. | ||
| seupgrade_fabric_pool_size - | Размер пула, используемый для всех команд ткани во время обновления се. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 20. | ||
| seupgrade_segroup_min_dead_timeout - | Время ожидания перед отменой обновления segroup как зависшего. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 360. | ||
| ssl_certificate_expiry_warning_days - | Количество дней для предупреждения о истечении срока действия сертификата ssl. | ||
| state - |
| Состояние, которое должно быть применено к объекту. | |
| tenant string | Значение по умолчанию: "admin" | Имя клиента, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_uuid string | Значение по умолчанию: "" | UUID клиента, используемого для всех вызовов API Avi и контекста объекта. | |
| unresponsive_se_reboot - | Количество unresponsive_se_reboot. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 300. | ||
| upgrade_dns_ttl - | Время учета dns ttl во время обновления. Это дополнительно к vs_scalein_timeout_for_upgrade в се_group. Поле введено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 5. | ||
| upgrade_lease_time - | Количество upgrade_lease_time. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 360. | ||
| url - | URL контроллера Avi для объекта. | ||
| username string | Значение по умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME. | |
| uuid - | Уникальный идентификатор объекта. | ||
| vnic_op_fail_time - | Значение vnic_op_fail_time. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 180. | ||
| vs_apic_scaleout_timeout - | Время ожидания готовности масштабируемого се до обозначения завершения масштабирования, применяется только к конфигурации apic. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 360. | ||
| vs_awaiting_se_timeout - | Значение vs_awaiting_se_timeout. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60. | ||
| vs_key_rotate_period - | Период для выполнения задачи вращения ключей vs. Допустимые значения — от 1 до 1051200. Особые значения: 0 — «выключено». Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 360. | ||
| vs_scaleout_ready_check_interval - добавлен в 2.9 | Интервал проверки статуса scaleout_ready, пока контроллер ожидает RPC scaleoutready от сетевого модуля. Поле введено в 18.2.2. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60. | ||
| vs_se_attach_ip_fail - добавлен в 2.5 | Время ожидания перед обозначением операции attach ip на se как неудачной. Поле введено в 17.2.2. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 600. | ||
| vs_se_bootup_fail - | Значение vs_se_bootup_fail. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 480. | ||
| vs_se_create_fail - | Значение vs_se_create_fail. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1500. | ||
| vs_se_ping_fail - | Значение vs_se_ping_fail. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60. | ||
| vs_se_vnic_fail - | Значение vs_se_vnic_fail. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 300. | ||
| vs_se_vnic_ip_fail - | Значение vs_se_vnic_ip_fail. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 120. | ||
| warmstart_se_reconnect_wait_time - | Значение warmstart_se_reconnect_wait_time. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 480. | ||
| warmstart_vs_resync_wait_time - добавлен в 2.9 | Таймаут для синхронизации warmstart vs. Поле введено в 18.1.4, 18.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 300. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create ControllerProperties object
avi_controllerproperties:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_controllerproperties
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменено | Объект ControllerProperties (api/controllerproperties) |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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_controllerproperties_module.html