openstack.cloud.server_action 模块 – 对 OpenStack 计算 (Nova) 实例执行操作

注意

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

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

要安装它，请使用：ansible-galaxy collection install openstack.cloud。您需要其他要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 playbook 中使用它，请指定：openstack.cloud.server_action。

概要

  • 对 OpenStack 计算 (Nova) 实例（又名服务器）执行操作。

要求

以下要求需要在执行此模块的主机上满足。

  • python >= 3.6

  • openstacksdk >= 1.0.0

参数

参数

注释

action

字符串 / 必需

要执行的操作。

默认情况下，只有服务器所有者和管理员才能执行 pause、unpause、suspend、resume、lock、unlock 和 shelve_offload 操作。

选择

  • "lock"

  • "pause"

  • "reboot_hard"

  • "reboot_soft"

  • "rebuild"

  • "resume"

  • "shelve"

  • "shelve_offload"

  • "start"

  • "stop"

  • "suspend"

  • "unlock"

  • "unpause"

  • "unshelve"

admin_password

字符串

要重建的服务器的管理员密码。

all_projects

布尔值

是否在所有项目或仅在当前项目中搜索服务器。

选择

  • false ← (默认)

  • true

api_timeout

整数

套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会将任何内容传递给 requests 库。

auth

字典

包含云的身份验证插件策略所需的身份验证信息的字典。对于默认的password插件，这将包含auth_url、username、password、project_name 和有关域的任何信息（例如，如果云支持它们，则为 user_domain_name 或 project_domain_name）。对于其他插件，此参数需要包含该身份验证插件所需的任何参数。如果提供了命名云或存在 OpenStack OS_* 环境变量，则不需要此参数。

auth_type

字符串

要使用的身份验证插件的名称。如果云使用密码身份验证以外的其他身份验证，则应在此处指示插件的名称，并且应相应地更新 auth 参数的内容。

ca_cert

别名：cacert

字符串

可用于验证 SSL API 请求的 CA 证书捆绑包的路径。

client_cert

别名：cert

字符串

用作 SSL 事务一部分的客户端证书的路径。

client_key

别名：key

字符串

用作 SSL 事务一部分的客户端密钥的路径。

cloud

任意

要操作的命名云或云配置。如果 cloud 是一个字符串，则它引用在 OpenStack clouds.yaml 文件中定义的命名云配置。为 auth 和 auth_type 提供默认值。如果提供了 auth 或存在 OpenStack OS_* 环境变量，则不需要此参数。如果 cloud 是一个字典，则它包含一个完整的云配置，就像在 clouds.yaml 的一个部分中一样。

image

字符串

服务器应重建的映像名称或 ID。

interface

别名：endpoint_type

字符串

要从服务目录中获取的端点 URL 类型。

选择

  • "admin"

  • "internal"

  • "public" ← (默认)

name

别名：server

字符串 / 必需

服务器名称或 ID。

region_name

字符串

区域的名称。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选择

  • "INFO" ← (默认)

  • "DEBUG"

sdk_log_path

字符串

OpenStackSDK 日志文件的路径。如果为空，则不写入日志。

timeout

整数

Ansible 等待请求资源的最长时间。

默认值： 180

validate_certs

别名：verify

布尔值

是否应验证 SSL API 请求。

在 Ansible 2.3 之前，此值默认为 true。

选择

  • false

  • true

wait

布尔值

Ansible 是否应等待，直到请求的资源完成。

选择

  • false

  • true ← (默认)

备注

注意

  • 可以使用标准的 OpenStack 环境变量，例如 OS_USERNAME，而不是提供显式值。

  • 身份验证信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 yaml 配置文件，然后来自标准环境变量，最后来自剧本中的显式参数。有关更多信息，请访问 https://docs.openstack.org/openstacksdk/

示例

- name: Pauses a compute instance
  openstack.cloud.server_action:
    cloud: devstack-admin
    action: pause
    server: vm1
    timeout: 200

作者

  • OpenStack Ansible SIG