Модуль f5networks.f5_modules.bigip_node — управление узлами F5 BIG-IP LTM

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Чтобы установить коллекцию, используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать её в плейбуке, укажите: f5networks.f5_modules.bigip_node.

Добавлено в f5networks.f5_modules 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Параметры

Параметр	Описание
address псевдонимы: ip, host string	IP-адрес узла. Может быть адресом IPv4 или IPv6. При создании нового узла необходимо указать либо `address`, либо `fqdn`. После установки этот параметр нельзя изменить.
availability_requirements dictionary	Если активировано несколько мониторов работоспособности, указывает количество мониторов, от которых должны поступить успешные ответы, чтобы канал считался доступным.
at_least integer	Указывает минимальное количество активных мониторов работоспособности, которые должны успешно сработать, чтобы канал считался работающим. Этот параметр имеет значение только при использовании `type` типа `at_least`. Этот параметр игнорируется, если используется тип `all`.
type string / обязательный	Тип правила монитора, когда указано `monitors`. При создании нового пула, если это значение не указано, будет использоваться значение по умолчанию «all». Варианты: `"all"` `"at_least"`
connection_limit integer	Лимит подключений узла. Значение `0` отключает ограничение.
description string	Указывает описательный текст, идентифицирующий узел. Описание можно удалить, указав пустую строку или специальное значение `none`.
dynamic_ratio integer	Динамический коэффициент узла. Используется для балансировки нагрузки с динамическим коэффициентом. При создании нового узла, если этот параметр не указан, будет использоваться значение по умолчанию `1`.
fqdn псевдонимы: hostname string	Полное доменное имя узла. Это может быть любое имя, соответствующее требованиям RFC 1123 к DNS-именам. Поэтому допускаются только символы от «A» до «Z», от «a» до «z», от «0» до «9», дефис («-») и точка («.»). Полные доменные имена должны содержать как минимум одну точку, отделяющую имя хоста от домена. Например, `host.domain`. Полные доменные имена должны заканчиваться буквой или цифрой. При создании нового узла необходимо указать либо `address`, либо `fqdn`. После установки этот параметр нельзя изменить.
fqdn_address_type string	Указывает, разрешается ли полное доменное имя узла в адрес IPv4 или IPv6. При создании нового узла, если этот параметр не указан, а указан `fqdn`, для параметра будет установлено значение по умолчанию `ipv4`. После установки этот параметр нельзя изменить. Варианты: `"ipv4"` `"ipv6"` `"all"`
fqdn_auto_populate boolean	Указывает, создает ли система автоматически временные узлы, используя IP-адреса, возвращаемые в ответ на DNS-запрос для узла, заданного полным доменным именем. При значении `true` система создает временный узел для каждого IP-адреса, возвращенного в ответ на DNS-запрос для полного доменного имени узла. Кроме того, если DNS-ответ указывает, что IP-адрес временного узла больше не существует, система удаляет этот временный узел. При значении `false` система разрешает DNS-запрос для полного доменного имени узла в единственный IP-адрес, связанный с этим именем. При создании нового узла, если этот параметр не указан, а указан `fqdn`, для параметра будет установлено значение по умолчанию `true`. После установки этот параметр нельзя изменить. Варианты: `false` `true`
fqdn_down_interval integer	Указывает интервал между запросами, когда DNS-сервер недоступен. Связанный монитор продолжает опрос, пока DNS-сервер не работает. При создании нового узла, если этот параметр не указан, а указан `fqdn`, для параметра будет установлено значение по умолчанию `5`.
fqdn_up_interval string	Указывает интервал между запросами, когда DNS-сервер доступен. Связанный монитор пытается выполнить проверку три раза и помечает сервер как недоступный, если в течение трех интервалов, выраженных в секундах, ответ не получен. Для этого параметра можно задать значение `ttl`, чтобы выполнять запросы с интервалом, основанным на TTL полного доменного имени. Интервал TTL по умолчанию соответствует значению `3600`. При создании нового узла, если этот параметр не указан, а указан `fqdn`, для параметра будет установлено значение по умолчанию `3600`.
monitors list / элементы=string	Указывает мониторы работоспособности, которые система в данный момент использует для наблюдения за этим узлом.
name string / обязательный	Указывает имя узла.
partition string	Раздел устройства, в котором будут управляться ресурсы. По умолчанию: `"Common"`
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Словарь с данными для подключения.
auth_provider string	Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр используется в основном при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если `yes`, данные телеметрии TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` объявлена устаревшей, поскольку её название было неоднозначным. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd string / обязательный	Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_PASSWORD`.
server string / обязательный	Хост BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_SERVER`.
server_port integer	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout integer	Задает время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истечет до завершения операции, модуль завершится с ошибкой.
transport string	Настраивает транспортное подключение для соединения с удаленным устройством. Варианты: `"rest"` ← (по умолчанию)
user string / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве. Этот параметр можно не указывать, задав переменную среды `F5_USER`.
validate_certs boolean	Если `no`, SSL-сертификаты не проверяются. Используйте этот параметр только на контролируемых вами сайтах с самоподписанными сертификатами. Этот параметр можно не указывать, задав переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
rate_limit integer	Ограничение скорости для узла (количество подключений в секунду). Значение `0` отключает ограничение.
ratio integer	Весовой коэффициент узла. Допустимые значения — от 1 до 100. При создании нового узла, если этот параметр не указан, будет использоваться значение по умолчанию `1`.
state string	Указывает текущее состояние узла. `enabled` (разрешен весь трафик) означает, что система отправляет трафик на этот узел независимо от его состояния. `disabled` (разрешены только постоянные или активные подключения) означает, что узел может обрабатывать только постоянные или активные подключения. `offline` (разрешены только активные подключения) означает, что узел может обрабатывать только активные подключения. Во всех случаях, кроме `absent`, узел будет создан, если он еще не существует. Будьте особенно осторожны при изменении состояния узла, полное доменное имя которого не разрешается. В таких ситуациях невозможно изменить его `state` на `disabled` или `offline`. Узел останется в состоянии Недоступен — включен. Варианты: `"present"` ← (по умолчанию) `"absent"` `"enabled"` `"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

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

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

Ключ	Описание
description string	Измененное значение описания узла. Возвращается: при изменении и успешном выполнении Пример: `"E-Commerce webserver in ORD"`
monitors list / элементы=string	Измененный список мониторов узла. Возвращается: при изменении и успешном выполнении Пример: `["icmp", "tcp_echo"]`
session string	Измененное значение внутреннего сеанса узла. Возвращается: при изменении и успешном выполнении Пример: `"user-disabled"`
state string	Измененное значение внутреннего состояния узла. Возвращается: при изменении и успешном выполнении Пример: `"user-down"`

Авторы

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

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_node_module.html