community.digitalocean.digital_ocean_volume_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_volume_info。

概要

  • 此模块可用于收集有关 DigitalOcean 提供的卷的信息。

  • 在 Ansible 2.9 之前，此模块称为 digital_ocean_volume_facts。使用方法没有改变。

别名：digital_ocean_volume_facts

要求

以下是执行此模块的主机所需的条件。

  • python >= 2.6

参数

参数

注释

baseurl

字符串

DigitalOcean API 基本 URL。

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

oauth_token

别名：api_token

字符串

DigitalOcean OAuth 令牌。

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

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

region_name

字符串

区域名称，用于将结果限制为特定区域中可用的卷。

请使用 community.digitalocean.digital_ocean_region_info 获取与区域相关的有效值。

timeout

整数

用于轮询 DigitalOcean API 的超时时间（秒）。

默认值： 30

validate_certs

布尔值

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

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

选项

  • false

  • true ← (默认值)

示例

- name: Gather information about all volume
  community.digitalocean.digital_ocean_volume_info:
    oauth_token: "{{ oauth_token }}"

- name: Gather information about volume in given region
  community.digitalocean.digital_ocean_volume_info:
    region_name: nyc1
    oauth_token: "{{ oauth_token }}"

- name: Get information about volume named nyc3-test-volume
  community.digitalocean.digital_ocean_volume_info:
  register: resp_out
- set_fact:
    volume_id: "{{ item.id }}"
  loop: "{{ resp_out.data | community.general.json_query(name) }}"
  vars:
    name: "[?name=='nyc3-test-volume']"
- debug: var=volume_id

返回值

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

键

描述

data

列表 / 元素=字符串

DigitalOcean 卷信息

返回：成功

示例： [{"created_at": "2016-03-02T17:00:49Z", "description": "Block store for examples", "droplet_ids": [], "id": "506f78a4-e098-11e5-ad9f-000f53306ae1", "name": "example", "region": {"available": true, "features": ["private_networking", "backups", "ipv6", "metadata"], "name": "New York 1", "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192gb"], "slug": "nyc1"}, "size_gigabytes": 10}]

作者

  • Abhijeet Kasurde (@Akasurde)