Модуль f5networks.f5_modules.bigip_asm_policy_import — управление импортом политик BIG-IP 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_import.

Добавлен в f5networks.f5_modules 1.0.0

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

Краткое описание

Управление импортом политик для политик BIG-IP ASM.

Параметры

Параметр	Комментарии
base64 boolean	Указывает, закодирована ли строка импортируемой политики в Base64. Этот параметр действует только при использовании метода импорта `inline`. Варианты: `false` `true`
encoding string	Задает предпочтительный язык приложения импортируемой политики. Импортируемая политика не может иметь тип `parent` или быть присоединена к политике `parent`, если задана кодировка `auto-detect`. При импорте политики для присоединения к политике `parent` значение `encoding` импортируемой политики, если оно отличается, должно совпадать со значением `parent_policy`, иначе импорт завершится ошибкой. Этот параметр доступен в TMOS версии 13.x и более поздних и действует только при использовании метода импорта `inline`. Варианты: `"windows-874"` `"utf-8"` `"koi8-r"` `"windows-1253"` `"iso-8859-10"` `"gbk"` `"windows-1256"` `"windows-1250"` `"iso-8859-13"` `"iso-8859-9"` `"windows-1251"` `"iso-8859-6"` `"big5"` `"gb2312"` `"iso-8859-1"` `"windows-1252"` `"iso-8859-4"` `"iso-8859-2"` `"iso-8859-3"` `"gb18030"` `"shift_jis"` `"iso-8859-8"` `"euc-kr"` `"iso-8859-5"` `"iso-8859-7"` `"windows-1255"` `"euc-jp"` `"iso-8859-15"` `"windows-1257"` `"iso-8859-16"` `"auto-detect"`
force boolean	Если задано значение `true`, существующая политика с тем же именем будет заменена новой импортированной политикой. Это работает как при импорте встроенной политики, так и при импорте из файла; если политика не существует, этот параметр игнорируется. Варианты: `false` ← (по умолчанию) `true`
inline string	Если указано, политика ASM создается из предоставленной строки. Содержимое должно быть представлено в допустимом формате XML, иначе операция завершится ошибкой.
name string / обязательный	Политика ASM, которую нужно создать или заменить.
parent_policy string	Родительская политика, к которой новая импортированная политика должна быть присоединена как дочерняя. Если указано `parent_policy`, импортируемая `policy_type` не должна быть `parent`. Этот параметр доступен в TMOS версии 13.x и более поздних и действует только при использовании метода импорта `inline`.
partition string	Раздел устройства, в котором будет создана политика. Этот параметр также используется для указания раздела политики `parent`. По умолчанию: `"Common"`
policy_type string	Тип импортируемой политики. Если `policy_type` имеет значение `security`, политика импортируется как политика безопасности приложений, которую можно применить к виртуальному серверу. Если `policy_type` имеет значение `parent`, политика становится родительской, к которой присоединяются другие политики безопасности, наследуя её атрибуты. Этот тип политики нельзя применять к виртуальным серверам. Этот параметр доступен в TMOS версии 13.x и более поздних и действует только при использовании метода импорта `inline`. Варианты: `"security"` ← (по умолчанию) `"parent"`
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` ← (по умолчанию)
retain_inheritance_settings boolean	Указывает, должна ли импортированная политика типа security сохранять настройки при присоединении к родительской политике. Этот параметр доступен в TMOS версии 13.x и более поздних и действует только при использовании метода импорта `inline`. Варианты: `false` `true`
source path	Полный путь к файлу политики, импортируемому в BIG-IP ASM. Файлы политик, экспортированные из более новых версий BIG-IP, нельзя импортировать в более старые версии BIG-IP. Однако файлы политик из более старых версий BIG-IP можно импортировать в более новые версии BIG-IP. Формат файла может быть двоичным или XML.

Примечания

Примечание

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

Примеры

- name: Import ASM policy
  bigip_asm_policy_import:
    name: new_asm_policy
    file: /root/asm_policy.xml
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Import ASM policy inline
  bigip_asm_policy_import:
    name: foo-policy4
    inline: <xml>content</xml>
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Override existing ASM policy
  bigip_asm_policy:
    name: new_asm_policy
    source: /root/asm_policy_new.xml
    force: true
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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

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

Ключ	Описание
base64 boolean	Указывает, закодирована ли строка импортированной политики в Base64. Возвращается: changed Пример: `true`
encoding string	Предпочтительный язык приложения импортированной политики. Возвращается: changed Пример: `"utf-8"`
force boolean	Устанавливается при перезаписи существующей политики. Возвращается: changed Пример: `true`
inline string	Содержимое политики в виде встроенной строки. Возвращается: changed Пример: `"<xml>foobar contents</xml>"`
name string	Имя политики ASM, которую нужно создать или перезаписать. Возвращается: changed Пример: `"Asm_APP1_Transparent"`
parent_policy string	Родительская политика, к которой новая импортированная политика должна быть присоединена как дочерняя. Возвращается: changed Пример: `"/Common/parent"`
policy_type string	Тип импортируемой политики. Возвращается: changed Пример: `"security"`
retain_inheritance_settings boolean	Указывает, должна ли импортированная политика типа security сохранять настройки при присоединении к родительской политике. Возвращается: changed Пример: `true`
source string	Локальный путь к файлу политики ASM. Возвращается: changed Пример: `"/root/some_policy.xml"`

Авторы

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_import_module.html