openstack.cloud.volume_type 模块 – 管理 OpenStack 卷类型

注意

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

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

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

要在剧本中使用它，请指定： openstack.cloud.volume_type。

概要 

在 OpenStack 中添加、删除或更新卷类型。

要求 

执行此模块的主机需要以下要求。

python >= 3.6
openstacksdk >= 1.0.0

参数 

参数	注释
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 字符串	CA 证书包的路径，可用作验证 SSL API 请求的一部分。
client_cert 别名：cert 字符串	客户端证书的路径，用作 SSL 事务的一部分。
client_key 别名：key 字符串	客户端密钥的路径，用作 SSL 事务的一部分。
cloud 任意	要操作的命名云或云配置。如果 cloud 是字符串，则它引用在 OpenStack clouds.yaml 文件中定义的命名云配置。为 auth 和 auth_type 提供默认值。如果提供了 auth 或存在 OpenStack OS_* 环境变量，则不需要此参数。如果 cloud 是字典，则它包含完整的云配置，就像 clouds.yaml 的一部分一样。
description 字符串	卷类型的描述。
extra_specs 字典	卷类型属性列表
interface 别名：endpoint_type 字符串	从服务目录中获取的端点 URL 类型。选项 `"admin"` `"internal"` `"public"` ← (默认)
is_public 布尔值	使卷类型对公众可见。只能在创建期间设置选项 `false` `true`
name 字符串 / 必填	卷类型名称或 ID。
region_name 字符串	区域名称。
sdk_log_level 字符串	OpenStackSDK 的日志级别选项 `"INFO"` ← (默认) `"DEBUG"`
sdk_log_path 字符串	OpenStackSDK 日志文件的路径。如果为空，则不写入日志
state 字符串	指示所需资源状态。当 state 为 `present` 时，需要 is_public。选项 `"present"` ← (默认) `"absent"`
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配置文件，然后来自标准环境变量，最后来自play中的显式参数。更多信息请参见 https://docs.openstack.org/openstacksdk/

示例 

- name: Delete volume type by name
  openstack.cloud.volume_type:
    name: test_type
    state: absent

- name: Delete volume type by id
  openstack.cloud.volume_type:
    name: fbadfa6b-5f17-4c26-948e-73b94de57b42
    state: absent

- name: Create volume type
  openstack.cloud.volume_type:
    name: unencrypted_volume_type
    state: present
    extra_specs:
      volume_backend_name: LVM_iSCSI
    description: Unencrypted volume type
    is_public: True

返回值 

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

键	描述
volume_type 字典	描述卷类型的字典返回：当state为‘present’时成功
description 字符串	卷类型描述返回：成功示例： `"未加密卷类型"`
extra_specs 字典	卷类型额外参数返回：成功
is_public 布尔值	卷类型是否为公开的返回：成功示例： `true`
name 字符串	卷类型名称返回：成功示例： `"test_type"`

作者

OpenStack Ansible SIG