ngine_io.cloudstack.cs_domain 模块 – 管理基于 Apache CloudStack 云的域。

注意

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

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

要安装它,请使用: ansible-galaxy collection install ngine_io.cloudstack。您需要其他要求才能使用此模块,有关详细信息,请参见 要求

要在剧本中使用它,请指定: ngine_io.cloudstack.cs_domain

ngine_io.cloudstack 0.1.0 中的新增功能

概要

  • 创建、更新和删除域。

要求

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

  • python >= 2.6

  • cs >= 0.9.0

参数

参数

注释

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 环境变量。

clean_up

布尔值

清理所有域资源,例如子域和帐户。

state=absent 时考虑。

选项

  • false ← (默认)

  • true

network_domain

字符串

域中网络的网络域。

path

字符串 / 必需

域的路径。

路径中的前缀 ROOT//ROOT/ 是可选的。

poll_async

布尔值

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

选项

  • false

  • true ← (默认)

state

字符串

域的状态。

选项

  • "present" ← (默认)

  • "absent"

validate_certs

布尔值

ngine_io.cloudstack 2.4.0 中新增

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

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

这只能在使用自签名证书的个人控制站点上使用。

选项

  • false

  • true ← (默认)

备注

注意

  • 有关 cloudstack 模块的详细指南,请参见 CloudStack 云指南

  • 此模块支持检查模式。

示例

- name: Create a domain
  ngine_io.cloudstack.cs_domain:
    path: ROOT/customers
    network_domain: customers.example.com

- name: Create another subdomain
  ngine_io.cloudstack.cs_domain:
    path: ROOT/customers/xy
    network_domain: xy.customers.example.com

- name: Remove a domain
  ngine_io.cloudstack.cs_domain:
    path: ROOT/customers/xy
    state: absent

返回值

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

描述

id

字符串

域的 UUID。

返回:成功

示例: "87b1e0ce-4e01-11e4-bb66-0050569e64b8"

name

字符串

域的名称。

返回:成功

示例: "customers"

network_domain

字符串

域的网络域。

返回:成功

示例: "example.local"

parent_domain

字符串

域的父域。

返回:成功

示例: "ROOT"

path

字符串

域路径。

返回:成功

示例: "/ROOT/customers"

作者

  • René Moser (@resmo)