ngine_io.cloudstack.cs_project 模块 – 管理基于 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_project

ngine_io.cloudstack 0.1.0 中的新增功能

概要

  • 创建、更新、暂停、激活和删除项目。

要求

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

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

display_text

字符串

项目的显示文本。

如果没有指定,则将 *name* 用作 *display_text*。

domain

字符串

项目相关的域。

name

字符串 / 必填

项目名称。

poll_async

布尔值

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

选项

  • false

  • true ← (默认)

state

字符串

项目的状态。

选项

  • "present" ← (默认)

  • "absent"

  • "active"

  • "suspended"

tags

别名:tag

列表 / 元素=字典

标签列表。标签是包含键 *key* 和 *value* 的字典列表。

如果要删除所有标签,请设置空列表,例如 *tags: []*。

validate_certs

布尔值

ngine_io.cloudstack 2.4.0 中新增

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

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

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

选项

  • false

  • true ← (默认)

备注

注意

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

  • 此模块支持检查模式。

示例

- name: Create a project
  ngine_io.cloudstack.cs_project:
    name: web
    tags:
      - { key: admin, value: john }
      - { key: foo,   value: bar }

- name: Rename a project
  ngine_io.cloudstack.cs_project:
    name: web
    display_text: my web project

- name: Suspend an existing project
  ngine_io.cloudstack.cs_project:
    name: web
    state: suspended

- name: Activate an existing project
  ngine_io.cloudstack.cs_project:
    name: web
    state: active

- name: Remove a project
  ngine_io.cloudstack.cs_project:
    name: web
    state: absent

返回值

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

描述

account

字符串

项目相关的帐户。

返回:成功

示例: "example account"

display_text

字符串

项目的显示文本。

返回:成功

示例: "web project"

domain

字符串

项目相关的域。

返回:成功

示例: "example domain"

id

字符串

项目的 UUID。

返回:成功

示例: "04589590-ac63-4ffc-93f5-b698b8ac38b6"

name

字符串

项目名称。

返回:成功

示例: "web project"

state

字符串

项目的状态。

返回:成功

示例: "Active"

tags

列表 / 元素=字符串

与项目关联的资源标签列表。

返回:成功

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

作者

  • René Moser (@resmo)