Модуль fortinet.fortimanager.fmgr_devprof_device_profile_fortiguard — профиль устройства FortiGuard системного шаблона
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать ее в плейбуке, укажите: fortinet.fortimanager.fmgr_devprof_device_profile_fortiguard.
Добавлено в fortinet.fortimanager 1.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
devprof string / обязательный | Параметр (devprof) в запрошенном URL. |
devprof_device_profile_fortiguard dictionary | Набор параметров верхнего уровня. |
|
auto_firmware_upgrade псевдонимы: auto-firmware-upgrade string |
Автоматическое обновление прошивки. Варианты:
|
|
auto_firmware_upgrade_day псевдонимы: auto-firmware-upgrade-day list / элементы=string |
День автоматического обновления прошивки. Варианты:
|
|
auto_firmware_upgrade_delay псевдонимы: auto-firmware-upgrade-delay integer |
Задержка автоматического обновления прошивки. |
|
auto_firmware_upgrade_end_hour псевдонимы: auto-firmware-upgrade-end-hour integer |
Час завершения автоматического обновления прошивки. |
|
auto_firmware_upgrade_start_hour псевдонимы: auto-firmware-upgrade-start-hour integer |
Час начала автоматического обновления прошивки. |
|
target string |
Цель. Варианты:
|
|
target_ip псевдонимы: target-ip string |
IP-адрес цели. |
|
vrf_select псевдонимы: vrf-select integer |
Выбор VRF. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Переопределенный метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия ошибки. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия успешного выполнения. |
workspace_locking_adom string | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие ADOM, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания, пока другой пользователь снимет блокировку рабочей области. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, имена всех входных аргументов задаются в соответствии с соглашением об именовании через подчеркивание (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, однако будут выводиться предупреждения об устаревании. Это предупреждение можно отключить, установив deprecation_warnings=False в ansible.cfg.
- Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
- Обычно выполнение модуля завершается ошибкой, если возвращается ненулевой код rc. Условия ошибки или успешного выполнения можно переопределить с помощью параметров rc_failed и rc_succeeded.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: System template device profile fortiguard
fortinet.fortimanager.fmgr_devprof_device_profile_fortiguard:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
devprof: <your own value>
devprof_device_profile_fortiguard:
# target: <value in [none, direct, this-fmg]>
# target_ip: <string>
# auto_firmware_upgrade: <value in [disable, enable]>
# auto_firmware_upgrade_day: ["sunday", "monday", "tuesday", "wednesday", "thursday",
# "friday", "saturday"]
# auto_firmware_upgrade_delay: <integer>
# auto_firmware_upgrade_end_hour: <integer>
# auto_firmware_upgrade_start_hour: <integer>
# vrf_select: <integer>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, относящиеся только к этому модулю:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=string | Предупреждение появляется, если используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при сложных условиях |
Ссылки на коллекцию
© 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/fortinet/fortimanager/fmgr_devprof_device_profile_fortiguard_module.html
