f5networks.f5_modules.bigip_node – Управляет узлами F5 BIG-IP LTM

Примечание

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

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

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_node.

В версии 1.0.0: из f5networks.f5_modules

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

Управляет узлами F5 BIG-IP LTM.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
address строка			IP-адрес узла. Это может быть IPv4 или IPv6. При создании нового узла необходимо указать один из `address` или `fqdn`. Этот параметр нельзя обновить после его установки. Псевдонимы: ip, host
availability_requirements словарь			Если активировано более одного монитора работоспособности, указывает количество мониторов работоспособности, которые должны получить успешные ответы, чтобы связь считалась доступной.
	at_least целое число		Указывает минимальное количество активных мониторов работоспособности, которые должны быть успешны, прежде чем связь будет считаться активной. Этот параметр актуален только при использовании `type` типа `at_least`. Этот параметр будет проигнорирован, если используется тип `all`.
	type строка / обязательно	Варианты: all at_least	Тип правила мониторинга при указании `monitors`. При создании нового пула, если это значение не указано, используется значение по умолчанию 'all'.
connection_limit целое число			Предел подключений к узлу. Установка значения `0` отключает ограничение.
description строка			Указывает описательный текст, идентифицирующий узел. Описание можно удалить, указав пустую строку или специальное значение `none`.
dynamic_ratio целое число			Число динамического коэффициента для узла. Используется для динамического балансирования нагрузки. При создании нового узла, если этот параметр не указан, используется значение по умолчанию `1`.
fqdn строка			FQDN-имя узла. Это может быть любое имя, являющееся допустимым именем DNS в соответствии с RFC 1123. Таким образом, могут использоваться только символы от "A" до "Z", от "a" до "z", от "0" до "9", дефис ("-") и точка ("."). FQDN-имена должны содержать хотя бы одну точку, отделяющую хост от домена. Например, `host.domain`. FQDN-имена должны заканчиваться буквой или цифрой. При создании нового узла необходимо указать одно из `address` или `fqdn`, предоставленных. Этот параметр нельзя обновить после его установки. Псевдонимы: hostname
fqdn_address_type строка		Варианты: ipv4 ipv6 all	Указывает, разрешается ли FQDN узла в IPv4 или IPv6 адрес. При создании нового узла, если этот параметр не указан и указан `fqdn`, этот параметр будет по умолчанию `ipv4`. Этот параметр нельзя изменить после его установки.
fqdn_auto_populate логическое значение		Варианты: no yes	Указывает, автоматически ли система создаёт временные узлы, используя IP-адреса, возвращаемые разрешением DNS-запроса для узла, определённого FQDN. Когда `yes`, система генерирует временный узел для каждого IP-адреса, возвращённого в ответ на DNS-запрос для FQDN узла. Кроме того, когда ответ DNS указывает, что IP-адрес временного узла больше не существует, система удаляет временный узел. Когда `no`, система разрешает DNS-запрос для FQDN узла с единственным IP-адресом, связанным с FQDN. При создании нового узла, если этот параметр не указан и указан `fqdn`, этот параметр будет по умолчанию `yes`. Этот параметр нельзя изменить после его установки.
fqdn_down_interval целое число			Указывает интервал, в течение которого происходит запрос, когда сервер DNS недоступен. Связанный монитор продолжает опрос до тех пор, пока сервер DNS недоступен. При создании нового узла, если этот параметр не указан и указан `fqdn`, этот параметр будет по умолчанию `5`.
fqdn_up_interval строка			Указывает интервал, в течение которого происходит запрос, когда сервер DNS доступен. Связанный монитор пытается осуществить запрос три раза и отмечает сервер как нерабочий, если ответа нет в течение промежутка времени, равного трём интервалам, в секундах. Этот параметр принимает значение `ttl`, основанное на TTL FQDN. Интервал TTL по умолчанию аналогичен указанию `3600`. При создании нового узла, если этот параметр не указан и указан `fqdn`, этот параметр будет по умолчанию `3600`.
monitor_type строка		Варианты: and_list m_of_n single	Тип правила мониторинга при указании `monitors`. При создании нового пула, если это значение не указано, используется значение по умолчанию 'and_list'. Оба `single` и `and_list` функционально идентичны, поскольку BIG-IP рассматривает все мониторы как "список". BIG-IP либо имеет список из многих, либо из одного. Отличие заключается в дополнительных защитных механизмах, которые предоставляет `single`, а именно, что он позволяет только один монитор.
monitors список / элементы=строка			Указывает мониторы работоспособности, которые система в настоящее время использует для мониторинга этого узла.
name строка / обязательно			Указывает имя узла.
partition строка		Значение по умолчанию: "Common"	Раздел устройства для управления ресурсами.
provider словарь добавлен в 1.0.0 модуля f5networks.f5_modules			Объект словаря, содержащий данные о подключении.
	auth_provider строка		Настраивает поставщика аутентификации для получения маркеров аутентификации от удалённого устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	no_f5_teem логическое значение	Варианты: no yes	Если `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 yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющимися сертификатами. Можно пропустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
quorum целое число			Значение кворума мониторинга, когда `monitor_type` равно `m_of_n`.
rate_limit целое число			Ограничение скорости узла (подключений в секунду). Установка значения `0` отключает ограничение.
ratio целое число			Коэффициент веса узла. Допустимые значения от 1 до 100. При создании нового узла, если этот параметр не указан, используется значение по умолчанию `1`.

END_OF_DOCUMENT_MARKER

состояние

строка

Варианты:

текущее ←
отсутствующее
активное
выключенное
офлайн

Указывает текущее состояние узла. enabled (Разрешен весь трафик), означает, что система отправляет трафик этому узлу независимо от его состояния. disabled (Разрешены только постоянные или активные соединения), означает, что узел может обрабатывать только постоянные или активные соединения. offline (Разрешены только активные соединения), означает, что узел может обрабатывать только активные соединения. Во всех случаях, кроме absent, узел будет создан, если он ещё не существует.

Обратите особое внимание на изменение статуса узла, FQDN которого не может быть разрешен. В таких ситуациях вы не сможете изменить его state на disabled или offline. Они останутся в состоянии *Недоступен - Включен*.

Примечания

Примечание

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

Примеры

- name: Add node
  bigip_node:
    host: 10.20.30.40
    name: 10.20.30.40
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Add node with a single 'ping' monitor
  bigip_node:
    host: 10.20.30.40
    name: mytestserver
    monitors:
      - /Common/icmp
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Modify node description
  bigip_node:
    name: 10.20.30.40
    description: Our best server yet
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Delete node
  bigip_node:
    state: absent
    name: 10.20.30.40
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Force node offline
  bigip_node:
    state: disabled
    name: 10.20.30.40
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Add node by their FQDN
  bigip_node:
    fqdn: foo.bar.com
    name: foobar.net
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
описание строка	изменено и успешно	Изменённое значение для описания узла. Пример: Веб-сервер электронной коммерции в ORD
тип_мониторинга строка	изменено и успешно	Изменённое значение для типа мониторинга узла. Пример: m_of_n
мониторы список / элементы=строка	изменено и успешно	Изменённый список мониторов для узла. Пример: ['icmp', 'tcp_echo']
кворум целое число	изменено и успешно	Изменённое значение для кворума узла. Пример: 1
сессия строка	изменено и успешно	Изменённое значение для внутренней сессии узла. Пример: user-disabled
состояние строка	изменено и успешно	Изменённое значение для внутреннего состояния узла. Пример: m_of_n

Авторы

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_node_module.html