openstack.cloud.baremetal_deploy_template 模块 – 从 OpenStack 创建/删除裸机部署模板资源

注意

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

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

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

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

概要

• 从 OpenStack 创建、更新和删除 ironic 部署模板。

要求

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

• 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 字符串	可用于验证 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 的某个部分一样。
extra 字典	一组或多组任意元数据键值对。
id 别名：uuid 字符串	部署模板的 ID。 如果未指定，将自动生成。
interface 别名：endpoint_type 字符串	要从服务目录中获取的端点 URL 类型。 选择 "admin" "internal" "public" ← (默认)
name 字符串	部署模板的名称。 必须格式化为特征名称（请参阅 API 参考）。 创建部署模板时是必需的，之后可以使用名称或 ID。
region_name 字符串	区域的名称。
sdk_log_level 字符串	OpenStackSDK 的日志级别 选择 "INFO" ← (默认) "DEBUG"
sdk_log_path 字符串	OpenStackSDK 的日志文件的路径。如果为空，则不写入任何日志
state 字符串	指示资源的所需状态 选择 "present" ← (默认) "absent"
steps 列表 / elements=dictionary	要应用的部署步骤列表。 创建部署模板时是必需的。
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 配置文件，然后来自标准环境变量，最后来自 plays 中的显式参数。有关更多信息，请访问 https://docs.openstack.org/openstacksdk/

示例

- name: Create Bare Metal deploy template
  openstack.cloud.baremetal_deploy_template:
    cloud: devstack
    state: present
    name: CUSTOM_FOO
    steps:
      - interface: bios
        step: apply_configuration
        args:
          settings:
            - name: LogicalProc
              value: Enabled
        priority: 110
    extra:
      something: extra
  register: result

- name: Delete Bare Metal deploy template
  openstack.cloud.baremetal_deploy_template:
    cloud: devstack
    state: absent
    id: 1a85ebca-22bf-42eb-ad9e-f640789b8098
  register: result

- name: Update Bare Metal deploy template
  openstack.cloud.baremetal_deploy_template:
    cloud: devstack
    state: present
    id: 1a85ebca-22bf-42eb-ad9e-f640789b8098
    extra:
      something: new

返回值

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

键	描述
template 字典	一个部署模板字典，可能会返回下面列出的字典键的子集，具体取决于您的云提供商。 返回： 成功
created_at 字符串	裸机部署模板创建时间戳。 返回： 成功
extra 字典	一组或多组任意元数据键值对。 返回： 成功
id 字符串	裸机部署模板资源的 UUID。 返回： 成功
links 列表 / 元素=字符串	包含自身链接和书签链接的相对链接列表。 返回： 成功
位置 字典	此资源的云位置（云、项目、区域、可用区） 返回： 成功
name 字符串	裸机部署模板名称。 返回： 成功
steps 列表 / elements=dictionary	部署步骤列表。 返回： 成功
更新时间 字符串	裸机部署模板更新的时间戳。 返回： 成功

作者

• OpenStack Ansible SIG

集合链接

• 问题跟踪器
• 仓库（源代码）