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 путь			Директория для сохранения файла политики. Этот параметр игнорируется, когда `inline` установлен в c(yes).
file строка			Имя файла, который будет создан на удалённом устройстве для загрузки. Когда `binary` установлен на `no`, политика ASM будет в формате XML.
force boolean		Варианты: no yes ←	Если `no`, файл будет передан только в том случае, если он не существует в назначении.
inline boolean		Варианты: no yes	Если `yes`, политика ASM будет экспортирована `inline` как строка, а не как файл. Политика может быть получена в книге сценариев `result` в словаре под ключом `inline_policy`.
name строка / обязательно			Имя политики, экспортируемой для создания файла на удалённом устройстве для загрузки.
partition строка		Значение по умолчанию: "Common"	Раздел устройства, содержащий политику ASM для экспорта.
password строка / обязательно			Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
provider словарь добавлено в 2.5			Объект словаря, содержащий данные подключения.
	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 целое число	Значение по умолчанию: 10	Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: cli rest ←	Настраивает транспортное соединение для использования при подключении к удалённому устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых вами лично, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
server строка / обязательно			Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
server_port целое число добавлено в 2.2		Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
user строка / обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs boolean добавлено в 2.0		Варианты: 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 должна быть экспортирована inline Пример: 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.8/modules/bigip_asm_policy_fetch_module.html