vmware.vmware_rest.vcenter_datacenter 模块 – 在 vCenter 清单中创建一个新的数据中心

注意

此模块是 vmware.vmware_rest 集合(版本 4.3.0)的一部分。

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

要安装它,请使用:ansible-galaxy collection install vmware.vmware_rest。您需要更多要求才能使用此模块,有关详细信息,请参阅 要求

要在 Playbook 中使用它,请指定:vmware.vmware_rest.vcenter_datacenter

vmware.vmware_rest 0.1.0 中的新增功能

概要

  • 在 vCenter 清单中创建一个新的数据中心

要求

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

  • vSphere 7.0.3 或更高版本

  • python >= 3.6

  • aiohttp

参数

参数

注释

datacenter

字符串

要删除的数据中心的标识符。

该参数必须是由 vmware.vmware_rest.vcenter_datacenter_info 返回的资源的 ID。当state=[‘absent’] 时为必需

folder

字符串

应在其中创建新数据中心的数据中心文件夹。

此字段目前是必需的。将来,如果未设置此字段,系统将尝试为数据中心选择合适的文件夹;如果无法选择文件夹,则数据中心创建操作将失败。

当客户端将此结构的某个值作为参数传递时,该字段必须是由 vmware.vmware_rest.vcenter_folder_info 返回的资源的 ID。

force

布尔值

如果为 true,即使数据中心不为空,也删除数据中心。

如果未设置,则当数据中心不为空时,将报告 ResourceInUse 错误。这等效于传递值 false。

选择

  • false

  • true

name

字符串

要创建的数据中心的名称。当state=[‘present’] 时为必需

session_timeout

浮点数

在 vmware.vmware_rest 2.1.0 中添加

客户端会话的超时设置。

整个操作的最大秒数,包括建立连接、发送请求和响应。

默认值为 300 秒。

state

字符串

选择

  • "absent"

  • "present" ← (默认)

vcenter_hostname

字符串 / 必需

vSphere vCenter 的主机名或 IP 地址

如果未在任务中指定该值,则将改用环境变量 VMWARE_HOST 的值。

vcenter_password

字符串 / 必需

vSphere vCenter 密码

如果未在任务中指定该值,则将改用环境变量 VMWARE_PASSWORD 的值。

vcenter_rest_log_file

字符串

您可以使用此可选参数设置日志文件的位置。

此文件将用于记录 HTTP REST 交互。

该文件将存储在运行该模块的主机上。

如果未在任务中指定该值,则将改用

环境变量 VMWARE_REST_LOG_FILE 的值。

vcenter_username

字符串 / 必需

vSphere vCenter 用户名

如果未在任务中指定该值,则将改用环境变量 VMWARE_USER 的值。

vcenter_validate_certs

布尔值

当 SSL 证书无效时允许连接。当证书不受信任时设置为 false

如果未在任务中指定该值,则将改用环境变量 VMWARE_VALIDATE_CERTS 的值。

选择

  • false

  • true ← (默认)

注释

注意

  • 在 vSphere 7.0.3 上测试

示例

- name: Get a list of all the datacenters
  register: existing_datacenters
  vmware.vmware_rest.vcenter_datacenter_info:
- name: Force delete the existing DC
  vmware.vmware_rest.vcenter_datacenter:
    state: absent
    datacenter: '{{ item.datacenter }}'
    force: true
  with_items: '{{ existing_datacenters.value }}'
  until:
  - _result is not failed
  retries: 7
- name: Create datacenter my_dc
  vmware.vmware_rest.vcenter_datacenter:
    name: my_dc
    folder: '{{ my_datacenter_folder.folder }}'

返回值

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

描述

msg

字符串

强制删除现有 DC

返回: 成功时

示例: "所有 项目 已完成"

results

列表 / 元素=字符串

强制删除现有 DC

返回: 成功时

示例: [{"_ansible_item_label": {"datacenter": "datacenter-1001", "name": "my_dc"}, "_ansible_no_log": null, "ansible_loop_var": "item", "attempts": 1, "changed": 1, "failed": 0, "invocation": {"module_args": {"datacenter": "datacenter-1001", "folder": null, "force": 1, "name": null, "session_timeout": null, "state": "absent", "vcenter_hostname": "vcenter.test", "vcenter_password": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER", "vcenter_rest_log_file": "/tmp/vmware_rest.log", "vcenter_username": "[email protected]", "vcenter_validate_certs": 0}}, "item": {"datacenter": "datacenter-1001", "name": "my_dc"}, "value": {}}]

作者

  • Ansible 云团队 (@ansible-collections)