bigip_config – Управление разделами конфигурации BIG-IP
Новая в версии 2.4.
Описание
- Управляет конфигурацией BIG-IP, позволяя командам TMSH изменять текущую конфигурацию или объединять файлы в формате SCF с текущей конфигурацией. Кроме того, этот модуль имеет важное значение, так как он позволяет сохранять текущую конфигурацию на диск. Поскольку модуль F5 манипулирует только текущей конфигурацией, важно использовать этот модуль для сохранения этой текущей конфигурации.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| merge_content строка | Загружает указанную конфигурацию для объединения с текущей конфигурацией. Это эквивалентно использованию команды tmsh load sys config from-terminal merge. Если вам нужно читать конфигурацию из файла или шаблона, используйте плагины поиска file или template Ansible соответственно. | ||
| provider словарь добавлен в 2.5 | Объект словаря, содержащий детали подключения. | ||
| auth_provider строка | Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ. | ||
| 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 целое число | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| user строка / требуется | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды F5_USER. | ||
| validate_certs булево |
| Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах, использующих самозаверяющие сертификаты.Этот параметр можно опустить, установив переменную среды F5_VALIDATE_CERTS. | |
| reset булево |
| Загружает конфигурацию по умолчанию на устройстве. Если этот параметр указан, конфигурация по умолчанию загрузится перед выполнением каких-либо команд или другой предоставленной конфигурации. | |
| save булево |
| Аргумент save указывает модулю сохранить текущую конфигурацию в стартовую конфигурацию.Эта операция выполняется после внесения любых изменений в текущую конфигурацию. Если изменений не было, конфигурация всё равно сохраняется в стартовую. Этот параметр всегда заставит модуль сообщить о изменениях. | |
| verify булево |
| Проверяет указанную конфигурацию на соответствие текущей конфигурации. Текущая конфигурация не будет изменена. Когда этот параметр установлен на yes, модуль не сообщит об изменениях. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP >= 12.
- Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохранится на диске, обязательно включите хотя бы одну задачу, которая использует модуль 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 разделено на список Пример: [['...', '...'], ['...'], ['...']] |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается партнером 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.9/modules/bigip_config_module.html