fortinet.fortimanager.fmgr_system_admin_profile 模块 – 管理员配置文件。

注意

此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。

如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。

要在剧本中使用它，请指定：fortinet.fortimanager.fmgr_system_admin_profile。

fortinet.fortimanager 2.0.0 中的新增功能

概要

• 此模块能够配置 FortiManager 设备。

• 示例包含所有参数和值，在使用前需要根据数据源进行调整。

参数

参数	注释
access_token 字符串	无需用户名和密码即可访问 FortiManager 的令牌。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项 false ← (默认) true
enable_log 布尔值	启用/禁用任务的日志记录。 选项 false ← (默认) true
forticloud_access_token 字符串	使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。
proposed_method 字符串	底层 Json RPC 请求的覆盖方法。 选项 "update" "set" "add"
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
state 字符串 / 必需	创建、更新或删除对象的指令。 选项 "present" "absent"
system_admin_profile 字典	设置的顶级参数。
adom_admin 别名：adom-admin 字符串	启用 ADOM 管理员。 disable - 禁用设置。 enable - 启用设置。 选项 "disable" "enable"
adom_lock 别名：adom-lock 字符串	ADOM 锁定 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
adom_policy_packages 别名：adom-policy-packages 字符串	ADOM 策略包。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
adom_switch 别名：adom-switch 字符串	管理员域。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
allow_to_install 别名：allow-to-install 字符串	启用/禁用受限用户将对象安装到设备。 disable - 禁用设置。 enable - 启用设置。 选项 "disable" "enable"
app_filter 别名：app-filter 字符串	应用程序过滤器。 disable - 禁用设置。 enable - 启用设置。 选项 "disable" "enable"
assignment 字符串	分配权限。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
change_password 别名：change-password 字符串	启用/禁用受限用户更改自身密码。 disable - 禁用设置。 enable - 启用设置。 选项 "disable" "enable"
config_retrieve 别名：config-retrieve 字符串	配置检索。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
config_revert 别名：config-revert 字符串	从修订历史记录中恢复配置 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
consistency_check 别名：consistency-check 字符串	一致性检查。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
datamask 字符串	启用/禁用数据屏蔽。 disable - 禁用数据屏蔽。 enable - 启用数据屏蔽。 选项 "disable" "enable"
datamask_custom_fields 别名：datamask-custom-fields 列表 / 元素=字典	数据屏蔽自定义字段。
field_category 别名：field-category 列表 / 元素=字符串	字段类别。 log - 日志。 fortiview - FortiView。 alert - 事件管理。 ueba - UEBA。 all - 全部。 选项 "log" "fortiview" "alert" "ueba" "all"
field_name 别名：field-name 字符串	字段名称。
field_status 别名：field-status 字符串	字段状态。 disable - 禁用字段。 enable - 启用字段。 选项 "disable" "enable"
field_type 别名：field-type 字符串	字段类型。 string - 字符串。 ip - IP 地址。 mac - MAC 地址。 email - 电子邮件地址。 unknown - 未知。 选项 "string" "ip" "mac" "email" "unknown"
datamask_custom_priority 别名：datamask-custom-priority 字符串	优先考虑自定义字段。 disable - 禁用自定义字段搜索优先级。 enable - 启用自定义字段搜索优先级。 选项 "disable" "enable"
datamask_fields 别名：datamask-fields 列表 / 元素=字符串	数据屏蔽字段。 user - 用户名。 srcip - 源 IP。 srcname - 源名称。 srcmac - 源 MAC。 dstip - 目标 IP。 dstname - 目标名称。 email - 电子邮件。 message - 消息。 domain - 域名。 选项 "user" "srcip" "srcname" "srcmac" "dstip" "dstname" "email" "message" "domain"
datamask_key 别名：datamask-key 任意	(列表) 数据屏蔽加密密钥。
datamask_unmasked_time 别名: datamask-unmasked-time 整数	数据脱敏失效时间（天）。
deploy_management 别名: deploy-management 字符串	安装到设备。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
描述 字符串	描述。
device_ap 别名: device-ap 字符串	管理AP。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
device_config 别名: device-config 字符串	管理设备配置。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
device_forticlient 别名: device-forticlient 字符串	管理FortiClient。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
device_fortiextender 别名: device-fortiextender 字符串	管理FortiExtender。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
device_fortiswitch 别名: device-fortiswitch 字符串	管理FortiSwitch。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
device_manager 别名: device-manager 字符串	设备管理器。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
device_op 别名: device-op 字符串	设备添加/删除/编辑。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
device_policy_package_lock 别名: device-policy-package-lock 字符串	设备/策略包锁定 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
device_profile 别名: device-profile 字符串	设备配置文件权限。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
device_revision_deletion 别名: device-revision-deletion 字符串	删除设备版本。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
device_wan_link_load_balance 别名: device-wan-link-load-balance 字符串	管理WAN链路负载均衡。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
event_management 别名: event-management 字符串	事件管理。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
extension_access 别名: extension-access 字符串	管理扩展访问。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
fabric_viewer 别名: fabric-viewer 字符串	Fabric查看器。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
fgd_center 字符串	FortiGuard中心。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
fgd_center_advanced 别名: fgd-center-advanced 字符串	FortiGuard高级中心。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
fgd_center_fmw_mgmt 别名: fgd-center-fmw-mgmt 字符串	FortiGuard中心固件管理。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
fgd_center_licensing 别名: fgd-center-licensing 字符串	FortiGuard中心许可证管理。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
fgt_gui_proxy 别名: fgt-gui-proxy 字符串	FortiGate GUI代理。 disable - 无权限。 enable - 有权限。 选项 "disable" "enable"
global_policy_packages 别名: global-policy-packages 字符串	全局策略包。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
import_policy_packages 别名: import-policy-packages 字符串	导入策略包。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
intf_mapping 别名: intf-mapping 字符串	接口映射 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
ips_baseline_cfg 别名: ips-baseline-cfg 字符串	IPS基线传感器配置。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
ips_baseline_ovrd 别名: ips-baseline-ovrd 字符串	启用/禁用覆盖基线IPS传感器。 disable - 禁用设置。 enable - 启用设置。 选项 "disable" "enable"
ips_filter 别名: ips-filter 字符串	IPS过滤器。 disable - 禁用设置。 enable - 启用设置。 选项 "disable" "enable"
ips_lock 别名: ips-lock 字符串	IPS锁定 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
ips_objects 别名: ips-objects 字符串	IPS对象配置。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
ipv6_trusthost1 字符串	管理员用户信任主机IPv6地址，默认值
ipv6_trusthost10 字符串	管理员用户信任主机IPv6地址，默认值 ffff
ipv6_trusthost2 字符串	管理员用户信任主机IPv6地址，默认值 ffff
ipv6_trusthost3 字符串	管理员用户信任主机IPv6地址，默认值 ffff
ipv6_trusthost4 字符串	管理员用户信任主机IPv6地址，默认值 ffff
ipv6_trusthost5 字符串	管理员用户信任主机IPv6地址，默认值 ffff
ipv6_trusthost6 字符串	管理员用户信任主机IPv6地址，默认值 ffff
ipv6_trusthost7 字符串	管理员用户信任主机IPv6地址，默认值 ffff
ipv6_trusthost8 字符串	管理员用户信任主机IPv6地址，默认值 ffff
ipv6_trusthost9 字符串	管理员用户信任主机IPv6地址，默认值 ffff
log_viewer 别名: log-viewer 字符串	日志查看器。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
policy_ips_attrs 别名: policy-ips-attrs 字符串	策略IPS属性配置。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
policy_objects 别名: policy-objects 字符串	策略对象权限。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
profileid 字符串 / 必需	配置文件ID。
read_passwd 别名: read-passwd 字符串	以明文查看密码。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
realtime_monitor 别名: realtime-monitor 字符串	实时监控。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
report_viewer 别名: report-viewer 字符串	报表查看器。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
rpc_permit 别名: rpc-permit 字符串	设置无/读/读写RPC权限 read-write - 读写权限。 none - 无权限。 read - 只读权限。 选项 "read-write" "none" "read"
run_report 别名: run-report 字符串	运行报表。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
scope 字符串	范围。 global - 全局范围。 adom - ADOM范围。 选项 "global" "adom"
script_access 别名: script-access 字符串	脚本访问。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
set_install_targets 别名: set-install-targets 字符串	编辑安装目标。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
super_user_profile 别名: super-user-profile 字符串	启用/禁用超级用户配置文件 disable - 禁用超级用户配置文件 enable - 启用超级用户配置文件 选项 "disable" "enable"
system_setting 别名: system-setting 字符串	系统设置。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
term_access 别名: term-access 字符串	终端访问。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
triage_events 别名: triage-events 字符串	分类事件。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
trusthost1 字符串	管理员用户信任主机IP，默认值0。
trusthost10 字符串	管理员用户信任主机IP，默认值255。
trusthost2 字符串	管理员用户信任主机IP，默认值255。
trusthost3 字符串	管理员用户信任主机IP，默认值255。
trusthost4 字符串	管理员用户信任主机IP，默认值255。
trusthost5 字符串	管理员用户信任主机IP，默认值255。
trusthost6 字符串	管理员用户信任主机IP，默认值255。
trusthost7 字符串	管理员用户信任主机IP，默认值255。
trusthost8 字符串	管理员用户信任主机IP，默认值255。
trusthost9 字符串	管理员用户信任主机IP，默认值255。
type 字符串	配置文件类型。 system - 系统管理员。 restricted - 受限管理员。 选项 "system" "restricted"
update_incidents 别名: update-incidents 字符串	创建/更新事件。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
vpn_manager 别名: vpn-manager 字符串	VPN管理器。 none - 无权限。 read - 读取权限。 read-write - 读写权限。 选项 "none" "read" "read-write"
web_filter 别名: web-filter 字符串	Web过滤器。 disable - 禁用设置。 enable - 启用设置。 选项 "disable" "enable"
write_passwd_access 别名: write-passwd-access 字符串	设置所有/按用户指定/按配置文件指定写入密码访问模式。 all - 除超级用户外所有用户。 specify-by-user - 按用户指定。 specify-by-profile - 按配置文件指定。 选项 "all" "specify-by-user" "specify-by-profile"
write_passwd_profiles 别名: write-passwd-profiles 列表 / 元素=字典	写入密码配置文件。
profileid 字符串	配置文件ID。
write_passwd_user_list 别名: write-passwd-user-list 列表 / 元素=字典	写入密码用户列表。
userid 字符串	用户ID。
workspace_locking_adom 字符串	在工作区模式下运行FortiManager时要锁定的ADOM，值可以是global和其他包括root。
workspace_locking_timeout 整数	等待其他用户释放工作区锁的最大时间（秒）。 默认值: 300

注释

注意

• 从2.4.0版本开始，所有输入参数都使用下划线命名约定（snake_case）。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您将收到弃用警告。您可以在ansible.cfg中设置deprecation_warnings=False来忽略此警告。

• 此FortiManager模块支持在工作区锁定模式下运行，顶级参数workspace_locking_adom和workspace_locking_timeout有助于完成此工作。

• 要创建或更新对象，请使用state present指令。

• 要删除对象，请使用state absent指令。

• 通常，当返回非零rc时，运行一个模块可能会失败。您还可以使用参数rc_failed和rc_succeeded来覆盖失败或成功的条件。

示例

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Admin profile.
      fortinet.fortimanager.fmgr_system_admin_profile:
        bypass_validation: false
        state: present
        system_admin_profile:
          description: ansible-test-description
          profileid: ansible-test-profile
          scope: adom # <value in [global, adom]>
          type: system # <value in [system, restricted]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the admin profiles
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_admin_profile"
          params:
            profile: "your_value"

返回值

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
meta 字典	请求的结果。 返回: 始终
request_url 字符串	请求的完整URL。 返回: 始终 示例: "/sys/login/user"
response_code 整数	API请求的状态。 返回: 始终 示例: 0
response_data 列表 / 元素=字符串	API响应。 返回: 始终
response_message 字符串	API响应的描述性消息。 返回: 始终 示例: "OK."
system_information 字典	目标系统的详细信息。 返回: 始终
rc 整数	请求的状态。 返回: 始终 示例: 0
version_check_warning 列表 / 元素=字符串	如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。 返回: 复杂类型

作者

• 杜欣伟 (@dux-fortinet)

• 李兴 (@lix-fortinet)

• 薛杰 (@JieX19)

• 郑琳 (@chillancezen)

• 沈方 (@fshen01)

• 卢洪斌 (@fgtdev-hblu)

相关链接

• 问题追踪器
• 主页
• 代码仓库