bigip_config – Управление разделами конфигурации BIG-IP

Новая в версии 2.4.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Управляет конфигурацией BIG-IP, позволяя использовать команды TMSH для изменения текущей конфигурации или слияния файлов в формате SCF с текущей конфигурацией. Кроме того, этот модуль имеет важное значение, поскольку позволяет сохранить текущую конфигурацию на диск. Поскольку модуль F5 манипулирует только текущей конфигурацией, важно использовать этот модуль для сохранения этой текущей конфигурации.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
merge_content -			Загружает указанную конфигурацию для слияния с текущей конфигурацией. Это эквивалентно использованию команды `tmsh` `load sys config from-terminal merge`. Если вам необходимо считать конфигурацию из файла или шаблона, используйте плагины Ansible `file` или `template` соответственно.
password строка / обязательно			Пароль учетной записи пользователя для подключения к BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_PASSWORD`. Псевдонимы: pass, pwd
provider словарь добавлен в 2.5			Объект словаря, содержащий сведения о подключении.
	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 строка	Варианты: cli rest ←	Настраивает транспортное подключение для подключения к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Этот параметр можно опустить, установив переменную среды `F5_USER`.
	validate_certs логическое значение	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте это только на сайтах, находящихся под вашим контролем, с использованием самозаверяющих сертификатов. Этот параметр можно опустить, установив переменную среды `F5_VALIDATE_CERTS`.
reset логическое значение		Варианты: no ← yes	Загружает конфигурацию по умолчанию на устройстве. Если этот параметр указан, конфигурация по умолчанию будет загружена перед выполнением любых команд или другой предоставленной конфигурации.
save логическое значение		Варианты: no yes ←	Аргумент `save` сообщает модулю сохранить текущую конфигурацию в конфигурацию по умолчанию. Эта операция выполняется после внесения любых изменений в текущую конфигурацию. Если изменений не было, конфигурация по-прежнему сохраняется в конфигурации по умолчанию. Этот параметр всегда заставит модуль вернуть значение changed.
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 yes ←	Если `no`, сертификаты SSL не проверяются. Используйте это только на сайтах, находящихся под вашим контролем, с использованием самозаверяющих сертификатов. Этот параметр можно опустить, установив переменную среды `F5_VALIDATE_CERTS`.
verify логическое значение		Варианты: no ← yes	Проверяет указанную конфигурацию на соответствие действительности для замены текущей конфигурации. Текущая конфигурация не будет изменена. Когда этот параметр установлен в `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, разбитое на список Пример: [['...', '...'], ['...'], ['...']]

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [preview]
Данный модуль поддерживается партнёром Ansible. [certified]

Авторы

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.8/modules/bigip_config_module.html