Модуль fortinet.fortimanager.fmgr_system_admin_setting – Настройка администрирования.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_system_admin_setting.
Новое в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать согласно источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
bypass_validation логическое значение | Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Выбори:
|
enable_log логическое значение | Включить/выключить ведение журнала для задачи. Выбори:
|
forticloud_access_token строка | Авторизовать клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределенный метод для базового запроса Json RPC. Выбори:
|
rc_failed список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия для сбоя. |
rc_succeeded список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия для успеха. |
system_admin_setting словарь | Установленные параметры верхнего уровня. |
|
access-banner строка |
Устаревший, пожалуйста, переименуйте на access_banner. Включить/выключить баннер доступа. disable - Выключить настройку. enable - Включить настройку. Выбори:
|
|
admin-https-redirect строка |
Устаревший, пожалуйста, переименуйте на admin_https_redirect. Включить/выключить перенаправление HTTP-трафика администрирования на HTTPS. disable - Выключить настройку. enable - Включить настройку. Выбори:
|
|
admin-login-max целое число |
Устаревший, пожалуйста, переименуйте на admin_login_max. Максимальное количество пользователей-администраторов, вошедших в систему одновременно |
|
admin_server_cert строка |
Сертификат сервера HTTPS и веб-службы. |
|
allow_register строка |
Включить/выключить разрешение регистрации незарегистрированного устройства. disable - Выключить настройку. enable - Включить настройку. Выбори:
|
|
auth_addr строка |
Устаревший, пожалуйста, переименуйте на auth_addr. IP-адрес, используемый FGT для авторизации FMG. |
|
auth_port целое число |
Устаревший, пожалуйста, переименуйте на auth_port. Порт, используемый FGT для авторизации FMG. |
|
auto_update строка |
Устаревший, пожалуйста, переименуйте на auto_update. Включить/выключить автоматическое обновление FortiGate. disable - Выключить автоматическое обновление устройства. enable - Включить автоматическое обновление устройства. Выбори:
|
|
banner_message строка |
Устаревший, пожалуйста, переименуйте на banner_message. Сообщение баннера. |
|
central_ftgd_local_cat_id строка |
Устаревший, пожалуйста, переименуйте на central_ftgd_local_cat_id. Управление идентификатором локальной категории FortiGuard централизованно, и не назначайте его автоматически во время установки. disable - Выключить настройку. enable - Включить настройку. Выбори:
|
|
chassis_mgmt строка |
Устаревший, пожалуйста, переименуйте на chassis_mgmt. Включить или выключить управление шасси. disable - Выключить настройку. enable - Включить настройку. Выбори:
|
|
chassis-update-interval integer |
Устарело, переименуйте в chassis_update_interval. Интервал фонового обновления шасси |
|
device_sync_status string |
Включить/выключить индикацию состояния синхронизации устройств. disable - Отключить настройку. enable - Включить настройку. Choices:
|
|
fgt-gui-proxy string |
Устарело, переименуйте в fgt_gui_proxy. Включить/выключить прокси FortiGate GUI. disable - Отключить настройку. enable - Включить настройку. Choices:
|
|
fgt-gui-proxy-port integer |
Устарело, переименуйте в fgt_gui_proxy_port. Порт прокси FortiGate GUI. |
|
firmware-upgrade-check string |
Устарело, переименуйте в firmware_upgrade_check. Включить/выключить проверку обновления прошивки. disable - Отключить настройку. enable - Включить настройку. Choices:
|
|
fsw-ignore-platform-check string |
Устарело, переименуйте в fsw_ignore_platform_check. Включить/выключить проверку поддержки платформы коммутатора FortiSwitch Manager. disable - Отключить настройку. enable - Включить настройку. Choices:
|
|
gui-theme string |
Устарело, переименуйте в gui_theme. Цветовая схема для административного графического интерфейса. blue - Черника green - Киви red - Вишня melongene - Слива spring - Весна summer - Лето autumn - Осень winter - Зима space - Космос calla-lily - Белая лилия binary-tunnel - Бинарный туннель diving - Дайвинг dreamy - Сновидения technology - Технологии landscape - Пейзаж twilight - Сумерки canyon - Каньон northern-light - Северное сияние astronomy - Астрономия fish - Рыба penguin - Пингвин panda - Панда polar-bear - Белый медведь parrot - Попугай cave - Пещера Choices:
|
|
http_port integer |
HTTP порт. |
|
https_port integer |
HTTPS порт. |
|
idle_timeout integer |
Таймаут бездействия |
|
idle_timeout_api integer |
Таймаут бездействия для сеансов API |
|
idle_timeout_gui integer |
Таймаут бездействия для сеансов GUI |
|
idle_timeout_sso integer |
Таймаут бездействия для сеансов SSO |
|
install-ifpolicy-only string |
Устарело, переименуйте в install_ifpolicy_only. Разрешить установку только политики интерфейса. disable - Отключить настройку. enable - Включить настройку. Choices:
|
|
mgmt-addr string |
Устарело, переименуйте в mgmt_addr. IP FortiManager, используемый FGFM. |
|
mgmt-fqdn string |
Устарело, переименуйте в mgmt_fqdn. FQDN FortiManager, используемый FGFM. |
|
objects-force-deletion string |
Устарело, переименуйте в objects_force_deletion. Включить/выключить принудительное удаление используемых объектов. disable - Отключить настройку. enable - Включить настройку. Choices:
|
|
offline_mode string |
Включить/выключить автономный режим. disable - Отключить автономный режим. enable - Включить автономный режим. Choices:
|
|
preferred-fgfm-intf string |
Устарело, переименуйте в preferred_fgfm_intf. Предпочтительный интерфейс для подключения FGFM. |
|
register_passwd any |
(list) Пароль для регистрации устройства. |
|
rtm-max-monitor-by-days integer |
Устарело, переименуйте в rtm_max_monitor_by_days. Максимальный мониторинг rtm |
|
rtm-temp-file-limit integer |
Устарело, переименуйте в rtm_temp_file_limit. Установить лимит временных файлов мониторинга rtm в часах. |
|
sdwan-monitor-history string |
Устарело, переименуйте в sdwan_monitor_history. Включить/выключить отображение имени хоста на странице входа в GUI. disable - Отключить настройку. enable - Включить настройку. Choices:
|
|
sdwan-skip-unmapped-input-device string |
Устарело, переименуйте в sdwan_skip_unmapped_input_device. Пропускать несопоставленные интерфейсы для sdwan/rule/input-device вместо сообщения об ошибке сопоставления. disable - Отключить настройку. enable - Включить настройку. Choices:
|
|
shell-access string |
Устарело, переименуйте в shell_access. Включить/выключить доступ к командной строке. disable - Отключить настройку. enable - Включить настройку. Choices:
|
|
shell-password any |
(list) Устарело, переименуйте в shell_password. Пароль для доступа к командной строке. |
|
show-add-multiple string |
Устарело, переименуйте в show_add_multiple. Показать кнопку добавления нескольких элементов. disable - Отключить настройку. enable - Включить настройку. Choices:
|
|
show-adom-devman string |
Устарело, переименуйте в show_adom_devman. Показать инструменты управления устройствами ADOM в GUI. disable - Скрыть инструменты управления устройствами в GUI. enable - Показать инструменты управления устройствами в GUI. Choices:
|
|
show-checkbox-in-table string |
Устарело, переименуйте в show_checkbox_in_table. Показать флажки в таблицах в GUI. disable - Отключить настройку. enable - Включить настройку. Choices:
|
|
show-device-import-export string |
Устарело, переименуйте в show_device_import_export. Включить/выключить импорт/экспорт списков ADOM, устройств и групп. disable - Отключить настройку. enable - Включить настройку. Choices:
|
|
show-fct-manager string |
Устарело, переименуйте в show_fct_manager. Включить/выключить менеджер FCT. disable - Отключить настройку. enable - Включить настройку. Choices:
|
|
show-hostname string |
Устарело, переименуйте в show_hostname. Включить/выключить отображение имени хоста на странице входа в GUI. disable - Отключить настройку. enable - Включить настройку. Choices:
|
|
show_automatic_script string |
Включить/выключить автоматический скрипт. disable - Отключить опцию скрипта. enable - Включить опцию скрипта. Choices:
|
|
show_grouping_script string |
Включить/выключить групповой скрипт. disable - Отключить опцию скрипта. enable - Включить опцию скрипта. Choices:
|
|
show_schedule_script string |
Включить или отключить скрипт расписания. disable - Отключить параметр скрипта. enable - Включить параметр скрипта. Варианты:
|
|
show_tcl_script string |
Включить/отключить скрипт TCL. disable - Отключить параметр скрипта. enable - Включить параметр скрипта. Варианты:
|
|
traffic-shaping-history string |
Устарело, пожалуйста, переименуйте на traffic_shaping_history. Включить/отключить трафик-формирование истории. disable - Отключить настройку. enable - Включить настройку. Варианты:
|
|
unreg_dev_opt string |
Действие, которое следует предпринять при подключении не зарегистрированного устройства к FortiManager. add_no_service - Добавить не зарегистрированные устройства, но запретить запросы сервиса. ignore - Игнорировать не зарегистрированные устройства. add_allow_service - Добавить не зарегистрированные устройства и разрешить запросы сервиса. Варианты:
|
|
webadmin_language string |
Язык веб-администрирования. auto_detect - Автоматическое определение языка. english - Английский. simplified_chinese - Упрощенный китайский. traditional_chinese - Традиционный китайский. japanese - Японский. korean - Корейский. spanish - Испанский. Варианты:
|
workspace_locking_adom string | ADOM для блокировки FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая корневой. |
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
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Admin setting.
fortinet.fortimanager.fmgr_system_admin_setting:
# 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, ...]
system_admin_setting:
access_banner: <value in [disable, enable]>
admin_https_redirect: <value in [disable, enable]>
admin_login_max: <integer>
admin_server_cert: <string>
allow_register: <value in [disable, enable]>
auto_update: <value in [disable, enable]>
banner_message: <string>
chassis_mgmt: <value in [disable, enable]>
chassis_update_interval: <integer>
device_sync_status: <value in [disable, enable]>
gui_theme: <value in [blue, green, red, ...]>
http_port: <integer>
https_port: <integer>
idle_timeout: <integer>
install_ifpolicy_only: <value in [disable, enable]>
mgmt_addr: <string>
mgmt_fqdn: <string>
objects_force_deletion: <value in [disable, enable]>
offline_mode: <value in [disable, enable]>
register_passwd: <list or string>
sdwan_monitor_history: <value in [disable, enable]>
shell_access: <value in [disable, enable]>
shell_password: <list or string>
show_add_multiple: <value in [disable, enable]>
show_adom_devman: <value in [disable, enable]>
show_checkbox_in_table: <value in [disable, enable]>
show_device_import_export: <value in [disable, enable]>
show_hostname: <value in [disable, enable]>
show_automatic_script: <value in [disable, enable]>
show_grouping_script: <value in [disable, enable]>
show_schedule_script: <value in [disable, enable]>
show_tcl_script: <value in [disable, enable]>
unreg_dev_opt: <value in [add_no_service, ignore, add_allow_service]>
webadmin_language: <value in [auto_detect, english, simplified_chinese, ...]>
show_fct_manager: <value in [disable, enable]>
sdwan_skip_unmapped_input_device: <value in [disable, enable]>
auth_addr: <string>
auth_port: <integer>
idle_timeout_api: <integer>
idle_timeout_gui: <integer>
central_ftgd_local_cat_id: <value in [disable, enable]>
idle_timeout_sso: <integer>
preferred_fgfm_intf: <string>
traffic_shaping_history: <value in [disable, enable]>
fsw_ignore_platform_check: <value in [disable, enable]>
rtm_max_monitor_by_days: <integer>
rtm_temp_file_limit: <integer>
firmware_upgrade_check: <value in [disable, enable]>
fgt_gui_proxy: <value in [disable, enable]>
fgt_gui_proxy_port: <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_system_admin_setting_module.html