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

Примечание

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

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

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

Управление группами устройств позволяет создавать пары HA и кластеры устройств 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`
...	...

Авторы

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