community.digitalocean.digital_ocean_snapshot 模块 – 创建和删除 DigitalOcean 快照

注意

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

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.digitalocean。

要在 playbook 中使用它，请指定： community.digitalocean.digital_ocean_snapshot。

community.digitalocean 1.7.0 中的新功能

概要

  • 此模块可用于创建和删除 DigitalOcean Droplet 和卷快照。

参数

参数

注释

baseurl

字符串

DigitalOcean API 基本 URL。

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

droplet_id

字符串

要创建快照的 Droplet ID。

oauth_token

别名：api_token

字符串

DigitalOcean OAuth 令牌。

还有几个其他环境变量可用于提供此值。

例如，- DO_API_TOKEN、 DO_API_KEY、 DO_OAUTH_TOKEN 和 OAUTH_TOKEN。

snapshot_id

字符串

要删除的快照 ID。

snapshot_name

字符串

要创建的快照的名称。

snapshot_tags

列表 / 元素=字符串

要应用于卷快照的标签列表。

仅适用于卷快照（不适用于 Droplet）。

默认值： []

snapshot_type

字符串

指定要创建或删除的快照信息的类型。

如果设置为 droplet，则会创建一个 Droplet 快照。

如果设置为 volume，则会创建一个卷快照。

选择

  • "droplet" ←（默认）

  • "volume"

state

字符串

快照应该存在（已创建）还是不存在（已删除）。

选择

  • "present" ←（默认）

  • "absent"

timeout

整数

用于轮询 DigitalOcean API 的超时时间（以秒为单位）。

默认值： 30

validate_certs

布尔值

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

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

选择

  • false

  • true ←（默认）

volume_id

字符串

要创建快照的卷 ID。

wait

布尔值

在返回之前等待快照创建完成。

选择

  • false

  • true ←（默认）

wait_timeout

整数

创建快照时，等待放弃的时间（以秒为单位）。

默认值： 120

示例

- name: Snapshot a Droplet
  community.digitalocean.digital_ocean_snapshot:
    state: present
    snapshot_type: droplet
    droplet_id: 250329179
  register: result

- name: Delete a Droplet snapshot
  community.digitalocean.digital_ocean_snapshot:
    state: absent
    snapshot_type: droplet
    snapshot_id: 85905825
  register: result

- name: Snapshot a Volume
  community.digitalocean.digital_ocean_snapshot:
    state: present
    snapshot_type: volume
    snapshot_name: mysnapshot1
    volume_id: 9db5e329-cc68-11eb-b027-0a58ac144f91

- name: Delete a Volume snapshot
  community.digitalocean.digital_ocean_snapshot:
    state: absent
    snapshot_type: volume
    snapshot_id: a902cdba-cc68-11eb-a701-0a58ac145708

返回值

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

键

描述

数据

字典

快照创建或删除操作。

已返回：成功

示例: [{"completed_at": "2021-06-14T12:36:00Z", "id": 1229119156, "region": {"available": true, "features": ["backups", "ipv6", "metadata", "install_agent", "storage", "image_transfer"], "name": "纽约 1", "sizes": ["s-1vcpu-1gb", "s-1vcpu-1gb-amd", "s-1vcpu-1gb-intel", "<snip>"], "slug": "nyc1"}, "region_slug": "nyc1", "resource_id": 250445117, "resource_type": "droplet", "started_at": "2021-06-14T12:35:25Z", "status": "completed", "type": "snapshot"}, {"created_at": "2021-06-14T12:55:10Z", "id": "c06d4a86-cd0f-11eb-b13c-0a58ac145472", "min_disk_size": 1, "name": "my-snapshot-1", "regions": ["nbg1"], "resource_id": "f0adea7e-cd0d-11eb-b027-0a58ac144f91", "resource_type": "volume", "size_gigabytes": 0, "tags": ["tag1", "tag2"]}]

作者

  • Mark Mercado (@mamercad)