vmware.vmware_rest.vcenter_folder_info 模块 – 返回最多 1000 个在 vCenter 中匹配 Folder.FilterSpec 的可见（取决于权限检查）文件夹的信息。
注意
此模块是 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_folder_info。
vmware.vmware_rest 0.1.0 中的新增功能
概要
返回最多 1000 个在 vCenter 中匹配 Folder.FilterSpec 的可见（取决于权限检查）文件夹的信息。
要求
执行此模块的主机需要以下要求。
vSphere 7.0.3 或更高版本
python >= 3.6
aiohttp
参数
参数 |
注释 |
|---|---|
必须包含文件夹的那些数据中心，以便文件夹与过滤器匹配。 如果未设置或为空，则任何数据中心中的文件夹都与过滤器匹配。 当客户端将此结构的值作为参数传递时，该字段必须包含 vmware.vmware_rest.vcenter_datacenter_info 返回的资源 ID。 |
|
可以与过滤器匹配的文件夹标识符。 如果未设置或为空，则具有任何标识符的文件夹都与过滤器匹配。 当客户端将此结构的值作为参数传递时，该字段必须包含 vmware.vmware_rest.vcenter_folder_info 返回的资源 ID。 |
|
文件夹必须具有的名称才能与过滤器匹配（参见 *name*）。 如果未设置或为空，则具有任何名称的文件夹都与过滤器匹配。 |
|
必须包含文件夹的那些文件夹，以便文件夹与过滤器匹配。 如果未设置或为空，则任何文件夹中的文件夹都与过滤器匹配。 当客户端将此结构的值作为参数传递时，该字段必须包含 vmware.vmware_rest.vcenter_folder_info 返回的资源 ID。 |
|
客户端会话的超时设置。 整个操作（包括连接建立、请求发送和响应）的最大秒数。 默认值为 300 秒。 |
|
*type* 枚举类型定义 vCenter Server 文件夹的类型。文件夹的类型决定了该文件夹中可以包含哪些类型的子项。 选项
|
|
vSphere vCenter 的主机名或 IP 地址 如果任务中未指定该值，则将使用环境变量 |
|
vSphere vCenter 密码 如果任务中未指定该值，则将使用环境变量 |
|
您可以使用此可选参数来设置日志文件的位置。 此文件将用于记录 HTTP REST 交互。 该文件将存储在运行模块的主机上。 如果任务中未指定该值，则将使用 环境变量 |
|
vSphere vCenter 用户名 如果任务中未指定该值，则将使用环境变量 |
|
允许在 SSL 证书无效时连接。当证书不受信任时，设置为 如果任务中未指定该值，则将使用环境变量 选项
|
备注
注意
在 vSphere 7.0.3 上测试
示例
- name: Build a list of all the folders
vmware.vmware_rest.vcenter_folder_info:
register: my_folders
- name: Build a list of all the folders with the type VIRTUAL_MACHINE and called vm
vmware.vmware_rest.vcenter_folder_info:
filter_type: VIRTUAL_MACHINE
filter_names:
- vm
register: my_folders
返回值
公共返回值已记录在 此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
构建一个包含所有类型为 VIRTUAL_MACHINE 并名为 vm 的文件夹的列表 返回：成功时 示例： |