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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aliases список добавлено в 2.7			Указывает альтернативные доменные имена для содержимого веб-сайта, которое вы настраиваете балансировку нагрузки. Вы можете использовать те же символы подстановки для псевдонимов, что и для фактических имен широких IP-адресов.
irules список добавлено в 2.6			Список правил, которые нужно применить. Если вы хотите удалить все существующие правила iRules, укажите единственное пустое значение; `""`. См. документацию для примера.
last_resort_pool строка добавлено в 2.8			Указывает пул GTM, который система должна использовать в качестве пула по умолчанию для широкого IP-адреса. Допустимые пулы для этого параметра — те, у которых указан `type` в этом модуле.
name строка / обязательно			Имя широкого IP-адреса. Это имя должно быть отформатировано как полное доменное имя (FQDN). Вы также можете использовать псевдоним `wide_ip`, но это устаревший метод и будет удален в будущей версии Ansible. псевдонимы: wide_ip
partition строка добавлено в 2.5		Значение по умолчанию: "Общие"	Раздел устройства для управления ресурсами.
pool_lb_method строка / обязательно добавлено в 2.5		Варианты: round-robin ratio topology global-availability	Указывает метод балансировки нагрузки, используемый для выбора пула в этом широком IP-адресе. Это значение актуально только при наличии нескольких пулов, настроенных для широкого IP-адреса. псевдонимы: lb_method
pools список добавлено в 2.5			Пулы, которые нужно ассоциировать с широким IP-адресом. Если `ratio` не указан при создании нового широкого IP-адреса, он будет по умолчанию равен 1.
	name строка / обязательно		Имя пула для включения.
	ratio целое число		Отношение для пула. Система использует это число с методом балансировки нагрузки Ratio.
provider словарь добавлено в 2.5			Объект словаря, содержащий сведения о подключении.
	auth_provider строка		Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	password строка / обязательно		Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port целое число	Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	ssh_keyfile путь		Указывает файл SSH-ключа, который нужно использовать для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Вы можете опустить этот параметр, установив переменную среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число		Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: cli rest ←	Настраивает транспортное подключение для использования при подключении к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs логическое	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте это только на управляемых вами сайтах, использующих самозаверяющие сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
state строка добавлено в 2.4		Варианты: present ← absent disabled enabled	Когда `present` или `enabled`, гарантирует, что широкий IP-адрес существует и включен. Когда `absent`, гарантирует, что широкий IP-адрес был удален. Когда `disabled`, гарантирует, что широкий IP-адрес существует и отключен.
type строка добавлено в 2.4		Варианты: a aaaa cname mx naptr srv	Указывает тип широкого IP-адреса. Широкие IP-адреса GTM должны быть сгруппированы по типу запроса помимо имени, так как членам пула требуются разные атрибуты в зависимости от RDATA ответа, который они должны предоставить. Это значение необходимо, если вы используете версии BIG-IP ≥ 12.0.0.

Примечания

Примечание

Поддержка версий TMOS ниже v12.x устарела для этого модуля и будет удалена в Ansible 2.12.
Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP ≥ 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохраняется на диске, убедитесь, что в задаче используется модуль 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
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

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

Ключ	Возвращаемое	Описание
aliases список	изменено	Псевдонимы, установленные на Wide IP. Пример: ['alias1.foo.com', '*.wildcard.domain']
irules список	изменено	Наборы iRules, установленные на Wide IP. Пример: ['/Common/irule1', '/Common/irule2']
lb_method строка	изменено	Новый метод балансировки нагрузки, используемый Wide IP. Пример: topology
state строка	изменено	Новое состояние Wide IP. Пример: disabled

Статус

Данный модуль гарантирует обратную совместимость изменений интерфейса в будущем. [stableinterface]
Этот модуль поддерживается партнером Ansible. [certified]

Авторы

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

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.

© 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/bigip_gtm_wide_ip_module.html