vmware.vmware_rest.vcenter_cluster_info 模块 – 获取与集群对应的集群信息。
注意
此模块是 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_cluster_info。
vmware.vmware_rest 0.1.0 中的新增功能
概要
获取与集群对应的集群信息。
要求
执行此模块的主机需要满足以下要求。
vSphere 7.0.3 或更高版本
python >= 3.6
aiohttp
参数
参数 |
注释 |
|---|---|
集群的标识符。 该参数必须是由 vmware.vmware_rest.vcenter_cluster_info 返回的资源的 ID。当 state=['get'] 时是必需的 |
|
可以匹配筛选器的集群的标识符。 如果未设置或为空，则任何标识符的集群都与筛选器匹配。 当客户端将此结构的值作为参数传递时，该字段必须包含由 vmware.vmware_rest.vcenter_cluster_info 返回的资源的 ID。 |
|
必须包含集群才能使集群与筛选器匹配的数据中心。 如果未设置或为空，则任何数据中心中的集群都与筛选器匹配。 当客户端将此结构的值作为参数传递时，该字段必须包含由 vmware.vmware_rest.vcenter_datacenter_info 返回的资源的 ID。 |
|
必须包含集群才能使集群与筛选器匹配的文件夹。 如果未设置或为空，则任何文件夹中的集群都与筛选器匹配。 当客户端将此结构的值作为参数传递时，该字段必须包含由 vmware.vmware_rest.vcenter_folder_info 返回的资源的 ID。 |
|
集群必须具有的名称才能与筛选器匹配（请参阅 name）。 如果未设置或为空，则任何名称的集群都与筛选器匹配。 |
|
客户端会话的超时设置。 包括连接建立、请求发送和响应在内的整个操作的最大秒数。 默认值为 300 秒。 |
|
vSphere vCenter 的主机名或 IP 地址 如果未在任务中指定该值，则将使用环境变量 |
|
vSphere vCenter 密码 如果未在任务中指定该值，则将使用环境变量 |
|
您可以使用此可选参数来设置日志文件的位置。 此文件将用于记录 HTTP REST 交互。 该文件将存储在运行模块的主机上。 如果未在任务中指定该值，则将使用 环境变量 |
|
vSphere vCenter 用户名 如果未在任务中指定该值，则将使用环境变量 |
|
当 SSL 证书无效时允许连接。当证书不受信任时，设置为 如果未在任务中指定该值，则将使用环境变量 选项
|
注释
注意
在 vSphere 7.0.3 上测试
示例
- name: Build a list of all the clusters
vmware.vmware_rest.vcenter_cluster_info:
register: all_the_clusters
- name: Retrieve details about the first cluster
vmware.vmware_rest.vcenter_cluster_info:
cluster: '{{ all_the_clusters.value[0].cluster }}'
register: my_cluster_info
返回值
常见返回值在此处记录 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
资源的 moid 返回： 成功时 示例： |
|
检索有关第一个集群的详细信息 返回： 成功时 示例: |