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 注册模板。
从已停止的虚拟机或其快照的 ROOT 卷创建模板。
更新、提取和删除模板。

要求 

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

python >= 2.6
cs >= 0.9.0

参数 

参数	注释
account 字符串	与模板、快照或虚拟机相关的帐户。
api_http_method 字符串	用于查询 API 端点的 HTTP 方法。如果未给出，则考虑 `CLOUDSTACK_METHOD` 环境变量。选择 `"get"` ← (默认) `"post"`
api_key 字符串 / 必需	CloudStack API 的 API 密钥。如果未给出，则考虑 `CLOUDSTACK_KEY` 环境变量。
api_secret 字符串 / 必需	CloudStack API 的密钥。如果未设置，则考虑 `CLOUDSTACK_SECRET` 环境变量。
api_timeout 整数	HTTP 超时（以秒为单位）。如果未给出，则考虑 `CLOUDSTACK_TIMEOUT` 环境变量。默认值: `10`
api_url 字符串 / 必需	CloudStack API 的 URL，例如 https://cloud.example.com/client/api。如果未给出，则考虑 `CLOUDSTACK_ENDPOINT` 环境变量。
api_verify_ssl_cert 字符串	验证 CA 授权证书文件。如果未给出，则考虑 `CLOUDSTACK_VERIFY` 环境变量。
bits 整数	32 或 64 位支持。选择 `32` `64` ← (默认)
checksum 字符串	此模板的 MD5 校验和值。如果设置，我们将按校验和而不是名称进行搜索。
cross_zones 布尔值	是否应在区域之间同步或删除模板。仅当 state 为 `present` 或 `absent` 时使用。选择 `false` ← (默认) `true`
details 字符串	键/值对中的模板详细信息。
display_text 字符串	模板的显示文本。
domain 字符串	模板、快照或虚拟机相关的域。
format 字符串	模板的格式。仅当 state=present 时才考虑。选择 `"QCOW2"` `"RAW"` `"VHD"` `"OVA"`
hypervisor 字符串	用于创建新模板的虚拟机管理程序名称。当使用 state=present 时相关。可能的值为 `KVM`、`VMware`、`BareMetal`、`XenServer`、`LXC`、`HyperV`、`UCS`、`OVM`、`Simulator`。
is_dynamically_scalable 布尔值	注册安装了 XS/VMware 工具的模板，以支持虚拟机 CPU/内存的动态缩放。仅当 state 为 `present` 时使用。选择 `false` `true`
is_extractable 布尔值	允许模板或其派生项可提取。选择 `false` `true`
is_featured 布尔值	注册要推荐的模板。仅当 state 为 `present` 时使用。选择 `false` `true`
is_public 布尔值	注册模板以供所有用户公开使用。仅当 state 为 `present` 时使用。选择 `false` `true`
is_routing 布尔值	将模板类型设置为路由，即如果模板用于部署路由器。仅当使用 url 时才考虑。选择 `false` `true`
mode 字符串	模板提取的模式。仅当 state=extracted 时使用。选择 `"http_download"` ← (默认) `"ftp_upload"`
name 字符串 / 必需	模板的名称。
os_type 字符串	最能代表此模板操作系统的操作系统类型。
password_enabled 布尔值	启用模板密码重置支持。选择 `false` `true`
poll_async 布尔值	轮询异步作业，直到作业完成。选择 `false` `true` ← (默认)
project 字符串	要在其中注册模板的项目的名称。
requires_hvm 布尔值	模板是否需要 HVM。仅在创建模板时考虑。选择 `false` `true`
snapshot 字符串	从虚拟机 ROOT 卷创建的快照的名称，将从中创建模板。 vm 需要与此参数一起使用。
sshkey_enabled 布尔值	如果模板支持 sshkey 上传功能，则为 True。仅当使用 url 时才考虑（API 限制）。选择 `false` `true`
state 字符串	模板的状态。选择 `"present"` ← (默认) `"absent"` `"extracted"`
tags 别名: tag 列表 / elements=字典	标签列表。标签是具有键 key 和 value 的字典列表。要删除所有标签，请设置一个空列表，例如 tags: []。
template_filter 字符串	用于搜索模板的筛选器的名称。筛选器 `all` 在 2.7 中添加。选择 `"all"` `"featured"` `"self"` ← (默认) `"selfexecutable"` `"sharedexecutable"` `"executable"` `"community"`
template_find_options 别名: template_find_option 列表 / 元素=字符串	用于唯一查找模板的选项。允许多个。选择 `"display_text"` `"checksum"` `"cross_zones"` 默认: `[]`
template_tag 字符串	此模板的标签。
url 字符串	当 state=present 时，模板所在的 URL。当 state=extracted 时，模板将被提取到的 URL。与 vm 互斥。
validate_certs 布尔值在 ngine_io.cloudstack 2.4.0 中添加	如果 `false`，则不会验证 SSL 证书。如果未给定，则考虑 `CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY` 环境变量。这应该仅在个人控制的使用自签名证书的站点上使用。选择 `false` `true` ← (默认)
vm 字符串	将从中创建模板的虚拟机名称（从其卷或快照）。如果从其卷创建，虚拟机必须处于停止状态。与 url 互斥。
zone 字符串	您希望注册或删除模板的区域的名称。当 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 字符串	模板所属的帐户。返回: 成功示例: `"示例帐户"`
checksum 字符串	模板的 MD5 校验和。返回: 如果可用示例: `"0b31bccccb048d20b551f70830bb7ad0"`
created 字符串	注册日期。返回: 成功示例: `"2015-03-29T14:57:06+0200"`
cross_zones 布尔值	如果模板在所有区域中管理，则为 true；否则为 false。返回: 如果可用示例: `false`
display_text 字符串	模板的显示文本。返回: 如果可用示例: `"Debian 7.7 64 位 minimal 2015-03-19"`
domain 字符串	模板所属的域。返回: 成功示例: `"示例域"`
format 字符串	模板的格式。返回: 如果可用示例: `"OVA"`
hypervisor 字符串	与此模板相关的虚拟机管理程序。返回: 如果可用示例: `"VMware"`
id 字符串	模板或提取对象的 UUID。返回: 成功示例: `"a6f7a5fc-43f8-11e5-a151-feff819cdc9f"`
is_extractable 布尔值	如果模板可提取，则为 True。返回: 如果可用示例: `true`
is_featured 布尔值	如果模板是精选的，则为 True。返回: 如果可用示例: `true`
is_public 布尔值	如果模板是公开的，则为 True。返回: 如果可用示例: `true`
is_ready 布尔值	如果模板已准备好部署，则为 True。返回: 如果可用示例: `true`
mode 字符串	提取模式返回: 当 state=extracted 时示例: `"http_download"`
name 字符串	模板或提取对象的名称。返回: 成功示例: `"Debian 7 64 位"`
os_type 字符串	操作系统的类型。返回: 如果可用示例: `"CentOS 6.5 (64 位)"`
password_enabled 布尔值	如果启用重置密码功能，则为 True；否则为 False。返回: 如果可用示例: `false`
project 字符串	模板所属的项目名称。返回: 成功示例: `"生产"`
sshkey_enabled 布尔值	如果模板启用了 sshkey，则为 true；否则为 false。返回: 如果可用示例: `false`
state 字符串	提取模板的状态返回: 当 state=extracted 时示例: `"DOWNLOAD_URL_CREATED"`
status 字符串	模板或提取对象的状态。返回: 成功示例: `"下载完成"`
tags 列表 / 元素=字符串	与模板关联的资源标签列表。返回: 如果可用示例: `["[ { \"key\": \"foo\"", " \"value\": \"bar\" } ]"]`
template_tag 字符串	与此模板相关的模板标签。返回: 如果可用示例: `"特殊"`
template_type 字符串	模板的类型。返回: 如果可用示例: `"USER"`
url 字符串	模板提取到的 URL 返回: 当 state=extracted 时示例: `"http://1.2.3.4/userdata/eb307f13-4aca-45e8-b157-a414a14e6b04.ova"`
zone 字符串	模板注册所在区域的名称。返回: 成功示例: `"zuerich"`

作者

René Moser (@resmo)