avi_controllerproperties - Модуль для настройки объекта ControllerProperties Avi RESTful

Новая версия 2.4.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

Этот модуль используется для настройки объекта ControllerProperties
больше примеров на https://github.com/avinetworks/devops

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

avisdk

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
allow_ip_forwarding bool	Варианты: no yes	Поле введено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
allow_unauthenticated_apis bool	Варианты: no yes	Разрешить доступ без аутентификации для специальных API. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
allow_unauthenticated_nodes bool	Варианты: no yes	Флаг Boolean для установки 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 bool	Варианты: no yes	Экспорт конфигурации в режиме совместимости с 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)	Варианты: add replace delete	Операция исправления для использования при использовании avi_api_update_method как patch.
avi_api_update_method (добавлен в 2.5)	Варианты: put ← patch	Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение, чтобы использовать HTTP PATCH.
avi_credentials (добавлен в 2.5)		Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в Avi Controller.
bm_use_ansible bool (добавлен в 2.5)	Варианты: no yes	Использовать ansible для создания se в 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.
enable_memory_balancer bool (добавлен в 2.6)	Варианты: no yes	Включить/выключить балансировщик памяти. Поле введено в 17.2.8. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.
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		Интервал между попытками переключения на SE. Значение по умолчанию, если не указано в 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		Размер пула, используемого для всех команд ткани во время обновления SE. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 20.
seupgrade_segroup_min_dead_timeout		Время ожидания перед тем как отметить обновление segroup как зависшее. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 360. Единицы (сек).
ssl_certificate_expiry_warning_days		Количество дней для предупреждения о сроке действия сертификата ssl. Единицы (дней).
state	Варианты: absent present ←	Состояние, которое должно быть применено к сущности.
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 в se_group. Поле введено в версии 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		Время ожидания, пока масштабируемое SE будет готово, прежде чем отметить масштабирование как завершенное, применяется только к конфигурации 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 к SE как проваленную. Поле введено в версии 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)

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

Гaurav 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.6/modules/avi_controllerproperties_module.html