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

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

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

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

Требования

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

f5-sdk >= 3.0.9

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
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)			Объект словаря, содержащий данные подключения.
	password обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная среды `F5_PASSWORD` задана. Псевдонимы: pass, pwd
	server обязательно		Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды `F5_SERVER` задана.
	server_port	По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды `F5_SERVER_PORT` задана.
	user обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная среды `F5_USER` задана.
	validate_certs bool	Варианты: no да ←	Если `no`, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, если переменная среды `F5_VALIDATE_CERTS` задана.
	timeout	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку.
	ssh_keyfile		Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	transport обязательно	Варианты: rest cli ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.
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 bool (добавлено в 2.0)		Варианты: no да ←	Если `no`, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, если переменная среды `F5_VALIDATE_CERTS` задана.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
Требуется пакет f5-sdk Python на хосте. Это так же просто, как pip install f5-sdk.

Примеры

- 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

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

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

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

Статус

Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будет внесено обратной несовместимости в интерфейс.

Техническое обслуживание

Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в Техническом обслуживании и поддержке модулей.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

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