community.network.avi_gslbgeodbprofile модуль — Модуль для настройки объекта GslbGeoDbProfile Avi RESTful
Примечание
Этот модуль является частью коллекции community.network (версия 5.0.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Чтобы использовать его в книге задач, укажите: community.network.avi_gslbgeodbprofile.
Обзор
- Этот модуль используется для настройки объекта GslbGeoDbProfile
- Дополнительные примеры на https://github.com/avinetworks/devops
Псевдонимы: network.avi.avi_gslbgeodbprofile
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
Параметр | Комментарии |
|---|---|
api_context словарь | Контекст API Avi, включающий текущий идентификатор сеанса и токен CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. |
api_version строка | Версия API Avi для использования с Avi API и объектами. По умолчанию: |
avi_api_patch_op строка | Операция обновления при использовании avi_api_update_method как patch. Варианты:
|
avi_api_update_method строка | Метод обновления объекта по умолчанию — HTTP PUT. Установка значения на patch переопределит это поведение, чтобы использовать HTTP PATCH. Варианты:
|
avi_credentials словарь | Словарь учетных данных Avi, который может использоваться вместо перечисления данных входа в Avi контроллер. |
|
api_version строка |
Версия контроллера Avi По умолчанию: |
|
controller строка |
IP-адрес или SQDN контроллера Avi |
|
csrftoken строка |
CSRF-токен 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-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды |
description строка | Поле, введенное в 17.1.1. |
entries строка | Список записей geodb. Запись может быть либо файлом geodb, либо группой IP-адресов с гео-свойствами. Поле, введенное в 17.1.1. |
is_federated логическое | Это поле указывает, что этот объект реплицируется в федерации gslb. Поле, введенное в 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. Варианты:
|
name строка / обязательно | Наименование профиля geodb для удобства пользователя. Поле добавлено в 17.1.1. |
password строка | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения |
state строка | Состояние, которое должно быть применено к сущности. Варианты:
|
tenant строка | Имя арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
tenant_ref строка | Ссылка на объект типа арендатор. Поле добавлено в 17.1.1. |
tenant_uuid строка | UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
url строка | URL контроллера Avi для объекта. |
username строка | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения |
uuid строка | Uuid профиля geodb. Поле добавлено в 17.1.1. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create GslbGeoDbProfile object
community.network.avi_gslbgeodbprofile:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_gslbgeodbprofile
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
obj словарь | Объект GslbGeoDbProfile (api/gslbgeodbprofile) Возвращается: 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_gslbgeodbprofile_module.html
