vmware.vmware_rest.vcenter_resourcepool_info 模块 – 获取由 resourcePool 指定的资源池信息。

注意

此模块是 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_resourcepool_info。

vmware.vmware_rest 0.3.0 中新增

概要

  • 获取由 resourcePool 指定的资源池信息。

要求

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

  • vSphere 7.0.3 或更高版本

  • python >= 3.6

  • aiohttp

参数

参数

注释

clusters

列表 / 元素=字符串

必须包含资源池的集群，以便资源池与过滤器匹配。

如果未设置或为空，则任何集群中的资源池都与过滤器匹配。

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

datacenters

别名：filter_datacenters

列表 / 元素=字符串

必须包含资源池的数据中心，以便资源池与过滤器匹配。

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

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

hosts

列表 / 元素=字符串

必须包含资源池的主机，以便资源池与过滤器匹配。

如果未设置或为空，则任何主机中的资源池都与过滤器匹配。

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

names

别名：filter_names

列表 / 元素=字符串

资源池必须具有的名称才能与过滤器匹配（参见 *name*）。

如果未设置或为空，则任何名称的资源池都与过滤器匹配。

parent_resource_pools

列表 / 元素=字符串

必须包含资源池的资源池，以便资源池与过滤器匹配。

如果未设置或为空，则任何资源池中的资源池都与过滤器匹配。

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

resource_pool

字符串

应检索其信息的资源池的标识符。

该参数必须是 vmware.vmware_rest.vcenter_resourcepool_info 返回的资源 ID。 需要使用 *state=[‘get’]*

resource_pools

列表 / 元素=字符串

可以与过滤器匹配的资源池标识符。

如果未设置或为空，则任何标识符的资源池都与过滤器匹配。

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

session_timeout

浮点数

vmware.vmware_rest 2.1.0 中新增

客户端会话的超时设置。

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

默认值为 300 秒。

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 the existing resource pools
  vmware.vmware_rest.vcenter_resourcepool_info:
  register: resource_pools
- name: Get the existing resource pool
  vmware.vmware_rest.vcenter_resourcepool_info:
    resource_pool: '{{ resource_pools.value[0].resource_pool }}'
  register: my_resource_pool
- name: Create a generic resource pool
  vmware.vmware_rest.vcenter_resourcepool:
    name: my_resource_pool
    parent: '{{ resource_pools.value[0].resource_pool }}'
  register: my_resource_pool
- name: Read details from a specific resource pool
  vmware.vmware_rest.vcenter_resourcepool_info:
    resource_pool: '{{ my_resource_pool.id }}'
  register: my_resource_pool

返回值

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

键

描述

id

字符串

资源的 moid

返回：成功时

示例： "resgroup-1009"

值

字典

从特定的资源池读取详细信息

返回：成功时

示例： {"cpu_allocation": {"expandable_reservation": 1, "limit": -1, "reservation": 0, "shares": {"level": "NORMAL"}}, "memory_allocation": {"expandable_reservation": 0, "limit": 1000, "reservation": 0, "shares": {"level": "NORMAL"}}, "name": "my_resource_pool", "resource_pools": []}

作者

  • Ansible 云团队 (@ansible-collections)