community.digitalocean.digital_ocean_image_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_image_info

概要

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

  • 这些镜像可以是 distributionapplicationprivate 类型。

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

别名:digital_ocean_image_facts

要求

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

  • python >= 2.6

参数

参数

注释

baseurl

字符串

DigitalOcean API 的基本 URL。

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

image_type

字符串

指定要检索的镜像信息的类型。

如果设置为 application,则会收集与所有应用程序镜像相关的信息。

如果设置为 distribution,则会收集与所有发行版镜像相关的信息。

如果设置为 private,则会收集与所有私有镜像相关的信息。

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

选项

  • "all" ← (默认)

  • "application"

  • "distribution"

  • "private"

oauth_token

别名:api_token

字符串

DigitalOcean OAuth 令牌。

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

例如,- DO_API_TOKENDO_API_KEYDO_OAUTH_TOKENOAUTH_TOKEN

timeout

整数

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

默认值: 30

validate_certs

布尔值

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

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

选项

  • false

  • true ← (默认)

示例

- name: Gather information about all images
  community.digitalocean.digital_ocean_image_info:
    image_type: all
    oauth_token: "{{ oauth_token }}"

- name: Gather information about application images
  community.digitalocean.digital_ocean_image_info:
    image_type: application
    oauth_token: "{{ oauth_token }}"

- name: Gather information about distribution images
  community.digitalocean.digital_ocean_image_info:
    image_type: distribution
    oauth_token: "{{ oauth_token }}"

- name: Get distribution about image with slug coreos-beta
  community.digitalocean.digital_ocean_image_info:
  register: resp_out
- set_fact:
    distribution_name: "{{ item.distribution }}"
  loop: "{{ resp_out.data | community.general.json_query(name) }}"
  vars:
    name: "[?slug=='coreos-beta']"
- debug:
    var: distribution_name

返回值

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

描述

data

列表 / 元素=字符串

DigitalOcean 镜像信息

返回:成功

示例: [{"created_at": "2018-02-02T07:11:43Z", "distribution": "CoreOS", "id": 31434061, "min_disk_size": 20, "name": "1662.1.0 (beta)", "public": true, "regions": ["nyc1", "sfo1", "nyc2", "ams2", "sgp1", "lon1", "nyc3", "ams3", "fra1", "tor1", "sfo2", "blr1"], "size_gigabytes": 0.42, "slug": "coreos-beta", "type": "snapshot"}]

作者

  • Abhijeet Kasurde (@Akasurde)