community.crypto.ecs_domain 模块 – 使用 Entrust Certificate Services (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 Certificate Services (ECS) API 请求验证或重新验证域名。
需要 Entrust Certificate Services (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 Certificate Services (ECS) API 进行身份验证的客户端证书的密钥的路径。 |
|
用于对 Entrust Certificate Services (ECS) API 进行身份验证的客户端证书的路径。 |
|
用于对 Entrust Certificate Services (ECS) API 进行身份验证的密钥（密码）。 |
|
定义 Entrust Certificate Services (ECS) API 配置的规范文件的路径。 您可以使用它来保留规范的本地副本，以避免每次使用模块时都下载它。 默认值： |
|
用于对 Entrust Certificate Services (ECS) API 进行身份验证的用户名。 |
|
用于验证域名所有权的电子邮件地址。 电子邮件地址必须是 请注意，如果 如果使用域名或其顶级命名空间的 WHOIS 数据中的电子邮件值，它们必须完全匹配。 如果 要验证域名所有权，域名所有者必须按照他们收到的电子邮件中的说明进行操作。 仅当 |
|
用于证明对域的控制权的验证方法。 如果 如果 如果 如果 选项
|
属性
属性 |
支持 |
描述 |
|---|---|---|
支持: 无 |
可以在 |
|
支持: 无 |
在 diff 模式下，将返回有关已更改（或可能需要在 |
注释
注意
当请求验证时，在
verification_method=dns或verification_method=web_server时获取随机值之前会有一个小的延迟（通常约为 5 秒，但最长可达 60 秒）。 如果进行许多域验证请求，请注意这一点。
另请参阅
另请参阅
- community.crypto.x509_certificate
可用于从 ECS 请求证书，使用
provider=entrust。- 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: [email protected]
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 希望在位于 返回: changed 以及如果 示例: |
|
ECS 希望能够找到用于域名验证的 DNS 条目的位置，其中包含 返回: changed 以及如果 示例: |
|
当前域的状态。 将为 返回: changed 或 success 示例: |
|
用于请求验证此域的电子邮件列表。 使用此模块请求的域将只有一个大小为 1 的列表。 返回: 示例: |
|
域名仍然有资格提交“EV”证书的天数。永远不会大于 返回: 成功且 示例: |
|
域名是否有资格提交“EV”证书。如果 返回: 成功且 示例: |
|
ECS 期望在 返回: 示例: |
|
ECS 期望能够找到用于域名验证的文件的位置，其中包含 返回: 示例: |
|
域名仍然有资格提交“OV”证书的天数。永远不会小于 返回: 成功且 示例: |
|
域名是否有资格提交“OV”证书。如果 返回: 成功且 示例: |
|