fortinet.fortimanager.fmgr_system_admin_setting module – Admin setting.
Note
This module is part of the fortinet.fortimanager collection (version 2.4.0).
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 |
|---|---|
The token to access FortiManager without using username and password. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The top level parameters set. |
|
Deprecated, please rename it to access_banner. Enable/disable access banner. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to admin_https_redirect. Enable/disable redirection of HTTP admin traffic to HTTPS. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to admin_login_max. Maximum number admin users logged in at one time |
|
HTTPS & Web Service server certificate. |
|
Enable/disable allowance of register an unregistered device. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to auth_addr. IP which is used by FGT to authorize FMG. |
|
Deprecated, please rename it to auth_port. Port which is used by FGT to authorize FMG. |
|
Deprecated, please rename it to auto_update. Enable/disable FortiGate automatic update. disable - Disable device automatic update. enable - Enable device automatic update. Choices:
|
|
Deprecated, please rename it to banner_message. Banner message. |
|
Deprecated, please rename it to central_ftgd_local_cat_id. Central FortiGuard local category id management, and do not auto assign id during installation. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to chassis_mgmt. Enable or disable chassis management. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to chassis_update_interval. Chassis background update interval |
|
Enable/disable device synchronization status indication. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to fgt_gui_proxy. Enable/disable FortiGate GUI proxy. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to fgt_gui_proxy_port. FortiGate GUI proxy port. |
|
Deprecated, please rename it to firmware_upgrade_check. Enable/disable firmware upgrade check. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to fsw_ignore_platform_check. Enable/disable FortiSwitch Manager switch platform support check. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to gui_theme. 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:
|
|
HTTP port. |
|
HTTPS port. |
|
Idle timeout |
|
Idle timeout for API sessions |
|
Idle timeout for GUI sessions |
|
Idle timeout for SSO sessions |
|
Deprecated, please rename it to install_ifpolicy_only. Allow install interface policy only. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to mgmt_addr. IP of FortiManager used by FGFM. |
|
Deprecated, please rename it to mgmt_fqdn. FQDN of FortiManager used by FGFM. |
|
Deprecated, please rename it to objects_force_deletion. Enable/disable used objects force deletion. disable - Disable setting. enable - Enable setting. Choices:
|
|
Enable/disable offline mode. disable - Disable offline mode. enable - Enable offline mode. Choices:
|
|
Deprecated, please rename it to preferred_fgfm_intf. Preferred interface for FGFM connection. |
|
(list) Password for register a device. |
|
Deprecated, please rename it to rtm_max_monitor_by_days. Maximum rtm monitor |
|
Deprecated, please rename it to rtm_temp_file_limit. Set rtm monitor temp file limit by hours. |
|
Deprecated, please rename it to sdwan_monitor_history. Enable/disable hostname display in the GUI login page. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to sdwan_skip_unmapped_input_device. Skip unmapped interface for sdwan/rule/input-device instead of report mapping error. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to shell_access. Enable/disable shell access. disable - Disable setting. enable - Enable setting. Choices:
|
|
(list) Deprecated, please rename it to shell_password. Password for shell access. |
|
Deprecated, please rename it to show_add_multiple. Show add multiple button. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to show_adom_devman. Show ADOM device manager tools on GUI. disable - Hide device manager tools on GUI. enable - Show device manager tools on GUI. Choices:
|
|
Deprecated, please rename it to show_checkbox_in_table. Show checkboxs in tables on GUI. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to show_device_import_export. Enable/disable import/export of ADOM, device, and group lists. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to show_fct_manager. Enable/disable FCT manager. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to show_hostname. Enable/disable hostname display in the GUI login page. disable - Disable setting. enable - Enable setting. Choices:
|
|
Enable/disable automatic script. disable - Disable script option. enable - Enable script option. Choices:
|
|
Enable/disable grouping script. disable - Disable script option. enable - Enable script option. Choices:
|
|
Enable or disable schedule script. disable - Disable script option. enable - Enable script option. Choices:
|
|
Enable/disable TCL script. disable - Disable script option. enable - Enable script option. Choices:
|
|
Deprecated, please rename it to traffic_shaping_history. Enable/disable traffic-shaping-history. disable - Disable setting. enable - Enable setting. Choices:
|
|
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:
|
|
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:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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 |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |