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

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

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

Обзор

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

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

f5-sdk >= 3.0.16

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aliases - добавлено в 2.7			Указывает альтернативные доменные имена для веб-контента, который вы балансируете. Вы можете использовать те же символы подстановки для псевдонимов, что и для фактических имен широких IP-адресов.
irules - добавлено в 2.6			Список правил, которые нужно применить. Если вы хотите удалить все существующие правила iRules, укажите единственное пустое значение; `""`. См. документацию для примера.
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		По умолчанию: null	Объект словаря, содержащий данные подключения.
	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 - / обязательно	Варианты: rest cli ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.
	user - / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
	validate_certs boolean	Варианты: no yes ←	Если `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 boolean добавлено в 2.0		Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте это только на сайтах, контролируемых лично, с использованием самозаверяемых сертификатов. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.

Примечания

Примечание

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

Примеры

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

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

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

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

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

Значения возврата

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

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

Статус

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

Авторы

Tim Rupp (@caphrim007)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_gtm_wide_ip_module.html