Модуль f5networks.f5_modules.bigip_apm_policy_fetch — экспортирует политику 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_fetch.

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

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

Обзор

Экспортирует политику APM или профиль доступа APM с удалённых узлов.

Параметры

Параметр	Комментарии
dest путь	Каталог, в который нужно сохранить файл.
file строка	Имя файла, который будет создан на удалённом устройстве для загрузки.
force логический	Если `false`, файл будет передан, только если он отсутствует в месте назначения. Варианты: `false` `true` ← (по умолчанию)
name строка / обязательный	Имя экспортируемой политики APM или профиля доступа APM, для которого на удалённом устройстве создаётся файл для загрузки.
partition строка	Раздел устройства, содержащий экспортируемую политику APM или профиль доступа APM. По умолчанию: `"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` ← (по умолчанию)
type строка	Задаёт тип элемента, экспортируемого с устройства. Варианты: `"profile_access"` ← (по умолчанию) `"access_policy"`

Примечания

Примечание

Из-за 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: Export APM access profile
  bigip_apm_policy_fetch:
    name: foobar
    file: export_foo
    dest: /root/download
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Export APM access policy
  bigip_apm_policy_fetch:
    name: foobar
    file: export_foo
    dest: /root/download
    type: access_policy
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Export APM access profile, autogenerate name
  bigip_apm_policy_fetch:
    name: foobar
    dest: /root/download
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Описание
dest строка	Локальный путь для загрузки экспортированной политики APM. Возвращается: если были внесены изменения Пример: `"/root/downloads/profile-foobar_file.conf.tar.gz"`
file строка	Имя экспортированного файла на удалённом BIG-IP, предназначенного для загрузки. Если имя не указано, будет создано случайное имя файла. Возвращается: если были внесены изменения Пример: `"foobar_file"`
name строка	Имя экспортируемой политики APM или профиля доступа APM. Возвращается: если были внесены изменения Пример: `"APM_policy_global"`
type строка	Указывает тип экспортируемого элемента. Возвращается: если были внесены изменения Пример: `"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_fetch_module.html