f5networks.f5_modules.bigip_config – Управление секциями конфигурации BIG-IP

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).

Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_config.

Новое в версии 1.0.0: модуля f5networks.f5_modules

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
merge_content строка			Загружает указанную конфигурацию, которую нужно объединить с текущей конфигурацией. Это эквивалентно использованию команды `tmsh` `load sys config from-terminal merge`. Если вам нужно прочитать конфигурацию из файла или шаблона, используйте плагины Ansible `file` или `template` соответственно.
provider словарь добавлен в 1.0.0 f5networks.f5_modules			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	no_f5_teem логическое значение	Варианты: no yes	Если `yes`, данные телеметрии TEEM не отправляются на F5. Вы можете опустить этот параметр, установив переменную среды `F5_TEEM`.
	password строка / обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port целое число	Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	timeout целое число		Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль вернет ошибку.
	transport строка	Варианты: rest ←	Настраивает транспортное соединение для подключения к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs логическое значение	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах под своим контролем с самозаверяющими сертификатами. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
reset логическое значение		Варианты: no ← yes	Загружает стандартную конфигурацию на устройство. Если этот параметр указан, перед выполнением команд или другой предоставленной конфигурации загрузится стандартная конфигурация.
save логическое значение		Варианты: no yes ←	Аргумент `save` указывает модулю сохранить текущую конфигурацию в конфигурацию по умолчанию. Эта операция выполняется после внесения любых изменений в текущую конфигурацию. Если изменений не было, конфигурация все равно сохраняется в конфигурацию по умолчанию. Этот параметр всегда приведет к тому, что модуль вернет changed.
verify логическое значение		Варианты: no ← yes	Проверяет указанную конфигурацию на валидность, чтобы определить, можно ли заменить ею текущую конфигурацию. Текущая конфигурация не будет изменена. Когда этот параметр установлен в `yes`, модуль не сообщит о каком-либо изменении.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP ≥ 12.
Модули F5 работают только с текущей конфигурацией продукта F5. Чтобы убедиться, что специфичная для BIG-IP конфигурация сохранится на диске, обязательно включите хотя бы одну задачу, которая использует модуль f5networks.f5_modules.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, разделенное на список. Пример: [['...', '...'], ['...'], ['...']]

Авторы

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.10/collections/f5networks/f5_modules/bigip_config_module.html