bigip_config – Управление разделами конфигурации BIG-IP
Новая версия с 2.4.
Описание
- Управляет конфигурацией BIG-IP, позволяя командам TMSH изменять текущую конфигурацию или объединять файлы формата SCF в текущую конфигурацию. Кроме того, данный модуль имеет важное значение, так как позволяет сохранять текущую конфигурацию на диск. Поскольку модуль F5 манипулирует только текущей конфигурацией, важно использовать этот модуль для сохранения этой текущей конфигурации.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| merge_content - | Загружает указанную конфигурацию для объединения с текущей конфигурацией. Это эквивалентно использованию команды tmsh load sys config from-terminal merge. Если требуется читать конфигурацию из файла или шаблона, используйте плагины поиска Ansible file или template соответственно. | ||
| 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. | |
| reset boolean |
| Загружает стандартную конфигурацию на устройстве. Если этот параметр указан, стандартная конфигурация будет загружена до выполнения любых команд или другой предоставленной конфигурации. | |
| save boolean |
| Аргумент save указывает модулю сохранить текущую конфигурацию в начальную конфигурацию.Эта операция выполняется после внесения любых изменений в текущую конфигурацию. Если изменений нет, конфигурация все равно сохраняется в начальную конфигурацию. Этот параметр всегда приведет к тому, что модуль вернет значение "изменено". | |
| server - / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port - добавлено в 2.2 | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs boolean добавлено в 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверенными сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| verify boolean |
| Проверяет указанную конфигурацию на валидность для замены текущей конфигурации. Текущая конфигурация не будет изменена. Когда этот параметр установлен в yes, модуль не сообщит об изменениях. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk. - Требуется версия ПО BIG-IP >= 12.
- Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы убедиться, что специфичная для BIG-IP конфигурация сохранится на диске, убедитесь, что включён хотя бы один таск, использующий модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- name: Save the running configuration of the BIG-IP
bigip_config:
save: yes
server: lb.mydomain.com
password: secret
user: admin
validate_certs: no
delegate_to: localhost
- name: Reset the BIG-IP configuration, for example, to RMA the device
bigip_config:
reset: yes
save: yes
server: lb.mydomain.com
password: secret
user: admin
validate_certs: no
delegate_to: localhost
- name: Load an SCF configuration
bigip_config:
merge_content: "{{ lookup('file', '/path/to/config.scf') }}"
server: lb.mydomain.com
password: secret
user: admin
validate_certs: no
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.7/modules/bigip_config_module.html
