community.digitalocean.digital_ocean_snapshot_info 模块 – 收集关于 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_info

概要

  • 此模块可用于根据提供的诸如 droplet、卷和快照 ID 之类的值来收集有关快照信息的信息。

  • 在 Ansible 2.9 之前,此模块被称为 digital_ocean_snapshot_facts。用法没有改变。

别名:digital_ocean_snapshot_facts

要求

在执行此模块的主机上需要以下要求。

  • python >= 2.6

参数

参数

注释

baseurl

字符串

DigitalOcean API 基本 URL。

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

oauth_token

别名:api_token

字符串

DigitalOcean OAuth 令牌。

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

例如,-DO_API_TOKENDO_API_KEYDO_OAUTH_TOKENOAUTH_TOKEN

snapshot_id

字符串

要检索有关快照的信息,请将其指定为快照 ID。

如果设置为实际快照 ID,则仅收集与该特定快照相关的信息。

如果 snapshot_type 设置为 by_id,则此为必需参数。

snapshot_type

字符串

指定要检索的快照信息的类型。

如果设置为 droplet,则仅收集与基于 Droplet 的快照相关的信息。

如果设置为 volume,则仅收集与基于卷的快照相关的信息。

如果设置为 by_id,则仅收集与基于快照 ID 的快照相关的信息。

如果未设置为以上任何一项,则收集与所有快照相关的信息。

选项

  • "all" ←(默认)

  • "droplet"

  • "volume"

  • "by_id"

timeout

整数

轮询 DigitalOcean API 的超时时间(以秒为单位)。

默认值: 30

validate_certs

布尔值

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

这应该只在个人控制的使用自签名证书的站点上设置为 no

选项

  • false

  • true ←(默认)

示例

- name: Gather information about all snapshots
  community.digitalocean.digital_ocean_snapshot_info:
    snapshot_type: all
    oauth_token: "{{ oauth_token }}"

- name: Gather information about droplet snapshots
  community.digitalocean.digital_ocean_snapshot_info:
    snapshot_type: droplet
    oauth_token: "{{ oauth_token }}"

- name: Gather information about volume snapshots
  community.digitalocean.digital_ocean_snapshot_info:
    snapshot_type: volume
    oauth_token: "{{ oauth_token }}"

- name: Gather information about snapshot by snapshot id
  community.digitalocean.digital_ocean_snapshot_info:
    snapshot_type: by_id
    snapshot_id: 123123123
    oauth_token: "{{ oauth_token }}"

- name: Get information about snapshot named big-data-snapshot1
  community.digitalocean.digital_ocean_snapshot_info:
  register: resp_out
- set_fact:
    snapshot_id: "{{ item.id }}"
  loop: "{{ resp_out.data | community.general.json_query(name) }}"
  vars:
    name: "[?name=='big-data-snapshot1']"
- debug:
    var: snapshot_id

返回值

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

描述

数据

列表 / elements=字典

DigitalOcean 快照信息

返回:成功

示例: [{"created_at": "2016-09-28T23:14:30Z", "id": "4f60fc64-85d1-11e6-a004-000f53315871", "min_disk_size": 10, "name": "big-data-snapshot1", "regions": ["nyc1"], "resource_id": "89bcc42f-85cf-11e6-a004-000f53315871", "resource_type": "volume", "size_gigabytes": 0}]

作者

  • Abhijeet Kasurde (@Akasurde)