bigip_gtm_server – Управляет серверами F5 BIG-IP GTM

Новая версия 2.5.

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

Обзор

Управляет конфигурацией сервера BIG-IP. Этот модуль способен управлять определениями серверов в BIG-IP.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
availability_requirements словарь добавлен в 2.8			Указывает, если вы активируете более одного монитора работоспособности, количество мониторов работоспособности, которые должны получить успешные ответы, чтобы связь считалась доступной.
	at_least целое число		Указывает минимальное количество активных мониторов работоспособности, которые должны быть успешными, прежде чем связь будет считаться активной. Этот параметр актуален только при использовании `type` `at_least`. Этот параметр будет проигнорирован, если используется тип `all` или `require`.
	number_of_probers целое число		Указывает количество зондирующих агентов, которые должны использоваться при выполнении проверок. При создании нового виртуального сервера, если этот параметр указан, то также должен быть указан параметр `number_of_probes`. Значение этого параметра должно быть всегда больше или равно значению `number_of_probers`. Этот параметр актуален только при использовании `type` `require`. Этот параметр будет проигнорирован, если используется тип `all` или `at_least`.
	number_of_probes целое число		Указывает минимальное количество проверок, которые должны быть успешными, для того, чтобы сервер считался активным. При создании нового виртуального сервера, если этот параметр указан, то также должен быть указан параметр `number_of_probers`. Значение этого параметра должно быть всегда меньше или равно значению `number_of_probers`. Этот параметр актуален только при использовании `type` `require`. Этот параметр будет проигнорирован, если используется тип `all` или `at_least`.
	type строка	Варианты: all at_least require	Тип правила мониторинга, когда указан `monitors`. При создании нового пула, если это значение не указано, будет использовано значение по умолчанию 'all'.
datacenter строка			Вычислительный центр, к которому принадлежит сервер. При создании нового сервера GTM это значение обязательно.
devices список			Список собственных IP-адресов и преобразований для каждого устройства. При создании нового сервера GTM это значение обязательно. Этот список представляет собой сложный список, который определяет ряд ключей. Ключ `name` указывает имя устройства. Имя устройства должно быть уникальным для каждого сервера. Этот ключ обязателен. Ключ `address` содержит IP-адрес или список IP-адресов целевого сервера. Этот ключ обязателен. Ключ `translation` содержит IP-адрес для преобразования значения `address` выше. Этот ключ необязателен. Указание дублирующих полей `name` является поддерживаемым способом предоставления адресов устройств. В этом случае адреса будут назначены в список адресов `name`.
iquery_options словарь добавлен в 2.7			Указывает, использует ли Global Traffic Manager этот сервер BIG-IP для проведения различных проверок перед делегированием трафика на него.
	allow_path логическое значение	Варианты: no yes	Указывает, что система проверяет логический маршрут сети между сервером вычислительного центра и локальным сервером DNS.
	allow_service_check логическое значение	Варианты: no yes	Указывает, что система проверяет, запущен ли на сервере какой-либо компонент, дистанционно выполняя его с помощью внешней программы проверки сервисов.
	allow_snmp логическое значение	Варианты: no yes	Указывает, что система проверяет производительность сервера, на котором запущен агент SNMP.
limits словарь добавлен в 2.8			Указывает пороговые значения ресурсов или требования к лимитам на уровне члена пула. При включении одного или нескольких настроек лимитов, система использует эти данные для включения/выключения членов в работе. Вы можете определить лимиты для любых или всех настроек лимитов. Однако, когда член не соответствует требованию порога ресурса, система помечает члена как недоступного и направляет трафик балансировки нагрузки на другой ресурс.
	bits_enabled логическое значение	Варианты: no yes	Включен ли лимит бит или нет. Этот параметр позволяет включить или выключить действие лимита.
	bits_limit целое число		Указывает максимальную разрешенную скорость передачи данных в битах в секунду для члена. Если объем сетевого трафика превышает этот лимит, система помечает члена как недоступного.
	connections_enabled логическое значение	Варианты: no yes	Включен ли лимит текущих подключений или нет. Этот параметр позволяет включить или выключить действие лимита.
	connections_limit целое число		Указывает максимальное количество одновременных подключений, совокупно, для всех членов. Если подключения превышают этот лимит, система помечает сервер как недоступный.
	cpu_enabled логическое значение	Варианты: no yes	Включен ли лимит ЦП или нет. Этот параметр позволяет включить или выключить действие лимита.
	cpu_limit целое число		Указывает процент использования ЦП. Если процент использования ЦП превышает лимит, система помечает сервер как недоступный.
	memory_enabled логическое значение	Варианты: no yes	Включен ли лимит памяти или нет. Этот параметр позволяет включить или выключить действие лимита.
	memory_limit целое число		Указывает доступную память, необходимую виртуальными серверами на сервере. Если доступная память падает ниже этого лимита, система помечает сервер как недоступный.
	packets_enabled логическое значение	Варианты: no yes	Включен ли лимит пакетов или нет. Этот параметр позволяет включить или выключить действие лимита.
	packets_limit целое число		Указывает максимальную разрешенную скорость передачи данных в пакетах в секунду для члена. Если объем сетевого трафика превышает этот лимит, система помечает члена как недоступного.
link_discovery строка		Варианты: enabled disabled enabled-no-delete	Указывает, автоматически ли система обнаруживает связи для этого сервера. При создании нового сервера GTM, если этот параметр не указан, используется значение по умолчанию `disabled`. Если вы установите этот параметр на `enabled` или `enabled-no-delete`, вы также должны убедиться, что параметр `virtual_server_discovery` также установлен на `enabled` или `enabled-no-delete`.
monitors список добавлен в 2.8			Указывает мониторы работоспособности, которые система в настоящее время использует для мониторинга этого ресурса. Когда `availability_requirements.type` равен `require`, в списке `monitors` может быть только один монитор.

имя строка / обязательно			Имя сервера.
раздел строка добавлен в 2.5		По умолчанию: "Общий"	Раздел устройства для управления ресурсами.
пароль строка / обязательно			Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
prober_fallback строка добавлен в 2.8		Варианты: любой внутри_датацентра вне_датацентра наследовать пул нет	Указывает тип зонда, используемого для мониторинга ресурсов этого сервера, когда предпочтительный зонд недоступен. Этот параметр игнорируется в версии `TMOS` версии `12.x`. С версии `TMOS` версии `13.x` и выше, при установке prober_preference на `pool`, должен быть указан параметр `prober_pool`. Варианты взаимоисключающие с параметром prober_preference, за исключением вариантов `any-available` или `none`.
prober_pool строка добавлен в 2.8			Указывает имя пула зондов, используемого для мониторинга ресурсов этого сервера. С версии `TMOS` версии `13.x` и выше, этот параметр является обязательным, когда `prober_preference` установлен на `pool`. Формат имени может быть префиксным разделом (`/Common/foo`), или указан как имя объекта (`foo`). В версии `TMOS` версии `12.x` пробер_пул может быть установлен на пустую строку, чтобы вернуться к значению по умолчанию "наследовать".
prober_preference строка добавлен в 2.8		Варианты: внутри_датацентра вне_датацентра наследовать пул	Указывает тип зонда, используемого для мониторинга ресурсов этого сервера. Этот параметр игнорируется в версии `TMOS` версии `12.x`. С версии `TMOS` версии `13.x` и выше, при установке prober_preference на `pool`, должен быть указан параметр `prober_pool`.
поставщик словарь добавлен в 2.5			Объект словаря, содержащий данные подключения.
	пароль строка / обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
	сервер строка / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.
	порт_сервера целое число	По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`.
	ssh_keyfile путь		Указывает SSH-ключевой файл для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Вы можете опустить этот параметр, установив переменную окружения `ANSIBLE_NET_SSH_KEYFILE`.
	таймаут целое число	По умолчанию: 10	Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.
	транспорт строка	Варианты: cli rest ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.
	пользователь строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
	validate_certs булево	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.
сервер строка / обязательно			Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.
порт_сервера целое число добавлен в 2.2		По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`.
тип_сервера строка		Варианты: alteon-ace-director cisco-css cisco-server-load-balancer generic-host radware-wsd windows-nt-4.0 bigip cisco-local-director-v2 extreme generic-load-balancer sun-solaris cacheflow cisco-local-director-v3 foundry-server-iron netapp windows-2000-server	Указывает тип сервера. Тип сервера определяет метрики, которые система может собирать с сервера. При создании нового сервера GTM используется значение по умолчанию `bigip`. псевдонимы: product
состояние строка		Варианты: present ← absent enabled disabled	Состояние сервера. Если `absent`, будет произведена попытка удалить сервер. Это удастся только в том случае, если этот сервер не используется виртуальным сервером. `present` создает сервер и включает его. Если `enabled`, включить сервер, если он существует. Если `disabled`, создать сервер при необходимости и установить состояние на `disabled`.
пользователь строка / обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
validate_certs булево добавлен в 2.0		Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.
virtual_server_discovery строка		Варианты: enabled disabled enabled-no-delete	Указывает, автоматически ли система обнаруживает виртуальные сервера для этого сервера. При создании нового сервера GTM, если этот параметр не указан, используется значение по умолчанию `disabled`.

Примечания

Примечание

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

Примеры

- name: Create server "GTM_Server"
  bigip_gtm_server:
    name: GTM_Server
    datacenter: /Common/New York
    server_type: bigip
    link_discovery: disabled
    virtual_server_discovery: disabled
    devices:
      - name: server_1
        address: 1.1.1.1
      - name: server_2
        address: 2.2.2.1
        translation: 192.168.2.1
      - name: server_2
        address: 2.2.2.2
      - name: server_3
        addresses:
          - address: 3.3.3.1
          - address: 3.3.3.2
      - name: server_4
        addresses:
          - address: 4.4.4.1
            translation: 192.168.14.1
          - address: 4.4.4.2
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Create server "GTM_Server" with expanded keys
  bigip_gtm_server:
    server: lb.mydomain.com
    user: admin
    password: secret
    name: GTM_Server
    datacenter: /Common/New York
    server_type: bigip
    link_discovery: disabled
    virtual_server_discovery: disabled
    devices:
      - name: server_1
        address: 1.1.1.1
      - name: server_2
        address: 2.2.2.1
        translation: 192.168.2.1
      - name: server_2
        address: 2.2.2.2
      - name: server_3
        addresses:
          - address: 3.3.3.1
          - address: 3.3.3.2
      - name: server_4
        addresses:
          - address: 4.4.4.1
            translation: 192.168.14.1
          - address: 4.4.4.2
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

Значения возврата

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

Ключ	Возвращённое значение	Описание
bits_enabled boolean	changed	Включена ли лимитация битов. Пример: True
bits_limit integer	changed	Новый лимит bits_enabled. Пример: 100
connections_enabled boolean	changed	Включена ли лимитация подключений. Пример: True
connections_limit integer	changed	Новый лимит connections_limit. Пример: 100
datacenter string	changed	Новая `datacenter`, к которой относится сервер. Пример: datacenter01
link_discovery string	changed	Новая `link_discovery`, настроенная на удалённом устройстве. Пример: enabled
monitors list	changed	Новый список мониторов для ресурса. Пример: ['/Common/monitor1', '/Common/monitor2']
packets_enabled boolean	changed	Включена ли лимитация пакетов. Пример: True
packets_limit integer	changed	Новый лимит packets_limit. Пример: 100
server_type string	changed	Новый тип сервера. Пример: bigip
virtual_server_discovery string	changed	Новое `virtual_server_discovery` имя для пункта назначения трапа. Пример: disabled

Статус

Данный модуль гарантирует отсутствие изменений интерфейса, несовместимых со старыми версиями. [stableinterface]
Данный модуль поддерживается партнёром Ansible. [certified]

Авторы

Robert Teller (@r-teller)
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_gtm_server_module.html