Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_system_admin_setting — Настройка администратора.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить/отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

proposed_method

string

Метод, переопределяющий метод базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, для которых переопределяются условия сбоя.

rc_succeeded

list / elements=integer

Список кодов rc, для которых переопределяются условия успешного выполнения.

system_admin_setting

dictionary

Набор параметров верхнего уровня.

access_banner

псевдонимы: access-banner

string

Включить/отключить баннер доступа.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

admin_https_redirect

псевдонимы: admin-https-redirect

string

Включить/отключить перенаправление административного HTTP-трафика на HTTPS.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

admin_login_max

псевдонимы: admin-login-max

integer

Максимальное количество одновременно вошедших в систему администраторов

admin_scp

псевдонимы: admin-scp

string

Включить/отключить SCP для администратора.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

admin_server_cert

string

Сертификат сервера HTTPS и веб-службы.

allow_register

string

Включить/отключить возможность регистрации незарегистрированного устройства.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

auth_addr

псевдонимы: auth-addr

string

IP-адрес, используемый FGT для авторизации в FMG.

auth_port

псевдонимы: auth-port

integer

Порт, используемый FGT для авторизации в FMG.

auto_update

псевдонимы: auto-update

string

Включить/отключить автоматическое обновление FortiGate.

disable — отключить автоматическое обновление устройства.

enable — включить автоматическое обновление устройства.

Варианты:

  • "disable"
  • "enable"

banner_message

псевдонимы: banner-message

string

Текст баннера.

central_ftgd_local_cat_id

псевдонимы: central-ftgd-local-cat-id

string

Централизованное управление идентификаторами локальных категорий FortiGuard; автоматическое назначение идентификатора при установке не выполняется.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

chassis_mgmt

псевдонимы: chassis-mgmt

string

Включить или отключить управление шасси.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

chassis_update_interval

псевдонимы: chassis-update-interval

integer

Интервал фонового обновления шасси

device_sync_status

string

Включить/отключить индикацию состояния синхронизации устройства.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

fgt_gui_proxy

псевдонимы: fgt-gui-proxy

string

Включить/отключить прокси GUI FortiGate.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

fgt_gui_proxy_port

псевдонимы: fgt-gui-proxy-port

integer

Порт прокси GUI FortiGate.

firmware_upgrade_check

псевдонимы: firmware-upgrade-check

string

Включить/отключить проверку обновления прошивки.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

fsw_ignore_platform_check

псевдонимы: fsw-ignore-platform-check

string

Включить/отключить проверку поддержки платформ коммутаторов в FortiSwitch Manager.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

gui_theme

псевдонимы: gui-theme

string

Цветовая схема административного интерфейса GUI.

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 — Пещера

Варианты:

  • "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"
  • "mountain"
  • "zebra"
  • "contrast-dark"
  • "circuit-board"
  • "mars"
  • "blue-sea"
  • "mariner"
  • "jade"
  • "neutrino"
  • "dark-matter"
  • "forest"
  • "cat"
  • "graphite"

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

псевдонимы: install-ifpolicy-only

string

Разрешить установку только политик интерфейса.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

mgmt_addr

псевдонимы: mgmt-addr

string

IP-адрес FortiManager, используемый FGFM.

mgmt_fqdn

псевдонимы: mgmt-fqdn

string

FQDN FortiManager, используемый FGFM.

object_threshold_limit

псевдонимы: object-threshold-limit

string

Пороговое ограничение объектов.

Варианты:

  • "disable"
  • "enable"

object_threshold_limit_value

псевдонимы: object-threshold-limit-value

integer

Значение порогового ограничения объектов.

objects_force_deletion

псевдонимы: objects-force-deletion

string

Включить/отключить принудительное удаление используемых объектов.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

offline_mode

string

Включить/отключить автономный режим.

disable — отключить автономный режим.

enable — включить автономный режим.

Варианты:

  • "disable"
  • "enable"

preferred_fgfm_intf

псевдонимы: preferred-fgfm-intf

string

Предпочтительный интерфейс для подключения FGFM.

register_passwd

any

(список) Пароль для регистрации устройства.

rtm_max_monitor_by_days

псевдонимы: rtm-max-monitor-by-days

integer

Максимальное количество мониторов rtm

rtm_max_monitor_by_size

псевдонимы: rtm-max-monitor-by-size

integer

Максимальное количество мониторов rtm

rtm_temp_file_limit

псевдонимы: rtm-temp-file-limit

integer

Задать ограничение срока хранения временных файлов монитора rtm в часах.

sdwan_monitor_history

псевдонимы: sdwan-monitor-history

string

Включить/отключить отображение имени узла на странице входа в GUI.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

sdwan_skip_unmapped_input_device

псевдонимы: sdwan-skip-unmapped-input-device

string

Пропускать несопоставленный интерфейс для sdwan/rule/input-device вместо сообщения об ошибке сопоставления.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

shell_access

псевдонимы: shell-access

string

Включить или отключить доступ к оболочке.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

shell_password

псевдонимы: shell-password

any

(список) Пароль для доступа к оболочке.

show_add_multiple

псевдонимы: show-add-multiple

string

Показывать кнопку добавления нескольких элементов.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

show_adom_devman

псевдонимы: show-adom-devman

string

Показывать инструменты диспетчера устройств ADOM в графическом интерфейсе.

disable — скрыть инструменты диспетчера устройств в графическом интерфейсе.

enable — показывать инструменты диспетчера устройств в графическом интерфейсе.

Варианты:

  • "disable"
  • "enable"

show_automatic_script

string

Включить или отключить автоматический скрипт.

disable — отключить параметр скрипта.

enable — включить параметр скрипта.

Варианты:

  • "disable"
  • "enable"

show_checkbox_in_table

псевдонимы: show-checkbox-in-table

string

Показывать флажки в таблицах графического интерфейса.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

show_device_import_export

псевдонимы: show-device-import-export

string

Включить или отключить импорт и экспорт списков ADOM, устройств и групп.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

show_fct_manager

псевдонимы: show-fct-manager

string

Включить или отключить диспетчер FCT.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

show_grouping_script

string

Включить или отключить скрипт группировки.

disable — отключить параметр скрипта.

enable — включить параметр скрипта.

Варианты:

  • "disable"
  • "enable"

show_hostname

псевдонимы: show-hostname

string

Включить или отключить отображение имени хоста на странице входа в графический интерфейс.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

show_schedule_script

string

Включить или отключить скрипт расписания.

disable — отключить параметр скрипта.

enable — включить параметр скрипта.

Варианты:

  • "disable"
  • "enable"

show_sdwan_manager

псевдонимы: show-sdwan-manager

string

Показывать диспетчер sdwan.

Варианты:

  • "disable"
  • "enable"

show_tcl_script

string

Включить или отключить скрипт TCL.

disable — отключить параметр скрипта.

enable — включить параметр скрипта.

Варианты:

  • "disable"
  • "enable"

traffic_shaping_history

псевдонимы: traffic-shaping-history

string

Включить или отключить историю управления трафиком.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

unreg_dev_opt

string

Действие при подключении незарегистрированного устройства к FortiManager.

add_no_service — добавить незарегистрированные устройства, но отклонять запросы на обслуживание.

ignore — игнорировать незарегистрированные устройства.

add_allow_service — добавить незарегистрированные устройства и разрешить запросы на обслуживание.

Варианты:

  • "add_no_service"
  • "ignore"
  • "add_allow_service"

webadmin_language

string

Язык веб-интерфейса администратора.

auto_detect — автоматически определять язык.

english — английский.

simplified_chinese — упрощенный китайский.

traditional_chinese — традиционный китайский.

japanese — японский.

korean — корейский.

spanish — испанский.

Варианты:

  • "auto_detect"
  • "english"
  • "simplified_chinese"
  • "traditional_chinese"
  • "japanese"
  • "korean"
  • "spanish"
  • "french"

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая root.

workspace_locking_timeout

integer

Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем.

По умолчанию: 300

Примечания

Примечание

  • Начиная с версии 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: Admin setting.
      fortinet.fortimanager.fmgr_system_admin_setting:
        # workspace_locking_adom: <global or your adom name>
        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>
          # object_threshold_limit: <value in [disable, enable]>
          # object_threshold_limit_value: <integer>
          # rtm_max_monitor_by_size: <integer>
          # show_sdwan_manager: <value in [disable, enable]>
          # admin_scp: <value in [disable, enable]>

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=string

Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией FortiManager.

Возвращается: в сложных случаях

Авторы

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 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_system_admin_setting_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API