fortinet.fortios.fortios_system_sso_admin 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 SSO 管理员用户。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_system_sso_admin。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改系统功能和 sso_admin 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数，并且在使用前需要将值调整为数据源。在 FOS v6.0.0 上测试。

要求

执行此模块的主机需要以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 FortiGate 的 GUI 生成。

enable_log

布尔值

启用/禁用任务的日志记录。

选项

  • false ← (默认)

  • true

member_path

字符串

要操作的成员属性路径。

如果有多个属性，则用斜杠字符分隔。

标有 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

指定 member_state 时，将忽略 state 选项。

选项

  • "present"

  • "absent"

state

字符串 / 必需

指示是创建还是删除对象。

选项

  • "present"

  • "absent"

system_sso_admin

字典

配置 SSO 管理员用户。

accprofile

字符串

SSO 管理员用户访问配置文件。来源 system.accprofile.name。

gui_dashboard

列表 / 元素=字典

GUI 仪表盘。

columns

整数

列数。

id

整数 / 必需

仪表盘 ID。参见 注释。

layout_type

字符串

布局类型。

选项

  • "responsive"

  • "fixed"

name

字符串

仪表盘名称。

permanent

字符串

永久仪表盘（无法通过 GUI 删除）。

选项

  • "disable"

  • "enable"

vdom

字符串

虚拟域。来源 system.vdom.name。

widget

列表 / 元素=字典

仪表盘小部件。

fabric_device

字符串

要监控的 Fabric 设备。

fabric_device_widget_name

字符串

Fabric 设备小部件名称。

fabric_device_widget_visualization_type

字符串

Fabric 设备小部件的可视化类型。

fortiview_device

字符串

FortiView 设备。

fortiview_filters

列表 / 元素=字典

FortiView 过滤器。

id

整数 / 必需

FortiView 过滤器 ID。参见 注释。

key

字符串

过滤器键。

value

字符串

过滤器值。

fortiview_sort_by

字符串

FortiView 排序依据。

fortiview_timeframe

字符串

FortiView 时间范围。

fortiview_type

字符串

FortiView 类型。

fortiview_visualization

字符串

FortiView 可视化。

height

整数

高度。

id

整数 / 必需

小部件 ID。参见 注释。

industry

字符串

安全审计评级行业。

选项

  • "default"

  • "custom"

interface

字符串

要监控的接口。来源 system.interface.name。

region

字符串

安全审计评级区域。

选项

  • "default"

  • "custom"

title

字符串

小部件标题。

type

字符串

小部件类型。

选项

  • "sysinfo"

  • "licinfo"

  • "forticloud"

  • "cpu-usage"

  • "memory-usage"

  • "disk-usage"

  • "log-rate"

  • "sessions"

  • "session-rate"

  • "tr-history"

  • "analytics"

  • "usb-modem"

  • "admins"

  • "security-fabric"

  • "security-fabric-ranking"

  • "sensor-info"

  • "ha-status"

  • "vulnerability-summary"

  • "host-scan-summary"

  • "fortiview"

  • "botnet-activity"

  • "fabric-device"

width

整数

宽度。

x_pos

整数

X 位置。

y_pos

整数

Y 位置。

gui_global_menu_favorites

列表 / 元素=字典

全局 VDOM 的收藏夹 GUI 菜单 ID。

id

字符串 / 必需

选择菜单 ID。

gui_ignore_release_overview_version

字符串

要忽略其版本发布概述提示的 FortiOS 版本。

gui_new_feature_acknowledge

列表 / 元素=字典

新功能确认。

id

字符串 / 必需

选择菜单 ID。

gui_vdom_menu_favorites

列表 / 元素=字典

VDOM 的收藏夹 GUI 菜单 ID。

id

字符串 / 必需

选择菜单 ID。

name

字符串 / 必需

SSO 管理员名称。

vdom

列表 / 元素=字典

管理员可以访问的虚拟域。

name

字符串 / 必需

虚拟域名称。来源 system.vdom.name。

vdom

字符串

在先前定义的虚拟域中。vdom 是 FortiGate 的虚拟实例，可以将其配置和用作不同的单元。

默认值： "root"

注释

注意

  • 旧版 fortiosapi 已弃用，httpapi 是运行 playbook 的首选方式。

  • 该模块支持 check_mode。

示例

- name: Configure SSO admin users.
  fortinet.fortios.fortios_system_sso_admin:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_sso_admin:
          accprofile: "<your_own_value> (source system.accprofile.name)"
          gui_dashboard:
              -
                  columns: "10"
                  id: "6"
                  layout_type: "responsive"
                  name: "default_name_8"
                  permanent: "disable"
                  vdom: "<your_own_value> (source system.vdom.name)"
                  widget:
                      -
                          fabric_device: "<your_own_value>"
                          fabric_device_widget_name: "<your_own_value>"
                          fabric_device_widget_visualization_type: "<your_own_value>"
                          fortiview_device: "<your_own_value>"
                          fortiview_filters:
                              -
                                  id: "17"
                                  key: "<your_own_value>"
                                  value: "<your_own_value>"
                          fortiview_sort_by: "<your_own_value>"
                          fortiview_timeframe: "<your_own_value>"
                          fortiview_type: "<your_own_value>"
                          fortiview_visualization: "<your_own_value>"
                          height: "25"
                          id: "25"
                          industry: "default"
                          interface: "<your_own_value> (source system.interface.name)"
                          region: "default"
                          title: "<your_own_value>"
                          type: "sysinfo"
                          width: "25"
                          x_pos: "500"
                          y_pos: "500"
          gui_global_menu_favorites:
              -
                  id: "35"
          gui_ignore_release_overview_version: "<your_own_value>"
          gui_new_feature_acknowledge:
              -
                  id: "38"
          gui_vdom_menu_favorites:
              -
                  id: "40"
          name: "default_name_41"
          vdom:
              -
                  name: "default_name_43 (source system.vdom.name)"

返回值

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

键

描述

build

字符串

FortiGate镜像的构建编号

返回值：始终返回

示例： "1547"

http_method

字符串

上次用于将内容置备到FortiGate的方法

返回值：始终返回

示例： "PUT"

http_status

字符串

FortiGate在上次应用的操作中给出的最后结果

返回值：始终返回

示例： "200"

mkey

字符串

上次调用FortiGate时使用的主密钥（ID）

返回值：成功

示例： "id"

name

字符串

table

返回值：始终返回

用于完成请求的表名称

示例： "urlfilter"

字符串

path

返回值：始终返回

用于完成请求的表的路径

示例： "webfilter"

字符串

revision

返回值：始终返回

内部修订号

示例： "17.0.2.10658"

字符串

serial

返回值：始终返回

设备的序列号

示例： "FGVMEVYYQT3AB5352"

字符串

status

返回值：始终返回

操作结果指示

vdom

字符串

示例： "success"

返回值：始终返回

vdom

使用的虚拟域

字符串

示例： "root"

返回值：始终返回

version

FortiGate的版本

  • 示例： "v5.6.3"

  • 作者

  • 郑林 (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆洪宾 (@fgtdev-hblu)

  • 沈峰 (@frankshen01)