community.network.avi_gslb модуль — Модуль для настройки объекта Gslb Avi RESTful

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.network.avi_gslb.

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

Обзор

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

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

Требования

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

avisdk

Параметры

Параметр	Комментарии
api_context словарь	Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс.
api_version строка	Версия API Avi для использования с API Avi и объектами. По умолчанию: `"16.4.4"`
async_interval строка	Частота распространения сообщений в vs mgr. Значение 0 отключает асинхронное поведение, и rpc отправляются встроеными. Допустимые значения — 0-5. Поле введено в 18.2.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0.
avi_api_patch_op строка	Операция обновления для использования при использовании avi_api_update_method как patch. Выборы: `"add"` `"replace"` `"delete"`
avi_api_update_method строка	Метод обновления объекта по умолчанию — HTTP PUT. Установка в patch переопределит это поведение, чтобы использовать HTTP PATCH. Выборы: `"put"` ← (по умолчанию) `"patch"`
avi_credentials словарь	Словарь учетных данных Avi, который можно использовать вместо перечисления учетных данных входа в контроллер Avi.
api_version строка	Версия контроллера Avi По умолчанию: `"16.4.4"`
controller строка	IP-адрес или SQDN контроллера.
csrftoken строка	CSRF-токен API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса. По умолчанию: `""`
password строка	Пароль контроллера Avi.
port строка	Порт контроллера Avi.
session_id строка	Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken. По умолчанию: `""`
tenant строка	Тенент контроллера Avi. По умолчанию: `"admin"`
tenant_uuid строка	UUID тенента контроллера Avi. По умолчанию: `""`
timeout строка	Таймаут запроса контроллера Avi. По умолчанию: `300`
token строка	Токен API контроллера Avi. По умолчанию: `""`
username строка	Имя пользователя контроллера Avi.
avi_disable_session_cache_as_fact логический	Отключает кеширование информации о сеансе Avi в качестве факта. Выборы: `false` ← (по умолчанию) `true`
clear_on_max_retries строка	Максимальное количество попыток, после которого удаленный сайт рассматривается как новый старт. При новом старте загружаются все конфигурации. Допустимые значения — 1-1024. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 20.
client_ip_addr_group строка	Группа, указывающая, являются ли адреса IP-адресов клиента публичными или частными. Поле введено в 17.1.2.
controller строка	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`.
description строка	Определяемое пользователем описание объекта.

dns_configs string	Конфигурация поддомена для GSLB. FQDN службы GSLB должен совпадать с одним из этих поддоменов.
is_federated boolean	Это поле указывает, что этот объект реплицируется по федерации GSLB. Поле добавлено в версии 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. Варианты: `false` `true`
leader_cluster_uuid string / required	Помечает этот сайт как ведущий для конфигурации GSLB. Этот сайт является одним из сайтов Avi.
maintenance_mode boolean	Это поле отключает операции конфигурации на ведущем узле для всех федеративных объектов. Операции CRUD над GSLB, GSLBService, GSLBGeoDBProfile и другими федеративными объектами будут отклонены. Отключение REST API помогает в сценариях обновления, когда нежелательны операции синхронизации конфигурации с участником GSLB, когда участник обновляется. Эта конфигурация программным образом блокирует ведущий узел от принятия новой конфигурации GSLB, когда узлы-участники проходят обновление. Поле добавлено в версии 17.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. Варианты: `false` `true`
name string / required	Имя для объекта GSLB.
password string	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`.
send_interval string	Частота, с которой члены группы общаются. Допустимые значения: 1-3600. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 15.
send_interval_prior_to_maintenance_mode string	Пользователь может указать send-interval при переходе в режим обслуживания. Действительность этого «send-interval обслуживания» только во время режима обслуживания. Когда пользователь выходит из режима обслуживания, восстанавливается исходный send-interval. Эта внутренняя переменная используется для хранения исходного send-interval. Поле добавлено в версии 18.2.3.
sites string	Выберите участника сайта Avi, принадлежащего этому GSLB.
state string	Состояние, которое должно быть применено к объекту. Варианты: `"absent"` `"present"` ← (default)
tenant string	Имя арендатора, используемого для всех вызовов API Avi и контекста объекта. Значение по умолчанию: `"admin"`
tenant_ref string	Это ссылка на объект типа tenant.
tenant_uuid string	UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. Значение по умолчанию: `""`
third_party_sites string	Участник стороннего сайта, принадлежащий этому GSLB. Поле добавлено в версии 17.1.1.
url string	URL-адрес контроллера Avi объекта.
username string	Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды `AVI_USERNAME`.
uuid string	Uuid объекта GSLB.
view_id string	Идентификатор представления используется в режиме change-leader для различения разделенных групп, если у них одно и то же пространство имен GSLB. Каждая разделенная группа сможет работать независимо, используя view-id. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0.

Примечания

Примечание

Для получения дополнительной информации об использовании Ansible для управления устройствами Avi Network см. https://www.ansible.com/ansible-avi-networks.

Примеры

- name: Example to create Gslb object
  community.network.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)
  community.network.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)
  community.network.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)
  community.network.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 словарь	Объект Gslb (api/gslb) Возвращено: успех, изменено

Авторы

Гаурав Растоги (@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_gslb_module.html