fortinet.fortimanager.fmgr_endpointcontrol_fctems 模块 – 配置 FortiClient 企业管理服务器

注意

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

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

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

要在 Playbook 中使用它，请指定：fortinet.fortimanager.fmgr_endpointcontrol_fctems。

fortinet.fortimanager 2.1.0 中的新增功能

概要 

此模块能够配置 FortiManager 设备。
示例包括所有参数和值，这些参数和值需要在使用前调整为数据源。

参数 

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必选	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而不验证参数。选择 `false` ← (默认) `true`
enable_log 布尔值	启用/禁用任务日志记录。选择 `false` ← (默认) `true`
endpointcontrol_fctems 字典	设置的顶层参数。
admin_password 别名: admin-password 任意	(列表) FortiClient EMS 管理员密码。
admin_username 别名: admin-username 字符串	FortiClient EMS 管理员用户名。
ca_cn_info 别名: ca-cn-info 字符串	Ca cn 信息。
call_timeout 别名: call-timeout 整数	FortiClient EMS 调用超时（秒）
capabilities 列表 / 元素=字符串	EMS 功能列表。选择 `"fabric-auth"` `"silent-approval"` `"websocket"` `"websocket-malware"` `"push-ca-certs"` `"common-tags-api"` `"tenant-id"` `"single-vdom-connector"` `"client-avatars"` `"fgt-sysinfo-api"` `"ztna-server-info"`
certificate 字符串	FortiClient EMS 证书。
certificate_fingerprint 别名: certificate-fingerprint 字符串	EMS 证书指纹。
cloud_authentication_access_key 别名: cloud-authentication-access-key 字符串	FortiClient EMS Cloud 多租户访问密钥
cloud_server_type 别名: cloud-server-type 字符串	云服务器类型。选择 `"production"` `"alpha"` `"beta"`
dirty_reason 别名: dirty-reason 字符串	FortiClient EMS 的脏原因。选择 `"none"` `"mismatched-ems-sn"`
ems_id 别名: ems-id 整数	EMS ID，按顺序
fortinetone_cloud_authentication 别名: fortinetone-cloud-authentication 字符串	启用/禁用通过 FortiCloud 帐户对 FortiClient EMS Cloud 进行身份验证。选择 `"disable"` `"enable"`
https_port 别名: https-port 整数	FortiClient EMS HTTPS 访问端口号。
interface 字符串	指定用于连接服务器的传出接口。
interface_select_method 别名: interface-select-method 字符串	指定如何选择用于连接服务器的传出接口。选择 `"auto"` `"sdwan"` `"specify"`
name 字符串 / 必选	FortiClient 企业管理服务器
out_of_sync_threshold 别名: out-of-sync-threshold 整数	过时资源阈值（秒）
preserve_ssl_session 别名: preserve-ssl-session 字符串	启用/禁用 EMS SSL 会话连接的保留。选择 `"disable"` `"enable"`
pull_avatars 别名: pull-avatars 字符串	启用/禁用从 EMS 拉取头像。选择 `"disable"` `"enable"`
pull_malware_hash 别名: pull-malware-hash 字符串	启用/禁用从 EMS 拉取 FortiClient 恶意软件哈希。选择 `"disable"` `"enable"`
pull_sysinfo 别名: pull-sysinfo 字符串	启用/禁用从 EMS 拉取系统信息。选择 `"disable"` `"enable"`
pull_tags 别名: pull-tags 字符串	启用/禁用从 EMS 拉取 FortiClient 用户标签。选择 `"disable"` `"enable"`
pull_vulnerabilities 别名: pull-vulnerabilities 字符串	启用/禁用从 EMS 拉取漏洞。选择 `"disable"` `"enable"`
send_tags_to_all_vdoms 别名: send-tags-to-all-vdoms 字符串	放宽标签限制，将所有 EMS 标签发送到所有 VDOM 选择 `"disable"` `"enable"`
serial_number 别名: serial-number 字符串	FortiClient EMS 序列号。
服务器字符串	FortiClient EMS FQDN 或 IPv4 地址。
source_ip 别名: source-ip 字符串	REST API 调用源 IP。
状态字符串	启用或禁用此 EMS 配置。选择 `"disable"` `"enable"`
status_check_interval 别名: status-check-interval 整数	FortiClient EMS 调用超时（秒）
tenant_id 别名: tenant-id 字符串	EMS 租户 ID。
trust_ca_cn 别名: trust-ca-cn 字符串	信任 CA CN。选择 `"disable"` `"enable"`
verified_cn 别名: verified-cn 字符串	EMS 证书 CN。
verifying_ca 别名: verifying-ca 字符串	FortiGate 上验证的 EMS 证书链中的最低 CA 证书。
websocket_override 别名: websocket-override 字符串	启用/禁用此 FortiGate 设备使用 WebSocket 连接到 EMS 的覆盖行为。选择 `"disable"` `"enable"`
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
proposed_method 字符串	底层 Json RPC 请求的覆盖方法。选择 `"update"` `"set"` `"add"`
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
状态字符串 / 必选	用于创建、更新或删除对象的指令。选择 `"present"` `"absent"`
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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure FortiClient Enterprise Management Server
      fortinet.fortimanager.fmgr_endpointcontrol_fctems:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        endpointcontrol_fctems:
          call_timeout: <integer>
          capabilities:
            - "fabric-auth"
            - "silent-approval"
            - "websocket"
            - "websocket-malware"
            - "push-ca-certs"
            - "common-tags-api"
            - "tenant-id"
            - "single-vdom-connector"
            - "client-avatars"
            - "fgt-sysinfo-api"
            - "ztna-server-info"
          certificate_fingerprint: <string>
          cloud_server_type: <value in [production, alpha, beta]>
          fortinetone_cloud_authentication: <value in [disable, enable]>
          https_port: <integer>
          name: <string>
          out_of_sync_threshold: <integer>
          preserve_ssl_session: <value in [disable, enable]>
          pull_avatars: <value in [disable, enable]>
          pull_malware_hash: <value in [disable, enable]>
          pull_sysinfo: <value in [disable, enable]>
          pull_tags: <value in [disable, enable]>
          pull_vulnerabilities: <value in [disable, enable]>
          server: <string>
          source_ip: <string>
          websocket_override: <value in [disable, enable]>
          status_check_interval: <integer>
          certificate: <string>
          admin_username: <string>
          serial_number: <string>
          admin_password: <list or string>
          interface: <string>
          interface_select_method: <value in [auto, sdwan, specify]>
          dirty_reason: <value in [none, mismatched-ems-sn]>
          ems_id: <integer>
          status: <value in [disable, enable]>
          ca_cn_info: <string>
          trust_ca_cn: <value in [disable, enable]>
          tenant_id: <string>
          send_tags_to_all_vdoms: <value in [disable, enable]>
          verified_cn: <string>
          verifying_ca: <string>
          cloud_authentication_access_key: <string>

返回值 

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

键	描述
元数据字典	请求的结果。返回值: 总是
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 版本不支持 playbook 中使用的参数，则会发出警告。返回值: 复杂

作者

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