f5networks.f5_modules.bigip_gtm_wide_ip – Управляет широким IP-адресом F5 BIG-IP GTM

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).

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

Для использования в книге задач укажите: f5networks.f5_modules.bigip_gtm_wide_ip.

Новое в версии 1.0.0: из f5networks.f5_modules

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

Описание

Управляет широким IP-адресом F5 BIG-IP GTM (сейчас BIG-IP DNS).

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aliases список / элементы=строка			Указывает альтернативные доменные имена для содержимого веб-сайта, которое вы балансируете. Вы можете использовать те же символы подстановки, что и для фактических имён широких IP-адресов.
irules список / элементы=строка			Список правил, которые должны применяться. Если вы хотите удалить все существующие iRules, укажите единственное пустое значение; `""`. См. документацию для примера.
last_resort_pool строка			Указывает, какой пул GTM система должна использовать в качестве пула по умолчанию для широкого IP-адреса. Действительные пулы для этого параметра — те, у которых указано `type` в этом модуле.
name строка / обязательно			Имя широкого IP-адреса. Это имя должно быть отформатировано как полное доменное имя (FQDN). Вы также можете использовать псевдоним `wide_ip`, но это устарело и будет удалено в будущей версии Ansible. псевдонимы: wide_ip
partition строка		По умолчанию: "Common"	Раздел устройства для управления ресурсами.
persist_cidr_ipv4 целое число			Указывает маску, используемую для группирования адресов IPv4 LDNS. Эта функция позволяет одному записям сохранения быть совмещенными адресами LDNS, которые совпадают в этой маске.
persist_cidr_ipv6 целое число			Указывает маску, используемую для группирования адресов IPv6 LDNS. Эта функция позволяет одному записям сохранения быть совмещенными адресами LDNS, которые совпадают в этой маске.
persistence логическое значение		Варианты: нет да	Когда `yes`, гарантирует, что когда локальный DNS выполняет повторяющиеся запросы от имени клиента, система подключает клиента к тому же ресурсу, что и предыдущие запросы. Когда `no`, гарантирует, что повторяющиеся запросы не подключают клиента к тому же ресурсу.
persistence_ttl целое число			Указывает время поддержания подключения между локальным DNS и конкретным виртуальным сервером.
pool_lb_method строка		Варианты: очередь соотношение топология глобальная доступность	Указывает метод балансировки нагрузки, используемый для выбора пула в этом широком IP-адресе. Это значение актуально только при конфигурации нескольких пулов для широкого IP-адреса. псевдонимы: lb_method
pools список / элементы=словарь			Пулы, которые вы хотите связать с широким IP-адресом. Если `ratio` не указан при создании нового широкого IP-адреса, он будет по умолчанию равен 1.
	name строка / обязательно		Имя пула, который нужно включить.
	order целое число		Порядок пула по отношению к другим пулам, подключенным к этому широкому IP-адресу. Порядок пулов имеет значение, когда используется метод балансировки нагрузки «Глобальная доступность». Когда `order` не указан, модуль присваивает ему значение `0`.
	ratio целое число		Соотношение для пула. Система использует это число с методом балансировки нагрузки «Соотношение». Когда `ratio` не указан, модуль присваивает ему значение `0`.
provider словарь добавлено в 1.0.0 f5networks.f5_modules			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщик аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	no_f5_teem логическое значение	Варианты: нет да	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, задав переменную окружения `F5_TEEM`.
	password строка / обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, задав переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, задав переменную окружения `F5_SERVER`.
	server_port целое число	По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, задав переменную окружения `F5_SERVER_PORT`.
	timeout целое число		Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль вернёт ошибку.
	transport строка	Варианты: rest ←	Настраивает транспортное соединение, которое будет использоваться при подключении к удалённому устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, задав переменную окружения `F5_USER`.
	validate_certs логическое значение	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самоподписанными сертификатами. Вы можете опустить этот параметр, задав переменную окружения `F5_VALIDATE_CERTS`.
state строка		Варианты: present ← отсутствует выключен включен	Когда `present` или `enabled`, гарантирует, что широкий IP-адрес существует и включен. Когда `absent`, гарантирует, что широкий IP-адрес был удалён. Когда `disabled`, гарантирует, что широкий IP-адрес существует и отключён.
type строка		Варианты: a aaaa cname mx naptr srv	Указывает тип широкого IP-адреса. Широкие IP-адреса GTM должны быть ключом по типу запроса в дополнение к имени, потому что членам пула необходимы различные атрибуты в зависимости от RDATA ответа, который они должны предоставить. Это значение обязательно, если вы используете версии BIG-IP >= 12.0.0.

Примечания

Примечание

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

Примеры

- name: Set lb method
  bigip_gtm_wide_ip:
    pool_lb_method: round-robin
    name: my-wide-ip.example.com
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Add iRules to the Wide IP
  bigip_gtm_wide_ip:
    pool_lb_method: round-robin
    name: my-wide-ip.example.com
    irules:
      - irule1
      - irule2
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Remove one iRule from the Virtual Server
  bigip_gtm_wide_ip:
    pool_lb_method: round-robin
    name: my-wide-ip.example.com
    irules:
      - irule1
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Remove all iRules from the Virtual Server
  bigip_gtm_wide_ip:
    pool_lb_method: round-robin
    name: my-wide-ip.example.com
    irules: ""
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Assign a pool with ratio to the Wide IP
  bigip_gtm_wide_ip:
    pool_lb_method: round-robin
    name: my-wide-ip.example.com
    pools:
      - name: pool1
        ratio: 100
        order: 2
      - name: pool1
        ratio: 100
        order: 1
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Assign a pool with persistence to the Wide IP
  bigip_gtm_wide_ip:
    pool_lb_method: round-robin
    name: my-wide-ip.example.com
    pools:
      - name: pool1
        persistence: yes
        persist_cidr_ipv4: 24
        persist_cidr_ipv6: 120
        persistence_ttl: 3500
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
aliases список / элементы=строка	изменённое	Псевдонимы, установленные на широком IP-адресе. Пример: ['alias1.foo.com', '*.wildcard.domain']
irules список / элементы=строка	изменённое	Установленные iRules на широком IP-адресе. Пример: ['/Common/irule1', '/Common/irule2']
lb_method строка	изменённое	Новый метод балансировки нагрузки, используемый широким IP-адресом. Пример: topology
persist_cidr_ipv4 целое число	изменённое	Указывает маску, используемую для группирования адресов IPv4 LDNS. Пример: 32
persist_cidr_ipv6 целое число	изменённое	Указывает маску, используемую для группирования адресов IPv6 LDNS. Пример: 128
persistence логическое значение	изменённое	Указывает, будут ли сохраняться подключения к пулу.
persistence_ttl целое число	изменённое	Указывает время жизни (TTL) сохранения состояния между локальным DNS-сервером и определённым виртуальным сервером. Пример: 3600
state строка	изменённое	Новое состояние широкого IP-адреса. Пример: выключен

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

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