ngine_io.cloudstack.cs_template 模块 – 管理基于 Apache CloudStack 的云上的模板。

注意

此模块是 ngine_io.cloudstack 集合（版本 2.5.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install ngine_io.cloudstack。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：ngine_io.cloudstack.cs_template。

ngine_io.cloudstack 0.1.0 中的新增功能

概要

  • 从 URL 注册模板。

  • 从已停止的 VM 的 ROOT 卷或其快照创建模板。

  • 更新、提取和删除模板。

要求

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

  • python >= 2.6

  • cs >= 0.9.0

参数

参数

注释

account

string

模板、快照或 VM 所属的帐户。

api_http_method

string

用于查询 API 端点的 HTTP 方法。

如果未给定，则考虑 CLOUDSTACK_METHOD 环境变量。

选项

  • "get" ←（默认）

  • "post"

api_key

string / 必需

CloudStack API 的 API 密钥。

如果未给定，则考虑 CLOUDSTACK_KEY 环境变量。

api_secret

string / 必需

CloudStack API 的密钥。

如果未设置，则考虑 CLOUDSTACK_SECRET 环境变量。

api_timeout

integer

HTTP 超时时间（秒）。

如果未给定，则考虑 CLOUDSTACK_TIMEOUT 环境变量。

默认： 10

api_url

string / 必需

CloudStack API 的 URL，例如 https://cloud.example.com/client/api。

如果未给定，则考虑 CLOUDSTACK_ENDPOINT 环境变量。

api_verify_ssl_cert

string

验证 CA 授权证书文件。

如果未给定，则考虑 CLOUDSTACK_VERIFY 环境变量。

bits

integer

32 位或 64 位支持。

选项

  • 32

  • 64 ←（默认）

checksum

string

此模板的 MD5 校验和值。

如果设置，我们将按校验和而不是名称进行搜索。

cross_zones

boolean

模板是否应跨区域同步或删除。

仅当 state 为 present 或 absent 时使用。

选项

  • false ←（默认）

  • true

details

string

键/值对中的模板详细信息。

display_text

string

模板的显示文本。

domain

string

模板、快照或 VM 所属的域。

format

string

模板的格式。

仅当 state=present 时考虑。

选项

  • "QCOW2"

  • "RAW"

  • "VHD"

  • "OVA"

hypervisor

string

用于创建新模板的虚拟机管理程序名称。

在使用 state=present 时相关。

可能的值为 KVM、VMware、BareMetal、XenServer、LXC、HyperV、UCS、OVM、Simulator。

is_dynamically_scalable

boolean

注册已安装 XS/VMware 工具的模板，以支持 VM CPU/内存的动态扩展。

仅当 state 为 present 时使用。

选项

  • false

  • true

is_extractable

boolean

允许提取模板或其衍生物。

选项

  • false

  • true

boolean

注册要作为特色的模板。

仅当 state 为 present 时使用。

选项

  • false

  • true

is_public

boolean

注册要公开提供给所有用户的模板。

仅当 state 为 present 时使用。

选项

  • false

  • true

is_routing

boolean

将模板类型设置为路由，即如果模板用于部署路由器。

仅当使用url时才考虑。

选项

  • false

  • true

模式

string

模板提取的模式。

仅当state=extracted时使用。

选项

  • "http_download" ← (默认)

  • "ftp_upload"

名称

string / 必需

模板的名称。

操作系统类型

string

最能代表此模板的操作系统类型。

密码启用

boolean

启用模板密码重置支持。

选项

  • false

  • true

轮询异步

boolean

轮询异步作业直到作业完成。

选项

  • false

  • true ← (默认)

项目

string

要注册模板的项目名称。

需要硬件虚拟化

boolean

模板是否需要HVM。

仅在创建模板时考虑。

选项

  • false

  • true

快照

string

从虚拟机 ROOT 卷创建的快照名称，模板将从此快照创建。

vm 需要与此参数一起使用。

ssh密钥启用

boolean

如果模板支持 ssh 密钥上传功能，则为 True。

仅当使用url时才考虑（API限制）。

选项

  • false

  • true

状态

string

模板的状态。

选项

  • "present" ← (默认)

  • "absent"

  • "extracted"

标签

别名：tag

列表 / 元素=字典

标签列表。标签是具有键key和value的字典列表。

要删除所有标签，请设置一个空列表，例如tags: []。

模板过滤器

string

用于搜索模板的过滤器名称。

过滤器all 在 2.7 中添加。

选项

  • "all"

  • "featured"

  • "self" ← (默认)

  • "selfexecutable"

  • "sharedexecutable"

  • "executable"

  • "community"

模板查找选项

别名：template_find_option

列表 / 元素=字符串

唯一查找模板的选项。

允许多个。

选项

  • "display_text"

  • "checksum"

  • "cross_zones"

默认值： []

模板标签

string

此模板的标签。

网址

string

模板在 state=present 时托管的 URL。

在 state=extracted 时将模板提取到的 URL。

与vm互斥。

验证证书

boolean

在 ngine_io.cloudstack 2.4.0 中添加

如果 false，则不会验证 SSL 证书。

如果未给出，则会考虑 CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY 环境变量。

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

选项

  • false

  • true ← (默认)

虚拟机

string

将从其卷或快照创建模板的虚拟机名称。

如果从其卷创建，则虚拟机必须处于停止状态。

与url互斥。

区域

string

您希望从中注册或删除模板的区域名称。

当 cross_zones 为 no 时是必需的

注释

注意

  • 有关 cloudstack 模块的详细指南可以在CloudStack 云指南中找到。

  • 此模块支持检查模式。

示例

- name: register a systemvm template
  ngine_io.cloudstack.cs_template:
    name: systemvm-vmware-4.5
    url: "http://packages.shapeblue.com/systemvmtemplate/4.5/systemvm64template-4.5-vmware.ova"
    hypervisor: VMware
    format: OVA
    cross_zones: yes
    os_type: Debian GNU/Linux 7(64-bit)

- name: Create a template from a stopped virtual machine's volume
  ngine_io.cloudstack.cs_template:
    name: Debian 9 (64-bit) 20GB ({{ ansible_date_time.date }})
    vm: debian-9-base-vm
    os_type: Debian GNU/Linux 9 (64-bit)
    zone: tokio-ix
    password_enabled: yes
    is_public: yes


# Note: Use template_find_option(s) when a template name is not unique
- name: Create a template from a stopped virtual machine's volume
  ngine_io.cloudstack.cs_template:
    name: Debian 9 (64-bit)
    display_text: Debian 9 (64-bit) 20GB ({{ ansible_date_time.date }})
    template_find_option: display_text
    vm: debian-9-base-vm
    os_type: Debian GNU/Linux 9 (64-bit)
    zone: tokio-ix
    password_enabled: yes
    is_public: yes

- name: create a template from a virtual machine's root volume snapshot
  ngine_io.cloudstack.cs_template:
    name: Debian 9 (64-bit) Snapshot ROOT-233_2015061509114
    snapshot: ROOT-233_2015061509114
    os_type: Debian GNU/Linux 9 (64-bit)
    zone: tokio-ix
    password_enabled: yes
    is_public: yes

- name: Remove a template
  ngine_io.cloudstack.cs_template:
    name: systemvm-4.2
    cross_zones: yes
    state: absent

返回值

通用返回值在此处记录此处，以下是此模块独有的字段

密钥

描述

account

string

模板所属的帐户。

返回： 成功

示例： "example account"

checksum

string

模板的 MD5 校验和。

返回： 如果可用

示例： "0b31bccccb048d20b551f70830bb7ad0"

已创建

string

注册日期。

返回： 成功

示例： "2015-03-29T14:57:06+0200"

cross_zones

boolean

如果模板在所有区域中进行管理，则为 true，否则为 false。

返回： 如果可用

示例： false

display_text

string

模板的显示文本。

返回： 如果可用

示例： "Debian 7.7 64-bit minimal 2015-03-19"

domain

string

模板所属的域。

返回： 成功

示例： "example domain"

format

string

模板的格式。

返回： 如果可用

示例： "OVA"

hypervisor

string

与此模板相关的虚拟机管理程序。

返回： 如果可用

示例： "VMware"

id

string

模板或提取对象的 UUID。

返回： 成功

示例： "a6f7a5fc-43f8-11e5-a151-feff819cdc9f"

is_extractable

boolean

如果模板可提取，则为 True。

返回： 如果可用

示例： true

boolean

如果模板是精选的，则为 True。

返回： 如果可用

示例： true

is_public

boolean

如果模板是公共的，则为 True。

返回： 如果可用

示例： true

准备就绪

boolean

如果模板可以从中部署，则为 True。

返回： 如果可用

示例： true

模式

string

提取模式

返回： 在 state=extracted 上

示例： "http_download"

名称

string

模板或提取对象的名称。

返回： 成功

示例： "Debian 7 64-bit"

操作系统类型

string

操作系统的类型。

返回： 如果可用

示例： "CentOS 6.5 (64-bit)"

密码启用

boolean

如果启用重置密码功能，则为 True，否则为 False。

返回： 如果可用

示例： false

项目

string

模板所属的项目名称。

返回： 成功

示例： "Production"

ssh密钥启用

boolean

如果模板启用了 ssh 密钥，则为 true，否则为 false。

返回： 如果可用

示例： false

状态

string

提取的模板状态

返回： 在 state=extracted 上

示例： "DOWNLOAD_URL_CREATED"

状态

string

模板或提取对象的状态。

返回： 成功

示例： "Download Complete"

标签

列表 / 元素=字符串

与模板关联的资源标签列表。

返回： 如果可用

示例： ["[ { \"key\": \"foo\"", " \"value\": \"bar\" } ]"]

模板标签

string

与此模板相关的模板标签。

返回： 如果可用

示例： "special"

模板类型

string

模板的类型。

返回： 如果可用

示例： "USER"

网址

string

将模板提取到的 URL

返回： 在 state=extracted 上

示例： "http://1.2.3.4/userdata/eb307f13-4aca-45e8-b157-a414a14e6b04.ova"

区域

string

模板注册的区域名称。

返回： 成功

示例： "zuerich"

作者

  • René Moser (@resmo)