Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин входит в коллекцию community.network (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.network.

Чтобы использовать его в playbook, укажите: community.network.avi_controllerproperties.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

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

Требования

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

  • avisdk

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
allow_ip_forwarding
boolean
    Варианты:
  • no
  • yes
Поле введено в 17.1.1.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
allow_unauthenticated_apis
boolean
    Варианты:
  • no
  • yes
Разрешить доступ к специальным API без аутентификации.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
allow_unauthenticated_nodes
boolean
    Варианты:
  • no
  • yes
Флаг boolean для установки allow_unauthenticated_nodes.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
api_context
dictionary
Контекст API Avi, включающий текущий идентификатор сессии и токен CSRF.
Это позволяет пользователю выполнить однократный вход и повторно использовать сессию.
api_idle_timeout
string
Допустимые значения от 0 до 1440.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 15.
api_perf_logging_threshold
string
Порог для логирования времени запросов в файл 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
    Варианты:
  • no
  • yes
Экспорт конфигурации в режиме совместимости с appviewx.
Поле введено в 17.1.1.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
attach_ip_retry_interval
string
Число attach_ip_retry_interval.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 360.
attach_ip_retry_limit
string
Число attach_ip_retry_limit.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 4.
avi_api_patch_op
string
    Варианты:
  • add
  • replace
  • delete
Операция патчинга для использования при использовании avi_api_update_method как patch.
avi_api_update_method
string
    Варианты:
  • put ←
  • patch
Метод по умолчанию для обновления объекта — HTTP PUT.
Установка в patch переопределит это поведение, чтобы использовать HTTP PATCH.
avi_credentials
dictionary
Словарь Avi Credentials, который может использоваться вместо перечисления данных входа в контроллер Avi.
api_version
string
Значение по умолчанию:
"16.4.4"
Версия контроллера Avi
controller
string
IP-адрес или FQDN контроллера Avi
csrftoken
string
Токен csrftoken API контроллера Avi для повторного использования существующей сессии с идентификатором сессии
password
string
Пароль контроллера Avi
port
string
Порт контроллера Avi
session_id
string
Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с токеном csrftoken
tenant
string
Значение по умолчанию:
"admin"
Тенент контроллера Avi
tenant_uuid
string
UUID тенента контроллера Avi
timeout
string
Значение по умолчанию:
300
Таймаут запросов контроллера Avi
token
string
Токен API контроллера Avi
username
string
Имя пользователя контроллера Avi
avi_disable_session_cache_as_fact
boolean
    Варианты:
  • no ←
  • yes
Отключает кеширование информации о сессии Avi в качестве факта.
bm_use_ansible
boolean
    Варианты:
  • no
  • yes
Использовать ansible для создания SE в baremetal.
Поле введено в 17.2.2.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.
cleanup_expired_authtoken_timeout_period
string
Период для задачи очистки токена аутентификации.
Поле введено в 18.1.1.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60.
cleanup_sessions_timeout_period
string
Период для задачи очистки сессий.
Поле введено в 18.1.1.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60.
cloud_reconcile
boolean
    Варианты:
  • no
  • yes
Включить/отключить периодическое примирение для всех облаков.
Поле введено в 17.2.14,18.1.5,18.2.1.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.
cluster_ip_gratuitous_arp_period
string
Период для задачи cluster ip gratuitous arp.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60.
consistency_check_timeout_period
string
Период для задачи проверки согласованности.
Поле введено в 18.1.1.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60.
controller
string
Значение по умолчанию:
""
IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER.
crashed_se_reboot
string
Число crashed_se_reboot.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 900.
dead_se_detection_timer
string
Число dead_se_detection_timer.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 360.
dns_refresh_period
string
Период обновления пула DNS и gslb DNS.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60.
dummy
string
Число dummy.
enable_api_sharding
boolean
    Варианты:
  • no
  • yes
Эта настройка позволяет лидеру контроллера распределять запросы API между последователями (если таковые имеются).
Поле введено в 18.1.5, 18.2.1.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.
enable_memory_balancer
boolean
    Варианты:
  • no
  • yes
Включить/выключить балансировщик памяти.
Поле введено в 17.2.8.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.
fatal_error_lease_time
string
Число fatal_error_lease_time.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 120.
max_dead_se_in_grp
string
Число max_dead_se_in_grp.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1.
max_pcap_per_tenant
string
Максимальное количество файлов pcap, хранимых на один tenant.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 4.
max_seq_attach_ip_failures
string
Максимальное число последовательных неудач при подключении IP, после чего приостанавливается размещение.
Поле введено в 17.2.2.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 3.
max_seq_vnic_failures
string
Число max_seq_vnic_failures.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 3.
пароль
строка
Значение по умолчанию:
""
Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения AVI_PASSWORD.
persistence_key_rotate_period
строка
Период для выполнения задачи по смене ключей сохранения приложения.
Допустимые значения: 1-1051200.
Особые значения: 0 — «отключено».
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0.
portal_token
строка
Токен, используемый для загрузки технической поддержки на портал.
Поле добавлено в 16.4.6, 17.1.2.
process_locked_useraccounts_timeout_period
строка
Период для выполнения задачи обработки заблокированных учетных записей пользователей.
Поле добавлено в 18.1.1.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1.
process_pki_profile_timeout_period
строка
Период для выполнения задачи обработки профиля pki.
Поле добавлено в 18.1.1.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1440.
query_host_fail
строка
Количество query_host_fail.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 180.
safenet_hsm_version
строка
Версия установленного пакета 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_from_marketplace
строка
Этот параметр определяет, будет ли се запускаться из облачного маркетплейса или создаваться контроллером.
Параметр применим только при выборе лицензии byol.
Варианты перечисления — MARKETPLACE, IMAGE.
Поле добавлено в 18.1.4, 18.2.1.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как IMAGE.
se_offline_del
строка
Количество se_offline_del.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 172000.
se_vnic_cooldown
строка
Количество se_vnic_cooldown.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 120.
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
строка
Время ожидания перед отметкой обновления сегруппы как зависшей.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 360.
ssl_certificate_expiry_warning_days
строка
Количество дней для предупреждения о истечении срока действия сертификата ssl.
состояние
строка
    Варианты:
  • отсутствует
  • присутствует ←
Состояние, которое должно быть применено к сущности.
арендатор
строка
Значение по умолчанию:
"admin"
Имя арендатора, используемого для всех вызовов API Avi и контекста объекта.
tenant_uuid
строка
Значение по умолчанию:
""
UUID арендатора, используемого для всех вызовов API Avi и контекста объекта.
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 для объекта.
имя_пользователя
строка
Значение по умолчанию:
""
Имя пользователя, используемое для доступа к контроллеру 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
строка
Интервал проверки статуса scaleout_ready, пока контроллер ожидает от сервис-движка RPC scaleoutready.
Поле добавлено в 18.2.2.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60.
vs_se_attach_ip_fail
строка
Время ожидания перед отменой операции присоединения ip к се как неудачной.
Поле добавлено в 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
строка
Тайм-аут для синхронизации vs при warmstart.
Поле добавлено в 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
  community.network.avi_controllerproperties:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_controllerproperties

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для этого модуля:

Ключ Возвращено Описание
obj
словарь
успех, изменено
Объект ControllerProperties (api/controllerproperties)


Авторы

  • Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/avi_controllerproperties_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API