bigip_device_group – Управление группами устройств на BIG-IP
Новая в версии 2.5.
Обзор
- Управление группами устройств позволяет создавать пары HA и кластеры устройств BIG-IP. Данный модуль следует использовать совместно с
bigip_configsync_actionsдля синхронизации конфигурации между парой или кластером, если автоматическая синхронизация отключена.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auto_sync boolean |
| Указывает, происходит ли синхронизация конфигурации вручную или автоматически. При создании новой группы устройств этот параметр будет по умолчанию равен no. | |
| description - | Описание группы устройств. | ||
| full_sync boolean |
| Указывает, синхронизирует ли система всю конфигурацию во время операций синхронизации. Когда no, система выполняет операции инкрементальной синхронизации, основанные на размере кэша, указанном в max_incremental_sync_size.Инкрементальная синхронизация конфигурации — это механизм синхронизации конфигурации группы устройств между ее членами без необходимости полного загрузки конфигурации для каждого изменения конфигурации. Для работы этого механизма все устройства в группе устройств должны первоначально согласовать конфигурацию. Обычно для этого требуется хотя бы одна полная загрузка конфигурации на каждое устройство. При создании новой группы устройств этот параметр будет по умолчанию равен no. | |
| max_incremental_sync_size - | Указывает размер кэша изменений для инкрементальной синхронизации. Например, если вы используете значение по умолчанию и внесли больше 1024 КБ изменений, система выполнит полную операцию синхронизации. Использование операций инкрементальной синхронизации может сократить время синхронизации/загрузки конфигурации на устройство при внесении изменений в конфигурацию. Это значение актуально только тогда, когда full_sync равно no. | ||
| name - / обязательно | Указывает имя группы устройств. | ||
| network_failover boolean добавлено в 2.7 |
| Указывает, происходит ли переключение по сети или оно жестко задано. Этот параметр действителен только для type устройств, которые sync-failover. | |
| password - / обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, задав переменную среды F5_PASSWORD.псевдонимы: pass, pwd | ||
| provider - добавлено в 2.5 | Значение по умолчанию: null | Объект dict, содержащий данные подключения. | |
| password - / обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, задав переменную среды F5_PASSWORD.псевдонимы: pass, pwd | ||
| server - / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, задав переменную среды F5_SERVER. | ||
| server_port - | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, задав переменную среды F5_SERVER_PORT. | |
| ssh_keyfile - | Указывает файл ключа SSH для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Вы можете опустить этот параметр, задав переменную среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout - | Значение по умолчанию: 10 | Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль вернет ошибку. | |
| transport - / обязательно |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, задав переменную среды F5_USER. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, управляемых лично, которые используют самоподписанные сертификаты.Вы можете опустить этот параметр, задав переменную среды F5_VALIDATE_CERTS. | |
| save_on_auto_sync boolean |
| При выполнении автосинхронизации указывает, будет ли конфигурация сохранена или нет. Если no, будут изменены только текущие конфигурации на синхронизируемых устройствах.При создании новой группы устройств этот параметр будет по умолчанию равен no. | |
| 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 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.
- На хосте требуется пакет f5-sdk Python. Это так же просто, как
pip install f5-sdk. - Требуется версия программного обеспечения BIG-IP >= 12.
- Модули F5 обрабатывают только рабочую конфигурацию продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохраняется на диске, убедитесь, что включён хотя бы один task, использующий модуль bigip_config для сохранения рабочей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения рабочей конфигурации.
Примеры
- 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 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)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_device_group_module.html
