bigip_config - Управление разделами конфигурации BIG-IP
Новое в версии 2.4.
Обзор
- Управляет конфигурацией BIG-IP, позволяя использовать команды TMSH для изменения рабочей конфигурации или слияния файлов в формате SCF в рабочую конфигурацию. Кроме того, этот модуль имеет важное значение, поскольку он позволяет сохранять рабочую конфигурацию на диск. Поскольку модуль F5 манипулирует только рабочей конфигурацией, важно использовать этот модуль для сохранения этой рабочей конфигурации.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| merge_content | Загружает указанную конфигурацию для слияния с рабочей конфигурацией. Это эквивалентно использованию команды tmsh load sys config from-terminal merge. Если необходимо читать конфигурацию из файла или шаблона, используйте Ansible file или template плагины поиска соответственно. | ||
| password обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, если переменная окружения F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| provider (добавлен в 2.5) | По умолчанию: None | Объект типа dict, содержащий данные подключения. | |
| ssh_keyfile | Указывает файл SSH-ключа, используемый для аутентификации подключения к удаленному устройству. Этот параметр используется только для транспортов cli. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout | По умолчанию: 10 | Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку. | |
| server обязательно | Хост BIG-IP. Этот параметр можно опустить, если переменная окружения F5_SERVER установлена. | ||
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, если переменная окружения F5_USER установлена. | ||
| server_port | По умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, если переменная окружения F5_SERVER_PORT установлена. | |
| password обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, если переменная окружения F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| validate_certs |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами, с самозаверяющимися сертификатами. Этот параметр можно опустить, если переменная окружения F5_VALIDATE_CERTS установлена. | |
| transport обязательно |
| Настраивает транспортное подключение для подключения к удаленному устройству. | |
| reset |
| Загружает стандартную конфигурацию на устройстве. Если этот параметр указан, стандартная конфигурация загрузится перед выполнением любых команд или другой предоставленной конфигурации. | |
| save |
| Параметр save сообщает модулю о сохранении текущей конфигурации в конфигурацию по умолчанию. Эта операция выполняется после внесения любых изменений в текущую рабочую конфигурацию. Если изменений не внесено, конфигурация все равно сохраняется в конфигурацию по умолчанию. Этот параметр всегда заставит модуль сообщить о внесенных изменениях. | |
| server обязательно | Хост BIG-IP. Этот параметр можно опустить, если переменная окружения F5_SERVER установлена. | ||
| server_port (добавлен в 2.2) | По умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, если переменная окружения F5_SERVER_PORT установлена. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, если переменная окружения F5_USER установлена. | ||
| validate_certs (добавлен в 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами, с самозаверяющимися сертификатами. Этот параметр можно опустить, если переменная окружения F5_VALIDATE_CERTS установлена. | |
| verify |
| Проверяет указанную конфигурацию на валидность для замены текущей рабочей конфигурации. Текущая рабочая конфигурация не будет изменена. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это очень просто:
pip install f5-sdk.
Примеры
- 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, разбитое на список Пример: [['...', '...'], ['...'], ['...']] |
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантируется обратной совместимости.
Автор
- 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.5/modules/bigip_config_module.html
