Spec-Zone.ru › Ansible 2.8

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

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

Синопсис

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
address
строка
добавлен в 2.2
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. Этот параметр нельзя обновить после его установки.

псевдонимы: hostname
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
список
добавлен в 2.2
Указывает мониторы работоспособности, которые в настоящее время используются системой для мониторинга этого узла.
name
строка / обязательно
Указывает имя узла.
partition
строка
добавлен в 2.5
По умолчанию:
"Common"
Раздел устройства для управления ресурсами.
password
строка / обязательно
Пароль для учётной записи пользователя, используемой для подключения к BIG-IP.
Вы можете опустить этот параметр, установив переменную окружения F5_PASSWORD.

псевдонимы: pass, pwd
provider
словарь
добавлен в 2.5
Объект словаря, содержащий данные подключения.
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
целое число
Значение по умолчанию:
10
Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку.
transport
строка
    Варианты:
  • cli
  • rest ←
Настраивает транспортное соединение для подключения к удалённому устройству.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Этот параметр можно опустить, установив переменную среды F5_USER.
validate_certs
булево
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самозаверяющими сертификатами.
Этот параметр можно опустить, установив переменную среды F5_VALIDATE_CERTS.
quorum
целое число
добавлен в 2.2
Отслеживать значение кворума, когда monitor_type равно m_of_n.
rate_limit
целое число
добавлен в 2.7
Предел скорости узла (соединений в секунду). Установка значения 0 отключает ограничение.
ratio
целое число
добавлен в 2.7
Весовой коэффициент соотношения узлов. Допустимые значения от 1 до 100.
При создании нового узла, если этот параметр не указан, будет использовано значение по умолчанию 1.
server
строка / обязательно
Хост BIG-IP.
Этот параметр можно опустить, установив переменную среды F5_SERVER.
server_port
целое число
добавлен в 2.2
Значение по умолчанию:
443
Порт сервера BIG-IP.
Этот параметр можно опустить, установив переменную среды F5_SERVER_PORT.
state
строка
    Варианты:
  • present ←
  • absent
  • enabled
  • disabled
  • offline
Указывает текущее состояние узла. enabled (Разрешён весь трафик), означает, что система отправляет трафик на этот узел независимо от его состояния. disabled (Разрешены только постоянные или активные соединения), означает, что узел может обрабатывать только постоянные или активные соединения. offline (Разрешены только активные соединения), означает, что узел может обрабатывать только активные соединения. Во всех случаях, кроме absent, узел будет создан, если он ещё не существует.
Обратите особое внимание на изменение статуса узла, FQDN которого нельзя разрешить. В таких ситуациях вы не сможете изменить его state на disabled или offline. Он останется в состоянии *Недоступен - Включён*.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Этот параметр можно опустить, установив переменную среды F5_USER.
validate_certs
булево
добавлен в 2.0
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самозаверяющими сертификатами.
Этот параметр можно опустить, установив переменную среды F5_VALIDATE_CERTS.

Примечания

Примечание

  • Дополнительную информацию об использовании 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
строка
изменено и успешно
Изменённое значение для описания узла.

Пример:
Веб-сервер электронной коммерции в ORD
monitor_type
строка
изменено и успешно
Изменённое значение для monitor_type узла.

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

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

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

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

Пример:
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.8/modules/bigip_node_module.html

Spec-Zone.ru

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