fortinet.fortimanager.fmgr_user_peer 模块 – 配置对等用户。

注意

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

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

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

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

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_peer 字典	设置的顶级参数。
ca 字符串	由 execute vpn certificate ca list 命令返回的 CA 证书的名称。
cn 字符串	对等证书的通用名称。
cn_type 别名：cn-type 字符串	对等证书通用名称类型。选择 `"string"` `"email"` `"FQDN"` `"ipv4"` `"ipv6"`
ldap_mode 别名：ldap-mode 字符串	LDAP 对等身份验证的模式。选择 `"password"` `"principal-name"`
ldap_password 别名：ldap-password 任何	（列表）LDAP 服务器绑定的密码。
ldap_server 别名：ldap-server 字符串	在 user ldap 命令下定义的 LDAP 服务器的名称。
ldap_username 别名：ldap-username 字符串	LDAP 服务器绑定的用户名。
mandatory_ca_verify 别名：mandatory-ca-verify 字符串	确定如果未安装 CA 证书，对等方会发生什么情况。选择 `"disable"` `"enable"`
mfa_mode 别名：mfa-mode 字符串	远程对等身份验证/授权的 MFA 模式。选择 `"none"` `"password"` `"subject-identity"`
mfa_password 别名：mfa-password 任何	（列表）用于远程身份验证的统一密码。
mfa_server 别名：mfa-server 字符串	远程身份验证器的名称。
mfa_username 别名：mfa-username 字符串	用于远程身份验证的统一用户名。
name 字符串 / 必选	对等名称。
ocsp_override_server 别名：ocsp-override-server 字符串	在线证书状态协议
passwd 任何	（列表）用于双因素身份验证的对等密码。
subject 字符串	对等证书名称约束。
two_factor 别名：two-factor 字符串	启用/禁用双因素身份验证，应用基于证书和密码的身份验证。选择 `"disable"` `"enable"`
workspace_locking_adom 字符串	用于在工作区模式下运行的 FortiManager 的锁定 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: Configure peer users.
      fortinet.fortimanager.fmgr_user_peer:
        bypass_validation: false
        adom: ansible
        state: present
        user_peer:
          cn-type: email # <value in [string, email, FQDN, ...]>
          name: ansible-test-peer
          passwd: fortinet

- 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 peer users
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_peer"
          params:
            adom: "ansible"
            peer: "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 列表 / 元素=字符串	如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。返回: 复杂类型

作者

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)