fortinet.fortimanager.fmgr_user_local 模块 – 配置本地用户。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

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"

user_local

字典

设置的顶级参数。

auth_concurrent_override

别名：auth-concurrent-override

字符串

启用/禁用覆盖 config system global 下的 policy-auth-concurrent。

选项

  • "disable"

  • "enable"

auth_concurrent_value

别名：auth-concurrent-value

整数

允许来自同一用户的最大并发登录数。

authtimeout

整数

用户身份验证超时前的时间（分钟）。

email_to

别名：email-to

字符串

双因素身份验证收件人的电子邮件地址。

fortitoken

字符串

双因素身份验证收件人的 FortiToken 序列号。

history0

任意

(列表) History0。

history1

任意

(列表) History1。

id

整数

用户 ID。

ldap_server

别名：ldap-server

字符串

用户必须对其进行身份验证的 LDAP 服务器名称。

name

字符串 / 必需

用户名。

passwd

任意

(列表) 用户密码。

passwd_policy

别名：passwd-policy

字符串

应用于此用户的密码策略，如 config user password-policy 中所定义。

ppk_identity

别名：ppk-identity

字符串

IKEv2 后量子预共享密钥身份。

ppk_secret

别名：ppk-secret

任意

(列表) IKEv2 后量子预共享密钥

qkd_profile

别名：qkd-profile

字符串

量子密钥分发

radius_server

别名：radius-server

字符串

用户必须对其进行身份验证的 RADIUS 服务器名称。

sms_custom_server

别名：sms-custom-server

字符串

双因素身份验证收件人的 SMS 服务器。

sms_phone

别名：sms-phone

字符串

双因素身份验证收件人的手机号码。

sms_server

别名：sms-server

字符串

通过 FortiGuard 或其他外部服务器发送 SMS。

选项

  • "fortiguard"

  • "custom"

status

字符串

启用/禁用允许本地用户使用 FortiGate 单元进行身份验证。

选项

  • "disable"

  • "enable"

tacacs__server

别名：tacacs+-server

字符串

用户必须对其进行身份验证的 TACACS+ 服务器名称。

two_factor

别名：two-factor

字符串

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

选项

  • "disable"

  • "fortitoken"

  • "email"

  • "sms"

  • "fortitoken-cloud"

two_factor_authentication

别名：two-factor-authentication

字符串

FortiToken Cloud 的身份验证方法。

选项

  • "fortitoken"

  • "email"

  • "sms"

two_factor_notification

别名：two-factor-notification

字符串

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

选项

  • "email"

  • "sms"

type

字符串

身份验证方法。

选项

  • "password"

  • "radius"

  • "tacacs+"

  • "ldap"

username_case_insensitivity

别名：username-case-insensitivity

字符串

启用/禁用执行用户名匹配时的区分大小写。

选项

  • "disable"

  • "enable"

username_case_sensitivity

别名：username-case-sensitivity

字符串

启用/禁用执行用户名匹配时的区分大小写。

选项

  • "disable"

  • "enable"

username_sensitivity

别名：username-sensitivity

字符串

启用/禁用执行用户名匹配时的区分大小写和重音符号。

选项

  • "disable"

  • "enable"

workstation

字符串

远程用户工作站名称，如果您想限制用户只能从特定工作站进行身份验证。

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: Configure local users.
      fortinet.fortimanager.fmgr_user_local:
        bypass_validation: false
        adom: ansible
        state: present
        user_local:
          id: 1
          name: ansible-test-local
          passwd: fortinet
          status: disable

- 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 local users
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_local"
          params:
            adom: "ansible"
            local: "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)