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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

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

Новая функция в f5networks.f5_modules 1.0.0

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

Описание

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

Параметры

Параметр	Комментарии
base64 boolean	Если `true`, возвращаемое `inline` содержимое политики ASM закодировано в Base64. Применяется только к `inline` экспорту политики ASM. Варианты: `false` `true`
binary boolean	Если `true`, экспортируемая политика ASM находится в двоичном формате. Применяется только к `file` экспорту политики ASM. Варианты: `false` `true`
compact boolean	Если `true`, экспортируются только настраиваемые параметры политики ASM. Применяется только к экспорту политики ASM типа XML. Варианты: `false` `true`
dest path	Директория для сохранения файла политики. Этот параметр игнорируется, когда `inline` установлен на `true`.
file string	Имя файла, который будет создан на удаленном устройстве для загрузки. Когда `binary` установлен на `false`, политика ASM находится в формате XML.
force boolean	Если `false`, файл будет перенесен только в том случае, если он не существует в пункте назначения. Варианты: `false` `true` ← (по умолчанию)
inline boolean	Если `true`, политика ASM экспортируется `inline` в виде строки вместо файла. Политика может быть получена в книге задач `result` в словаре под ключом `inline_policy`. Варианты: `false` `true`
name string / обязательно	Имя политики, экспортированной для создания файла на удаленном устройстве для загрузки.
partition string	Раздел устройства, содержащий политику ASM для экспорта. По умолчанию: `"Common"`
provider dictionary добавлен в f5networks.f5_modules 1.0.0	Объект словаря, содержащий данные подключения.
auth_provider string	Настраивает поставщик аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TELEMETRY_OFF`. Предыдущая переменная `F5_TEEM` устарела, так как её название вызывало путаницу. Варианты: `false` ← (по умолчанию) `true`
password aliases: pass, pwd string / обязательно	Пароль для учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`.
server string / обязательно	Хост BIG-IP или хост BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
server_port integer	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout integer	Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль вернёт ошибку.
transport string	Настраивает транспортное соединение для подключения к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
user string / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.

END_OF_DOCUMENT_MARKER

validate_certs

boolean

Если no, сертификаты SSL не проверяются. Используйте эту опцию только на сайтах под вашим контролем, использующих самозаверяющие сертификаты.

Вы можете опустить эту опцию, установив переменную среды F5_VALIDATE_CERTS.

Варианты:

false
true ← (по умолчанию)

Примечания

Примечание

Дополнительную информацию об использовании 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: true
    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: true
    base64: true
    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: true
    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: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

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

Авторы

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

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_asm_policy_fetch_module.html