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)