fortinet.fortios.fortios_vpn_certificate_local 模块 – 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_vpn_certificate_local
。
fortinet.fortios 2.0.0 中的新增功能
概要
此模块能够配置 FortiGate 或 FortiOS (FOS) 设备,允许用户设置和修改 vpn_certificate 功能和本地类别。示例包括所有参数和值都需要在使用前调整为数据源。使用 FOS v6.0.0 测试。
要求
执行此模块的主机需要满足以下要求。
ansible>=2.15
参数
参数 |
注释 |
---|---|
基于令牌的身份验证。从 Fortigate 的 GUI 生成。 |
|
启用/禁用任务日志记录。 选项
|
|
要操作的成员属性路径。 如果有多个属性,则用斜杠字符分隔。 标记为 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 当指定 member_state 时,将忽略 state 选项。 选项
|
|
指示是创建还是删除对象。 选项
|
|
虚拟域,在先前定义的那些之中。vdom 是 FortiGate 的虚拟实例,可以配置并用作不同的单元。 默认值: |
|
本地密钥和证书。 |
|
ACME CA 服务器的 URL(“Let's Encrypt”是)。 |
|
解析为此 FortiGate 单元的有效域名。 |
|
某些 CA(如 LetsEncrypt)需要的联系人电子邮件地址。 |
|
续订窗口的开始时间(在证书过期前几天,默认为 30 天)。 |
|
生成的证书的 RSA 私钥的长度(最小 2048 位)。 |
|
在请求更新的本地证书过期之前等待的天数(0 = 禁用)。 |
|
在生成过期警告消息之前等待的天数(0 = 禁用)。 |
|
通过 SCEP 签名时 CA 服务器的 CA 标识符。 |
|
PEM 格式的证书。 |
|
CMP 服务器内部的路径位置。 |
|
CMP 自动再生方法。 选项
|
|
CMP 服务器的地址和端口(格式 = address:port)。 |
|
CMP 服务器证书。源 vpn.certificate.ca.name vpn.certificate.remote.name。 |
|
注释。 |
|
证书签名请求。 |
|
证书注册协议。 选项
|
|
通过 EST 签名时 CA 服务器的 CA 标识符。 |
|
用于将此 FortiGate 验证到 EST 服务器的证书。源 vpn.certificate.local.name。 |
|
通过 EST 签名时的 HTTP 身份验证密码。 |
|
通过 EST 签名时的 HTTP 身份验证用户名。 |
|
EST 服务器的地址和端口(例如,https://example.com:1234)。 |
|
必须通过此证书验证 EST 服务器的证书才能进行身份验证。源 vpn.certificate.ca.name vpn.certificate .remote.name。 |
|
EST SRP 身份验证密码。 |
|
EST SRP 身份验证用户名。 |
|
FortiGate 用作 VPN 客户端进行身份验证的本地 ID。 |
|
IKE 本地 ID 类型。 选项
|
|
证书上次更新的时间。 |
|
名称。 |
|
用于自动再生的名称编码方法。 选项
|
|
作为 PEM 文件的密码。 |
|
使用密码加密的 PEM 格式密钥。 |
|
在 SCEP 续订期间启用/禁用保留私钥。 选项
|
|
证书的全局或 VDOM IP 地址范围。 选项
|
|
SCEP 服务器质询密码,用于自动重新生成。 |
|
SCEP 服务器 URL。 |
|
证书源类型。 选项
|
|
与 SCEP 服务器通信的源 IP 地址。 |
|
证书签名请求状态。 |
备注
注意
旧版的 fortiosapi 已被弃用,httpapi 是运行 playbook 的首选方法
此模块支持 check_mode。
示例
- name: Local keys and certificates.
fortinet.fortios.fortios_vpn_certificate_local:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_certificate_local:
acme_ca_url: "<your_own_value>"
acme_domain: "<your_own_value>"
acme_email: "<your_own_value>"
acme_renew_window: "30"
acme_rsa_key_size: "2048"
auto_regenerate_days: "0"
auto_regenerate_days_warning: "0"
ca_identifier: "myId_10"
certificate: "<your_own_value>"
cmp_path: "<your_own_value>"
cmp_regeneration_method: "keyupate"
cmp_server: "<your_own_value>"
cmp_server_cert: "<your_own_value> (source vpn.certificate.ca.name vpn.certificate.remote.name)"
comments: "<your_own_value>"
csr: "<your_own_value>"
enroll_protocol: "none"
est_ca_id: "<your_own_value>"
est_client_cert: "<your_own_value> (source vpn.certificate.local.name)"
est_http_password: "<your_own_value>"
est_http_username: "<your_own_value>"
est_server: "<your_own_value>"
est_server_cert: "<your_own_value> (source vpn.certificate.ca.name vpn.certificate.remote.name)"
est_srp_password: "<your_own_value>"
est_srp_username: "<your_own_value>"
ike_localid: "<your_own_value>"
ike_localid_type: "asn1dn"
last_updated: "2147483647"
name: "default_name_30"
name_encoding: "printable"
password: "<your_own_value>"
private_key: "<your_own_value>"
private_key_retain: "enable"
range: "global"
scep_password: "<your_own_value>"
scep_url: "<your_own_value>"
source: "factory"
source_ip: "84.230.14.43"
state: "<your_own_value>"
返回值
通用返回值已在此处记录 这里,以下是此模块特有的字段
键 |
描述 |
---|---|
飞塔镜像的版本号 返回: 总是 示例: |
|
用于将内容配置到 FortiGate 的最后使用的方法 返回: 总是 示例: |
|
FortiGate 在上次应用操作时给出的最后结果 返回: 总是 示例: |
|
上次调用 FortiGate 时使用的主键 (id) 返回: 成功 示例: |
|
用于满足请求的表名 返回: 总是 示例: |
|
用于满足请求的表的路径 返回: 总是 示例: |
|
内部修订号 返回: 总是 示例: |
|
设备的序列号 返回: 总是 示例: |
|
指示操作的结果 返回: 总是 示例: |
|
使用的虚拟域 返回: 总是 示例: |
|
FortiGate 的版本 返回: 总是 示例: |