VMware exporter configuration file (jpc_vmware_exporter.yml)

Organization of this page

Format

Write in YAML format.

default:
    vsphere_host: "xxx.xxx.xxx.xxx"
    vsphere_user: "user"
    ignore_ssl: False
    specs_size: 5000
    fetch_custom_attributes: False
    fetch_tags: False
    fetch_alarms: False
    collect_only:
        vms: True
        vmguests: True
        datastores: True
        hosts: True
        snapshots: False

To Page Top

File

jpc_vmware_exporter.yml

jpc_vmware_exporter.yml.model (model file)

To Page Top

Storage directory

■Integrated agent host

For Windows

When using a physical host

Agent-path\conf\

For Linux

When using a physical host

/opt/jp1ima/conf/

To Page Top

Description

This is a configuration file that specifies the operation of VMware exporter.

Important: The section-name "default" is subject to presence checking and should not be deleted or modified.

To Page Top

Character code

UTF-8 (without BOM)

To Page Top

Line feed code

In Windows: CR+LF

In Linux: LF

To Page Top

When the definitions are applied

It will take effect when you restart VMware exporter.

To Page Top

Information that is specified

Item			Description	Changeability	What You Setup in Your JP1/IM - Agent	JP1/IM - Agent Defaults Value
Section name			Specify the section name. When adding a target, specify an arbitrary value. The section-name you set here must be passed as a parameter when Prometheus is scrape, so set the same params in Prometheus configuration file (jpc_prometheus_server). <Setting example> 1st monitor target (fixed) default 2nd monitor target (optional) section01	Y	1st monitor target (fixed) default Second monitor target (optional) Any character string	default
	vsphere_host		Specify the hostname or IP addressto connect to.	Y	Host name or IP Address	"xxx.xxx.xxx.xxx"
	vsphere_user		Specify the user name to connect to the server to be monitored.	Y	Server user name	"user"
	ignore_ssl		Specify whether to check SSL certificate. True Ignore the alert and connect. False If an alert occurs, the connection is not made as an error.	Y	True or False	False
	specs_size		Specifies the maximum number of virtual machines that can be collected in a single scrape for virtual machines under the control of ESXi.	Y	Positive number	5000
	fetch_custom_attributes		Specify whether to collect custom objects as metric labels. Gets the tag information set by vCenter. Since vCenter is not monitored, it is fixed to "False".	N	False	False
	fetch_tags		Specify whether object tags are collected as metric labels. Gets the tag information set by vCenter. Since vCenter is not monitored, it is fixed to "False".	N	False	False
	fetch_alarms		Specify whether to trigger an alarm when an object is retrieved. Gets the tag information set by vCenter. Since vCenter is not monitored, it is fixed to "False".	N	False	False
	collect_only:		Setting part of metric to be collected	--	--	--
		vms	Specifies whether to collect metric for VMS category. True Collect. False Do not collect.	Y	True or False	True
		vmguests	Specifies whether to collect metric for VMGUESTS category. True Collect. False Do not collect.	Y	True or False	True
		datastores	Specifies whether to collect metric for DATASTORES category. True Collect. False Do not collect.	Y	True or False	True
		hosts	Specifies whether to collect metric for HOSTS category. True Collect. False Do not collect.	Y	True or False	True
		snapshots	Specifies whether to collect metric for SNAPSHOTS category. True Collect. False Do not collect.	Y	True or False	False

Legend:: Y: Changeable, N: Not changeable, --: Not applicable

To Page Top