fortinet.fortimanager.fmgr_system_admin_setting – Настройка администратора.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_system_admin_setting.
В версии 2.10: of fortinet.fortimanager
Обзор
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить из источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| устанавливается в значение True только при различиях в схеме модуля и структуре API FortiManager, модуль продолжает выполнение без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, при которых будут переопределены условия для отказа | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых будут переопределены условия для успеха | ||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | |
| system_admin_setting словарь | параметры верхнего уровня | ||
| access-banner строка |
| Включить/выключить баннер доступа. выключено - Выключить настройку. включено - Включить настройку. | |
| admin-https-redirect строка |
| Включить/выключить перенаправление HTTP-административного трафика на HTTPS. выключено - Выключить настройку. включено - Включить настройку. | |
| admin-login-max целое число | Значение по умолчанию: 256 | Максимальное количество административных пользователей, вошедших в систему одновременно (1 - 256). | |
| admin_server_cert строка | Значение по умолчанию: "server.crt" | Сертификат сервера HTTPS и веб-службы. | |
| allow_register строка |
| Включить/выключить разрешение регистрации незарегистрированного устройства. выключено - Выключить настройку. включено - Включить настройку. | |
| auto-update строка |
| Включить/выключить автоматическое обновление FortiGate. выключено - Отключить автоматическое обновление устройства. включено - Включить автоматическое обновление устройства. | |
| banner-message строка | Сообщение баннера. | ||
| chassis-mgmt строка |
| Включить или выключить управление шасси. выключено - Выключить настройку. включено - Включить настройку. | |
| chassis-update-interval целое число | Значение по умолчанию: 15 | Интервал обновления шасси в фоновом режиме (4 - 1440 мин). | |
| device_sync_status строка |
| Включить/выключить индикацию статуса синхронизации устройств. выключено - Выключить настройку. включено - Включить настройку. | |
| gui-theme строка |
| Схема цветов для использования в администрирующем интерфейсе. синий - Голубика зелёный - Киви красный - Вишня фиолетовый - Слива весна - Весна лето - Лето осень - Осень зима - Зима космос - Космос калла - Калла бинарный-туннель - Бинарный туннель погружение - Погружение мечтательный - Мечтательный технологии - Технологии пейзаж - Пейзаж сумерки - Сумерки каньон - Каньон северное-сияние - Северное сияние астрономия - Астрономия рыба - Рыба пингвин - Пингвин панды - Панды белый медведь - Белый медведь попугай - Попугай пещера - Пещера | |
| http_port целое число | Значение по умолчанию: 80 | Порт HTTP. | |
| https_port целое число | Значение по умолчанию: 443 | Порт HTTPS. | |
| idle_timeout целое число | Значение по умолчанию: 15 | Таймаут бездействия (1 - 480 мин). | |
| install-ifpolicy-only строка |
| Разрешить установку только политики интерфейса. выключено - Выключить настройку. включено - Включить настройку. | |
| mgmt-addr строка | IP адрес FortiManager, используемый FGFM. | ||
| mgmt-fqdn строка | FQDN FortiManager, используемый FGFM. | ||
| objects-force-deletion строка |
| Включить/выключить принудительное удаление используемых объектов. выключено - Выключить настройку. включено - Включить настройку. | |
| offline_mode строка |
| Включить/выключить режим офлайн. выключено - Выключить режим офлайн. включено - Включить режим офлайн. | |
| register_passwd строка | нет описания | ||
| sdwan-monitor-history строка |
| Включить/выключить отображение имени хоста на странице входа в GUI. выключено - Выключить настройку. включено - Включить настройку. | |
| shell-access строка |
| Включить/выключить доступ к оболочке. выключено - Выключить настройку. включено - Включить настройку. | |
| shell-password строка | нет описания | ||
| show-add-multiple строка |
| Показать кнопку добавления нескольких элементов. выключено - Выключить настройку. включено - Включить настройку. | |
| show-adom-devman строка |
| Показать инструменты диспетчера устройств ADOM в GUI. выключено - Скрыть инструменты диспетчера устройств в GUI. включено - Показать инструменты диспетчера устройств в GUI. | |
| show-checkbox-in-table строка |
| Показать флажки в таблицах в GUI. выключено - Выключить настройку. включено - Включить настройку. | |
| show-device-import-export строка |
| Включить/выключить импорт/экспорт списков ADOM, устройств и групп. выключено - Выключить настройку. включено - Включить настройку. | |
| show-hostname строка |
| Включить/выключить отображение имени хоста на странице входа в GUI. выключено - Выключить настройку. включено - Включить настройку. | |
| show_automatic_script строка |
| Включить/выключить автоматический скрипт. выключено - Выключить опцию скрипта. включено - Включить опцию скрипта. | |
| show_grouping_script строка |
| Включить/выключить группировочный скрипт. выключено - Выключить опцию скрипта. включено - Включить опцию скрипта. | |
| show_schedule_script строка |
| Включить или выключить скрипт планирования. выключено - Выключить опцию скрипта. включено - Включить опцию скрипта. | |
| show_tcl_script строка |
| Включение/выключение скрипта TCL. disable - Отключение опции скрипта. enable - Включение опции скрипта. | |
| unreg_dev_opt строка |
| Действие при подключении незарегистрированного устройства к FortiManager. add_no_service - Добавить незарегистрированные устройства, но запретить запросы на обслуживание. ignore - Игнорировать незарегистрированные устройства. add_allow_service - Добавить незарегистрированные устройства и разрешить запросы на обслуживание. | |
| webadmin_language строка |
| Язык веб-администрирования. auto_detect - Автоматическое определение языка. english - Английский. simplified_chinese - Упрощенный китайский. traditional_chinese - Традиционный китайский. japanese - Японский. korean - Корейский. spanish - Испанский. | |
| workspace_locking_adom строка | Область (ADOM), которая должна быть заблокирована для FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным и другими, включая root | ||
| workspace_locking_timeout целое число | Значение по умолчанию: 300 | Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. | |
Примечания
Примечание
- Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться ошибкой при возвращении ненулевого значения rc. Вы также можете переопределить условия для ошибки или успеха с помощью параметров rc_failed и rc_succeeded
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Admin setting.
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: <value of integer>
admin_server_cert: <value of string>
allow_register: <value in [disable, enable]>
auto-update: <value in [disable, enable]>
banner-message: <value of string>
chassis-mgmt: <value in [disable, enable]>
chassis-update-interval: <value of integer>
device_sync_status: <value in [disable, enable]>
gui-theme: <value in [blue, green, red, ...]>
http_port: <value of integer>
https_port: <value of integer>
idle_timeout: <value of integer>
install-ifpolicy-only: <value in [disable, enable]>
mgmt-addr: <value of string>
mgmt-fqdn: <value of string>
objects-force-deletion: <value in [disable, enable]>
offline_mode: <value in [disable, enable]>
register_passwd: <value of string>
sdwan-monitor-history: <value in [disable, enable]>
shell-access: <value in [disable, enable]>
shell-password: <value of 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, ...]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | Полный запрошенный URL Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Описание ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_admin_setting_module.html
