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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.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 boolean	При значении `true` любая существующая политика с таким же именем будет перезаписана новым импортом. Если политика не существует, это значение игнорируется. Варианты: `false` ← (по умолчанию) `true`
name строка / обязательно	Имя политики APM или профиля доступа APM для создания или перезаписи.
partition строка	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект типа словарь, содержащий детали подключения.
auth_provider строка	Настраивает поставщик аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если `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 boolean	Если `no`, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах с самозаверенными сертификатами. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
reuse_objects boolean	При значении `true` и если объекты, на которые ссылается политика, существуют на BIG-IP, будут использоваться они, а не объекты, определённые в политике. Использование существующих объектов уменьшает размер конфигурации. Конфигурация существующих объектов может отличаться от конфигурации объектов, определённых в политике! Варианты: `false` `true` ← (по умолчанию)
source путь	Полный путь к файлу, который необходимо импортировать в BIG-IP APM.
type строка	Указывает тип элемента для экспорта с устройства. Варианты: `"profile_access"` ← (по умолчанию) `"access_policy"` `"profile_api_protection"`

Примечания

Примечание

Из-за ID685681 невозможно выполнить инструменты ng_* через REST API на версиях v12.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 boolean	Устанавливается при перезаписи существующей политики или профиля. Возвращаемое значение: changed Пример: `true`
name string	Имя политики APM или профиля доступа APM, которое требуется создать или перезаписать. Возвращаемое значение: changed Пример: `"APM_policy_global"`
reuse_objects boolean	Устанавливается при повторном использовании существующих объектов на BIG-IP. Возвращаемое значение: changed Пример: `true`
source string	Локальный путь к файлу политики APM. Возвращаемое значение: changed Пример: `"/root/some_policy.tar.gz"`
type string	Устанавливается для указания типа импортируемого элемента. Возвращаемое значение: changed Пример: `"access_policy"`

Авторы

Wojciech Wypior (@wojtek0806)

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

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