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
参数
参数 |
注释 |
|---|---|
必须包含资源池的集群，资源池才能匹配过滤器。 如果未设置或为空，则任何集群中的资源池都与过滤器匹配。 当客户端将此结构的的值作为参数传递时，该字段必须包含由 vmware.vmware_rest.vcenter_cluster_info 返回的资源的 ID。 |
|
必须包含资源池的数据中心，资源池才能匹配过滤器。 如果未设置或为空，则任何数据中心中的资源池都与过滤器匹配。 当客户端将此结构的值作为参数传递时，该字段必须包含由 vmware.vmware_rest.vcenter_datacenter_info 返回的资源的 ID。 |
|
必须包含资源池的主机，资源池才能匹配过滤器。 如果未设置或为空，则任何主机中的资源池都与过滤器匹配。 当客户端将此结构的值作为参数传递时，该字段必须包含由 vmware.vmware_rest.vcenter_host_info 返回的资源的 ID。 |
|
资源池必须具有的名称才能匹配过滤器（请参阅 name）。 如果未设置或为空，则任何名称的资源池都与过滤器匹配。 |
|
必须包含资源池的父资源池，资源池才能匹配过滤器。 如果未设置或为空，则任何资源池中的资源池都与过滤器匹配。 当客户端将此结构的值作为参数传递时，该字段必须包含由 vmware.vmware_rest.vcenter_resourcepool_info 返回的资源的 ID。 |
|
应检索信息的资源池的标识符。 该参数必须是由 vmware.vmware_rest.vcenter_resourcepool_info 返回的资源的 ID。使用 state=['get'] 时是必需的 |
|
可以匹配过滤器的资源池的标识符。 如果未设置或为空，则任何标识符的资源池都与过滤器匹配。 当客户端将此结构的值作为参数传递时，该字段必须包含由 vmware.vmware_rest.vcenter_resourcepool_info 返回的资源的 ID。 |
|
客户端会话的超时设置。 包括连接建立、请求发送和响应在内的整个操作的最大秒数。 默认值为 300 秒。 |
|
vSphere vCenter 的主机名或 IP 地址 如果未在任务中指定值，则将改用环境变量 |
|
vSphere vCenter 密码 如果未在任务中指定值，则将改用环境变量 |
|
您可以使用此可选参数设置日志文件的位置。 此文件将用于记录 HTTP REST 交互。 该文件将存储在运行模块的主机上。 如果未在任务中指定值，则 将改用环境变量 |
|
vSphere vCenter 用户名 如果未在任务中指定值，则将改用环境变量 |
|
当 SSL 证书无效时允许连接。当证书不受信任时，设置为 如果未在任务中指定值，则将改用环境变量 选项
|
注意
注意
在 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
返回值
常见的返回值已在此处文档中记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
资源的moid 返回： 成功时 示例： |
|
从特定资源池读取详细信息 返回： 成功时 示例： |