Spec-Zone.ru › Ansible

f5networks.f5_modules.bigip_gtm_server модуль — Управляет серверами F5 BIG-IP GTM

Примечание

Этот модуль является частью коллекции f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_gtm_server.

Новая функция в f5networks.f5_modules 1.0.0

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

Описание

  • Управляет конфигурацией серверов 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

строка / обязательный

Тип правила мониторинга при указании monitors.

При создании нового пула, если это значение не указано, используется значение по умолчанию all.

Варианты:

  • "all"
  • "at_least"
  • "require"

datacenter

строка

Дата-центр, к которому принадлежит сервер. При создании нового сервера GTM это значение обязательно.

devices

любой

Список собственных IP-адресов и переводов для каждого устройства. При создании нового сервера GTM это значение обязательно. Этот список — сложный список, который определяет ряд ключей.

Ключ name указывает имя устройства. Имя устройства должно быть уникальным для каждого сервера. Этот ключ обязателен.

Ключ address содержит IP-адрес или список IP-адресов целевого сервера. Этот ключ обязателен.

Ключ translation содержит IP-адрес для перевода значения address выше. Этот ключ необязателен.

Указание дублирующих полей name — это поддерживаемый способ предоставления адресов устройств. В этом случае адреса будут назначены в список адресов name.

iquery_options

словарь

Указывает, использует ли Global Traffic Manager эту систему BIG-IP для проведения различных проверок перед делегированием трафика на нее.

allow_path

логическое значение

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

Варианты:

  • false
  • true

allow_service_check

логическое значение

Указывает, проверяет ли система, работает ли приложение на сервере, путем удаленного запуска приложения с помощью внешней программы проверки службы.

Варианты:

  • false
  • true

allow_snmp

логическое значение

Указывает, проверяет ли система производительность сервера, на котором работает агент SNMP.

Варианты:

  • false
  • true

limits

словарь

Указывает пороговые значения ресурсов или требования к лимитам на уровне участника пула.

При активации одного или нескольких параметров лимитов, система использует эти данные для включения и выключения участников в работу.

Вы можете определить лимиты для любых или всех параметров лимитов. Однако, когда участник не соответствует требованию порогового значения ресурса, система помечает участника как недоступного и перенаправляет трафик балансировки нагрузки на другой ресурс.

bits_enabled

логическое значение

Включен или нет лимит на биты.

Этот параметр позволяет включить или выключить действие лимита.

Варианты:

  • false
  • true

bits_limit

целое число

Указывает максимальную допустимую скорость пропускной способности данных для участника в битах в секунду.

Если объем сетевого трафика превышает этот лимит, система помечает участника как недоступного.

connections_enabled

логическое значение

Включен или нет лимит на текущие соединения.

Этот параметр позволяет включить или выключить действие лимита.

Варианты:

  • false
  • true
END_OF_DOCUMENT_MARKER

connections_limit

целое число

Указывает максимальное количество одновременных подключений, в совокупности, для всех членов.

Если подключения превысят этот лимит, система помечает сервер как недоступный.

cpu_enabled

булево

Включен ли лимит по использованию ЦП.

Этот параметр позволяет включить или выключить ограничение.

Выбори:

  • false
  • true

cpu_limit

целое число

Указывает процент использования ЦП.

Если процент использования ЦП превысит лимит, система помечает сервер как недоступный.

memory_enabled

булево

Включен ли лимит по памяти?

Этот параметр позволяет включить или выключить ограничение.

Выбори:

  • false
  • true

memory_limit

целое число

Указывает необходимый объём свободной памяти для виртуальных серверов на сервере.

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

packets_enabled

булево

Включен ли лимит по пакетам?

Этот параметр позволяет включить или выключить ограничение.

Выбори:

  • false
  • true

packets_limit

целое число

Указывает максимальную скорость передачи данных для члена в пакетах в секунду.

Если объём сетевого трафика превысит этот лимит, система помечает члена как недоступный.

link_discovery

строка

Указывает, автоматически ли система обнаруживает соединения для этого сервера. При создании нового сервера GTM, если этот параметр не указан, используется значение по умолчанию disabled. Если вы установите этот параметр в enabled или enabled-no-delete, вы также должны убедиться, что параметр virtual_server_discovery также установлен в enabled или enabled-no-delete.

Выбори:

  • "enabled"
  • "disabled"
  • "enabled-no-delete"

monitors

список / элементы=строка

Указывает используемые в настоящее время мониторы состояния для мониторинга этого ресурса.

Когда availability_requirements.type равно require, в списке monitors может быть только один монитор.

name

строка / обязательный

Имя сервера.

Если виртуальный сервер обнаруживается автоматически из LTM, то имя раздела необходимо включить в имя виртуального сервера при ссылке на модуль, например, «/Common/vsname».

partition

строка

Раздел устройства для управления ресурсами.

По умолчанию: "Common"

prober_fallback

строка

Указывает тип пробера для мониторинга ресурсов сервера, когда предпочтительный пробер недоступен.

Этот параметр игнорируется в версии TMOS 12.x. С версии TMOS 13.x и выше, когда prober_preference установлен на pool, параметр prober_pool должен быть указан. Параметры взаимоисключающие, за исключением any-available или none.

Выбори:

  • "any"
  • "inside-datacenter"
  • "outside-datacenter"
  • "inherit"
  • "pool"
  • "none"

prober_pool

строка

Указывает имя пула проберов для мониторинга ресурсов сервера.

В версии TMOS 13.x и более поздних, этот параметр является обязательным, когда prober_preference установлен на pool. Имя может быть либо с префиксом раздела (/Common/foo), либо указано как имя объекта (foo).

В версии TMOS 12.x, prober_pool может быть пустой строкой, чтобы вернуться к значению по умолчанию inherit.

prober_preference

строка

Указывает тип пробера для мониторинга ресурсов сервера.

Этот параметр игнорируется в версии TMOS 12.x. С версии TMOS 13.x и выше, когда prober_preference установлен на pool, параметр prober_pool должен быть указан.

Выбори:

  • "inside-datacenter"
  • "outside-datacenter"
  • "inherit"
  • "pool"

provider

словарь

добавлен в f5networks.f5_modules 1.0.0

Объект словаря, содержащий данные соединения.

auth_provider

строка

Настраивает поставщик аутентификации для получения токенов аутентификации с удалённого устройства.

Этот параметр используется при работе с устройствами BIG-IQ.

no_f5_teem

boolean

Если yes, данные телеметрии TEEM не отправляются на F5.

Вы можете опустить этот параметр, установив переменную среды F5_TELEMETRY_OFF.

Ранее используемая переменная F5_TEEM устарела, так как её название вызывало путаницу.

Варианты:

  • false ← (по умолчанию)
  • true

password

aliases: 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 ← (по умолчанию)

server_type

aliases: product

string

Указывает тип сервера. Тип сервера определяет метрики, которые система может собирать с сервера. При создании нового сервера GTM используется значение по умолчанию bigip.

Варианты:

  • "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"

state

string

Состояние сервера. Если absent, модуль пытается удалить сервер. Это удастся только если этот сервер не используется виртуальным сервером. present создаёт сервер и включает его. Если enabled, включает сервер, если он существует. Если disabled, создаёт сервер при необходимости и устанавливает состояние в disabled.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"
  • "enabled"
  • "disabled"

virtual_server_discovery

string

Указывает, автоматически ли система обнаруживает виртуальные серверы для этого сервера. При создании нового сервера GTM, если этот параметр не указан, используется значение по умолчанию disabled.

Варианты:

  • "enabled"
  • "disabled"
  • "enabled-no-delete"

Примечания

Примечание

  • Дополнительную информацию о использовании 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

Новый лимит bits_enabled.

Возвращается: changed

Пример: 100

connections_enabled

boolean

Включен ли лимит соединений.

Возвращается: changed

Пример: true

connections_limit

integer

Новый лимит connections_limit.

Возвращается: changed

Пример: 100

datacenter

string

Новая datacenter, к которой принадлежит сервер.

Возвращается: changed

Пример: "datacenter01"

link_discovery

string

Новая link_discovery на удаленном устройстве.

Возвращается: changed

Пример: "enabled"

monitors

list / elements=string

Новый список мониторов для ресурса.

Возвращается: changed

Пример: ["/Common/monitor1", "/Common/monitor2"]

packets_enabled

boolean

Включен ли лимит пакетов.

Возвращается: changed

Пример: true

packets_limit

integer

Новый лимит packets_limit.

Возвращается: changed

Пример: 100

server_type

string

Новый тип сервера.

Возвращается: changed

Пример: "bigip"

virtual_server_discovery

string

Новое имя virtual_server_discovery для пункта назначения ловушки.

Возвращается: changed

Пример: "disabled"

Авторы

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

Spec-Zone.ru

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