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 - 秋天 冬季 - 冬季 太空 - 太空 马蹄莲 - 马蹄莲 二进制隧道 - 二进制隧道 潜水 - 潜水 梦幻般的 - 梦幻般的 技术 - 技术 风景 - 风景 暮色 - 暮色 峡谷 - 峡谷 北极光 - 北极光 天文学 - 天文学 鱼 - 鱼 企鹅 - 企鹅 熊猫 - 熊猫 北极熊 - 北极熊 鹦鹉 - 鹦鹉 洞穴 - 洞穴 选项
|
|
HTTP端口。 |
|
HTTPS端口。 |
|
空闲超时 |
|
API会话的空闲超时 |
|
GUI会话的空闲超时 |
|
SSO会话的空闲超时 |
|
仅允许安装接口策略。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
FGFM使用的FortiManager的IP地址。 |
|
FGFM使用的FortiManager的FQDN。 |
|
启用/禁用已使用的对象的强制删除。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
启用/禁用离线模式。 disable - 禁用离线模式。 enable - 启用离线模式。 选项
|
|
FGFM连接的首选接口。 |
|
(列表) 注册设备的密码。 |
|
最大RTM监控天数 |
|
按小时设置RTM监控临时文件限制。 |
|
启用/禁用在GUI登录页面显示主机名。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
跳过未映射的SDWAN/规则/输入设备接口，而不是报告映射错误。 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，值可以是全局的和其他包括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响应的描述性消息。 返回：始终 示例： |
|
目标系统的信息。 返回：始终 |
|
请求的状态。 返回：始终 示例： |
|
如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。 返回：复杂类型 |