Модуль f5networks.f5_modules.bigip_apm_policy_fetch – Экспорт профиля политики APM или профиля доступа APM с удаленных узлов.

Примечание

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

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

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

Для использования в playbook, укажите: f5networks.f5_modules.bigip_apm_policy_fetch.

Новое в f5networks.f5_modules 1.0.0

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

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

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

Параметры

Параметр	Комментарии
dest path	Каталог для сохранения файла.
file string	Имя файла, который будет создан на удаленном устройстве для загрузки.
force boolean	Если `false`, файл будет передан только в том случае, если его нет в месте назначения. Варианты: `false` `true` ← (по умолчанию)
name string / обязательно	Имя профиля политики APM или профиля доступа APM, экспортируемого для создания файла на удаленном устройстве для загрузки.
partition string	Раздел устройства, содержащий экспортируемый профиль политики APM или профиль доступа APM. По умолчанию: `"Common"`
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий данные подключения.
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`
timeout integer	Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истекло до завершения операции, модуль выдаст ошибку.
transport string	Настраивает транспортное соединение, используемое при подключении к удаленному устройству. Варианты: `"rest"` ← (по умолчанию)
user string / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs boolean	Если `no`, SSL-сертификаты не проверяются. Используйте это только на лично контролируемых сайтах, использующих самозаверяющие сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
type string	Указывает тип элемента для экспорта с устройства. Варианты: `"profile_access"` ← (по умолчанию) `"access_policy"`

Примечания

Примечание

Из-за 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: 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–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_fetch_module.html