fortinet.fortimanager.fmgr_system_admin_setting module – Admin setting.

Note

This module is part of the fortinet.fortimanager collection (version 2.8.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_admin_setting.

New in fortinet.fortimanager 2.0.0

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

system_admin_setting

dictionary

The top level parameters set.

access_banner

aliases: access-banner

string

Enable/disable access banner.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

admin_https_redirect

aliases: admin-https-redirect

string

Enable/disable redirection of HTTP admin traffic to HTTPS.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

admin_login_max

aliases: admin-login-max

integer

Maximum number admin users logged in at one time

admin_server_cert

string

HTTPS & Web Service server certificate.

allow_register

string

Enable/disable allowance of register an unregistered device.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

auth_addr

aliases: auth-addr

string

IP which is used by FGT to authorize FMG.

auth_port

aliases: auth-port

integer

Port which is used by FGT to authorize FMG.

auto_update

aliases: auto-update

string

Enable/disable FortiGate automatic update.

disable - Disable device automatic update.

enable - Enable device automatic update.

Choices:

  • "disable"

  • "enable"

banner_message

aliases: banner-message

string

Banner message.

central_ftgd_local_cat_id

aliases: central-ftgd-local-cat-id

string

Central FortiGuard local category id management, and do not auto assign id during installation.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

chassis_mgmt

aliases: chassis-mgmt

string

Enable or disable chassis management.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

chassis_update_interval

aliases: chassis-update-interval

integer

Chassis background update interval

device_sync_status

string

Enable/disable device synchronization status indication.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

fgt_gui_proxy

aliases: fgt-gui-proxy

string

Enable/disable FortiGate GUI proxy.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

fgt_gui_proxy_port

aliases: fgt-gui-proxy-port

integer

FortiGate GUI proxy port.

firmware_upgrade_check

aliases: firmware-upgrade-check

string

Enable/disable firmware upgrade check.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

fsw_ignore_platform_check

aliases: fsw-ignore-platform-check

string

Enable/disable FortiSwitch Manager switch platform support check.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

gui_theme

aliases: gui-theme

string

Color scheme to use for the administration GUI.

blue - Blueberry

green - Kiwi

red - Cherry

melongene - Plum

spring - Spring

summer - Summer

autumn - Autumn

winter - Winter

space - Space

calla-lily - Calla Lily

binary-tunnel - Binary Tunnel

diving - Diving

dreamy - Dreamy

technology - Technology

landscape - Landscape

twilight - Twilight

canyon - Canyon

northern-light - Northern Light

astronomy - Astronomy

fish - Fish

penguin - Penguin

panda - Panda

polar-bear - Polar Bear

parrot - Parrot

cave - Cave

Choices:

  • "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 port.

https_port

integer

HTTPS port.

idle_timeout

integer

Idle timeout

idle_timeout_api

integer

Idle timeout for API sessions

idle_timeout_gui

integer

Idle timeout for GUI sessions

idle_timeout_sso

integer

Idle timeout for SSO sessions

install_ifpolicy_only

aliases: install-ifpolicy-only

string

Allow install interface policy only.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

mgmt_addr

aliases: mgmt-addr

string

IP of FortiManager used by FGFM.

mgmt_fqdn

aliases: mgmt-fqdn

string

FQDN of FortiManager used by FGFM.

objects_force_deletion

aliases: objects-force-deletion

string

Enable/disable used objects force deletion.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

offline_mode

string

Enable/disable offline mode.

disable - Disable offline mode.

enable - Enable offline mode.

Choices:

  • "disable"

  • "enable"

preferred_fgfm_intf

aliases: preferred-fgfm-intf

string

Preferred interface for FGFM connection.

register_passwd

any

(list) Password for register a device.

rtm_max_monitor_by_days

aliases: rtm-max-monitor-by-days

integer

Maximum rtm monitor

rtm_temp_file_limit

aliases: rtm-temp-file-limit

integer

Set rtm monitor temp file limit by hours.

sdwan_monitor_history

aliases: sdwan-monitor-history

string

Enable/disable hostname display in the GUI login page.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

sdwan_skip_unmapped_input_device

aliases: sdwan-skip-unmapped-input-device

string

Skip unmapped interface for sdwan/rule/input-device instead of report mapping error.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

shell_access

aliases: shell-access

string

Enable/disable shell access.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

shell_password

aliases: shell-password

any

(list) Password for shell access.

show_add_multiple

aliases: show-add-multiple

string

Show add multiple button.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

show_adom_devman

aliases: show-adom-devman

string

Show ADOM device manager tools on GUI.

disable - Hide device manager tools on GUI.

enable - Show device manager tools on GUI.

Choices:

  • "disable"

  • "enable"

show_automatic_script

string

Enable/disable automatic script.

disable - Disable script option.

enable - Enable script option.

Choices:

  • "disable"

  • "enable"

show_checkbox_in_table

aliases: show-checkbox-in-table

string

Show checkboxs in tables on GUI.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

show_device_import_export

aliases: show-device-import-export

string

Enable/disable import/export of ADOM, device, and group lists.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

show_fct_manager

aliases: show-fct-manager

string

Enable/disable FCT manager.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

show_grouping_script

string

Enable/disable grouping script.

disable - Disable script option.

enable - Enable script option.

Choices:

  • "disable"

  • "enable"

show_hostname

aliases: show-hostname

string

Enable/disable hostname display in the GUI login page.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

show_schedule_script

string

Enable or disable schedule script.

disable - Disable script option.

enable - Enable script option.

Choices:

  • "disable"

  • "enable"

show_tcl_script

string

Enable/disable TCL script.

disable - Disable script option.

enable - Enable script option.

Choices:

  • "disable"

  • "enable"

traffic_shaping_history

aliases: traffic-shaping-history

string

Enable/disable traffic-shaping-history.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

unreg_dev_opt

string

Action to take when unregistered device connects to FortiManager.

add_no_service - Add unregistered devices but deny service requests.

ignore - Ignore unregistered devices.

add_allow_service - Add unregistered devices and allow service requests.

Choices:

  • "add_no_service"

  • "ignore"

  • "add_allow_service"

webadmin_language

string

Web admin language.

auto_detect - Automatically detect language.

english - English.

simplified_chinese - Simplified Chinese.

traditional_chinese - Traditional Chinese.

japanese - Japanese.

korean - Korean.

spanish - Spanish.

Choices:

  • "auto_detect"

  • "english"

  • "simplified_chinese"

  • "traditional_chinese"

  • "japanese"

  • "korean"

  • "spanish"

  • "french"

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- 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>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)