Модуль f5networks.f5_modules.bigip_gtm_topology_region — управление регионами топологии 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_region.

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

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

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

Управление регионами топологии GTM (ныне BIG-IP DNS).

Параметры

Параметр	Комментарии
name string / обязательный	Задает имя региона.
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` ← (по умолчанию)
region_members list / элементы типа dictionary	Задает список элементов региона. Список элементов задается целиком: чтобы добавить или удалить элемент, необходимо указать полный список. Если указанный список отличается от списка на устройстве, он заменит его. Если указать пустой список, список элементов региона будет удален.
continent string	Задает один из семи континентов вместе с параметром `Unknown`. Указание `Unknown` заставляет систему использовать разрешение по умолчанию, если она не может определить местоположение локального DNS-сервера, отправившего запрос. Поддерживаются полные названия континентов и их сокращенные варианты.
country string	Название или код страны. Помимо полных названий стран, можно указывать их сокращенные обозначения, например `US` вместо `United States`. Допустимые коды стран можно найти здесь: https://countrycode.org/.
datacenter string	Задает имя центра обработки данных GTM, уже определенного в конфигурации.
geo_isp string	Задает географическое расположение интернет-провайдера.
isp string	Задает интернет-провайдера. Варианты: `"AOL"` `"BeijingCNC"` `"CNC"` `"ChinaEducationNetwork"` `"ChinaMobilNetwork"` `"ChinaRailwayTelcom"` `"ChinaTelecom"` `"ChinaUnicom"` `"Comcast"` `"Earthlink"` `"ShanghaiCNC"` `"ShanghaiTelecom"`
negate boolean	Если задано значение c(true), система выбирает этот регион топологии, когда источник запроса не соответствует условию. Вместе с параметром negate можно указать только одну запись списка. Варианты: `false` ← (по умолчанию) `true`
pool string	Задает имя пула GTM, уже определенного в конфигурации.
region string	Задает имя региона, уже определенного в конфигурации.
state string	Задает штат или территорию в указанной стране.
subnet string	IP-адрес и маска сети в формате CIDR.
state string	Если для `state` задано значение `present`, обеспечивает наличие региона. Если для `state` задано значение `absent`, обеспечивает удаление региона. Варианты: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

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

Примеры

- name: Create topology region
  bigip_gtm_topology_region:
    name: foobar
    region_members:
      - country: CN
        negate: true
      - datacenter: baz
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify topology region
  bigip_gtm_topology_region:
    name: foobar
    region_members:
      - continent: EU
      - country: PL
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Описание
name string	Значение имени региона GTM. Возвращается: при изменении Пример: `"foobar"`
region_members list / элементы типа string	Список элементов региона GTM. Возвращается: при изменении Пример: `[{"continent": "EU"}, {"country": "PL"}]`

Авторы

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_region_module.html