community.vmware.vmware_folder_info 模块 – 提供数据中心中文件夹的信息

注意

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

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

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

要在 playbook 中使用它，请指定：community.vmware.vmware_folder_info。

概要

  • 该模块可用于收集数据中心内存在的文件夹的层次结构视图

参数

参数

注释

datacenter

别名：datacenter_name

字符串 / 必需

数据中心的名称。

hostname

字符串

vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。

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

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 的值。

username

别名：admin, user

字符串

vSphere vCenter 或 ESXi 服务器的用户名。

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

validate_certs

布尔值

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

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

选项

  • false

  • true ← (默认)

注意

注意

  • 所有模块都需要 API 写入访问权限，因此免费 ESXi 许可证不支持。

  • 所有变量和 VMware 对象名称都区分大小写。

示例

- name: Provide information about vCenter folders
  community.vmware.vmware_folder_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: datacenter_name
  delegate_to: localhost
  register: vcenter_folder_info

- name: Get information about folders
  community.vmware.vmware_folder_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: 'Asia-Datacenter1'
  register: r

- name: Set Managed object ID for the given folder
  ansible.builtin.set_fact:
    folder_mo_id: "{{ (r.flat_folder_info | selectattr('path', 'equalto', '/Asia-Datacenter1/vm/tier1/tier2') | map(attribute='moid'))[0] }}"

返回值

常见的返回值记录在这里，以下是此模块特有的字段

键

描述

flat_folder_info

列表 / 元素=字符串

扁平结构中关于文件夹的字典列表

返回: 成功

示例: [{"moid": "group-v3", "path": "/Asia-Datacenter1/vm"}, {"moid": "group-v44", "path": "/Asia-Datacenter1/vm/tier1"}, {"moid": "group-v45", "path": "/Asia-Datacenter1/vm/tier1/tier2"}]

folder_info

字典

关于文件夹的字典

返回: 成功

示例: {"datastoreFolders": {"moid": "group-v10", "path": "/DC01/datastore", "subfolders": {"Local Datastores": {"path": "/DC01/datastore/Local Datastores", "subfolders": {}}}}, "hostFolders": {"moid": "group-v21", "path": "/DC01/host", "subfolders": {}}, "networkFolders": {"moid": "group-v31", "path": "/DC01/network", "subfolders": {}}, "vmFolders": {"moid": "group-v41", "path": "/DC01/vm", "subfolders": {"Core Infrastructure Servers": {"moid": "group-v42", "path": "/DC01/vm/Core Infrastructure Servers", "subfolders": {"Staging Network Services": {"moid": "group-v43", "path": "/DC01/vm/Core Infrastructure Servers/Staging Network Services", "subfolders": {}}, "VMware": {"moid": "group-v44", "path": "/DC01/vm/Core Infrastructure Servers/VMware", "subfolders": {}}}}}}}

作者

  • David Hewitt (@davidmhewitt)