bigip_asm_policy_fetch – Экспорт политики asm с удаленных узлов

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
base64 boolean		Варианты: no yes	Если `yes`, возвращаемое `inline` содержимое политики ASM будет закодировано в Base64. Применимо только к `inline` экспорту политики ASM.
binary boolean		Варианты: no yes	Если `yes`, экспортируемая политика ASM будет в двоичном формате. Применимо только к `file` экспорту политики ASM.
compact boolean		Варианты: no yes	Если `yes`, будут экспортированы только пользовательские настройки политики ASM. Применимо только к экспорту политики ASM в формате XML.
dest path			Каталог для сохранения файла политики. Этот параметр игнорируется, когда `inline` установлено в c(yes).
file string			Имя файла, который будет создан на удаленном устройстве для загрузки. Когда `binary` установлено в `no`, политика ASM будет в формате XML.
force boolean		Варианты: no yes ←	Если `no`, файл будет передан только в том случае, если он не существует в указанном месте.
inline boolean		Варианты: no yes	Если `yes`, политика ASM будет экспортирована `inline` в виде строки вместо файла. Политика может быть получена в playbook `result` словаре по ключу `inline_policy`.
name string / обязательно			Имя экспортируемой политики для создания файла на удаленном устройстве для загрузки.
partition string		Значение по умолчанию: "Common"	Раздел устройства, содержащий политику ASM для экспорта.
provider dictionary добавлено в 2.5			Объект словаря, содержащий данные подключения.
	auth_provider string		Настраивает поставщик аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	password string / обязательно		Пароль учетной записи пользователя для подключения к BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server string / обязательно		Хост BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER`.
	server_port integer	Значение по умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER_PORT`.
	ssh_keyfile path		Указывает файл ключа SSH для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Этот параметр можно опустить, установив переменную среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout integer		Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.
	transport string	Варианты: cli rest ←	Настраивает транспортное соединение для подключения к удаленному устройству.
	user string / обязательно		Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды `F5_USER`.
	validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Используйте это только на контролируемых вами сайтах с самозаверенными сертификатами. Этот параметр можно опустить, установив переменную среды `F5_VALIDATE_CERTS`.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP >= 12.
Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохранится на диске, обязательно включите по крайней мере одну задачу, использующую модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Export policy in binary format
  bigip_asm_policy_fetch:
    name: foobar
    file: export_foo
    dest: /root/download
    binary: yes
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Export policy inline base64 encoded format
  bigip_asm_policy_fetch:
    name: foobar
    inline: yes
    base64: yes
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Export policy in XML format
  bigip_asm_policy_fetch:
    name: foobar
    file: export_foo
    dest: /root/download
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Export compact policy in XML format
  bigip_asm_policy_fetch:
    name: foobar
    file: export_foo.xml
    dest: /root/download/
    compact: yes
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Export policy in binary format, autogenerate name
  bigip_asm_policy_fetch:
    name: foobar
    dest: /root/download/
    binary: yes
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
base64 boolean	изменённое	Установлено для кодирования встроенного экспорта в формате base64.
binary boolean	изменённое	Установлено для экспорта политики ASM в двоичном формате. Пример: True
compact boolean	изменённое	Установлено только для экспорта пользовательских настроек политики ASM.
dest string	изменённое	Локальный путь для загрузки экспортированной политики ASM. Пример: /root/downloads/foobar.xml
file string	изменённое	Имя файла политики на удалённом BIG-IP для загрузки. Если не указано, то будет сгенерировано случайное имя файла. Пример: foobar.xml
inline boolean	изменённое	Устанавливается, когда политика ASM должна быть экспортирована встраиваемо. Пример: True
name string	изменённое	Имя политики ASM, которая должна быть экспортирована. Пример: Asm_APP1_Transparent

Статус

Данный модуль не гарантирует обратную совместимость. [превью]
Данный модуль поддерживается партнёром 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_asm_policy_fetch_module.html