bigip_apm_policy_fetch – Экспорт политики APM или профиля доступа APM с удалённых узлов
Новое в версии 2.8.
Описание
- Экспортирует политику APM или профиль доступа APM с удалённых узлов.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| dest путь | Директория для сохранения файла. | ||
| file строка | Имя файла, который будет создан на удалённом устройстве для загрузки. | ||
| force логическое значение |
| Если no, файл будет передан только в том случае, если он не существует в указанном месте назначения. | |
| name строка / обязательно | Имя экспортируемой политики APM или профиля доступа APM, для создания файла на удалённом устройстве для загрузки. | ||
| partition строка | Значение по умолчанию: "Общие" | Раздел устройства, содержащий политику APM или профиль доступа APM для экспорта. | |
| password строка / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Можно опустить этот параметр, установив переменную среды F5_PASSWORD.Псевдонимы: pass, pwd | ||
| provider словарь добавлено в 2.5 | Объект словаря, содержащий сведения о подключении. | ||
| password строка / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Можно опустить этот параметр, установив переменную среды F5_PASSWORD.Псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Можно опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port целое число | Значение по умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| ssh_keyfile путь | Указывает файл SSH-ключа для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Можно опустить этот параметр, установив переменную среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Значение по умолчанию: 10 | Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. | |
| transport строка |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs логическое значение |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых лично, с самозаверенными сертификатами.Можно опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| server строка / обязательно | Хост BIG-IP. Можно опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port целое число добавлено в 2.2 | Значение по умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| type строка |
| Указывает тип элемента для экспорта с устройства. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs логическое значение добавлено в 2.0 |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых лично, с самозаверенными сертификатами.Можно опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Из-за 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 на диске, убедитесь, что включена задача, использующая модуль 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 |
Статус
- Данный модуль не гарантирует обратную совместимость. [превью]
- Данный модуль поддерживается партнёром Ansible. [сертифицировано]
Авторы
- Wojciech Wypior (@wojtek0806)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/bigip_apm_policy_fetch_module.html
