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

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改系统功能和管理员类别来配置 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_admin

字典

配置管理员用户。

accprofile

字符串

此管理员的访问配置文件。访问配置文件控制管理员对 FortiGate 功能的访问权限。源 system.accprofile.name。

accprofile_override

字符串

启用以使用远程身份验证服务器提供的访问配置文件的名称来控制此管理员可以访问的 FortiGate 功能。

选项

  • "enable"

  • "disable"

allow_remove_admin_session

字符串

启用/禁用允许特权管理员用户删除管理员会话。

选项

  • "enable"

  • "disable"

comments

字符串

注释。

email_to

字符串

此管理员的电子邮件地址。

force_password_change

字符串

启用/禁用下次登录时强制更改密码。

选项

  • "enable"

  • "disable"

fortitoken

字符串

此管理员的 FortiToken 序列号。

guest_auth

字符串

启用/禁用访客身份验证。

选项

  • "disable"

  • "enable"

guest_lang

字符串

访客管理门户语言。源 system.custom-language.name。

guest_usergroups

列表 / elements=字典

选择访客用户组。

name

字符串 / 必需

选择访客用户组。

gui_dashboard

列表 / elements=字典

GUI 仪表板。

columns

整数

列数。

id

整数 / 必需

仪表板 ID。请参阅 <a href=’#notes’>注释</a>。

layout_type

字符串

布局类型。

选项

  • "responsive"

  • "fixed"

name

字符串

仪表板名称。

permanent

字符串

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

选项

  • "disable"

  • "enable"

scope

字符串

仪表板范围。

选项

  • "global"

  • "vdom"

vdom

字符串

虚拟域。源 system.vdom.name。

widget

列表 / elements=字典

仪表板小部件。

fabric_device

字符串

要监视的 Fabric 设备。

fabric_device_widget_name

字符串

Fabric 设备小部件名称。

fabric_device_widget_visualization_type

字符串

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

fortiview_device

字符串

FortiView 设备。

fortiview_filters

列表 / elements=字典

FortiView 过滤器。

id

整数 / 必需

FortiView 过滤器 ID。请参阅 <a href=’#notes’>注释</a>。

key

字符串

过滤器键。

value

字符串

过滤器值。

fortiview_sort_by

字符串

FortiView 排序依据。

fortiview_timeframe

字符串

FortiView 时间范围。

fortiview_type

字符串

FortiView 类型。

fortiview_visualization

字符串

FortiView 可视化。

height

整数

高度。

id

整数 / 必需

小部件 ID。请参阅 <a href=’#notes’>注释</a>。

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"

  • "fortimail"

width

整数

宽度。

x_pos

整数

X 位置。

y_pos

整数

Y 位置。

gui_global_menu_favorites

列表 / elements=字典

全局 VDOM 的收藏 GUI 菜单 ID。

id

字符串 / 必需

选择菜单 ID。

gui_new_feature_acknowledge

列表 / elements=字典

新功能的确认。

id

字符串 / 必需

选择菜单 ID。

gui_vdom_menu_favorites

列表 / elements=字典

VDOM 的收藏 GUI 菜单 ID。

id

字符串 / 必需

选择菜单 ID。

hidden

整数

管理员用户隐藏属性。

history0

字符串

history0

history1

字符串

history1

ip6_trusthost1

字符串

管理员可以从中连接到 FortiGate 单元的任何 IPv6 地址。默认允许从任何 IPv6 地址访问。

ip6_trusthost10

字符串

管理员可以从中连接到 FortiGate 单元的任何 IPv6 地址。默认允许从任何 IPv6 地址访问。

ip6_trusthost2

字符串

管理员可以从中连接到 FortiGate 单元的任何 IPv6 地址。默认允许从任何 IPv6 地址访问。

ip6_trusthost3

字符串

管理员可以从中连接到 FortiGate 单元的任何 IPv6 地址。默认允许从任何 IPv6 地址访问。

ip6_trusthost4

字符串

管理员可以从中连接到 FortiGate 单元的任何 IPv6 地址。默认允许从任何 IPv6 地址访问。

ip6_trusthost5

字符串

管理员可以从中连接到 FortiGate 单元的任何 IPv6 地址。默认允许从任何 IPv6 地址访问。

ip6_trusthost6

字符串

管理员可以从中连接到 FortiGate 单元的任何 IPv6 地址。默认允许从任何 IPv6 地址访问。

ip6_trusthost7

字符串

管理员可以从中连接到 FortiGate 单元的任何 IPv6 地址。默认允许从任何 IPv6 地址访问。

ip6_trusthost8

字符串

管理员可以从中连接到 FortiGate 单元的任何 IPv6 地址。默认允许从任何 IPv6 地址访问。

ip6_trusthost9

字符串

管理员可以从中连接到 FortiGate 单元的任何 IPv6 地址。默认允许从任何 IPv6 地址访问。

login_time

列表 / elements=字典

记录用户登录时间。

last_failed_login

字符串

上次登录失败时间。

last_login

字符串

上次成功登录时间。

usr_name

字符串 / 必需

用户名。

name

字符串 / 必需

用户名。

password

字符串

管理员用户密码。

password_expire

字符串

密码到期时间。

peer_auth

字符串

设置为启用对等证书身份验证（用于 HTTPS 管理访问）。

选项

  • "enable"

  • "disable"

peer_group

字符串

在配置用户组下定义的、拥有 PKI 成员的对等组的名称。用于对等证书身份验证（用于 HTTPS 管理访问）。

radius_vdom_override

字符串

启用此项后，将使用远程身份验证服务器提供的 VDOM 名称来控制此管理员可以访问的 VDOM。

选项

  • "enable"

  • "disable"

remote_auth

字符串

启用/禁用使用远程 RADIUS、LDAP 或 TACACS+ 服务器进行身份验证。

选项

  • "enable"

  • "disable"

remote_group

字符串

用于远程身份验证的用户组名称。

schedule

字符串

用于限制管理员登录时间的防火墙计划。没有计划意味着没有限制。

sms_custom_server

字符串

用于发送短信的自定义 SMS 服务器。源系统：sms-server.name。

sms_phone

字符串

管理员接收短信的电话号码。

sms_server

字符串

使用 FortiGuard SMS 服务器或自定义服务器发送短信。

选项

  • "fortiguard"

  • "custom"

ssh_certificate

字符串

选择 FortiGate 用于与 SSH 客户端进行身份验证的证书。源证书：remote.name。

ssh_public_key1

字符串

SSH 客户端的公钥。客户端无需输入凭据即可进行身份验证。在 SSH 客户端应用程序中创建公私钥对。

ssh_public_key2

字符串

SSH 客户端的公钥。客户端无需输入凭据即可进行身份验证。在 SSH 客户端应用程序中创建公私钥对。

ssh_public_key3

字符串

SSH 客户端的公钥。客户端无需输入凭据即可进行身份验证。在 SSH 客户端应用程序中创建公私钥对。

trusthost1

字符串

管理员可以从中连接到 FortiGate 设备的任何 IPv4 地址或子网地址和网络掩码。默认允许从任何 IPv4 地址访问。

trusthost10

字符串

管理员可以从中连接到 FortiGate 设备的任何 IPv4 地址或子网地址和网络掩码。默认允许从任何 IPv4 地址访问。

trusthost2

字符串

管理员可以从中连接到 FortiGate 设备的任何 IPv4 地址或子网地址和网络掩码。默认允许从任何 IPv4 地址访问。

trusthost3

字符串

管理员可以从中连接到 FortiGate 设备的任何 IPv4 地址或子网地址和网络掩码。默认允许从任何 IPv4 地址访问。

trusthost4

字符串

管理员可以从中连接到 FortiGate 设备的任何 IPv4 地址或子网地址和网络掩码。默认允许从任何 IPv4 地址访问。

trusthost5

字符串

管理员可以从中连接到 FortiGate 设备的任何 IPv4 地址或子网地址和网络掩码。默认允许从任何 IPv4 地址访问。

trusthost6

字符串

管理员可以从中连接到 FortiGate 设备的任何 IPv4 地址或子网地址和网络掩码。默认允许从任何 IPv4 地址访问。

trusthost7

字符串

管理员可以从中连接到 FortiGate 设备的任何 IPv4 地址或子网地址和网络掩码。默认允许从任何 IPv4 地址访问。

trusthost8

字符串

管理员可以从中连接到 FortiGate 设备的任何 IPv4 地址或子网地址和网络掩码。默认允许从任何 IPv4 地址访问。

trusthost9

字符串

管理员可以从中连接到 FortiGate 设备的任何 IPv4 地址或子网地址和网络掩码。默认允许从任何 IPv4 地址访问。

two_factor

字符串

启用/禁用双因素身份验证。

选项

  • "disable"

  • "fortitoken"

  • "fortitoken-cloud"

  • "email"

  • "sms"

two_factor_authentication

字符串

通过 FortiToken Cloud 进行身份验证的方法。

选项

  • "fortitoken"

  • "email"

  • "sms"

two_factor_notification

字符串

通过 FortiToken Cloud 进行用户激活的通知方法。

选项

  • "email"

  • "sms"

vdom

列表 / elements=字典

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

name

字符串 / 必需

虚拟域名。源系统：vdom.name。

vdom_override

字符串

启用此项后，将使用远程身份验证服务器提供的 VDOM 名称来控制此管理员可以访问的 VDOM。

选项

  • "enable"

  • "disable"

wildcard

字符串

启用/禁用通配符 RADIUS 身份验证。

选项

  • "enable"

  • "disable"

vdom

字符串

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

默认值： "root"

注释

注意

  • 旧版 fortiosapi 已被弃用，httpapi 是运行剧本的首选方法

  • 该模块支持 check_mode。

示例

- name: Configure admin users.
  fortinet.fortios.fortios_system_admin:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_admin:
          accprofile: "<your_own_value> (source system.accprofile.name)"
          accprofile_override: "enable"
          allow_remove_admin_session: "enable"
          comments: "<your_own_value>"
          email_to: "<your_own_value>"
          force_password_change: "enable"
          fortitoken: "<your_own_value>"
          guest_auth: "disable"
          guest_lang: "<your_own_value> (source system.custom-language.name)"
          guest_usergroups:
              -
                  name: "default_name_13"
          gui_dashboard:
              -
                  columns: "10"
                  id: "16"
                  layout_type: "responsive"
                  name: "default_name_18"
                  permanent: "disable"
                  scope: "global"
                  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: "28"
                                  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: "36"
                          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: "46"
          gui_new_feature_acknowledge:
              -
                  id: "48"
          gui_vdom_menu_favorites:
              -
                  id: "50"
          hidden: "127"
          history0: "<your_own_value>"
          history1: "<your_own_value>"
          ip6_trusthost1: "myhostname"
          ip6_trusthost10: "myhostname"
          ip6_trusthost2: "myhostname"
          ip6_trusthost3: "myhostname"
          ip6_trusthost4: "myhostname"
          ip6_trusthost5: "myhostname"
          ip6_trusthost6: "myhostname"
          ip6_trusthost7: "myhostname"
          ip6_trusthost8: "myhostname"
          ip6_trusthost9: "myhostname"
          login_time:
              -
                  last_failed_login: "<your_own_value>"
                  last_login: "<your_own_value>"
                  usr_name: "<your_own_value>"
          name: "default_name_68"
          password: "<your_own_value>"
          password_expire: "<your_own_value>"
          peer_auth: "enable"
          peer_group: "<your_own_value>"
          radius_vdom_override: "enable"
          remote_auth: "enable"
          remote_group: "<your_own_value>"
          schedule: "<your_own_value>"
          sms_custom_server: "<your_own_value> (source system.sms-server.name)"
          sms_phone: "<your_own_value>"
          sms_server: "fortiguard"
          ssh_certificate: "<your_own_value> (source certificate.remote.name)"
          ssh_public_key1: "<your_own_value>"
          ssh_public_key2: "<your_own_value>"
          ssh_public_key3: "<your_own_value>"
          trusthost1: "myhostname"
          trusthost10: "myhostname"
          trusthost2: "myhostname"
          trusthost3: "myhostname"
          trusthost4: "myhostname"
          trusthost5: "myhostname"
          trusthost6: "myhostname"
          trusthost7: "myhostname"
          trusthost8: "myhostname"
          trusthost9: "myhostname"
          two_factor: "disable"
          two_factor_authentication: "fortitoken"
          two_factor_notification: "email"
          vdom:
              -
                  name: "default_name_98 (source system.vdom.name)"
          vdom_override: "enable"
          wildcard: "enable"

返回值

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

键

描述

build

字符串

Fortigate 映像的版本号

返回：始终

示例： "1547"

http_method

字符串

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

返回：始终

示例： "PUT"

http_status

字符串

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

返回：始终

示例： "200"

mkey

字符串

上次调用 FortiGate 时使用的主键 (id)

返回：成功

示例： "id"

name

字符串

用于满足请求的表名称

返回：始终

示例： "urlfilter"

path

字符串

用于满足请求的表的路径

返回：始终

示例： "webfilter"

revision

字符串

内部修订号

返回：始终

示例： "17.0.2.10658"

serial

字符串

设备的序列号

返回：始终

示例： "FGVMEVYYQT3AB5352"

status

字符串

操作结果的指示

返回：始终

示例： "success"

vdom

字符串

使用的虚拟域

返回：始终

示例： "root"

version

字符串

FortiGate 的版本

返回：始终

示例： "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)