Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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

dictionary

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

at_least

integer

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

Этот параметр имеет значение, только если используется type типа at_least.

Этот параметр игнорируется, если используется тип all или require.

number_of_probers

integer

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

При создании нового виртуального сервера, если указан этот параметр, также необходимо указать параметр number_of_probes.

Значение этого параметра всегда должно быть больше или равно значению number_of_probers.

Этот параметр имеет значение, только если используется type типа require.

Этот параметр игнорируется, если используется тип all или at_least.

number_of_probes

integer

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

При создании нового виртуального сервера, если указан этот параметр, также необходимо указать параметр number_of_probers.

Значение этого параметра всегда должно быть меньше или равно значению number_of_probers.

Этот параметр имеет значение, только если используется type типа require.

Этот параметр игнорируется, если используется тип all или at_least.

type

string / обязательный

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

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

Варианты:

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

datacenter

string

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

devices

any

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

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

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

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

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

iquery_options

dictionary

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

allow_path

boolean

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

Варианты:

  • false
  • true

allow_service_check

boolean

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

Варианты:

  • false
  • true

allow_snmp

boolean

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

Варианты:

  • false
  • true

limits

dictionary

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

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

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

bits_enabled

boolean

Указывает, включено ли ограничение битовой скорости.

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

Варианты:

  • false
  • true

bits_limit

integer

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

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

connections_enabled

boolean

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

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

Варианты:

  • false
  • true

connections_limit

integer

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

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

cpu_enabled

boolean

Указывает, включено ли ограничение на использование ЦП.

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

Варианты:

  • false
  • true

cpu_limit

integer

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

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

memory_enabled

boolean

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

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

Варианты:

  • false
  • true

memory_limit

integer

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

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

packets_enabled

boolean

Указывает, включено ли ограничение на количество пакетов.

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

Варианты:

  • false
  • true

packets_limit

integer

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

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

link_discovery

string

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

Если для этого параметра задано значение enabled или enabled-no-delete, необходимо также убедиться, что для параметра virtual_server_discovery задано значение enabled или enabled-no-delete.

Варианты:

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

monitors

list / elements=string

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

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

name

string / обязательный

Имя сервера.

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

partition

string

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

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

prober_fallback

string

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

Этот параметр игнорируется в версии TMOS 12.x.

Начиная с версии TMOS 13.x, если для prober_preference задано значение pool, необходимо указать параметр prober_pool.

Значения этого параметра взаимоисключающие со значениями параметра prober_preference, за исключением вариантов any-available и none.

Варианты:

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

prober_pool

string

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

В версии TMOS 13.x и более поздних этот параметр обязателен, если для prober_preference задано значение pool.

Имя можно указать с префиксом раздела (/Common/foo) или только как имя объекта (foo).

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

prober_preference

string

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

Этот параметр игнорируется в версии TMOS 12.x.

Начиная с версии TMOS 13.x, если для prober_preference задано значение pool, необходимо указать параметр prober_pool.

Варианты:

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

provider

dictionary

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

Словарь с параметрами подключения.

auth_provider

string

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

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

no_f5_teem

boolean

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

Этот параметр можно не указывать, задав переменную среды F5_TELEMETRY_OFF.

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

Варианты:

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

password

псевдонимы: 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

псевдоним: 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

Включено ли ограничение битовой скорости.

Возвращается: при изменении

Пример: true

bits_limit

integer

Новое значение ограничения bits_enabled.

Возвращается: при изменении

Пример: 100

connections_enabled

boolean

Включено ли ограничение количества подключений.

Возвращается: при изменении

Пример: true

connections_limit

integer

Новое значение ограничения connections_limit.

Возвращается: при изменении

Пример: 100

datacenter

string

Новый datacenter, к которому относится сервер.

Возвращается: при изменении

Пример: "datacenter01"

link_discovery

string

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

Возвращается: при изменении

Пример: "enabled"

monitors

list / элементы=string

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

Возвращается: при изменении

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

packets_enabled

boolean

Включено ли ограничение количества пакетов.

Возвращается: при изменении

Пример: true

packets_limit

integer

Новое значение ограничения packets_limit.

Возвращается: при изменении

Пример: 100

server_type

string

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

Возвращается: при изменении

Пример: "bigip"

virtual_server_discovery

string

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

Возвращается: при изменении

Пример: "disabled"

Авторы

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

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

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