community.network.avi_systemconfiguration модуль — Модуль для настройки объекта SystemConfiguration Avi RESTful
Примечание
Этот модуль является частью коллекции community.network (версия 5.0.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install community.network. Для использования этого модуля требуются дополнительные условия, см. Требования для получения подробностей.
Для использования в книге задач укажите: community.network.avi_systemconfiguration.
Обзор
- Этот модуль используется для конфигурирования объекта SystemConfiguration
- Дополнительные примеры на https://github.com/avinetworks/devops
Псевдонимы: network.avi.avi_systemconfiguration
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
Параметр | Комментарии |
|---|---|
admin_auth_configuration строка | Настройки adminauthconfiguration для systemconfiguration. |
api_context словарь | Контекст Avi API, включающий текущий идентификатор сессии и токен CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию. |
api_version строка | Версия Avi API для использования с Avi API и объектами. По умолчанию: |
avi_api_patch_op строка | Операция исправления, используемая при использовании avi_api_update_method как исправления. Выбор:
|
avi_api_update_method строка | Метод по умолчанию для обновления объекта — HTTP PUT. Установка значения на patch переопределит это поведение, чтобы использовать HTTP PATCH. Выбор:
|
avi_credentials словарь | Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в Avi Controller. |
|
api_version строка |
Версия контроллера Avi По умолчанию: |
|
controller строка |
IP-адрес или SQDN контроллера |
|
csrftoken строка |
Токен csrftoken API контроллера Avi для повторного использования существующей сессии с идентификатором сессии По умолчанию: |
|
password строка |
Пароль контроллера Avi |
|
port строка |
Порт контроллера Avi |
|
session_id строка |
Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken По умолчанию: |
|
tenant строка |
Подписчик контроллера Avi По умолчанию: |
|
tenant_uuid строка |
UUID подписчика контроллера Avi По умолчанию: |
|
timeout строка |
Таймаут запроса контроллера Avi По умолчанию: |
|
token строка |
Токен API контроллера Avi По умолчанию: |
|
username строка |
Имя пользователя контроллера Avi |
avi_disable_session_cache_as_fact логическое | Отключает кэширование информации о сессии avi в качестве факта. Выбор:
|
controller строка | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды |
default_license_tier строка | Указывает лицензионный уровень по умолчанию, который будет использоваться для новых облаков. Варианты перечисления — ENTERPRISE_16, ENTERPRISE_18. Поле введено в версии 17.2.5. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как ENTERPRISE_18. |
dns_configuration строка | Настройки dnsconfiguration для systemconfiguration. |
dns_virtualservice_refs string | Dns virtualservices hosting fqdn records for applications across avi vantage. If no virtualservices are provided, avi vantage will provide dns services for configured applications. Switching back to avi vantage from dns virtualservices is not allowed. It is a reference to an object of type virtualservice. |
docker_mode boolean | Флаг boolean для установки docker_mode. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. Варианты:
|
email_configuration string | Настройки emailconfiguration для systemconfiguration. |
global_tenant_config string | Настройки tenantconfiguration для systemconfiguration. |
linux_configuration string | Настройки linuxconfiguration для systemconfiguration. |
mgmt_ip_access_control string | Настройка ip-контроля доступа для управления контроллером для ограничения открытого доступа. |
ntp_configuration string | Настройки ntpconfiguration для systemconfiguration. |
password string | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения |
portal_configuration string | Настройки portalconfiguration для systemconfiguration. |
proxy_configuration string | Настройки proxyconfiguration для systemconfiguration. |
secure_channel_configuration string | Настройка свойств защищенного канала. Поле добавлено в 18.1.4, 18.2.1. |
snmp_configuration string | Настройки snmpconfiguration для systemconfiguration. |
ssh_ciphers string | Список разрешенных шифров для ssh к интерфейсу управления на контроллере и сетевых устройствах. Если это не указано, все стандартные шифры разрешены. |
ssh_hmacs string | Список разрешенных hmac для ssh к интерфейсу управления на контроллере и сетевых устройствах. Если это не указано, все стандартные hmacs разрешены. |
state string | Состояние, которое должно быть применено к объекту. Варианты:
|
tenant string | Имя тенанта, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
tenant_uuid string | UUID тенанта, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
url string | URL контроллера Avi для объекта. |
username string | Имя пользователя, используемого для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения |
uuid string | Уникальный идентификатор объекта. |
welcome_workflow_complete boolean | Этот флаг устанавливается после завершения начального процесса настройки контроллера. Поле добавлено в 18.2.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. Варианты:
|
Примечания
Примечание
- Для получения дополнительной информации об использовании Ansible для управления устройствами сети Avi см. https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create SystemConfiguration object
community.network.avi_systemconfiguration:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_systemconfiguration
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
obj словарь | Объект SystemConfiguration (api/systemconfiguration) Возвращаемое значение: success, changed |
Ссылки на коллекцию
© 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_systemconfiguration_module.html
