community.general.clc_server_snapshot 模块 – 在 CenturyLink Cloud 中创建、删除和恢复服务器快照
注意
此模块是 community.general 集合 (版本 10.1.0) 的一部分。
如果您使用的是 ansible
包,则可能已安装此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用: ansible-galaxy collection install community.general
。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求。
要在 playbook 中使用它,请指定: community.general.clc_server_snapshot
。
概要
一个 Ansible 模块,用于在 CenturyLink Cloud 中创建、删除和恢复服务器快照。
要求
执行此模块的主机需要以下要求。
python = 2.7
requests >= 2.5.0
clc-sdk
参数
参数 |
注释 |
---|---|
服务器快照过期前保留的天数。 默认值: |
|
CLC 服务器 ID 列表。 |
|
确保提供的资源处于的状态。 选项
|
|
是否在返回之前等待预配任务完成。 默认值: |
属性
属性 |
支持 |
描述 |
---|---|---|
支持:完全支持 |
可以在 |
|
支持:不支持 |
在 diff 模式下,将返回有关已更改内容(或可能需要在 |
备注
注意
要使用此模块,需要设置以下环境变量,以启用对 CenturyLink Cloud 的访问 - CLC_V2_API_USERNAME,Centurylink cloud 的帐户登录 ID - CLC_V2_API_PASSWORD,Centurylink cloud 的帐户密码
或者,该模块接受 API 令牌和帐户别名。API 令牌可以通过 HTTP api 调用在 https://api.ctl.io/v2/authentication/login 使用 CLC 帐户登录名和密码生成 - CLC_V2_API_TOKEN,从 https://api.ctl.io/v2/authentication/login 生成的 API 令牌 - CLC_ACCT_ALIAS,与 Centurylink cloud 关联的帐户别名
用户可以设置 CLC_V2_API_URL 来指定指向不同 CLC 环境的端点。
示例
# Note - You must set the CLC_V2_API_USERNAME And CLC_V2_API_PASSWD Environment variables before running these examples
- name: Create server snapshot
community.general.clc_server_snapshot:
server_ids:
- UC1TEST-SVR01
- UC1TEST-SVR02
expiration_days: 10
wait: true
state: present
- name: Restore server snapshot
community.general.clc_server_snapshot:
server_ids:
- UC1TEST-SVR01
- UC1TEST-SVR02
wait: true
state: restore
- name: Delete server snapshot
community.general.clc_server_snapshot:
server_ids:
- UC1TEST-SVR01
- UC1TEST-SVR02
wait: true
state: absent
返回值
常见的返回值已在此处记录 此处,以下是此模块特有的字段
键 |
描述 |
---|---|
已更改的服务器 ID 列表 返回:成功 示例: |