Модуль f5networks.f5_modules.bigip_apm_policy_import – управление импортом политик BIG-IP APM или профилей доступа APM

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: f5networks.f5_modules.bigip_apm_policy_import.

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

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

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

Управление импортом политик BIG-IP APM или профилей доступа APM.

Параметры

Параметр	Комментарии
force логический	Если задано значение `true`, существующая политика с таким же именем будет заменена новой импортируемой политикой. Если политика не существует, этот параметр игнорируется. Варианты: `false` ← (по умолчанию) `true`
name строка / обязательный	Имя политики APM или профиля доступа APM, который нужно создать или заменить.
partition строка	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий сведения о подключении.
auth_provider строка	Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр используется главным образом при работе с устройствами BIG-IQ.
no_f5_teem логический	Если задано значение `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную окружения `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` объявлена устаревшей, поскольку ее имя было неясным. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательный	Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную окружения `F5_PASSWORD`.
server строка / обязательный	Узел BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER_PORT`. По умолчанию: `443`
timeout целое число	Задает время ожидания в секундах при взаимодействии с сетевым устройством — для подключения или отправки команд. Если время ожидания истекает до завершения операции, модуль завершится с ошибкой.
transport строка	Настраивает транспортное соединение для подключения к удаленному устройству. Варианты: `"rest"` ← (по умолчанию)
user строка / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен обладать правами администратора на устройстве. Этот параметр можно не указывать, задав переменную окружения `F5_USER`.
validate_certs логический	Если задано значение `no`, сертификаты SSL не проверяются. Используйте этот параметр только на подконтрольных вам сайтах с самоподписанными сертификатами. Этот параметр можно не указывать, задав переменную окружения `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
reuse_objects логический	Если задано значение `true` и объекты, на которые ссылается политика, существуют на BIG-IP, будут использованы эти объекты вместо объектов, определенных в политике. Повторное использование существующих объектов уменьшает размер конфигурации. Конфигурация существующих объектов может отличаться от конфигурации объектов, определенных в политике! Варианты: `false` `true` ← (по умолчанию)
source путь	Полный путь к файлу, который необходимо импортировать в BIG-IP APM.
type строка	Указывает тип элемента, который нужно экспортировать с устройства. Варианты: `"profile_access"` ← (по умолчанию) `"access_policy"` `"profile_api_protection"`

Примечания

Примечание

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

Примеры

- name: Import APM profile
  bigip_apm_policy_import:
    name: new_apm_profile
    source: /root/apm_profile.tar.gz
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Import APM policy
  bigip_apm_policy_import:
    name: new_apm_policy
    source: /root/apm_policy.tar.gz
    type: access_policy
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Override existing APM policy
  bigip_asm_policy:
    name: new_apm_policy
    source: /root/apm_policy.tar.gz
    force: true
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Import APM profile without re-using existing configuration objects
  bigip_apm_policy_import:
    name: new_apm_profile
    source: /root/apm_profile.tar.gz
    reuse_objects: false
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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

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

Ключ	Описание
force логический	Устанавливается при замене существующей политики или профиля. Возвращается: changed Пример: `true`
name строка	Имя создаваемой или заменяемой политики APM либо профиля доступа APM. Возвращается: changed Пример: `"APM_policy_global"`
reuse_objects логический	Устанавливается при повторном использовании существующих объектов на BIG-IP. Возвращается: changed Пример: `true`
source строка	Локальный путь к файлу политики APM. Возвращается: changed Пример: `"/root/some_policy.tar.gz"`
type строка	Задает тип экспортируемого элемента. Возвращается: changed Пример: `"access_policy"`

Авторы

Wojciech Wypior (@wojtek0806)

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

© 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_apm_policy_import_module.html