fortinet.fortimanager.fmgr_system_admin_user 模块 – 管理员用户。

注意

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

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

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

要在 playbook 中使用它，请指定： fortinet.fortimanager.fmgr_system_admin_user。

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_user

字典

设置的顶级参数。

adom

列表 / 元素=字典

ADOM。

adom_name

别名：adom-name

字符串

管理员域名称。

adom_access

别名：adom-access

字符串

设置所有/指定/排除 adom 访问模式。

all - 所有 ADOM 访问。

specify - 指定 ADOM 访问。

exclude - 排除 ADOM 访问。

选项

  • "all"

  • "specify"

  • "exclude"

  • "per-adom-profile"

adom_exclude

别名：adom-exclude

列表 / 元素=字典

排除的 ADOM。

adom_name

别名：adom-name

字符串

管理员域名称。

app_filter

别名：app-filter

列表 / 元素=字典

应用过滤器。

app_filter_name

别名：app-filter-name

字符串

应用过滤器名称。

avatar

字符串

头像的图像文件

ca

字符串

PKI 用户证书 CA

change_password

别名：change-password

字符串

启用/禁用受限用户更改自身密码。

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

cors_allow_origin

别名：cors-allow-origin

字符串

Access-Control-Allow-Origin。

dashboard

列表 / 元素=字典

仪表盘。

column

整数

小部件列 ID。

diskio_content_type

别名：diskio-content-type

字符串

磁盘 I/O 监控小部件图表类型。

util - 带宽利用率。

iops - I/O 请求数。

blks - I/O 请求的数据量。

选项

  • "util"

  • "iops"

  • "blks"

diskio_period

别名：diskio-period

字符串

磁盘 I/O 监控小部件数据周期。

1hour - 1 小时。

8hour - 8 小时。

24hour - 24 小时。

选项

  • "1hour"

  • "8hour"

  • "24hour"

log_rate_period

别名：log-rate-period

字符串

日志接收监控小部件数据周期。

2min - 2 分钟。

1hour - 1 小时。

6hours - 6 小时。

选项

  • "2min"

  • "1hour"

  • "6hours"

log_rate_topn

别名：log-rate-topn

字符串

日志接收监控小部件要显示的顶部项目数量。

1 - 顶部 1。

2 - 顶部 2。

3 - 顶部 3。

4 - 顶部 4。

5 - 顶部 5。

选项

  • "1"

  • "2"

  • "3"

  • "4"

  • "5"

log_rate_type

别名：log-rate-type

字符串

日志接收监控小部件统计细分选项。

log - 显示每种日志类型的日志速率。

device - 显示每个设备的日志速率。

选项

  • "log"

  • "device"

moduleid

整数

小部件 ID。

name

字符串

小部件名称。

num_entries

别名：num-entries

整数

条目数。

refresh_interval

别名：refresh-interval

整数

小部件刷新间隔。

res_cpu_display

别名：res-cpu-display

字符串

小部件 CPU 显示类型。

average - CPU 的平均使用率。

each - CPU 的每个使用率。

选项

  • "average"

  • "each"

res_period

别名：res-period

字符串

小部件数据周期。

10min - 过去 10 分钟。

hour - 过去一小时。

day - 过去一天。

选项

  • "10min"

  • "hour"

  • "day"

res_view_type

别名：res-view-type

字符串

小部件数据视图类型。

real-time - 实时视图。

history - 历史视图。

选项

  • "real-time"

  • "history"

status

字符串

小部件已打开/关闭状态。

close - 小部件已关闭。

打开 - 小部件已打开。

选项

  • "关闭"

  • "打开"

tabid

整数

显示小部件的选项卡 ID。

time_period

别名：time-period

字符串

日志数据库监控小部件数据周期。

1hour - 1 小时。

8hour - 8 小时。

24hour - 24 小时。

选项

  • "1hour"

  • "8hour"

  • "24hour"

widget_type

别名：widget-type

字符串

小部件类型。

top-lograte - 日志接收监控。

sysres - 系统资源。

sysinfo - 系统信息。

licinfo - 许可证信息。

jsconsole - 命令行控制台。

sysop - 单位操作。

alert - 警报信息控制台。

statistics - 统计信息。

rpteng - 报表引擎。

raid - 磁盘监控。

logrecv - 日志/数据接收。

devsummary - 设备摘要。

logdb-perf - 日志数据库性能监控。

logdb-lag - 日志数据库延迟时间。

disk-io - 磁盘 I/O。

log-rcvd-fwd - 日志接收和转发监控。

选项

  • "top-lograte"

  • "sysres"

  • "sysinfo"

  • "licinfo"

  • "jsconsole"

  • "sysop"

  • "alert"

  • "statistics"

  • "rpteng"

  • "raid"

  • "logrecv"

  • "devsummary"

  • "logdb-perf"

  • "logdb-lag"

  • "disk-io"

  • "log-rcvd-fwd"

dashboard_tabs

别名：dashboard-tabs

列表 / 元素=字典

仪表板选项卡。

name

字符串

选项卡名称。

tabid

整数

选项卡 ID。

description

字符串

描述。

dev_group

别名：dev-group

字符串

设备组。

email_address

别名：email-address

字符串

电子邮件地址。

ext_auth_accprofile_override

别名：ext-auth-accprofile-override

字符串

允许使用远程认证服务器提供的访问配置文件。

disable - 禁用访问配置文件覆盖。

enable - 启用访问配置文件覆盖。

选项

  • "disable"

  • "enable"

ext_auth_adom_override

别名：ext-auth-adom-override

字符串

允许使用远程认证服务器提供的 ADOM。

disable - 禁用 ADOM 覆盖。

enable - 启用 ADOM 覆盖。

选项

  • "disable"

  • "enable"

ext_auth_group_match

别名：ext-auth-group-match

字符串

只有属于此组的管理员才能登录。

fingerprint

字符串

PKI 用户证书指纹。

first_name

别名：first-name

字符串

名字。

force_password_change

别名：force-password-change

字符串

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

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

fortiai

字符串

启用/禁用 FortiAI。

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

group

字符串

组名。

hidden

整数

隐藏管理员。

ips_filter

别名：ips-filter

列表 / 元素=字典

IPS 过滤。

ips_filter_name

别名：ips-filter-name

字符串

IPS 过滤器名称。

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。

last_name

别名：last-name

字符串

姓氏。

ldap_server

别名：ldap-server

字符串

LDAP 服务器名称。

login_max

别名：login-max

整数

此用户的最大登录会话数。

meta_data

别名：meta-data

列表 / 元素=字典

元数据。

fieldlength

整数

字段长度。

fieldname

字符串

字段名称。

fieldvalue

字符串

字段值。

importance

字符串

重要性。

optional - 此字段是可选的。

required - 此字段是必需的。

选项

  • "optional"

  • "required"

status

字符串

状态。

disabled - 此字段已禁用。

enabled - 此字段已启用。

选项

  • "disabled"

  • "enabled"

mobile_number

别名：mobile-number

字符串

手机号码。

pager_number

别名：pager-number

字符串

寻呼机号码。

password

any

(列表) 密码。

password_expire

别名：password-expire

any

(列表或字符串) 密码过期时间（格林威治标准时间）。

phone_number

别名：phone-number

字符串

电话号码。

policy_block

别名：policy-block

列表 / 元素=字典

策略块。

policy_block_name

别名：policy-block-name

字符串

策略块名称。

policy_package

别名：policy-package

列表 / 元素=字典

策略包。

policy_package_name

别名：policy-package-name

字符串

策略包名称。

profileid

字符串

配置文件 ID。

radius_server

字符串

RADIUS 服务器名称。

restrict_access

别名：restrict-access

字符串

启用/禁用对开发 VDOM 的受限访问。

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

restrict_dev_vdom

别名：restrict-dev-vdom

列表 / 元素=字典

限制开发 VDOM。

dev_vdom

别名：dev-vdom

字符串

设备或设备 VDOM。

rpc_permit

别名：rpc-permit

字符串

设置 none/read/read-write rpc 权限。

read-write - 读写权限。

none - 无权限。

read - 只读权限。

选项

  • "read-write"

  • "none"

  • "read"

  • "from-profile"

ssh_public_key1

别名：ssh-public-key1

any

(列表) SSH 公钥 1。

ssh_public_key2

别名：ssh-public-key2

any

(列表) SSH 公钥 2。

ssh_public_key3

别名：ssh-public-key3

any

(列表) SSH 公钥 3。

subject

字符串

PKI 用户证书名称约束。

tacacs_plus_server

别名：tacacs-plus-server

字符串

TACACS+ 服务器名称。

th6_from_profile

别名：th6-from-profile

整数

仅供内部使用。

th_from_profile

别名：th-from-profile

整数

仅供内部使用。

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。

two_factor_auth

别名：two-factor-auth

字符串

启用双因素身份验证。

disable - 禁用双因素身份验证。

enable - 启用双因素身份验证。

选项

  • "disable"

  • "enable"

  • "password"

  • "ftc-ftm"

  • "ftc-email"

  • "ftc-sms"

use_global_theme

别名：use-global-theme

字符串

启用/禁用管理 GUI 的全局主题。

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

user_theme

别名：user-theme

字符串

管理员用户 GUI 要使用的配色方案。

blue - 蓝莓

green - 奇异果

red - 樱桃

melongene - 李子

spring - 春天

summer - 夏天

autumn - 秋天

winter - 冬天

circuit-board - 电路板

calla-lily - 马蹄莲

binary-tunnel - 二进制隧道

mars - 火星

blue-sea - 蓝色海洋

technology - 科技

landscape - 风景

twilight - 黄昏

canyon - 峡谷

northern-light - 北极光

astronomy - 天文学

fish - 鱼

penguin - 企鹅

mountain - 山脉

panda - 熊猫

parrot - 鹦鹉

cave - 洞穴

zebra - 斑马

contrast-dark - 高对比度深色

选项

  • "blue"

  • "green"

  • "red"

  • "melongene"

  • "spring"

  • "summer"

  • "autumn"

  • "winter"

  • "circuit-board"

  • "calla-lily"

  • "binary-tunnel"

  • "mars"

  • "blue-sea"

  • "technology"

  • "landscape"

  • "twilight"

  • "canyon"

  • "northern-light"

  • "astronomy"

  • "fish"

  • "penguin"

  • "mountain"

  • "panda"

  • "parrot"

  • "cave"

  • "zebra"

  • "contrast-dark"

  • "mariner"

  • "jade"

  • "neutrino"

  • "dark-matter"

  • "forest"

  • "cat"

  • "graphite"

user_type

字符串

用户类型。

local - 本地用户。

radius - RADIUS 用户。

ldap - LDAP 用户。

tacacs-plus - TACACS+ 用户。

pki-auth - PKI 用户。

group - 组用户。

选项

  • "local"

  • "radius"

  • "ldap"

  • "tacacs-plus"

  • "pki-auth"

  • "group"

  • "sso"

  • "api"

userid

字符串 / 必填

用户名。

web_filter

别名：web-filter

列表 / 元素=字典

Web 过滤器。

web_filter_name

别名：web-filter-name

字符串

Web 过滤器名称。

wildcard

字符串

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

disable - 禁用用户名通配符。

enable - 启用用户名通配符。

选项

  • "disable"

  • "enable"

workspace_locking_adom

字符串

在工作区模式下运行的 FortiManager 中，要锁定的 ADOM，其值可以是全局的，也可以是其他 ADOM，包括 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 User
      fortinet.fortimanager.fmgr_system_admin_user:
        state: present
        system_admin_user:
          adom:
            - adom-name: ansible
          userid: "ansible-test"
    - name: Admin domain.
      fortinet.fortimanager.fmgr_system_admin_user_adom:
        bypass_validation: false
        user: ansible-test # userid
        state: present
        system_admin_user_adom:
          adom-name: "ALL ADOMS"

返回值

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

键

描述

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)