fortinet.fortios.fortios_user_certificate 模块 – 在 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_user_certificate
。
在 fortinet.fortios 2.0.0 中新增
概要
此模块能够通过允许用户设置和修改用户功能和证书类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值,需要在使用前调整为数据源。在 FOS v6.0.0 中测试。
要求
执行此模块的主机需要满足以下要求。
ansible>=2.15
参数
参数 |
注释 |
---|---|
基于令牌的身份验证。从 Fortigate 的 GUI 生成。 |
|
启用/禁用任务的日志记录。 选项
|
|
要操作的成员属性路径。 如果存在多个属性,则用斜杠字符分隔。 标记为 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 当指定 member_state 时,将忽略 state 选项。 选项
|
|
指示是创建还是删除对象。 选项
|
|
配置证书用户。 |
|
证书通用名称。 |
|
用户 ID。 |
|
用于客户端证书验证的 CA 证书。源 vpn.certificate.ca.name。 |
|
用户名。 |
|
启用/禁用允许证书用户使用 FortiGate 设备进行身份验证。 选项
|
|
证书身份验证方法的类型。 选项
|
|
虚拟域,在之前定义的那些中。 vdom 是 FortiGate 的虚拟实例,可以配置并用作不同的单元。 默认: |
备注
注意
传统的 fortiosapi 已被弃用,httpapi 是运行 playbook 的首选方式
示例
- name: Configure certificate users.
fortinet.fortios.fortios_user_certificate:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_certificate:
common_name: "<your_own_value>"
id: "4"
issuer: "<your_own_value> (source vpn.certificate.ca.name)"
name: "default_name_6"
status: "enable"
type: "single-certificate"
返回值
常见的返回值记录在此处,以下是此模块特有的字段
键 |
描述 |
---|---|
Fortigate 映像的内部版本号 返回: 总是 示例: |
|
上次用于将内容配置到 FortiGate 中的方法 返回: 总是 示例: |
|
FortiGate 在上次应用的操作中给出的最后结果 返回: 总是 示例: |
|
上次调用 FortiGate 时使用的主键(id) 返回: 成功 示例: |
|
用于满足请求的表的名称 返回: 总是 示例: |
|
用于满足请求的表的路径 返回: 总是 示例: |
|
内部修订号 返回: 总是 示例: |
|
单元的序列号 返回: 总是 示例: |
|
指示操作结果 返回: 总是 示例: |
|
使用的虚拟域 返回: 总是 示例: |
|
FortiGate 的版本 返回: 总是 示例: |