f5networks.f5_modules.bigip_config – Управление разделами конфигурации BIG-IP
Примечание
Этот плагин является частью коллекции f5networks.f5_modules (версия 1.7.1).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Для использования в плейбуке укажите: f5networks.f5_modules.bigip_config.
Новое в версии 1.0.0: из f5networks.f5_modules
Обзор
- Управляет конфигурацией BIG-IP, позволяя использовать команды TMSH для изменения рабочей конфигурации или слияния файлов в формате SCF в рабочую конфигурацию. Кроме того, этот модуль имеет важное значение, поскольку он позволяет сохранять рабочую конфигурацию на диск. Поскольку все модули F5 манипулируют рабочей конфигурацией, важно использовать этот модуль для сохранения этой рабочей конфигурации.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| merge_content строка | Загружает указанную конфигурацию для слияния с рабочей конфигурацией. Это эквивалентно использованию команды tmsh load sys config from-terminal merge. Если необходимо читать конфигурацию из файла или шаблона, используйте плагины Ansible file или template соответственно. | ||
| provider словарь добавлен в 1.0.0 f5networks.f5_modules | Объект словаря, содержащий сведения о соединении. | ||
| auth_provider строка | Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ. | ||
| no_f5_teem логическое значение |
| Если yes, данные телеметрии TEEM не отправляются на F5.Вы можете опустить этот параметр, установив переменную среды F5_TEEM. | |
| password строка / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port целое число | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| timeout целое число | Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное соединение, которое будет использоваться при подключении к удаленному устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь права администратора на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs логическое значение |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, которыми вы управляете, и на сайтах с самозаверенными сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| reset логическое значение |
| Загружает конфигурацию по умолчанию на устройстве. Если этот параметр указан, перед выполнением любых команд или другой предоставленной конфигурации будет загружена конфигурация по умолчанию. | |
| save логическое значение |
| Параметр save указывает модулю сохранить рабочую конфигурацию в конфигурацию по умолчанию.Эта операция выполняется после внесения любых изменений в текущую рабочую конфигурацию. Если изменений не произошло, конфигурация все равно сохраняется в конфигурацию по умолчанию. Этот параметр всегда заставит модуль вернуть changed. | |
| verify логическое значение |
| Проверяет указанную конфигурацию, чтобы определить, является ли она допустимой для замены рабочей конфигурации. Рабочая конфигурация не будет изменена. Когда этот параметр установлен в значение yes, модуль не сообщит об изменении. | |
Примечания
Примечание
- Для этого модуля необходимо, чтобы переменная sys db на устройстве
systemauth.disablebashбыла установлена вfalse. - Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP >= 12.
- Модули F5 только манипулируют рабочей конфигурацией продукта F5. Чтобы гарантировать, что специфичная для BIG-IP конфигурация сохранится на диске, обязательно включите по крайней мере одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения рабочей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения вашей рабочей конфигурации.
Примеры
- name: Save the running configuration of the BIG-IP
bigip_config:
save: yes
provider:
server: lb.mydomain.com
password: secret
user: admin
delegate_to: localhost
- name: Reset the BIG-IP configuration, for example, to RMA the device
bigip_config:
reset: yes
save: yes
provider:
server: lb.mydomain.com
password: secret
user: admin
delegate_to: localhost
- name: Load an SCF configuration
bigip_config:
merge_content: "{{ lookup('file', '/path/to/config.scf') }}"
provider:
server: lb.mydomain.com
password: secret
user: admin
delegate_to: localhost
Значения возврата
Общие значения возврата описаны в этой секции, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| stdout список / элементы=строка | всегда | Набор ответов от параметров. Пример: ['...', '...'] |
| stdout_lines список / элементы=строка | всегда | Значение stdout разделено на список. Пример: [['...', '...'], ['...'], ['...']] |
Авторы
- Tim Rupp (@caphrim007)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_config_module.html