cloudscale_ch.cloud.objects_user 模块 – 管理 cloudscale.ch IaaS 服务上的对象用户

注意

此模块是 cloudscale_ch.cloud 集合 (版本 2.4.0) 的一部分。

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

要安装它,请使用: ansible-galaxy collection install cloudscale_ch.cloud

要在 playbook 中使用它,请指定: cloudscale_ch.cloud.objects_user

cloudscale_ch.cloud 1.1.0 中的新增功能

概要

  • 创建、更新和删除 cloudscale.ch IaaS 服务的对象用户。

参数

参数

注释

api_timeout

整数

对 cloudscale.ch API 的调用的超时时间(以秒为单位)。

这也可以在 CLOUDSCALE_API_TIMEOUT 环境变量中传递。

默认值: 45

api_token

字符串 / 必需

cloudscale.ch API 令牌。

这也可以在 CLOUDSCALE_API_TOKEN 环境变量中传递。

api_url

字符串

cloudscale_ch.cloud 1.3.0 中新增

cloudscale.ch API URL。

这也可以在 CLOUDSCALE_API_URL 环境变量中传递。

默认值: "https://api.cloudscale.ch/v1"

display_name

别名:name

字符串

对象用户的显示名称。

需要 display_nameid 之一。

id

字符串

对象用户的名称。

需要 display_nameid 之一。

state

字符串

对象用户的状态。

选项

  • "present" ← (默认)

  • "absent"

tags

字典

与对象用户关联的标签。将其设置为 {} 以清除所有标签。

注释

注意

示例

- name: Create an objects user
  cloudscale_ch.cloud.objects_user:
    display_name: alan
    tags:
      project: luna
    api_token: xxxxxx
  register: object_user

- name: print keys
  debug:
    var: object_user.keys

- name: Update an objects user
  cloudscale_ch.cloud.objects_user:
    display_name: alan
    tags:
      project: gemini
    api_token: xxxxxx

- name: Remove an objects user
  cloudscale_ch.cloud.objects_user:
    display_name: alan
    state: absent
    api_token: xxxxxx

返回值

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

描述

display_name

字符串

对象用户的显示名称。

返回:成功

示例: "alan"

href

字符串

获取有关此资源的详细信息的 API URL。

返回:当 state == present 时成功

示例: "https://api.cloudscale.ch/v1/objects-users/6fe39134bf4178747eebc429f82cfafdd08891d4279d0d899bc4012db1db6a15"

id

字符串

id

返回:成功

对象用户的 ID。

示例: "6fe39134bf4178747eebc429f82cfafdd08891d4279d0d899bc4012db1db6a15"

keys

复杂类型

返回:成功

密钥对象的列表。

字符串

access_key

返回:成功

访问密钥。

示例: "0ZTAIBKSGYBRHQ09G11W"

字符串

secret_key

返回:成功

密钥。

state

字符串

示例: "bn2ufcwbIa0ARLc5CLRSlVaCfFxPHOpHmjKiH34T"

返回:成功

state

tags

字典

对象用户的当前状态。

返回:成功

示例: "present"

tags

  • 与对象用户关联的标签。