Spec-Zone.ru › Ansible 2.9

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

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

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
address
строка
IP-адрес узла. Это может быть IPv4 или IPv6. При создании нового узла необходимо указать либо address, либо fqdn. Данный параметр не может быть обновлен после его установки.

Псевдонимы: ip, host
availability_requirements
словарь
добавлен в 2.8
Указывает, если активировано более одного монитора работоспособности, количество мониторов работоспособности, которые должны получить успешные ответы для того, чтобы соединение считалось доступным.
at_least
целое число
Указывает минимальное количество активных мониторов работоспособности, которые должны получить успешные ответы, прежде чем соединение будет считаться активным.
Этот параметр имеет значение только при использовании type типа at_least.
Этот параметр будет проигнорирован, если используется тип all.
type
строка
    Варианты:
  • all
  • at_least
Тип правила мониторинга при указании monitors.
При создании нового пула, если этот параметр не указан, используется значение по умолчанию 'all'.
connection_limit
целое число
добавлен в 2.7
Предел подключений к узлу. Установка значения 0 отключает ограничение.
description
строка
Указывает описательный текст, идентифицирующий узел.
Вы можете удалить описание, указав пустую строку или специальное значение none.
dynamic_ratio
целое число
добавлен в 2.7
Число динамического коэффициента для узла. Используется для динамического балансирования нагрузки.
При создании нового узла, если этот параметр не указан, используется значение по умолчанию 1.
fqdn
строка
добавлен в 2.5
Имя FQDN узла. Это может быть любое имя, которое является корректным именем DNS RFC 1123. Следовательно, могут использоваться только символы от "A" до "Z", от "a" до "z", от "0" до "9", тире ("-") и точка (".").
Имена FQDN должны содержать по крайней мере одну точку; отделяющую хост от домена. Например: host.domain.
Имена FQDN должны заканчиваться буквой или цифрой.
При создании нового узла необходимо указать либо address, либо fqdn. Этот параметр не может быть обновлен после его установки.

Псевдонимы: имя_хоста
fqdn_address_type
строка
добавлен в 2.6
    Варианты:
  • ipv4
  • ipv6
  • all
Указывает, разрешается ли FQDN узла до IPv4 или IPv6 адреса.
При создании нового узла, если этот параметр не указан и указан fqdn, этот параметр будет иметь значение по умолчанию ipv4.
Этот параметр не может быть изменён после установки.
fqdn_auto_populate
булево
добавлен в 2.6
    Варианты:
  • no
  • yes
Указывает, автоматически ли система создаёт временные узлы, используя IP-адреса, полученные по результатам разрешения запроса DNS для узла, определённого FQDN.
При yes, система генерирует временный узел для каждого IP-адреса, возвращенного в ответ на запрос DNS для FQDN узла. Кроме того, когда ответ DNS указывает, что IP-адрес временного узла больше не существует, система удаляет временный узел.
При no, система разрешает запрос DNS для FQDN узла с единственным IP-адресом, связанным с FQDN.
При создании нового узла, если этот параметр не указан и указан fqdn, этот параметр будет иметь значение по умолчанию yes.
Этот параметр не может быть изменён после установки.
fqdn_down_interval
целое число
добавлен в 2.6
Указывает интервал, в котором происходит запрос, когда DNS-сервер недоступен. Связанный монитор продолжает опрос до тех пор, пока DNS-сервер не доступен.
При создании нового узла, если этот параметр не указан и указан fqdn, этот параметр будет иметь значение по умолчанию 5.
fqdn_up_interval
строка
добавлен в 2.6
Указывает интервал, в котором происходит запрос, когда 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
строка
добавлен в 2.5
Значение по умолчанию:
"Common"
Раздел устройства для управления ресурсами.
provider
словарь
добавлен в 2.5
Объект словаря, содержащий данные подключения.
auth_provider
строка
Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства.
Этот параметр используется в работе с устройствами BIG-IQ.
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
целое число
Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль вернёт ошибку.
transport
string
    Варианты:
  • cli
  • rest ←
Настраивает транспортное подключение, используемое при подключении к удалённому устройству.
user
string / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Этот параметр можно опустить, установив переменную окружения F5_USER.
validate_certs
boolean
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых вами лично, с самозаверяющими сертификатами.
Этот параметр можно опустить, установив переменную окружения F5_VALIDATE_CERTS.
quorum
integer
Отслеживать значение кворума, когда monitor_type равно m_of_n.
rate_limit
integer
добавлено в 2.7
Предел скорости узла (подключений в секунду). Установка значения 0 отключает ограничение.
ratio
integer
добавлено в 2.7
Вес коэффициента узла. Допустимые значения от 1 до 100.
При создании нового узла, если этот параметр не указан, будет использоваться значение по умолчанию 1.
state
string
    Варианты:
  • present ←
  • absent
  • enabled
  • disabled
  • offline
Указывает текущее состояние узла. 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 сохраняется на диске, обязательно включите хотя бы одну задачу, использующую модуль 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
monitor_type
string
изменено и успешно
Изменённое значение для monitor_type узла.

Пример:
m_of_n
monitors
list
изменено и успешно
Изменённый список мониторов для узла.

Пример:
['icmp', 'tcp_echo']
quorum
integer
изменено и успешно
Изменённое значение для кворума узла.

Пример:
1
session
string
изменено и успешно
Изменённое значение для внутреннего сеанса узла.

Пример:
user-disabled
state
string
изменено и успешно
Изменённое значение для внутреннего состояния узла.

Пример:
m_of_n


Статус

  • Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
  • Этот модуль поддерживается партнером Ansible. [сертифицировано]

Авторы

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

Подсказка

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

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API