vmware.vmware_rest.vcenter_host_info 模块 – 返回 vCenter 中最多 2500 个可见(受权限检查约束)且与 Host.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_host_info

vmware.vmware_rest 0.1.0 中的新增功能

概要

  • 返回 vCenter 中最多 2500 个可见(受权限检查约束)且与 Host.FilterSpec 匹配的主机信息。

要求

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

  • vSphere 7.0.3 或更高版本

  • python >= 3.6

  • aiohttp

参数

参数

注释

clusters

列表 / 元素=字符串

必须包含主机的集群,以便主机与过滤器匹配。

如果未设置或为空,则任何集群中的主机以及不在集群中的主机都与过滤器匹配。如果此字段不为空且 *standalone* 为 true,则没有主机与过滤器匹配。

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

connection_states

列表 / 元素=字符串

主机必须处于连接状态才能与过滤器匹配(请参阅 *

如果未设置或为空,则任何连接状态下的主机都与过滤器匹配。

datacenters

别名:filter_datacenters

列表 / 元素=字符串

必须包含主机的 Datacenter,以便主机与过滤器匹配。

如果未设置或为空,则任何 Datacenter 中的主机都与过滤器匹配。

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

folders

别名:filter_folders

列表 / 元素=字符串

必须包含主机的文件夹,以便主机与过滤器匹配。

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

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

hosts

列表 / 元素=字符串

可以与过滤器匹配的主机的标识符。

如果未设置或为空,则任何标识符的主机都与过滤器匹配。

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

names

别名:filter_names

列表 / 元素=字符串

主机必须具有才能与过滤器匹配的名称(请参阅 *name*)。

如果未设置或为空,则任何名称的主机都与过滤器匹配。

session_timeout

浮点数

在 vmware.vmware_rest 2.1.0 中添加

客户端会话的超时设置。

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

默认值为 300 秒。

standalone

布尔值

如果为 true,则只有不属于集群的主机才能与过滤器匹配;如果为 false,则只有属于集群的主机才能与过滤器匹配。

如果未设置,则主机可以与过滤器匹配,而不管它们是否是集群的一部分。如果此字段为 true 且 *clusters* 不为空,则没有主机与过滤器匹配。

选择

  • false

  • true

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 a list of the hosts
  vmware.vmware_rest.vcenter_host_info:
  register: my_hosts

返回值

通用的返回值记录在这里,以下是此模块独有的字段

描述

列表 / 元素=字符串

获取主机列表

返回: 成功时

示例: [{"connection_state": "CONNECTED", "host": "host-1013", "name": "esxi1.test", "power_state": "POWERED_ON"}]

作者

  • Ansible 云团队 (@ansible-collections)