avi_controllerproperties - Модуль для настройки объекта ControllerProperties Avi RESTful
Новая версия с 2.4.
Обзор
- Этот модуль используется для конфигурации объекта ControllerProperties
- больше примеров на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| allow_ip_forwarding |
| Поле введено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| allow_unauthenticated_apis |
| Разрешить доступ без аутентификации для специальных API. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| allow_unauthenticated_nodes |
| Флаг булевого типа для установки allow_unauthenticated_nodes. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| api_context (добавлено в 2.5) | Контекст Avi API, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию. | |
| api_idle_timeout | Допустимые значения от 0 до 1440. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 15. Единицы (МИН). | |
| api_version | Значение по умолчанию: 16.4.4 | Версия Avi API для использования в Avi API и объектах. |
| appviewx_compat_mode |
| Экспорт конфигурации в режиме совместимости 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 как патча. |
| avi_api_update_method (добавлено в 2.5) |
| Метод по умолчанию для обновления объекта - HTTP PUT. Установление значения в патч переопределит это поведение для использования HTTP PATCH. |
| avi_credentials (добавлено в 2.5) | Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в Avi Controller. | |
| bm_use_ansible (добавлено в 2.5) |
| Использовать ansible для создания се в baremetal. Поле введено в 17.2.2. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. |
| cluster_ip_gratuitous_arp_period | Числовое значение cluster_ip_gratuitous_arp_period. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60. Единицы (МИН). | |
| controller | Значение по умолчанию: | IP-адрес или имя хоста контроллера. Значение по умолчанию - переменная окружения AVI_CONTROLLER. |
| crashed_se_reboot | Числовое значение crashed_se_reboot. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 900. Единицы (СЕК). | |
| dead_se_detection_timer | Числовое значение dead_se_detection_timer. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 360. Единицы (СЕК). | |
| dns_refresh_period | Числовое значение dns_refresh_period. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60. Единицы (МИН). | |
| dummy | Числовое значение dummy. | |
| fatal_error_lease_time | Числовое значение fatal_error_lease_time. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 120. Единицы (СЕК). | |
| max_dead_se_in_grp | Числовое значение max_dead_se_in_grp. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1. | |
| max_pcap_per_tenant | Максимальное количество файлов pcap, хранящихся на одного пользователя. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 4. | |
| max_seq_attach_ip_failures (добавлено в 2.5) | Максимальное количество последовательных неудач при подключении IP, которое останавливает размещение. Поле введено в 17.2.2. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 3. | |
| max_seq_vnic_failures | Числовое значение max_seq_vnic_failures. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 3. | |
| password | Значение по умолчанию: | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию - переменная окружения AVI_PASSWORD. |
| persistence_key_rotate_period | Допустимые значения от 1 до 1051200. Специальные значения: 0 - 'выключено'. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60. Единицы (МИН). | |
| portal_token (добавлено в 2.4) | Токен, используемый для загрузки технической поддержки на портал. Поле введено в 16.4.6, 17.1.2. | |
| query_host_fail | Числовое значение query_host_fail. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 180. Единицы (СЕК). | |
| safenet_hsm_version (добавлено в 2.5) | Версия пакета safenet, установленного на контроллере. Поле введено в 16.5.2, 17.2.3. | |
| se_create_timeout | Числовое значение se_create_timeout. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 900. Единицы (СЕК). | |
| se_failover_attempt_interval | Интервал между попытками переключения на се. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 300. Единицы (СЕК). | |
| se_offline_del | Числовое значение se_offline_del. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 172000. Единицы (СЕК). | |
| se_vnic_cooldown | Числовое значение se_vnic_cooldown. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 120. Единицы (СЕК). | |
| secure_channel_cleanup_timeout | Числовое значение secure_channel_cleanup_timeout. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60. Единицы (МИН). | |
| secure_channel_controller_token_timeout | Числовое значение secure_channel_controller_token_timeout. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60. Единицы (МИН). | |
| secure_channel_se_token_timeout | Числовое значение secure_channel_se_token_timeout. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60. Единицы (МИН). | |
| seupgrade_fabric_pool_size | Размер пула, используемого для всех команд fabric во время обновления se. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 20. | |
| seupgrade_segroup_min_dead_timeout | Время ожидания перед отметочкой обновления segroup как зависшего. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 360. Единицы (СЕК). | |
| ssl_certificate_expiry_warning_days | Количество дней для предупреждения о истечении срока действия сертификата ssl. Единицы (ДНИ). | |
| state |
| Состояние, которое должно быть применено к сущности. |
| tenant | Значение по умолчанию: admin | Имя пользователя, используемое для всех вызовов Avi API и контекста объекта. |
| tenant_uuid | Значение по умолчанию: | UUID пользователя, используемого для всех вызовов Avi API и контекста объекта. |
| unresponsive_se_reboot | Числовое значение unresponsive_se_reboot. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 300. Единицы (СЕК). | |
| upgrade_dns_ttl | Время учета dns ttl во время обновления. Это в дополнение к vs_scalein_timeout_for_upgrade в се группе. Поле введено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 5. Единицы (СЕК). | |
| upgrade_lease_time | Числовое значение upgrade_lease_time. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 360. Единицы (СЕК). |
| url | URL контроллера Avi для объекта. | |
| username | Значение по умолчанию: | Имя пользователя для доступа к контроллеру 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 | Допустимые значения от 1 до 1051200. Специальные значения 0 — 'отключено'. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60. Единицы (мин). | |
| vs_se_attach_ip_fail (добавлено в 2.5) | Время ожидания, прежде чем операция привязки IP к се будет помечена как неудачная. Поле добавлено в 17.2.2. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 3600. Единицы (сек). | |
| 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 как 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 dict | успех, изменения | Объект ControllerProperties (api/controllerproperties) |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Автор
- 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.5/modules/avi_controllerproperties_module.html