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

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

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

Обзор

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

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

f5-sdk >= 3.0.9

Параметры

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

Примечания

Примечание

Этот модуль в основном используется как компонент для настройки пар BIG-IP устройств с высокой доступностью.
Требуется BIG-IP >= 12.1.x.
Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется пакет f5-sdk Python на хосте. Это так же просто, как pip install f5-sdk.

Примеры

- name: Create a sync-only device group
  bigip_device_group:
    name: foo-group
    password: secret
    server: lb.mydomain.com
    state: present
    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
    password: secret
    server: lb.mydomain.com
    state: present
    user: admin
  delegate_to: localhost

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

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

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

Статус

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

Автор

Tim Rupp (@caphrim007)

Подсказка

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

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