vultr.cloud.startup_script 模块 – 管理 Vultr 上的启动脚本

注意

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

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

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

要在剧本中使用它,请指定: vultr.cloud.startup_script

vultr.cloud 1.0.0 中的新增功能

概要

  • 创建、更新和删除启动脚本。

参数

参数

注释

api_endpoint

字符串

API 终结点的 URL(不带尾部斜杠)。

回退环境变量 VULTR_API_ENDPOINT

默认值: "https://api.vultr.com/v2"

api_key

字符串 / 必填

Vultr API 的 API 密钥。

回退环境变量 VULTR_API_KEY

api_retries

整数

如果 Vultr API 返回 HTTP 错误代码(例如 - 429 请求过多 - 500 内部服务器错误 - 504 网关超时),则重试次数。

回退环境变量 VULTR_API_RETRIES

默认值: 5

api_retry_max_delay

整数

以秒为单位的重试回退延迟,呈指数增长,直至达到此最大值(秒)。

回退环境变量 VULTR_API_RETRY_MAX_DELAY

默认值: 12

api_timeout

整数

到 Vultr API 的 HTTP 超时。

回退环境变量 VULTR_API_TIMEOUT

默认值: 180

name

字符串 / 必填

脚本名称。

script

字符串

脚本源代码。

如果 state=present,则为必填。

state

字符串

脚本的状态。

选项

  • "present" ← (默认)

  • "absent"

type

别名:script_type

字符串

脚本类型,创建后无法更改。

选项

  • "boot" ← (默认)

  • "pxe"

validate_certs

布尔值

验证 Vultr API 的 SSL 证书。

选项

  • false

  • true ← (默认)

注释

注意

示例

- name: ensure a pxe script exists, source from a file
  vultr.cloud.startup_script:
    name: my_web_script
    script_type: pxe
    script: "{{ lookup('file', 'path/to/script') }}"

- name: ensure a boot script exists
  vultr.cloud.startup_script:
    name: vultr_startup_script
    script: "#!/bin/bash
echo Hello World > /root/hello"

- name: ensure a script is absent
  vultr.cloud.startup_script:
    name: my_web_script
    state: absent

返回值

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

描述

vultr_api

字典

来自 Vultr API 的响应,带有一些补充/修改。

返回:成功

api_endpoint

字符串

用于 API 请求的端点。

返回:成功

示例: "https://api.vultr.com/v2"

api_retries

整数

API 请求的最大重试次数。

返回:成功

示例: 5

api_retry_max_delay

整数

重试之间以秒为单位的指数回退延迟,直至达到此最大延迟值。

返回:成功

示例: 12

api_timeout

整数

用于 API 请求的超时。

返回:成功

示例: 60

vultr_startup_script

字典

来自 Vultr API 的响应。

返回:成功

date_created

字符串

创建启动脚本的日期。

返回:成功

示例: "2020-10-10T01:56:20+00:00"

date_modified

字符串

修改启动脚本的日期。

返回:成功

示例: "2020-10-10T01:56:20+00:00"

id

字符串

启动脚本的 ID。

返回:成功

示例: "7d726ffe-9be2-4f88-8cda-fa7eba1da2b5"

name

字符串

启动脚本的名称。

返回:成功

示例: "my startup script"

script

字符串

启动脚本的源代码。

返回:成功

示例: "#!/bin/bash echo Hello World > /root/hello"

type

字符串

启动脚本的类型。

返回:成功

示例: "pxe"

作者

  • René Moser (@resmo)