community.vmware.vcenter_folder 模块 – 管理给定数据中心的文件夹

注意

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

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

要安装它，请使用： ansible-galaxy collection install community.vmware。

要在剧本中使用它，请指定： community.vmware.vcenter_folder。

概要 

此模块可用于在给定数据中心创建、删除、移动和重命名文件夹。
此模块仅支持 vCenter。

参数 

参数	注释
datacenter 别名：datacenter_name 字符串 / 必填	数据中心名称。
folder_name 字符串 / 必填	要管理的文件夹名称。文件夹名称应少于 80 个字符。这是 VMware 的限制。
folder_type 字符串	这是文件夹的类型。如果设置为 `vm`，则会在数据中心下创建“虚拟机和模板文件夹”。如果设置为 `host`，则会在数据中心下创建“主机和集群文件夹”。如果设置为 `datastore`，则会在数据中心下创建“存储文件夹”。如果设置为 `network`，则会在数据中心下创建“网络文件夹”。如果 `state=absent` 且 `parent_folder` 未设置，则此参数为必填。选项 `"datastore"` `"host"` `"network"` `"vm"` ← (默认)
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。如果任务中未指定此值，则将使用环境变量 `VMWARE_HOST` 的值。
parent_folder 字符串	需要在其中创建新文件夹的父文件夹的名称。如果用户想在“/DC0/vm/vm_folder”下创建一个文件夹，则此值为“vm_folder”。如果用户想在“/DC0/vm/folder1/folder2”下创建一个文件夹，则此值为“folder1/folder2”。
password 别名：pass，pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。如果任务中未指定此值，则将使用环境变量 `VMWARE_PASSWORD` 的值。
port 整数	vSphere vCenter 或 ESXi 服务器的端口号。如果任务中未指定此值，则将使用环境变量 `VMWARE_PORT` 的值。默认值： `443`
proxy_host 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。格式为主机名或 IP。如果任务中未指定此值，则将使用环境变量 `VMWARE_PROXY_HOST` 的值。
proxy_port 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。如果任务中未指定此值，则将使用环境变量 `VMWARE_PROXY_PORT` 的值。
state 字符串	文件夹的状态。如果设置为 `present` 且未设置父文件夹参数，则会创建具有 `folder_type` 的文件夹。如果设置为 `present` 且设置了父文件夹参数，则会在父文件夹下创建文件夹。`folder_type` 将被忽略。如果设置为 `absent`，则会注销并销毁文件夹。选项 `"present"` ← (默认) `"absent"`
username 别名：admin，user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。如果任务中未指定值，则将使用环境变量`VMWARE_USER`的值。
validate_certs 布尔值	允许在SSL证书无效时连接。当证书不受信任时，将其设置为`false`。如果任务中未指定值，则将使用环境变量`VMWARE_VALIDATE_CERTS`的值。选项 `false` `true` ← (默认)

备注 

注意

所有模块都需要API写入访问权限，因此在免费ESXi许可证上不受支持。
所有变量和VMware对象名称都区分大小写。

示例 

- name: Create a VM folder on given datacenter
  community.vmware.vcenter_folder:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter_name
    folder_name: sample_vm_folder
    folder_type: vm
    state: present
  register: vm_folder_creation_result
  delegate_to: localhost

- name: Create a datastore folder on given datacenter
  community.vmware.vcenter_folder:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter_name
    folder_name: sample_datastore_folder
    folder_type: datastore
    state: present
  register: datastore_folder_creation_result
  delegate_to: localhost

- name: Create a sub folder under VM folder on given datacenter
  community.vmware.vcenter_folder:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter_name
    folder_name: sample_sub_folder
    parent_folder: vm_folder
    state: present
  register: sub_folder_creation_result
  delegate_to: localhost

- name: Delete a VM folder on given datacenter
  community.vmware.vcenter_folder:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter_name
    folder_name: sample_vm_folder
    folder_type: vm
    state: absent
  register: vm_folder_deletion_result
  delegate_to: localhost

返回值 

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

键	描述
result 复杂类型	新文件夹的详细信息返回：成功时
msg 字符串	关于结果的字符串说明返回：成功
path 字符串	新文件夹的完整路径返回：成功

作者

Abhijeet Kasurde (@Akasurde)
Christian Kotte (@ckotte)
Jan Meerkamp (@meerkampdvv)