f5networks.f5_modules.bigip_apm_policy_fetch – Экспортирует политику APM или профиль доступа APM с удалённых узлов.

Примечание

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

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

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

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

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

Обзор

Экспортирует политику APM или профиль доступа APM с удалённых узлов.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
dest путь			Директория для сохранения файла.
file строка			Имя файла, создаваемого на удалённом устройстве для загрузки.
force булево		Варианты: нет да ←	Если `no`, файл будет передан только в случае, если он не существует в указанном месте назначения.
name строка / обязательный			Имя экспортируемой политики APM или профиля доступа APM для создания файла на удалённом устройстве для загрузки.
partition строка		Значение по умолчанию: "Общие"	Раздел устройства, содержащий политику APM или профиль доступа APM для экспорта.
provider словарь добавлен в версии 1.0.0 f5networks.f5_modules			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	no_f5_teem булево	Варианты: нет да	Если `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`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверенными сертификатами. Этот параметр можно опустить, установив переменную среды `F5_VALIDATE_CERTS`.
type строка		Варианты: профиль_доступа ← политика_доступа	Указывает тип элемента для экспорта с устройства.

Примечания

Примечание

Из-за ID685681 невозможно выполнить инструменты ng_* через REST API в версиях v12.x и 13.x. После исправления это ограничение будет удалено.
Требуется BIG-IP >= 14.0.0
Дополнительную информацию о использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP >= 12.
Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы гарантировать сохранение специфичной для BIG-IP конфигурации в файловой системе, необходимо включить хотя бы одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения вашей текущей конфигурации.

Примеры

- name: Export APM access profile
  bigip_apm_policy_fetch:
    name: foobar
    file: export_foo
    dest: /root/download
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Export APM access policy
  bigip_apm_policy_fetch:
    name: foobar
    file: export_foo
    dest: /root/download
    type: access_policy
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Export APM access profile, autogenerate name
  bigip_apm_policy_fetch:
    name: foobar
    dest: /root/download
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
dest строка	изменено	Локальный путь для загрузки экспортированной политики APM. Пример: /root/downloads/profile-foobar_file.conf.tar.gz
file строка	изменено	Имя экспортированного файла на удалённом BIG-IP для загрузки. Если не указано, это будет случайное имя файла. Пример: foobar_file
name строка	изменено	Имя политики APM или профиля доступа APM, подлежащего экспорту. Пример: APM_policy_global
type строка	изменено	Установлено для указания типа экспортируемого элемента. Пример: политика_доступа

Авторы

Wojciech Wypior (@wojtek0806)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_apm_policy_fetch_module.html