Модуль fortinet.fortimanager.fmgr_devprof_device_profile_fortiguard – Шаблон устройства для профиля fortiguard
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров. Варианты:
|
devprof строка / обязательно | Параметр (devprof) в запрошенном URL. |
devprof_device_profile_fortiguard словарь | Настроенные параметры верхнего уровня. |
|
auto_firmware_upgrade строка |
Устарело, пожалуйста, переименуйте на auto_firmware_upgrade. Автоматическое обновление прошивки. Варианты:
|
|
auto_firmware_upgrade_day список / элементы=строка |
Устарело, пожалуйста, переименуйте на auto_firmware_upgrade_day. День автоматического обновления прошивки. Варианты:
|
|
auto_firmware_upgrade_delay целое число |
Устарело, пожалуйста, переименуйте на auto_firmware_upgrade_delay. Задержка автоматического обновления прошивки. |
|
auto_firmware_upgrade_end_hour целое число |
Устарело, пожалуйста, переименуйте на auto_firmware_upgrade_end_hour. Конечный час автоматического обновления прошивки. |
|
auto_firmware_upgrade_start_hour целое число |
Устарело, пожалуйста, переименуйте на auto_firmware_upgrade_start_hour. Начальный час автоматического обновления прошивки. |
|
target строка |
Целевая установка. Варианты:
|
|
target_ip строка |
Устарело, пожалуйста, переименуйте на target_ip. Целевой IP-адрес. |
enable_log булево | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизовать Ansible-клиент с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, с которыми условия ошибки будут переопределены. |
rc_succeeded список / элементы=целое число | Список кодов rc, с которыми условия успеха будут переопределены. |
workspace_locking_adom строка | Область (adom), которая будет заблокирована для FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и другими, включая root. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, все входные аргументы имеют имена, использующие нижнее подчеркивание (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов все еще доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
- В этом модуле FortiManager поддерживается режим блокировки рабочей области. Параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Обычно выполнение одного модуля может завершиться ошибкой, если возвращен ненулевой код возврата. Вы также можете переопределить условия завершения ошибкой или успехом с помощью параметров rc_failed и rc_succeeded
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: System template device profile fortiguard
fortinet.fortimanager.fmgr_devprof_device_profile_fortiguard:
# bypass_validation: false
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
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>
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус API запроса. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложный |
Ссылки на коллекцию
© 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/fortinet/fortimanager/fmgr_devprof_device_profile_fortiguard_module.html
