Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию community.network (версия 5.0.3).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.

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

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

Описание

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

Псевдонимы: network.avi.avi_controllerproperties

Требования

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

  • avisdk

Параметры

Параметр

Комментарии

allow_ip_forwarding

boolean

Поле введено в 17.1.1.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

  • false
  • true

allow_unauthenticated_apis

boolean

Разрешить доступ без аутентификации для специальных API.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

  • false
  • true

allow_unauthenticated_nodes

boolean

Флаг boolean для установки allow_unauthenticated_nodes.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

  • false
  • true

api_context

dictionary

Контекст Avi API, включающий текущий ID сеанса и 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

Версия Avi API для использования с Avi API и объектами.

Значение по умолчанию: "16.4.4"

appviewx_compat_mode

boolean

Экспорт конфигурации в режиме совместимости appviewx.

Поле введено в 17.1.1.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

  • false
  • true

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

Операция исправления для использования при использовании avi_api_update_method как patch.

Варианты:

  • "add"
  • "replace"
  • "delete"

avi_api_update_method

string

Метод по умолчанию для обновления объекта — HTTP PUT.

Установка значения на patch переопределит это поведение для использования HTTP PATCH.

Варианты:

  • "put" ← (по умолчанию)
  • "patch"

avi_credentials

dictionary

Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в контроллер Avi.

api_version

string

Версия контроллера Avi

Значение по умолчанию: "16.4.4"

controller

string

IP-адрес или SQDN контроллера Avi

csrftoken

string

CSRF-токен API контроллера Avi для повторного использования существующего сеанса с ID сеанса.

Значение по умолчанию: ""

password

string

Пароль контроллера Avi

port

string

Порт контроллера Avi

session_id

string

ID сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken.

Значение по умолчанию: ""

tenant

string

Теней контроллера Avi

Значение по умолчанию: "admin"

END_OF_DOCUMENT_MARKER

tenant_uuid

string

UUID арендатора контроллера Avi

По умолчанию: ""

timeout

string

Таймаут запроса контроллера Avi

По умолчанию: 300

token

string

Токен API контроллера Avi

По умолчанию: ""

username

string

Имя пользователя контроллера Avi

avi_disable_session_cache_as_fact

boolean

Отключает кэширование информации о сессии Avi в качестве факта.

Варианты:

  • false ← (по умолчанию)
  • true

bm_use_ansible

boolean

Использовать ansible для создания се в baremetal.

Поле введено в 17.2.2.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.

Варианты:

  • false
  • 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

Включить/отключить периодическое согласование для всех облаков.

Поле введено в 17.2.14, 18.1.5, 18.2.1.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.

Варианты:

  • false
  • true

cluster_ip_gratuitous_arp_period

string

Период для работы Gratuitous ARP кластерного IP.

Значение по умолчанию, если не указано в 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.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60.

dummy

string

Количество dummy.

enable_api_sharding

boolean

Этот параметр позволяет лидеру контроллера фрагментировать запросы API к фолловерам (если таковые имеются).

Поле введено в 18.1.5, 18.2.1.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.

Варианты:

  • false
  • true

enable_memory_balancer

boolean

Включить/отключить балансировщик памяти.

Поле введено в 17.2.8.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.

Варианты:

  • false
  • 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, хранящихся для каждого арендатора.

Значение по умолчанию, если не указано в 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.

password

string

Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD.

persistence_key_rotate_period

string

Период для задания вращения ключей постоянства приложения.

Допустимые значения — 1-1051200.

Специальные значения: 0 — «отключено».

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0.

portal_token

string

Токен, используемый для загрузки технической поддержки на портал.

Поле добавлено в версиях 16.4.6, 17.1.2.

process_locked_useraccounts_timeout_period

string

Период для задания обработки заблокированных учетных записей пользователей.

Поле добавлено в версии 18.1.1.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1.

process_pki_profile_timeout_period

string

Период для задания обработки профиля PKI.

Поле добавлено в версии 18.1.1.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1440.

query_host_fail

string

Количество query_host_fail.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 180.

safenet_hsm_version

string

Версия пакета Safenet, установленного на контроллере.

Поле добавлено в версиях 16.5.2, 17.2.3.

se_create_timeout

string

Количество se_create_timeout.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 900.

se_failover_attempt_interval

string

Интервал между попытками переключения на другой экземпляр SE.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 300.

se_from_marketplace

string

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

Параметр применим только при выборе лицензии BYOL.

Варианты перечисления — MARKETPLACE, IMAGE.

Поле добавлено в версиях 18.1.4, 18.2.1.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как IMAGE.

se_offline_del

string

Количество se_offline_del.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 172000.

se_vnic_cooldown

string

Количество se_vnic_cooldown.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 120.

secure_channel_cleanup_timeout

string

Период для задания очистки защищенного канала.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60.

secure_channel_controller_token_timeout

string

Количество secure_channel_controller_token_timeout.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60.

secure_channel_se_token_timeout

string

Количество secure_channel_se_token_timeout.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60.

seupgrade_fabric_pool_size

string

Размер пула, используемый для всех команд fabric во время обновления SE.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 20.

seupgrade_segroup_min_dead_timeout

string

Время ожидания перед пометкой обновления группы SE как зависшего.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 360.

ssl_certificate_expiry_warning_days

string

Количество дней для предупреждения о истечении срока действия SSL-сертификата.

state

string

Состояние, которое должно быть применено к сущности.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

tenant

string

Имя тенанта, используемого для всех вызовов API Avi и контекста объекта.

По умолчанию: "admin"

tenant_uuid

string

UUID тенанта, используемого для всех вызовов API Avi и контекста объекта.

По умолчанию: ""

unresponsive_se_reboot

string

Количество unresponsive_se_reboot.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 300.

upgrade_dns_ttl

string

Время учета dns ttl во время обновления.

Это дополнительно к vs_scalein_timeout_for_upgrade в se_group.

Поле введено в версии 17.1.1.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 5.

upgrade_lease_time

string

Числовое значение upgrade_lease_time.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 360.

url

string

URL контроллера Avi для объекта.

username

string

Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME.

uuid

string

Уникальный идентификатор объекта.

vnic_op_fail_time

string

Количество vnic_op_fail_time.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 180.

vs_apic_scaleout_timeout

string

Время ожидания, пока масштабируемый SE станет готовым, прежде чем отметить масштабирование как завершенное, применяется только к конфигурации apic.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 360.

vs_awaiting_se_timeout

string

Количество vs_awaiting_se_timeout.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60.

vs_key_rotate_period

string

Период для выполнения задачи вращения ключей vs.

Допустимые значения от 1 до 1051200.

Особые значения: 0 — «отключено».

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 360.

vs_scaleout_ready_check_interval

string

Интервал проверки состояния scaleout_ready, в то время как контроллер ожидает rpc scaleoutready от сетевого устройства.

Поле введено в версии 18.2.2.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60.

vs_se_attach_ip_fail

string

Время ожидания, прежде чем отметить операцию привязки IP к се как неудачную.

Поле введено в версии 17.2.2.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 600.

vs_se_bootup_fail

string

Количество vs_se_bootup_fail.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 480.

vs_se_create_fail

string

Количество vs_se_create_fail.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1500.

vs_se_ping_fail

string

Количество vs_se_ping_fail.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60.

vs_se_vnic_fail

string

Количество vs_se_vnic_fail.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 300.

vs_se_vnic_ip_fail

string

Количество vs_se_vnic_ip_fail.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 120.

warmstart_se_reconnect_wait_time

string

Количество warmstart_se_reconnect_wait_time.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 480.

warmstart_vs_resync_wait_time

string

Время ожидания для warmstart или resync.

Поле введено в 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)

Возвращается: success, changed

Авторы

  • Gaurav Rastogi (@grastogi23)

Ссылки на сборку

  • Отслеживание проблем
  • Репозиторий (источники)

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

Spec-Zone.ru

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