vmware.vmware_rest.appliance_monitoring_query 模块 – 获取监控数据。

注意

此模块是 vmware.vmware_rest 集合 (版本 4.3.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install vmware.vmware_rest。您需要其他要求才能使用此模块，请参阅要求了解详情。

要在 playbook 中使用它，请指定： vmware.vmware_rest.appliance_monitoring_query。

vmware.vmware_rest 2.0.0 中的新增功能

摘要 

获取监控数据。

要求 

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

vSphere 7.0.3 或更高版本
python >= 3.6
aiohttp

参数 

参数	注释
end_time 字符串 / 必填	UTC 时间结束时间此参数是必需的。
function 字符串 / 必填	function_type 枚举类型定义聚合函数此参数是必需的。选项 `"AVG"` `"COUNT"` `"MAX"` `"MIN"`
interval 字符串 / 必填	interval_type 枚举类型定义以小时和分钟为单位的值之间的间隔，聚合将应用于此此参数是必需的。选项 `"DAY1"` `"HOURS2"` `"HOURS6"` `"MINUTES30"` `"MINUTES5"`
names 列表 / 元素=字符串 / 必填	监控项 ID 例如：CPU、MEMORY 当客户端将此结构的值作为参数传递时，该字段必须包含 vmware.vmware_rest.appliance_monitoring_info 返回的资源 ID。
session_timeout 浮点数 vmware.vmware_rest 2.1.0 中添加	客户端会话的超时设置。整个操作（包括连接建立、请求发送和响应）的最大秒数。默认值为 300 秒。
start_time 字符串 / 必填	UTC 时间开始时间此参数是必需的。
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: Query the monitoring backend
  vmware.vmware_rest.appliance_monitoring_query:
    end_time: 2021-04-14 09:34:56+00:00
    start_time: 2021-04-14 08:34:56+00:00
    names:
    - mem.total
    interval: MINUTES5
    function: AVG
  register: result

返回值 

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

键	描述
值列表 / 元素=字符串	查询监控后端返回：成功时示例： `[{"data": ["", "", "", "", "", "", "", "", "", "", "", "", ""], "end_time": "2021-04-14T09:34:56.000Z", "function": "AVG", "interval": "MINUTES5", "name": "mem.total", "start_time": "2021-04-14T08:34:56.000Z"}]`

作者

Ansible 云团队 (@ansible-collections)