vmware.vmware_rest.vcenter_folder_info 模块 – 返回 vCenter 中最多 1000 个可见（受权限检查约束）的与 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 中的新增功能

概要

  • 返回 vCenter 中最多 1000 个可见（受权限检查约束）的与 Folder.FilterSpec 匹配的文件夹的信息。

要求

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

  • vSphere 7.0.3 或更高版本

  • python >= 3.6

  • aiohttp

参数

参数

注释

datacenters

别名：filter_datacenters

列表 / 元素=字符串

必须包含文件夹才能使文件夹与过滤器匹配的数据中心。

如果未设置或为空，则任何数据中心中的文件夹都与过滤器匹配。

当客户端将此结构的值作为参数传递时，该字段必须包含 vmware.vmware_rest.vcenter_datacenter_info 返回的资源的 ID。

folders

别名：filter_folders

列表 / 元素=字符串

可以匹配过滤器的文件夹的标识符。

如果未设置或为空，则具有任何标识符的文件夹都与过滤器匹配。

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

names

别名：filter_names

列表 / 元素=字符串

文件夹必须具有才能匹配过滤器的名称（请参阅name）。

如果未设置或为空，则具有任何名称的文件夹都与过滤器匹配。

parent_folders

列表 / 元素=字符串

必须包含文件夹才能使文件夹与过滤器匹配的文件夹。

如果未设置或为空，则任何文件夹中的文件夹都与过滤器匹配。

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

session_timeout

浮点数

在 vmware.vmware_rest 2.1.0 中添加

客户端会话的超时设置。

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

默认值为 300 秒。

type

别名：filter_type

字符串

type 枚举类型定义了 vCenter Server 文件夹的类型。文件夹的类型确定了文件夹中可以包含哪种类型的子项。

选择

  • "DATACENTER"

  • "DATASTORE"

  • "HOST"

  • "NETWORK"

  • "VIRTUAL_MACHINE"

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: 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 的所有文件夹的列表

返回: 成功时

示例: [{"folder": "group-v1002", "name": "vm", "type": "VIRTUAL_MACHINE"}]

作者

  • Ansible 云团队 (@ansible-collections)