fortinet.fortimanager.fmgr_system_admin_setting 模块 – 管理设置。
注意
此模块是 fortinet.fortimanager 集合（版本 2.8.2）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。
要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_system_admin_setting。
在 fortinet.fortimanager 2.0.0 中新增
概要
此模块能够配置 FortiManager 设备。
示例包括在使用前需要调整到数据源的所有参数和值。
参数
参数 |
注释 |
|---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而不验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
使用 forticloud API 访问令牌验证 Ansible 客户端。 |
|
底层 Json RPC 请求的覆盖方法。 选项
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
设置的顶级参数。 |
|
启用/禁用访问横幅。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
启用/禁用将 HTTP 管理流量重定向到 HTTPS。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
一次登录的最大管理员用户数 |
|
HTTPS 和 Web 服务服务器证书。 |
|
启用/禁用允许注册未注册设备。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
FGT 用于授权 FMG 的 IP。 |
|
FGT 用于授权 FMG 的端口。 |
|
启用/禁用 FortiGate 自动更新。 disable - 禁用设备自动更新。 enable - 启用设备自动更新。 选项
|
|
横幅消息。 |
|
中央 FortiGuard 本地类别 ID 管理，并且在安装期间不自动分配 ID。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
启用或禁用机箱管理。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
机箱后台更新间隔 |
|
启用/禁用设备同步状态指示。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
启用/禁用 FortiGate GUI 代理。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
FortiGate GUI 代理端口。 |
|
启用/禁用固件升级检查。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
启用/禁用 FortiSwitch Manager 交换机平台支持检查。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
用于管理 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 - 山洞 选项
|
|
HTTP 端口。 |
|
HTTPS 端口。 |
|
空闲超时 |
|
API 会话的空闲超时 |
|
GUI 会话的空闲超时 |
|
SSO 会话的空闲超时 |
|
仅允许安装接口策略。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
FGFM 使用的 FortiManager 的 IP。 |
|
FGFM 使用的 FortiManager 的 FQDN。 |
|
启用/禁用强制删除已使用的对象。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
启用/禁用离线模式。 disable - 禁用离线模式。 enable - 启用离线模式。 选项
|
|
FGFM 连接的首选接口。 |
|
(列表) 用于注册设备的密码。 |
|
最大 rtm 监控天数 |
|
设置 rtm 监控临时文件限制（小时）。 |
|
在 GUI 登录页面启用/禁用主机名显示。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
对于 sdwan/rule/input-device 跳过未映射的接口，而不是报告映射错误。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
启用/禁用 shell 访问。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
(列表) 用于 shell 访问的密码。 |
|
显示“添加多个”按钮。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
在 GUI 上显示 ADOM 设备管理器工具。 disable - 在 GUI 上隐藏设备管理器工具。 enable - 在 GUI 上显示设备管理器工具。 选项
|
|
启用/禁用自动脚本。 disable - 禁用脚本选项。 enable - 启用脚本选项。 选项
|
|
在 GUI 上的表格中显示复选框。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
启用/禁用 ADOM、设备和组列表的导入/导出。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
启用/禁用 FCT 管理器。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
启用/禁用分组脚本。 disable - 禁用脚本选项。 enable - 启用脚本选项。 选项
|
|
在 GUI 登录页面启用/禁用主机名显示。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
启用或禁用计划脚本。 disable - 禁用脚本选项。 enable - 启用脚本选项。 选项
|
|
启用/禁用 TCL 脚本。 disable - 禁用脚本选项。 enable - 启用脚本选项。 选项
|
|
启用/禁用流量整形历史记录。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
当未注册的设备连接到 FortiManager 时采取的操作。 add_no_service - 添加未注册的设备，但拒绝服务请求。 ignore - 忽略未注册的设备。 add_allow_service - 添加未注册的设备并允许服务请求。 选项
|
|
Web 管理语言。 auto_detect - 自动检测语言。 english - 英语。 simplified_chinese - 简体中文。 traditional_chinese - 繁体中文。 japanese - 日语。 korean - 韩语。 spanish - 西班牙语。 选项
|
|
在工作区模式下运行的 FortiManager 要锁定的 ADOM，该值可以是 global 和其他值，包括 root。 |
|
等待其他用户释放工作区锁定的最长时间（秒）。 默认值: |
说明
注意
从 2.4.0 版本开始，所有输入参数都使用下划线命名约定 (snake_case) 命名。请将 “var-name” 等参数更改为 “var_name”。旧的参数名称仍然可用，但您将收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。
此 FortiManager 模块支持在工作区锁定模式下运行，顶层参数 workspace_locking_adom 和 workspace_locking_timeout 帮助完成这项工作。
通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件
示例
- 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>
返回值
常见的返回值记录在此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
请求的结果。 返回: 总是 |
|
请求的完整 URL。 返回: 总是 示例: |
|
API 请求的状态。 返回: 总是 示例: |
|
API 响应。 返回: 总是 |
|
API 响应的描述性消息。 返回: 总是 示例: |
|
目标系统的信息。 返回: 总是 |
|
请求的状态。 返回: 总是 示例: |
|
如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回: 复杂 |