community.digitalocean.digital_ocean_cdn_endpoints 模块 – 创建、更新和删除 DigitalOcean CDN 端点

注意

此模块是 community.digitalocean 集合 (版本 1.27.0) 的一部分。

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

要安装它,请使用: ansible-galaxy collection install community.digitalocean

要在 playbook 中使用它,请指定: community.digitalocean.digital_ocean_cdn_endpoints

community.digitalocean 1.10.0 中的新增功能

概要

  • 创建、更新和删除 DigitalOcean CDN 端点

参数

参数

注释

baseurl

字符串

DigitalOcean API 基地址。

默认值: "https://api.digitalocean.com/v2"

certificate_id

字符串

提供自定义子域名时用于 SSL 的 DigitalOcean 托管 TLS 证书的 ID。

默认值: ""

custom_domain

字符串

与 CDN 端点一起使用的自定义子域的完全限定域名 (FQDN)。

默认值: ""

oauth_token

别名:api_token

字符串

DigitalOcean OAuth 令牌。

可以使用其他几个环境变量来提供此值。

例如,- DO_API_TOKENDO_API_KEYDO_OAUTH_TOKENOAUTH_TOKEN

origin

字符串 / 必需

提供 CDN 内容的源服务器的完全限定域名 (FQDN)。

目前仅限于 Space。

state

字符串

通常,present 用于创建,absent 用于销毁

选项

  • "present" ← (默认)

  • "absent"

timeout

整数

用于轮询 DigitalOcean API 的超时时间(秒)。

默认值: 30

ttl

整数

CDN 边缘服务器缓存内容的时间量(秒)。

TTL 必须是 60、600、3600、86400 或 604800 之一。

省略时默认为 3600(一小时)。

选项

  • 60

  • 600

  • 3600 ← (默认)

  • 86400

  • 604800

validate_certs

布尔值

如果设置为 no,则不会验证 SSL 证书。

只有在使用自签名证书的个人控制站点上才应将其设置为 no

选项

  • false

  • true ← (默认)

示例

- name: Create DigitalOcean CDN Endpoint
  community.digitalocean.digital_ocean_cdn_endpoints:
    state: present
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    origin: mamercad.nyc3.digitaloceanspaces.com

- name: Update DigitalOcean CDN Endpoint (change ttl to 600, default is 3600)
  community.digitalocean.digital_ocean_cdn_endpoints:
    state: present
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    origin: mamercad.nyc3.digitaloceanspaces.com
    ttl: 600

- name: Delete DigitalOcean CDN Endpoint
  community.digitalocean.digital_ocean_cdn_endpoints:
    state: absent
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    origin: mamercad.nyc3.digitaloceanspaces.com

返回值

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

描述

data

字典

DigitalOcean CDN 端点

返回:成功

示例: {"data": {"endpoint": {"created_at": "2021-09-05T13:47:23Z", "endpoint": "mamercad.nyc3.cdn.digitaloceanspaces.com", "id": "01739563-3f50-4da4-a451-27f6d59d7573", "origin": "mamercad.nyc3.digitaloceanspaces.com", "ttl": 3600}}}

作者

  • Mark Mercado (@mamercad)