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

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).

Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.

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

Новое в версии 1.0.0: модуля f5networks.f5_modules

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
availability_requirements словарь			Если активировано более одного монитора состояния, указывает количество мониторов состояния, которые должны получить успешные ответы для того, чтобы ссылка считалась доступной.
	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 словарь			Указывает, использует ли Global Traffic Manager этот сервер BIG-IP для проведения различных зондирований перед делегированием трафика.
	allow_path булево значение	Варианты: no yes	Указывает, проверяет ли система логический маршрут сети между сервером вычислительного центра и локальным сервером DNS.
	allow_service_check булево значение	Варианты: no yes	Указывает, проверяет ли система, работает ли приложение на сервере, выполняя приложение удаленно с помощью внешней программы проверки служб.
	allow_snmp булево значение	Варианты: no yes	Указывает, проверяет ли система производительность сервера, на котором работает агент SNMP.
limits словарь			Устанавливает пороговые значения или требования к ресурсам на уровне члена пула. Когда включено одно или несколько ограничений, система затем использует эти данные для включения и выключения членов в работу. Можно определять ограничения для любых или всех настроек ограничений. Однако, когда член не соответствует порогу ресурса, система помечает члена как недоступный и направляет трафик балансировки нагрузки на другой ресурс.
	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 список / элементы=строка			Указывает мониторы состояния, которые в настоящее время используются системой для мониторинга этого ресурса. Когда `availability_requirements.type` является `require`, в списке `monitors` может быть только один монитор.
name строка / обязательно			Имя сервера.
partition строка		Значение по умолчанию: "Common"	Раздел устройства для управления ресурсами.
prober_fallback строка		Варианты: any inside-datacenter outside-datacenter inherit pool none	Указывает тип зондирующего агента, который следует использовать для мониторинга ресурсов этого сервера, когда предпочтительный зондирующий агент недоступен. Этот параметр игнорируется в версии `TMOS` `12.x`. С версии `TMOS` `13.x` и выше, при установке prober_preference в `pool`, необходимо указать параметр `prober_pool`. Варианты являются взаимоисключающими с параметром prober_preference, за исключением вариантов `any-available` или `none`.

prober_pool string			Указывает имя пула зондов для мониторинга ресурсов этого сервера. В версии `TMOS` `13.x` и более поздних, этот параметр является обязательным, когда `prober_preference` установлен в `pool`. Формат имени может быть либо с префиксом раздела (`/Common/foo`), либо указан просто как имя объекта (`foo`). В версии `TMOS` `12.x`, prober_pool можно установить в пустую строку, чтобы вернуться к значению по умолчанию `inherit`.
prober_preference string		Варианты: inside-datacenter outside-datacenter inherit pool	Указывает тип зонда, используемого для мониторинга ресурсов этого сервера. Этот параметр игнорируется в версии `TMOS` `12.x`. Начиная с версии `TMOS` `13.x` и выше, при установке prober_preference в `pool` необходимо указать параметр `prober_pool`.
provider dictionary добавлен в версии 1.0.0 модуля f5networks.f5_modules			Объект типа dict, содержащий детали подключения.
	auth_provider string		Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	no_f5_teem boolean	Варианты: no yes	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную окружения `F5_TEEM`.
	password string / required		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
	server string / required		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.
	server_port integer	По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`.
	timeout integer		Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль вернёт ошибку.
	transport string	Варианты: rest ←	Настраивает транспортное соединение для использования при подключении к удалённому устройству.
	user string / required		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
	validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте это только на сайтах, находящихся под вашим контролем, использующих самоподписанные сертификаты. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.
server_type string		Варианты: 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
state string		Варианты: present ← absent enabled disabled	Состояние сервера. Если `absent`, модуль пытается удалить сервер. Это удастся только если этот сервер не используется виртуальным сервером. `present` создаёт сервер и включает его. Если `enabled`, включает сервер, если он существует. Если `disabled`, создаёт сервер при необходимости и устанавливает состояние в `disabled`.
virtual_server_discovery string		Варианты: enabled disabled enabled-no-delete	Указывает, будет ли система автоматически обнаруживать виртуальные серверы для этого сервера. При создании нового сервера GTM, если этот параметр не указан, используется значение по умолчанию `disabled`.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 работают только с текущей конфигурацией продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохраняется на диске, обязательно включите задачу, использующую модуль f5networks.f5_modules.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	Новый лимит на биты. Пример: 100
connections_enabled boolean	changed	Включен ли лимит на соединения. Пример: True
connections_limit integer	changed	Новый лимит на соединения. Пример: 100
datacenter string	changed	Новая `datacenter`, к которой принадлежит сервер. Пример: datacenter01
link_discovery string	changed	Новая `link_discovery` настроенная на удалённом устройстве. Пример: enabled
monitors list / elements=string	changed	Новый список мониторов для ресурса. Пример: ['/Common/monitor1', '/Common/monitor2']
packets_enabled boolean	changed	Включен ли лимит на пакеты. Пример: True
packets_limit integer	changed	Новый лимит на пакеты. Пример: 100
server_type string	changed	Новый тип сервера. Пример: bigip
virtual_server_discovery string	changed	Новое имя `virtual_server_discovery` для пункта назначения трапов. Пример: disabled

Авторы

Robert Teller (@r-teller)
Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

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