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

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

Описание
Параметры
Примечания
Примеры
Значения возврата
Статус

Описание

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

Параметры

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

Примечания

Примечание

Этот модуль в основном используется в качестве компонента для настройки пар 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	changed	Новое значение auto_sync группы устройств. Пример: True
description строка	changed	Новое описание группы устройств. Пример: это группа устройств
full_sync boolean	changed	Новое значение full_sync группы устройств.
max_incremental_sync_size целое число	changed	Новый размер синхронизации группы устройств Пример: 1000
network_failover boolean	changed	Включена ли функция переключения сети. Пример: True
save_on_auto_sync boolean	changed	Новое значение save_on_auto_sync группы устройств. Пример: True
type строка	changed	Новый тип группы устройств. Пример: 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.8/modules/bigip_device_group_module.html