bigip_device_group – Управление группами устройств BIG-IP

Новое в версии 2.5.

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auto_sync boolean		Варианты: no yes	Указывает, происходит ли синхронизация конфигурации вручную или автоматически. При создании новой группы устройств этот параметр по умолчанию равен `no`.
description string			Описание группы устройств.
full_sync boolean		Варианты: no yes	Указывает, синхронизирует ли система всю конфигурацию во время операций синхронизации. Когда `no`, система выполняет операции инкрементальной синхронизации, основанные на размере кэша, указанном в `max_incremental_sync_size`. Инкрементальная синхронизация конфигурации — это механизм синхронизации конфигурации группы устройств между ее членами без необходимости полного загрузки конфигурации для каждого изменения. Для этого все устройства в группе устройств должны изначально согласовать конфигурацию. Как правило, это требует как минимум одной полной загрузки конфигурации на каждое устройство. При создании новой группы устройств этот параметр по умолчанию равен `no`.
max_incremental_sync_size integer			Указывает размер кэша изменений для инкрементальной синхронизации. Например, используя значение по умолчанию, если вы внесете больше 1024 КБ инкрементальных изменений, система выполнит полную операцию синхронизации. Использование операций инкрементальной синхронизации может сократить время синхронизации/загрузки конфигурации на каждое устройство при внесении изменений. Это значение актуально только тогда, когда `full_sync` равно `no`.
name string / обязательно			Указывает имя группы устройств.
network_failover boolean добавлено в 2.7		Варианты: no yes	Указывает, происходит ли отказ по сети или жестко закодирован. Этот параметр действителен только для `type` устройств, которые `sync-failover`.
provider dictionary добавлено в 2.5			Объект словаря, содержащий данные подключения.
	auth_provider string		Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	password string / обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server string / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port integer	По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	ssh_keyfile путь		Указывает файл ключа SSH, который необходимо использовать для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Вы можете опустить этот параметр, установив переменную среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout integer		Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истечет до завершения операции, модуль вернет ошибку.
	transport string	Варианты: cli rest ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.
	user string / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самоподписанными сертификатами. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
save_on_auto_sync boolean		Варианты: no yes	При выполнении автоматической синхронизации указывает, будет ли сохранена конфигурация. Если `no`, на синхронизируемых устройствах будут изменены только текущие настройки. При создании новой группы устройств этот параметр по умолчанию равен `no`.
state string		Варианты: present ← absent	Если `state` равно `present`, гарантирует существование группы устройств. Если `state` равно `absent`, гарантирует удаление группы устройств.
type string		Варианты: sync-failover sync-only	Указывает тип группы. Группа устройств типа `sync-failover` содержит устройства, которые синхронизируют свои данные конфигурации и переключаются друг на друга, когда устройство становится недоступным. Группа устройств типа `sync-only` не имеет такого переключения. При создании новой группы устройств этот параметр по умолчанию равен `sync-only`. Это значение нельзя изменить после установки.

Примечания

Примечание

Этот модуль в основном используется как компонент для настройки пар HA устройств BIG-IP.
Требуется BIG-IP >= 12.1.x.
Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что специфичная для BIG-IP конфигурация сохраняется на диске, обязательно включите хотя бы одну задачу, которая использует модуль 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: yes
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Возвращённое значение	Описание
auto_sync boolean	изменённое	Новое значение auto_sync для группы устройств. Пример: True
description string	изменённое	Новое описание группы устройств. Пример: это группа устройств
full_sync boolean	изменённое	Новое значение full_sync для группы устройств.
max_incremental_sync_size integer	изменённое	Новый размер синхронизации группы устройств Пример: 1000
network_failover boolean	изменённое	Включён ли failover сети. Пример: True
save_on_auto_sync boolean	изменённое	Новое значение save_on_auto_sync для группы устройств. Пример: True
type string	изменённое	Новый тип группы устройств. Пример: sync-failover

Статус

Данный модуль гарантирует обратную совместимость изменений интерфейса в дальнейшем. [stableinterface]
Этот модуль поддерживается партнёром Ansible. [certified]

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/bigip_device_group_module.html