Try SpotterAdmin setting.
| "added in version" 2.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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>
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
system_admin_setting:
description: The top level parameters set.
required: false
suboptions:
access-banner:
choices:
- disable
- enable
description:
- Deprecated, please rename it to access_banner.
- Enable/disable access banner.
- disable - Disable setting.
- enable - Enable setting.
type: str
admin-https-redirect:
choices:
- disable
- enable
description:
- Deprecated, please rename it to admin_https_redirect.
- Enable/disable redirection of HTTP admin traffic to HTTPS.
- disable - Disable setting.
- enable - Enable setting.
type: str
admin-login-max:
description: Deprecated, please rename it to admin_login_max. Maximum number admin
users logged in at one time
type: int
admin_server_cert:
description: HTTPS & Web Service server certificate.
type: str
allow_register:
choices:
- disable
- enable
description:
- Enable/disable allowance of register an unregistered device.
- disable - Disable setting.
- enable - Enable setting.
type: str
auth-addr:
description: Deprecated, please rename it to auth_addr. IP which is used by FGT
to authorize FMG.
type: str
auth-port:
description: Deprecated, please rename it to auth_port. Port which is used by
FGT to authorize FMG.
type: int
auto-update:
choices:
- disable
- enable
description:
- Deprecated, please rename it to auto_update.
- Enable/disable FortiGate automatic update.
- disable - Disable device automatic update.
- enable - Enable device automatic update.
type: str
banner-message:
description: Deprecated, please rename it to banner_message. Banner message.
type: str
central-ftgd-local-cat-id:
choices:
- disable
- enable
description:
- 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.
type: str
chassis-mgmt:
choices:
- disable
- enable
description:
- Deprecated, please rename it to chassis_mgmt.
- Enable or disable chassis management.
- disable - Disable setting.
- enable - Enable setting.
type: str
chassis-update-interval:
description: Deprecated, please rename it to chassis_update_interval. Chassis
background update interval
type: int
device_sync_status:
choices:
- disable
- enable
description:
- Enable/disable device synchronization status indication.
- disable - Disable setting.
- enable - Enable setting.
type: str
fgt-gui-proxy:
choices:
- disable
- enable
description:
- Deprecated, please rename it to fgt_gui_proxy.
- Enable/disable FortiGate GUI proxy.
- disable - Disable setting.
- enable - Enable setting.
type: str
fgt-gui-proxy-port:
description: Deprecated, please rename it to fgt_gui_proxy_port. FortiGate GUI
proxy port.
type: int
firmware-upgrade-check:
choices:
- disable
- enable
description:
- Deprecated, please rename it to firmware_upgrade_check.
- Enable/disable firmware upgrade check.
- disable - Disable setting.
- enable - Enable setting.
type: str
fsw-ignore-platform-check:
choices:
- disable
- enable
description:
- Deprecated, please rename it to fsw_ignore_platform_check.
- Enable/disable FortiSwitch Manager switch platform support check.
- disable - Disable setting.
- enable - Enable setting.
type: str
gui-theme:
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
description:
- 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
type: str
http_port:
description: HTTP port.
type: int
https_port:
description: HTTPS port.
type: int
idle_timeout:
description: Idle timeout
type: int
idle_timeout_api:
description: Idle timeout for API sessions
type: int
idle_timeout_gui:
description: Idle timeout for GUI sessions
type: int
idle_timeout_sso:
description: Idle timeout for SSO sessions
type: int
install-ifpolicy-only:
choices:
- disable
- enable
description:
- Deprecated, please rename it to install_ifpolicy_only.
- Allow install interface policy only.
- disable - Disable setting.
- enable - Enable setting.
type: str
mgmt-addr:
description: Deprecated, please rename it to mgmt_addr. IP of FortiManager used
by FGFM.
type: str
mgmt-fqdn:
description: Deprecated, please rename it to mgmt_fqdn. FQDN of FortiManager used
by FGFM.
type: str
objects-force-deletion:
choices:
- disable
- enable
description:
- Deprecated, please rename it to objects_force_deletion.
- Enable/disable used objects force deletion.
- disable - Disable setting.
- enable - Enable setting.
type: str
offline_mode:
choices:
- disable
- enable
description:
- Enable/disable offline mode.
- disable - Disable offline mode.
- enable - Enable offline mode.
type: str
preferred-fgfm-intf:
description: Deprecated, please rename it to preferred_fgfm_intf. Preferred interface
for FGFM connection.
type: str
register_passwd:
description: (list) Password for register a device.
type: raw
rtm-max-monitor-by-days:
description: Deprecated, please rename it to rtm_max_monitor_by_days. Maximum
rtm monitor
type: int
rtm-temp-file-limit:
description: Deprecated, please rename it to rtm_temp_file_limit. Set rtm monitor
temp file limit by hours.
type: int
sdwan-monitor-history:
choices:
- disable
- enable
description:
- Deprecated, please rename it to sdwan_monitor_history.
- Enable/disable hostname display in the GUI login page.
- disable - Disable setting.
- enable - Enable setting.
type: str
sdwan-skip-unmapped-input-device:
choices:
- disable
- enable
description:
- 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.
type: str
shell-access:
choices:
- disable
- enable
description:
- Deprecated, please rename it to shell_access.
- Enable/disable shell access.
- disable - Disable setting.
- enable - Enable setting.
type: str
shell-password:
description: (list) Deprecated, please rename it to shell_password. Password for
shell access.
type: raw
show-add-multiple:
choices:
- disable
- enable
description:
- Deprecated, please rename it to show_add_multiple.
- Show add multiple button.
- disable - Disable setting.
- enable - Enable setting.
type: str
show-adom-devman:
choices:
- disable
- enable
description:
- 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.
type: str
show-checkbox-in-table:
choices:
- disable
- enable
description:
- Deprecated, please rename it to show_checkbox_in_table.
- Show checkboxs in tables on GUI.
- disable - Disable setting.
- enable - Enable setting.
type: str
show-device-import-export:
choices:
- disable
- enable
description:
- 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.
type: str
show-fct-manager:
choices:
- disable
- enable
description:
- Deprecated, please rename it to show_fct_manager.
- Enable/disable FCT manager.
- disable - Disable setting.
- enable - Enable setting.
type: str
show-hostname:
choices:
- disable
- enable
description:
- Deprecated, please rename it to show_hostname.
- Enable/disable hostname display in the GUI login page.
- disable - Disable setting.
- enable - Enable setting.
type: str
show_automatic_script:
choices:
- disable
- enable
description:
- Enable/disable automatic script.
- disable - Disable script option.
- enable - Enable script option.
type: str
show_grouping_script:
choices:
- disable
- enable
description:
- Enable/disable grouping script.
- disable - Disable script option.
- enable - Enable script option.
type: str
show_schedule_script:
choices:
- disable
- enable
description:
- Enable or disable schedule script.
- disable - Disable script option.
- enable - Enable script option.
type: str
show_tcl_script:
choices:
- disable
- enable
description:
- Enable/disable TCL script.
- disable - Disable script option.
- enable - Enable script option.
type: str
traffic-shaping-history:
choices:
- disable
- enable
description:
- Deprecated, please rename it to traffic_shaping_history.
- Enable/disable traffic-shaping-history.
- disable - Disable setting.
- enable - Enable setting.
type: str
unreg_dev_opt:
choices:
- add_no_service
- ignore
- add_allow_service
description:
- 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.
type: str
webadmin_language:
choices:
- auto_detect
- english
- simplified_chinese
- traditional_chinese
- japanese
- korean
- spanish
- french
description:
- Web admin language.
- auto_detect - Automatically detect language.
- english - English.
- simplified_chinese - Simplified Chinese.
- traditional_chinese - Traditional Chinese.
- japanese - Japanese.
- korean - Korean.
- spanish - Spanish.
type: str
type: dict
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list