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)			Объект типа dict, содержащий данные подключения.
	password обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная среды `F5_PASSWORD` установлена. псевдонимы: pass, pwd
	server обязательно		Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды `F5_SERVER` установлена.
	server_port	Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды `F5_SERVER_PORT` установлена.
	user обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная среды `F5_USER` установлена.
	validate_certs bool	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Используйте только на сайтах с собственными сертификатами. Вы можете опустить этот параметр, если переменная среды `F5_VALIDATE_CERTS` установлена.
	timeout	Значение по умолчанию: 10	Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль вернёт ошибку.
	ssh_keyfile		Указывает SSH-ключевой файл для аутентификации соединения с удаленным устройством. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	transport обязательно	Варианты: rest cli ←	Настраивает транспортное соединение для подключения к удалённому устройству.
reset bool		Варианты: no ← yes	Загружает стандартную конфигурацию устройства. Если этот параметр указан, стандартная конфигурация будет загружена перед выполнением каких-либо команд или другой заданной конфигурации.
save bool		Варианты: no yes ←	Аргумент `save` указывает модулю сохранить текущую конфигурацию в конфигурацию по умолчанию. Эта операция выполняется после внесения любых изменений в текущую конфигурацию. Если изменений нет, конфигурация всё равно сохраняется в конфигурацию по умолчанию. Этот параметр всегда заставит модуль вернуть изменённое значение.
server обязательно			Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды `F5_SERVER` установлена.
server_port (добавлен в 2.2)		Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды `F5_SERVER_PORT` установлена.
user обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная среды `F5_USER` установлена.
validate_certs bool (добавлен в 2.0)		Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Используйте только на сайтах с собственными сертификатами. Вы можете опустить этот параметр, если переменная среды `F5_VALIDATE_CERTS` установлена.
verify bool		Варианты: no ← yes	Проверяет указанную конфигурацию на соответствие для замены текущей конфигурации. Текущая конфигурация не будет изменена. Когда этот параметр установлен в `yes`, модуль не сообщит об изменении.

Примечания

Примечание

Дополнительную информацию об использовании 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, разделенное на список Пример: [['...', '...'], ['...'], ['...']]

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Более подробная информация о поддержке модулей приведена здесь.

Список других модулей, также поддерживаемых сообществом 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.6/modules/bigip_config_module.html