community.crypto.ecs_domain 模块 – 使用 Entrust 证书服务 (ECS) API 请求域验证
注意
此模块是 community.crypto 集合 (版本 2.22.3) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install community.crypto。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。
要在 playbook 中使用它，请指定：community.crypto.ecs_domain。
community.crypto 1.0.0 中的新增功能
概要
使用 Entrust 证书服务 (ECS) API 请求验证或重新验证域。
需要 Entrust 证书服务 (ECS) API 的凭据。
如果域已处于验证过程中，则不会请求新的验证，但将返回验证数据（如果适用）。
如果域已处于验证过程中，但指定的
verification_method与当前verification_method不同，则将更新verification_method，并将返回验证数据（如果适用）。如果域是已激活的已验证域，则
changed的返回值将为 false，除非domain_status=EXPIRED，在这种情况下将执行重新验证。如果
verification_method=dns，则所需 DNS 条目的详细信息将指定在返回参数dns_contents、dns_location和dns_resource_type中。如果
verification_method=web_server，则所需文件详细信息将指定在返回参数file_contents和file_location中。如果
verification_method=email，则已发送验证电子邮件的电子邮件地址将位于返回参数emails中。这纯粹是信息性的。对于使用此模块请求的域，这始终是一个大小为 1 的列表。
要求
在执行此模块的主机上需要以下要求。
PyYAML >= 3.11
参数
参数 |
注释 |
|---|---|
请求将域关联到的客户端 ID。 如果未指定客户端 ID，则域将在 ID 为 1 的主客户端下添加。 默认值： |
|
要验证或重新验证的域名。 |
|
用于向 Entrust 证书服务 (ECS) API 进行身份验证的客户端证书密钥的路径。 |
|
用于向 Entrust 证书服务 (ECS) API 进行身份验证的客户端证书的路径。 |
|
用于向 Entrust 证书服务 (ECS) API 进行身份验证的密钥（密码）。 |
|
定义 Entrust 证书服务 (ECS) API 配置的规范文件的路径。 您可以使用此路径保存规范文件的本地副本，避免每次使用模块时都下载。 默认值： |
|
Entrust 证书服务 (ECS) API 身份验证的用户名。 |
|
用于验证域名所有权的电子邮件地址。 电子邮件地址必须是 请注意，如果 如果使用域或其顶级命名空间 WHOIS 数据中的电子邮件值，则必须完全匹配。 如果 要验证域名所有权，域名所有者必须按照收到的电子邮件中的说明操作。 仅当 |
|
用于证明控制域的验证方法。 如果 如果 如果 如果 选项
|
属性
属性 |
支持 |
描述 |
|---|---|---|
支持：不支持 |
可以在 |
|
支持：不支持 |
在差异模式下，将返回有关已更改内容（或可能需要在 |
备注
注意
在请求验证时，获取随机值之前存在短暂延迟（通常约 5 秒，但最长可达 60 秒），此时
verification_method=dns或verification_method=web_server。进行许多域名验证请求时，请注意这一点。
另请参阅
另请参阅
- community.crypto.x509_certificate
可用于使用
provider=entrust从 ECS 请求证书。- community.crypto.ecs_certificate
可用于使用已验证的域名从 ECS 请求证书。
示例
- name: Request domain validation using email validation for client ID of 2.
community.crypto.ecs_domain:
domain_name: ansible.com
client_id: 2
verification_method: email
verification_email: admin@ansible.com
entrust_api_user: apiusername
entrust_api_key: a^lv*32!cd9LnT
entrust_api_client_cert_path: /etc/ssl/entrust/ecs-client.crt
entrust_api_client_cert_key_path: /etc/ssl/entrust/ecs-client.key
- name: Request domain validation using DNS. If domain is already valid,
request revalidation if expires within 90 days
community.crypto.ecs_domain:
domain_name: ansible.com
verification_method: dns
entrust_api_user: apiusername
entrust_api_key: a^lv*32!cd9LnT
entrust_api_client_cert_path: /etc/ssl/entrust/ecs-client.crt
entrust_api_client_cert_key_path: /etc/ssl/entrust/ecs-client.key
- name: Request domain validation using web server validation, and revalidate
if fewer than 60 days remaining of EV eligibility.
community.crypto.ecs_domain:
domain_name: ansible.com
verification_method: web_server
entrust_api_user: apiusername
entrust_api_key: a^lv*32!cd9LnT
entrust_api_client_cert_path: /etc/ssl/entrust/ecs-client.crt
entrust_api_client_cert_key_path: /etc/ssl/entrust/ecs-client.key
- name: Request domain validation using manual validation.
community.crypto.ecs_domain:
domain_name: ansible.com
verification_method: manual
entrust_api_user: apiusername
entrust_api_key: a^lv*32!cd9LnT
entrust_api_client_cert_path: /etc/ssl/entrust/ecs-client.crt
entrust_api_client_cert_key_path: /etc/ssl/entrust/ecs-client.key
返回值
常见返回值已记录在 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
ECS 期望在位于 返回：已更改，如果 示例： |
|
ECS 期望能够找到用于域名验证的 DNS 条目的位置，其中包含 返回：已更改，如果 示例： |
|
当前域的状态。将是以下之一： 返回：已更改或成功 示例： |
|
用于请求此域验证的电子邮件列表。 使用此模块请求的域将只有一个大小为1的列表。 返回值： 示例： |
|
域剩余可提交“EV”证书的天数。永远不会大于 返回值：成功且 示例： |
|
域是否符合提交“EV”证书的条件。如果 返回值：成功且 示例： |
|
ECS 期望在 返回值： 示例： |
|
ECS 期望能够找到用于域验证的文件的位置，该文件包含 返回值： 示例： |
|
域剩余可提交“OV”证书的天数。永远不会小于 返回值：成功且 示例： |
|
域是否符合提交“OV”证书的条件。如果 返回值：成功且 示例： |
|