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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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`, возвращаемое содержимое политики ASM в формате `inline` кодируется в Base64. Применяется только к экспорту политики ASM в формате `inline`. Варианты: `false` `true`
binary boolean	Если `true`, политика ASM экспортируется в двоичном формате. Применяется только к экспорту политики ASM в формате `file`. Варианты: `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	Объект dict с данными для подключения.
auth_provider string	Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр фактически используется при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если `yes`, данные телеметрии TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную окружения `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` устарела, поскольку её имя вводило в заблуждение. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: 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`.
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. Возвращается: изменено Пример: `false`
binary boolean	Включает экспорт политики ASM в двоичном формате. Возвращается: изменено Пример: `true`
compact boolean	Включает экспорт только пользовательских настроек политики ASM. Возвращается: изменено Пример: `false`
dest string	Локальный путь для загрузки экспортированной политики ASM. Возвращается: изменено Пример: `"/root/downloads/foobar.xml"`
file string	Имя файла политики на удалённом BIG-IP для загрузки. Если оно не указано, будет создано случайное имя файла. Возвращается: изменено Пример: `"foobar.xml"`
inline boolean	Устанавливается, если экспортируемая политика ASM встроенная Возвращается: изменено Пример: `true`
name string	Имя экспортируемой политики ASM. Возвращается: изменено Пример: `"Asm_APP1_Transparent"`

Авторы

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

Ссылки на коллекцию

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