Модуль f5networks.f5_modules.bigip_asm_policy_import — Управление импортами политик BIG-IP 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_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	Объект словаря, содержащий данные подключения.
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`

END_OF_DOCUMENT_MARKER

timeout целое число	Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку.
transport строка	Настраивает транспортное соединение для подключения к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
user строка / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
validate_certs логическое значение	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
retain_inheritance_settings логическое значение	Указывает, следует ли политикам типа «тип безопасности» сохранять настройки при подключении к родительской политике. Этот параметр доступен в версиях TMOS 13.x и выше и действует только при использовании метода импорта `inline`. Варианты: `false` `true`
source путь	Полный путь к файлу политики, который необходимо импортировать в 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	Указывает, должна ли импортированная политика типа безопасности сохранять настройки при прикреплении к родительской политике. Возвращено: changed Пример: `true`
source string	Локальный путь к файлу политики ASM. Возвращено: changed Пример: `"/root/some_policy.xml"`

Авторы

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