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

Примечание

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

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

Чтобы использовать его в playbook, укажите: f5networks.f5_modules.bigip_apm_policy_fetch.

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

Описание
Параметры
Примечания
Примеры
Значения возврата

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
dest path			Директория для сохранения файла.
file string			Имя файла, который будет создан на удаленном устройстве для загрузки.
force boolean		Варианты: no yes ←	Если `no`, файл будет передан только в том случае, если он не существует в указанном каталоге назначения.
name string / обязательно			Имя экспортируемой политики APM или профиля доступа APM для создания файла на удаленном устройстве для загрузки.
partition string		По умолчанию: "Common"	Раздел устройства, содержащий политику APM или профиль доступа APM для экспорта.
provider dictionary добавлено в 1.0.0 модуля f5networks.f5_modules			Объект dict, содержащий данные подключения.
	auth_provider string		Настраивает поставщик аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	no_f5_teem boolean	Варианты: no yes	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную окружения `F5_TEEM`.
	password string / обязательно		Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
	server string / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.
	server_port integer	По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`.
	timeout integer		Устанавливает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.
	transport string	Варианты: rest ←	Настраивает транспортное подключение для использования при подключении к удаленному устройству.
	user string / обязательно		Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
	validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.
type string		Варианты: profile_access ← access_policy	Указывает тип элемента для экспорта с устройства.

Примечания

Примечание

Из-за 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 сохранится на диске, убедитесь, что включен хотя бы один task, использующий модуль 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 string	changed	Локальный путь для загрузки экспортированной политики APM. Пример: /root/downloads/profile-foobar_file.conf.tar.gz
file string	changed	Имя экспортированного файла на удаленном BIG-IP для загрузки. Если не указано, то это будет случайное имя файла. Пример: foobar_file
name string	changed	Имя политики APM или профиля доступа APM, подлежащего экспорту. Пример: APM_policy_global
type string	changed	Установлено для указания типа экспортируемого элемента. Пример: access_policy

Авторы

Wojciech Wypior (@wojtek0806)

© 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_apm_policy_fetch_module.html