Модуль f5networks.f5_modules.bigip_gtm_topology_record — управление записями топологии GTM

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

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

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать её в плейбуке, укажите: f5networks.f5_modules.bigip_gtm_topology_record.

Добавлено в f5networks.f5_modules 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Управляет записями топологии GTM (теперь BIG-IP DNS). После создания можно изменить только запись топологии weight.

Параметры

Параметр	Комментарии
destination dictionary / обязательный	Указывает, куда система направляет входящий DNS-запрос.
continent string	Указывает один из семи континентов вместе с параметром `Unknown`. Указание `Unknown` заставляет систему использовать разрешение по умолчанию, если системе не удаётся определить местоположение локального DNS-сервера, отправившего запрос. Поддерживаются полные названия континентов и их сокращённые варианты.
country string	Указывает страну. Поддерживаются полные названия континентов и их сокращённые варианты.
datacenter string	Указывает имя центра обработки данных GTM, уже определённого в конфигурации.
geo_isp string	Указывает интернет-провайдера, определённого по геолокации.
isp string	Указывает интернет-провайдера. Варианты: `"AOL"` `"BeijingCNC"` `"CNC"` `"ChinaEducationNetwork"` `"ChinaMobilNetwork"` `"ChinaRailwayTelcom"` `"ChinaTelecom"` `"ChinaUnicom"` `"Comcast"` `"Earthlink"` `"ShanghaiCNC"` `"ShanghaiTelecom"`
negate boolean	Если задано значение `true`, система выбирает эту запись топологии, когда назначение запроса не совпадает. Варианты: `false` ← (по умолчанию) `true`
pool string	Указывает имя пула GTM, уже определённого в конфигурации.
region string	Указывает имя региона, уже определённого в конфигурации.
state string	Указывает штат или регион в указанной стране. Для этого параметра требуется параметр `country`.
subnet string	IP-адрес и маска сети в формате CIDR.
partition string	Раздел устройства, в котором будут управляться ресурсы. Параметр раздела учитывается при использовании совместно с параметрами `pool`, `data_center` и `region`; в противном случае он игнорируется. По умолчанию: `"Common"`
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий сведения о подключении.
auth_provider string	Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр используется при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если задано значение `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную окружения `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` объявлена устаревшей, поскольку её название вводило в заблуждение. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd string / обязательный	Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную окружения `F5_PASSWORD`.
server string / обязательный	Узел BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER`.
server_port integer	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER_PORT`. По умолчанию: `443`
timeout integer	Задаёт время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истечёт до завершения операции, модуль завершится с ошибкой.
transport string	Настраивает транспортное подключение для связи с удалённым устройством. Варианты: `"rest"` ← (по умолчанию)
user string / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь права администратора на устройстве. Этот параметр можно не указывать, задав переменную окружения `F5_USER`.
validate_certs boolean	Если задано значение `no`, сертификаты SSL не проверяются. Используйте этот параметр только на сайтах под вашим личным контролем, где применяются самоподписанные сертификаты. Этот параметр можно не указывать, задав переменную окружения `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
source dictionary / обязательный	Указывает источник входящего DNS-запроса.
continent string	Указывает один из семи континентов вместе с параметром `Unknown`. Указание `Unknown` заставляет систему использовать разрешение по умолчанию, если системе не удаётся определить местоположение локального DNS-сервера, отправившего запрос. Поддерживаются полные названия континентов и их сокращённые варианты.
country string	Указывает страну. Помимо полных названий стран можно указывать их сокращённые обозначения, например `US` вместо `United States`. Допустимые коды стран можно найти здесь: https://countrycode.org/.
geo_isp string	Указывает интернет-провайдера, определённого по геолокации.
isp string	Указывает интернет-провайдера. Варианты: `"AOL"` `"BeijingCNC"` `"CNC"` `"ChinaEducationNetwork"` `"ChinaMobilNetwork"` `"ChinaRailwayTelcom"` `"ChinaTelecom"` `"ChinaUnicom"` `"Comcast"` `"Earthlink"` `"ShanghaiCNC"` `"ShanghaiTelecom"`
negate boolean	Если задано значение c(true), система выбирает эту запись топологии, когда источник запроса не совпадает. Варианты: `false` ← (по умолчанию) `true`
region string	Указывает имя региона, уже определённого в конфигурации.
state string	Указывает штат или регион в указанной стране. Для этого параметра требуется параметр `country`.
subnet string	IP-адрес и маска сети в формате CIDR.
state string	Если `state` имеет значение `present`, гарантирует, что запись существует. Если `state` имеет значение `absent`, гарантирует, что запись удалена. Варианты: `"present"` ← (по умолчанию) `"absent"`
weight integer	Указывает вес записи топологии. Система находит вес первой записи топологии, соответствующей объекту сервера (пулу или участнику пула) и локальному DNS-серверу. Затем система назначает этот вес в качестве оценки топологии для данного объекта сервера. Система балансирует нагрузку в пользу объекта сервера с наивысшей оценкой топологии. Если система не находит запись топологии, соответствующую одновременно объекту сервера и локальному DNS-серверу, она присваивает этому объекту сервера нулевую оценку. Если при создании записи параметр не указан, система задаёт для него значение по умолчанию `1` Допустимый диапазон: (0–4294967295)

Примечания

Примечание

Дополнительные сведения об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы сохранить на диск конфигурацию BIG-IP, обязательно добавьте как минимум одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Инструкции по правильному использованию модуля для сохранения текущей конфигурации см. в его документации.

Примеры

- name: Create an IP Subnet and an ISP based topology record
  bigip_gtm_topology_record:
    source:
      - subnet: 192.168.1.0/24
    destination:
      - isp: AOL
    weight: 10
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a region and a pool based topology record
  bigip_gtm_topology_record:
    source:
      - region: Foo
    destination:
      - pool: FooPool
    partition: FooBar
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a negative region and a negative data center based topology record
  bigip_gtm_topology_record:
    source:
      - region: Baz
      - negate: true
    destination:
      - datacenter: Baz-DC
      - negate: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
weight integer	Вес записи топологии. Возвращается: если состояние изменено Пример: `20`

Авторы

Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_gtm_topology_record_module.html