avi_gslb – Модуль для настройки Gslb Avi RESTful объекта
Новое в версии 2.4.
Описание
- Этот модуль используется для настройки объекта Gslb
- больше примеров по адресу https://github.com/avinetworks/devops
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь добавлено в 2.5 | Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования с Avi API и объектами. | |
| async_interval - добавлено в 2.9 | Частота распространения сообщений в vs mgr. Значение 0 отключает асинхронное поведение, и RPC отправляются в строке. Допустимые значения от 0 до 5. Поле добавлено в 18.2.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 0. | ||
| avi_api_patch_op - добавлено в 2.5 |
| Операция обновления для использования при использовании avi_api_update_method как patch. | |
| avi_api_update_method - добавлено в 2.5 |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение для использования HTTP PATCH. | |
| avi_credentials словарь добавлено в 2.5 | Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в Avi Controller. | ||
| api_version - | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller - | IP-адрес или SQDN контроллера Avi | ||
| csrftoken - | Маркер csrftoken API контроллера Avi для повторного использования существующей сессии с идентификатором сессии | ||
| password - | Пароль для пользователя Avi в контроллере Avi | ||
| port - | Порт контроллера Avi | ||
| session_id - | Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken | ||
| tenant - | По умолчанию: "admin" | Тенент контроллера Avi | |
| tenant_uuid - | UUID тенента контроллера Avi | ||
| timeout - | По умолчанию: 300 | Таймаут запроса контроллера Avi | |
| token - | Токен API контроллера Avi | ||
| username - | Имя пользователя контроллера Avi | ||
| avi_disable_session_cache_as_fact булево добавлено в 2.6 |
| Отключает кеширование информации о сессии Avi в качестве факта. | |
| clear_on_max_retries - | Максимальное количество попыток, после которого удаленный сайт рассматривается как новый старт. При новом запуске загружаются все конфигурации. Допустимые значения от 1 до 1024. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 20. | ||
| client_ip_addr_group - добавлено в 2.4 | Группа для указания, являются ли IP-адреса клиентов общедоступными или частными. Поле добавлено в 17.1.2. | ||
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| description - | Определяемая пользователем описательная информация для объекта. | ||
| dns_configs - | Настройка поддомена для gslb. FQDN службы Gslb должен совпадать с одним из этих поддоменов. | ||
| is_federated булево добавлено в 2.4 |
| Это поле указывает, что этот объект дублируется через федерацию gslb. Поле добавлено в 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как True. | |
| leader_cluster_uuid - / обязательно | Отметить этот сайт как лидера конфигурации gslb. Этот сайт является одним из сайтов Avi. | ||
| maintenance_mode булево добавлено в 2.5 |
| Это поле отключает операции конфигурации на лидере для всех федеративных объектов. Операции Cud по gslb, gslbservice, gslbgeodbprofile и другим федеративным объектам будут отклонены. Отключение rest-api помогает в сценариях обновления, где мы не хотим синхронизировать операции конфигурации с членом gslb, когда член обновляется. Эта конфигурация программно блокирует лидера от принятия новой конфигурации gslb, когда сайты-члены проходят обновление. Поле добавлено в 17.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как False. | |
| name - / обязательно | Имя объекта gslb. | ||
| password строка | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | |
| send_interval - | Частота обмена информацией между членами группы. Допустимые значения от 1 до 3600. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 15. | ||
| send_interval_prior_to_maintenance_mode - добавлено в 2.9 | Пользователь может указать интервал отправки при входе в режим обслуживания. Действительность этого «интервала отправки в режиме обслуживания» действует только в режиме обслуживания. При выходе из режима обслуживания восстанавливается исходный интервал отправки. Эта внутренняя переменная используется для хранения исходного интервала отправки. Поле добавлено в 18.2.3. | ||
| sites - | Выберите сайт-член Avi, принадлежащий этому gslb. | ||
| state - |
| Состояние, которое должно быть применено к сущности. | |
| tenant строка | По умолчанию: "admin" | Имя тенента, используемое для всех вызовов Avi API и контекста объекта. | |
| tenant_ref - | Ссылка на объект типа tenant. | ||
| tenant_uuid строка | Значение по умолчанию: "" | UUID арендатора, используемый для всех вызовов API Avi и контекста объекта. | |
| third_party_sites - | Член стороннего сайта, принадлежащий этому gslb. Поле введено в версии 17.1.1. | ||
| url - | URL контроллера Avi объекта. | ||
| username строка | Значение по умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME. | |
| uuid - | Uuid объекта gslb. | ||
| view_id - | Идентификатор представления используется в режиме change-leader для различения разграниченных групп, имеющих одинаковое пространство имен gslb. Каждая разграниченная группа сможет работать независимо, используя идентификатор представления. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create Gslb object
avi_gslb:
name: "test-gslb"
avi_credentials:
username: '{{ username }}'
password: '{{ password }}'
controller: '{{ controller }}'
sites:
- name: "test-site1"
username: "gslb_username"
password: "gslb_password"
ip_addresses:
- type: "V4"
addr: "10.10.28.83"
enabled: True
member_type: "GSLB_ACTIVE_MEMBER"
port: 443
cluster_uuid: "cluster-d4ee5fcc-3e0a-4d4f-9ae6-4182bc605829"
- name: "test-site2"
username: "gslb_username"
password: "gslb_password"
ip_addresses:
- type: "V4"
addr: "10.10.28.86"
enabled: True
member_type: "GSLB_ACTIVE_MEMBER"
port: 443
cluster_uuid: "cluster-0c37ae8d-ab62-410c-ad3e-06fa831950b1"
dns_configs:
- domain_name: "test1.com"
- domain_name: "test2.com"
leader_cluster_uuid: "cluster-d4ee5fcc-3e0a-4d4f-9ae6-4182bc605829"
- name: Update Gslb site's configurations (Patch Add Operation)
avi_gslb:
avi_credentials:
username: '{{ username }}'
password: '{{ password }}'
controller: '{{ controller }}'
avi_api_update_method: patch
avi_api_patch_op: add
leader_cluster_uuid: "cluster-d4ee5fcc-3e0a-4d4f-9ae6-4182bc605829"
name: "test-gslb"
dns_configs:
- domain_name: "temp1.com"
- domain_name: "temp2.com"
gslb_sites_config:
- ip_addr: "10.10.28.83"
dns_vses:
- dns_vs_uuid: "virtualservice-f2a711cd-5e78-473f-8f47-d12de660fd62"
domain_names:
- "test1.com"
- "test2.com"
- ip_addr: "10.10.28.86"
dns_vses:
- dns_vs_uuid: "virtualservice-c1a63a16-f2a1-4f41-aab4-1e90f92a5e49"
domain_names:
- "temp1.com"
- "temp2.com"
- name: Update Gslb site's configurations (Patch Replace Operation)
avi_gslb:
avi_credentials:
username: "{{ username }}"
password: "{{ password }}"
controller: "{{ controller }}"
# On basis of cluster leader uuid dns_configs is set for that particular leader cluster
leader_cluster_uuid: "cluster-84aa795f-8f09-42bb-97a4-5103f4a53da9"
name: "test-gslb"
avi_api_update_method: patch
avi_api_patch_op: replace
dns_configs:
- domain_name: "test3.com"
- domain_name: "temp3.com"
gslb_sites_config:
# Ip address is mapping key for dns_vses field update. For the given IP address,
# dns_vses is updated.
- ip_addr: "10.10.28.83"
dns_vses:
- dns_vs_uuid: "virtualservice-7c947ed4-77f3-4a52-909c-4f12afaf5bb0"
domain_names:
- "test3.com"
- ip_addr: "10.10.28.86"
dns_vses:
- dns_vs_uuid: "virtualservice-799b2c6d-7f2d-4c3f-94c6-6e813b20b674"
domain_names:
- "temp3.com"
- name: Update Gslb site's configurations (Patch Delete Operation)
avi_gslb:
avi_credentials:
username: "{{ username }}"
password: "{{ password }}"
controller: "{{ controller }}"
# On basis of cluster leader uuid dns_configs is set for that particular leader cluster
leader_cluster_uuid: "cluster-84aa795f-8f09-42bb-97a4-5103f4a53da9"
name: "test-gslb"
avi_api_update_method: patch
avi_api_patch_op: delete
dns_configs:
gslb_sites_config:
- ip_addr: "10.10.28.83"
- ip_addr: "10.10.28.86"
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | success, changed | Объект Gslb (api/gslb) |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Gaurav Rastogi (@grastogi23) <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.9/modules/avi_gslb_module.html