bigip_device_group — Управление группами устройств BIG-IP
Новое в версии 2.5.
Обзор
- Управление группами устройств позволяет создавать пары HA и кластеры устройств BIG-IP. Использование данного модуля должно осуществляться совместно с
bigip_configsync_actions, чтобы синхронизировать конфигурацию по всей паре или кластеру, если автоматическая синхронизация отключена.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auto_sync bool |
| Указывает, происходит ли синхронизация конфигурации вручную или автоматически. При создании новой группы устройств этот параметр будет по умолчанию false. | |
| description | Описание группы устройств. | ||
| full_sync bool |
| Определяет, синхронизирует ли система всю конфигурацию во время операций синхронизации. Когда 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) | Объект dict, содержащий данные подключения. | ||
| password обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_PASSWORD установлена.Псевдонимы: pass, pwd | ||
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER установлена. | ||
| server_port | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER_PORT установлена. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, если переменная окружения F5_USER установлена. | ||
| validate_certs bool |
| Если no, сертификаты SSL не будут проверяться. Используйте это только на контролируемых вами сайтах, использующих самоподписанные сертификаты. Вы можете опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена. | |
| timeout | По умолчанию: 10 | Устанавливает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль вернёт ошибку. | |
| ssh_keyfile | Указывает SSH-ключевой файл для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, будет использоваться значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно |
| Настраивает транспортное подключение для подключения к удалённому устройству. | |
| save_on_auto_sync bool |
| При выполнении автоматической синхронизации указывает, будет ли сохранена конфигурация. Если false, только текущая конфигурация будет изменена на устройстве(ах), к которому(ым) выполняется синхронизация. При создании новой группы устройств этот параметр будет по умолчанию false. | |
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER установлена. | ||
| server_port (добавлено в 2.2) | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER_PORT установлена. | |
| state |
| Если state равно present, гарантирует существование группы устройств.Если state равно absent, гарантирует удаление группы устройств. | |
| type |
| Определяет тип группы. Группа устройств типа sync-failover содержит устройства, синхронизирующие данные конфигурации и выполняющие переход на другое устройство при недоступности одного из устройств. В группе устройств типа sync-only перехода нет. При создании новой группы устройств этот параметр будет по умолчанию sync-only. Это значение нельзя изменить после его установки. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, если переменная окружения F5_USER установлена. | ||
| validate_certs bool (добавлено в 2.0) |
| Если no, сертификаты SSL не будут проверяться. Используйте это только на контролируемых вами сайтах, использующих самоподписанные сертификаты. Вы можете опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена. | |
Примечания
Примечание
- Этот модуль в основном используется как компонент для настройки пар BIG-IP устройств в HA.
- Требуется BIG-IP >= 12.1.x.
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
- Требуется пакет Python f5-sdk на хосте. Это так же просто, как
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 |
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют отсутствие несовместимых изменений интерфейса.
Обслуживание
Этот модуль помечен как community, что означает, что его поддерживает сообщество Ansible. Для получения дополнительной информации см. Обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/bigip_device_group_module.html
