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

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

description

字符串

角色的描述。

name

字符串 / 必需

角色的名称。

role_type

字符串

角色的类型。

仅在创建时考虑。

选项

  • "User" ← (默认)

  • "DomainAdmin"

  • "ResourceAdmin"

  • "Admin"

state

字符串

角色的状态。

选项

  • "present" ← (默认)

  • "absent"

uuid

别名:id

字符串

角色的 ID。

如果提供,则 *uuid* 用作键。

validate_certs

布尔值

ngine_io.cloudstack 2.4.0 中新增

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

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

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

选项

  • false

  • true ← (默认)

注释

注意

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

  • 此模块支持检查模式。

示例

- name: Ensure an user role is present
  ngine_io.cloudstack.cs_role:
    name: myrole_user

- name: Ensure a role having particular ID is named as myrole_user
  ngine_io.cloudstack.cs_role:
    name: myrole_user
    id: 04589590-ac63-4ffc-93f5-b698b8ac38b6

- name: Ensure a role is absent
  ngine_io.cloudstack.cs_role:
    name: myrole_user
    state: absent

返回值

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

描述

description

字符串

角色的描述。

返回值: success

示例: "This is my role description"

id

字符串

角色的 UUID。

返回值: success

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

name

字符串

角色的名称。

返回值: success

示例: "myrole"

role_type

字符串

角色的类型。

返回值: success

示例: "User"

作者

  • René Moser (@resmo)