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

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).

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

Для использования в книге задач укажите: f5networks.f5_modules.bigip_apm_policy_import.

Новое в версии 1.0.0: модуля f5networks.f5_modules

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
force boolean		Варианты: нет ← да	При установке в `yes` любая существующая политика с тем же именем будет перезаписана новым импортом. Если политика не существует, это значение игнорируется.
name строка / обязательно			Имя APM политики или профиля доступа APM для создания или переопределения.
partition строка		По умолчанию: "Общая"	Раздел устройства для управления ресурсами.
provider словарь добавлен в 1.0.0 модуля f5networks.f5_modules			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	no_f5_teem boolean	Варианты: нет да	Если `yes`, данные телеметрии TEEM не отправляются на F5. Этот параметр можно опустить, установив переменную среды `F5_TEEM`.
	password строка / обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER`.
	server_port целое число	По умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER_PORT`.
	timeout целое число		Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль вернёт ошибку.
	transport строка	Варианты: rest ←	Настраивает транспортное соединение для подключения к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды `F5_USER`.
	validate_certs boolean	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на управляемых вами сайтах с самозаверяющимися сертификатами. Этот параметр можно опустить, установив переменную среды `F5_VALIDATE_CERTS`.
reuse_objects boolean		Варианты: нет да ←	При установке в `yes` и использовании объектов в рамках политики, существующих на BIG-IP, они будут использоваться вместо объектов, определённых в политике. Использование существующих объектов уменьшает размер конфигурации. Конфигурация существующих объектов может отличаться от конфигурации объектов, определённых в политике!
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: yes
    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 строка	changed	Имя APM политики или профиля доступа APM, которое будет создано/перезаписано. Пример: APM_policy_global
reuse_objects boolean	changed	Устанавливается при повторном использовании существующих объектов на BIG-IP. Пример: True
source строка	changed	Локальный путь к файлу APM политики. Пример: /root/some_policy.tar.gz
type строка	changed	Устанавливается для указания типа импортируемого элемента. Пример: access_policy

Авторы

Wojciech Wypior (@wojtek0806)

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