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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.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.

Параметры

Параметр	Комментарии
адрес псевдонимы: ip, хост строка	IP-адрес узла. Это может быть IPv4 или IPv6. При создании нового узла вы должны указать один из `address` или `fqdn`. Этот параметр нельзя обновить после его установки.
требования_доступности словарь	Если вы активируете более одного монитора работоспособности, задает количество мониторов работоспособности, которые должны получить успешные ответы, чтобы подключение считалось доступным.
не_менее целое_число	Указывает минимальное количество активных мониторов работоспособности, которые должны быть успешными, прежде чем соединение будет считаться активным. Этот параметр актуален только при использовании `type` `at_least`. Этот параметр будет проигнорирован, если используется тип `all`.
тип строка / обязательный	Тип правила мониторинга при указании `monitors`. При создании нового пула, если это значение не указано, по умолчанию будет использоваться ‘all’. Варианты: `"all"` `"at_least"`
предел_соединений целое_число	Предел подключений узла. Установка этого значения на `0` отключает ограничение.
описание строка	Указывает описательный текст, который идентифицирует узел. Вы можете удалить описание, указав пустую строку или специальное значение `none`.
динамический_коэффициент целое_число	Число динамического коэффициента для узла. Используется для динамического распределения нагрузки. При создании нового узла, если этот параметр не указан, по умолчанию будет использоваться `1`.
полное_доменное_имя псевдонимы: имя_хоста строка	Полное доменное имя узла. Это может быть любое имя, которое является допустимым именем DNS в соответствии с RFC 1123. Следовательно, допустимы только символы от «A» до «Z», от «a» до «z», от «0» до «9», дефис («-») и точка (.). Полные доменные имена должны содержать как минимум одну точку; разделяющую хост и домен. Например, `host.domain`. Полные доменные имена должны заканчиваться буквой или цифрой. При создании нового узла вы должны указать один из `address` или `fqdn`. Этот параметр нельзя обновить после его установки.
тип_адреса_fqdn строка	Указывает, соответствует ли FQDN узла IPv4 или IPv6 адресу. При создании нового узла, если этот параметр не указан, а `fqdn` указан, по умолчанию будет `ipv4`. Этот параметр нельзя изменить после его установки. Варианты: `"ipv4"` `"ipv6"` `"all"`
автоматическое_заполнение_fqdn логическое_значение	Указывает, автоматически ли система создает временные узлы, используя IP-адреса, полученные в результате разрешения запроса DNS для узла, определенного FQDN. При `true`, система генерирует временный узел для каждого IP-адреса, возвращенного в ответ на запрос DNS для FQDN узла. Кроме того, когда ответ DNS указывает, что IP-адрес временного узла больше не существует, система удаляет временный узел. При `false`, система разрешает запрос DNS для FQDN узла с единственным IP-адресом, связанным с FQDN. При создании нового узла, если этот параметр не указан, а `fqdn` указан, по умолчанию используется `true`. Этот параметр нельзя изменить после его установки. Варианты: `false` `true`
fqdn_интервал_отключения целое_число	Указывает интервал, в течение которого происходит запрос, когда сервер DNS недоступен. Соответствующий монитор продолжает выполнять опрос до тех пор, пока сервер DNS не вернется в онлайн-режим. При создании нового узла, если этот параметр не указан, а `fqdn` указан, по умолчанию будет использоваться `5`.
fqdn_интервал_включения строка	Указывает интервал, в течение которого происходит запрос, когда сервер DNS доступен. Монитор пытается провести три запроса, и отмечает сервер как недоступный, если нет ответа в течение трех интервалов, указанных в секундах. Этот параметр принимает значение `ttl` для запроса, основанного на TTL FQDN. Значение TTL по умолчанию аналогично указанию `3600`. При создании нового узла, если этот параметр не указан, а `fqdn` указан, по умолчанию будет использоваться `3600`.
мониторы список / элементы=строка	Указывает мониторы работоспособности, которые система в данный момент использует для мониторинга этого узла.
имя строка / обязательный	Указывает имя узла.
раздел строка	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
поставщик словарь добавлен в 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`, узел будет создан, если он еще не существует. Обращайте особое внимание на изменение состояния узла, FQDN которого невозможно разрешить. В этих ситуациях вы не сможете изменить его `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 строка	Изменённое значение для описания узла. Возвращено: изменённое и успешно Пример: `"E-Commerce webserver in ORD"`
monitors список / элементы=строка	Изменённый список мониторов для узла. Возвращено: изменённое и успешно Пример: `["icmp", "tcp_echo"]`
session строка	Изменённое значение для внутренней сессии узла. Возвращено: изменённое и успешно Пример: `"user-disabled"`
state строка	Изменённое значение для внутреннего состояния узла. Возвращено: изменённое и успешно Пример: `"user-down"`

Авторы

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

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

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