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

Новое в версии 2.8.

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
dest путь			Директория для сохранения файла.
file строка			Имя файла, который будет создан на удаленном устройстве для загрузки.
force булево		Варианты: нет да ←	Если `no`, файл будет перенесен только в том случае, если он не существует в указанном месте.
name строка / обязательно			Имя экспортируемой политики APM или профиля доступа APM, для создания файла на удаленном устройстве для загрузки.
partition строка		По умолчанию: "Общие"	Раздел устройства, содержащий политику APM или профиль доступа APM для экспорта.
provider словарь добавлен в 2.5			Объект словаря, содержащий данные соединения.
	auth_provider строка		Настраивает поставщика авторизации для получения токенов авторизации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	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 целое число		Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: cli rest ←	Настройка используемого транспортного соединения при подключении к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs булево	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
type строка		Варианты: 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 сохранится на диске, необходимо включить по крайней мере одну задачу, использующую модуль 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 строка	changed	Локальный путь для загрузки экспортированной политики APM. Пример: /root/downloads/profile-foobar_file.conf.tar.gz
file строка	changed	Имя экспортированного файла на удаленном BIG-IP для загрузки. Если не указано, будет сгенерировано случайное имя файла. Пример: foobar_file
name строка	changed	Имя политики APM или профиля доступа APM для экспорта. Пример: APM_policy_global
type строка	changed	Установлено для указания типа экспортируемого элемента. Пример: access_policy

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается партнером Ansible. [сертифицировано]

Авторы

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.9/modules/bigip_apm_policy_fetch_module.html