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

Новое в версии 2.0.

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

Описание

Управляет широким 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		Значение по умолчанию: "Common"	Раздел устройства для управления ресурсами.
password строка / обязательно			Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
pool_lb_method строка / обязательно добавлен в 2.5		Варианты: round-robin ratio topology global-availability global_availability round_robin	Указывает метод балансировки нагрузки, используемый для выбора пула в этом широком IP. Это значение актуально только при конфигурации нескольких пулов для широкого IP. Значение `round_robin` устарело и будет удалено в Ansible 2.9. Значение `global_availability` устарело и будет удалено в Ansible 2.9. псевдонимы: lb_method
pools список добавлен в 2.5			Пулы, которые вы хотите связать с широким IP. Если `ratio` не предоставлен при создании нового широкого IP, он будет по умолчанию равен 1.
	name строка / обязательно		Имя пула для включения.
	ratio целое число		Коэффициент для пула. Система использует это число с методом балансировки нагрузки Ratio.
provider словарь добавлен в 2.5			Объект словаря, содержащий данные подключения.
	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 целое число	Значение по умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль вернёт ошибку.
	transport строка	Варианты: cli rest ←	Конфигурирует транспортное соединение, которое нужно использовать при подключении к удалённому устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
	validate_certs логическое значение	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самозаверяющими сертификатами. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.
server строка / обязательно			Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.
server_port целое число добавлен в 2.2		Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`.
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.
user строка / обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
validate_certs логическое значение добавлен в 2.0		Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самозаверяющими сертификатами. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.

Примечания

Примечание

Поддержка версий 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 список	изменилось	Псевдонимы, установленные на широком IP-адресе. Пример: ['alias1.foo.com', '*.wildcard.domain']
irules список	изменилось	iRules, установленные на широком IP-адресе. Пример: ['/Common/irule1', '/Common/irule2']
lb_method строка	изменилось	Новый метод балансировки нагрузки, используемый широким IP-адресом. Пример: topology
state строка	изменилось	Новое состояние широкого 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.8/modules/bigip_gtm_wide_ip_module.html