f5networks.f5_modules.bigip_asm_policy_fetch — Экспорт политики ASM с удаленных узлов.

Примечание

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

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

Для использования в книге задач укажите: f5networks.f5_modules.bigip_asm_policy_fetch.

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
base64 логический тип		Варианты: no yes	Если `yes`, возвращаемое `inline` содержимое политики ASM будет закодировано в Base64. Применимо только к экспорту политики ASM в `inline` формате.
binary логический тип		Варианты: no yes	Если `yes`, экспортируемая политика ASM будет в двоичном формате. Применимо только к экспорту политики ASM в `file` формате.
compact логический тип		Варианты: no yes	Если `yes`, будут экспортированы только настраиваемые параметры политики ASM. Применимо только к экспорту политики ASM в формате XML.
dest путь			Директория для сохранения файла политики. Этот параметр игнорируется, когда `inline` задан как c(yes).
file строка			Имя файла, который будет создан на удалённом устройстве для загрузки. Когда `binary` установлен в `no`, политика ASM будет в формате XML.
force логический тип		Варианты: no yes ←	Если `no`, файл будет перенесён только если он не существует в указанном каталоге.
inline логический тип		Варианты: no yes	Если `yes`, политика ASM будет экспортирована `inline` в виде строки вместо файла. Политика может быть получена в книге задач `result` в словаре под ключом `inline_policy`.
name строка / обязательно			Имя экспортируемой политики для создания файла на удалённом устройстве для загрузки.
partition строка		Значение по умолчанию: "Common"	Раздел устройства, содержащий политику ASM для экспорта.
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`.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы гарантировать сохранение специфической для BIG-IP конфигурации в диске, убедитесь, что включён хотя бы один этап, использующий модуль f5networks.f5_modules.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 логический тип	changed	Установлено для кодирования инлайнового экспорта в формате Base64.
binary логический тип	changed	Установлено для экспорта политики ASM в двоичном формате. Пример: True
compact логический тип	changed	Установлено для экспорта только настраиваемых параметров политики ASM.
dest строка	changed	Локальный путь для загрузки экспортированной политики ASM. Пример: /root/downloads/foobar.xml
file строка	changed	Имя файла политики на удалённом BIG-IP для загрузки. Если не указано, то будет сгенерировано случайное имя. Пример: foobar.xml
inline логический тип	changed	Установлено, когда экспортируемая политика ASM инлайновая. Пример: True
name строка	changed	Имя экспортируемой политики ASM. Пример: Asm_APP1_Transparent

Авторы

Wojciech Wypior (@wojtek0806)
Nitin Khanna (@nitinthewiz)

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