Модуль f5networks.f5_modules.bigip_device_group — управление группами устройств на BIG-IP

Примечание

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

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

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

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

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

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

Краткое описание

Управление группами устройств позволяет создавать пары высокой доступности и кластеры устройств BIG-IP. Этот модуль следует использовать вместе с bigip_configsync_actions для синхронизации конфигурации между устройствами в паре или кластере, если автоматическая синхронизация отключена.

Параметры

Параметр	Комментарии
asm_sync boolean добавлено в f5networks.f5_modules 1.22.0	Определяет, нужно ли синхронизировать конфигурации ASM участников группы устройств. Устройство может входить только в одну группу устройств с включенным ASM. При создании группы устройств этот параметр по умолчанию имеет значение `false`. Варианты: `false` `true`
auto_sync boolean	Указывает, выполняется ли синхронизация конфигурации вручную или автоматически. При создании группы устройств этот параметр по умолчанию имеет значение `false`. Варианты: `false` `true`
description string	Описание группы устройств.
full_sync boolean	Определяет, синхронизирует ли система всю конфигурацию во время операций синхронизации. Если задано значение `no`, система выполняет операции инкрементальной синхронизации на основе размера кэша, указанного в `max_incremental_sync_size`. Инкрементальная синхронизация конфигурации позволяет синхронизировать конфигурацию группы устройств между ее участниками без полной загрузки конфигурации при каждом изменении. Для этого все устройства в группе должны изначально иметь согласованные конфигурации. Обычно для этого необходимо как минимум один раз полностью загрузить конфигурацию на каждое устройство. При создании группы устройств этот параметр по умолчанию имеет значение `false`. Варианты: `false` `true`
max_incremental_sync_size integer	Задает размер кэша изменений для инкрементальной синхронизации. Например, при использовании значения по умолчанию, если объем инкрементальных изменений превысит 1024 КБ, система выполнит полную синхронизацию. Инкрементальная синхронизация может сократить время синхронизации и загрузки изменений конфигурации на каждом устройстве. Этот параметр применяется только, если для `full_sync` задано значение `no`.
name string / обязательный	Задает имя группы устройств.
network_failover boolean	Указывает, выполняется ли переключение при отказе по сети или через аппаратное соединение. Этот параметр допустим только для `type`, которые являются `sync-failover`. Варианты: `false` `true`
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict с параметрами подключения.
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` ← (по умолчанию)
save_on_auto_sync boolean	При выполнении автоматической синхронизации определяет, сохраняется ли конфигурация. Если задано значение `false`, на синхронизируемых устройствах изменяется только текущая конфигурация. При создании группы устройств этот параметр по умолчанию имеет значение `false`. Варианты: `false` `true`
state string	Если для `state` задано значение `present`, модуль обеспечивает существование группы устройств. Если для `state` задано значение `absent`, модуль обеспечивает удаление группы устройств. Варианты: `"present"` ← (по умолчанию) `"absent"`
type string	Задает тип группы. Группа устройств типа `sync-failover` содержит устройства, которые синхронизируют данные конфигурации и переключаются друг на друга при недоступности одного из устройств. В группе устройств типа `sync-only` такое переключение не выполняется. При создании группы устройств этот параметр по умолчанию имеет значение `sync-only`. Изменить это значение после установки нельзя. Варианты: `"sync-failover"` `"sync-only"`

Примечания

Примечание

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

Примеры

- name: Create a sync-only device group
  bigip_device_group:
    name: foo-group
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a sync-only device group with auto-sync enabled
  bigip_device_group:
    name: foo-group
    auto_sync: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a sync-only device group with auto-sync and asm-sync enabled
  bigip_device_group:
    name: foo-group
    auto_sync: true
    asm_sync: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Возвращаемые значения

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

Ключ	Описание
asm_sync boolean	Новое значение asm_sync для группы устройств. Возвращается: changed Пример: `true`
auto_sync boolean	Новое значение auto_sync для группы устройств. Возвращается: changed Пример: `true`
description string	Новое описание группы устройств. Возвращается: changed Пример: `"this is a device group"`
full_sync boolean	Новое значение full_sync для группы устройств. Возвращается: changed Пример: `false`
max_incremental_sync_size integer	Новый размер синхронизации группы устройств. Возвращается: changed Пример: `1000`
network_failover boolean	Указывает, включено ли переключение при отказе по сети. Возвращается: changed Пример: `true`
save_on_auto_sync boolean	Новое значение save_on_auto_sync для группы устройств. Возвращается: changed Пример: `true`
type string	Новый тип группы устройств. Возвращается: changed Пример: `"sync-failover"`

Авторы

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_device_group_module.html