---
title: "Host Template: OS - VMware vSphere ESXi Generic MOB"
description: ""
url: "https://docs.itrsgroup.com/docs/opsview/6.11.7/opspacks/os-vmware-vsphere-opspack/os-vmware-vsphere-esxi-generic-mob-host-template/index.html"
---## Overview

Monitor generic ESXi metrics via raw Managed Object Browser (MOB) paths.

This Host Template includes the following Service Checks:

| Service&nbsp;Check&nbsp;Name | Description | Default&nbsp;Thresholds (Metric:&nbsp;Warning,&nbsp;Critical) | UOM |
|:-----------------------------|:------------|:------------------------------------------------:|:---:|
| vSphere - Generic - MOB Path Metric | Monitor generic MOB paths. | N/A | N/A |


**Note**


See details about [Monitoring Plugin thresholds here](https://www.monitoring-plugins.org/doc/guidelines.html#THRESHOLDFORMAT).



## Usage Instructions

Please review the overall [OS - VMware vSphere Opspack](https://docs.itrsgroup.com/docs/opsview/6.11.7/opspacks/os-vmware-vsphere-opspack/os-vmware-vsphere-opspack/index.html) documentation for details on prerequisites, known issues, and other necessary configurations that apply to all Host Templates in the Opspack.

### Add this Host Template

Add the **OS - VMware vSphere ESXi Generic MOB** Host Template to your Opsview Monitor host.
If the resource you're monitoring has no hostname or public IP, then open the **Advanced** settings pane and change **Host Check Command** to **Always assumed to be UP**.


**Note**


For more information, refer to the documentation on [Adding Host Templates to Hosts](https://docs.itrsgroup.com/docs/opsview/6.11.7/host/index.html#host-templates).



### Add and configure Variables

The Service Checks in this Host Template use the following variables, and they will be added to your Opsview Monitor instance alongside the Host Template:

- [**VSPHERE_ESXI_HOST_NAME**](#vsphere_esxi_host_name)
- [**VSPHERE_ESXI_MOB_GENERIC**](#vsphere_esxi_mob_generic)
- [**VSPHERE_ESXI_CREDENTIALS**](#vsphere_esxi_credentials)
- [**VSPHERE_CERTIFICATES**](#ssl-certificates-vsphere_certificates)
- [**VSPHERE_VC_CREDENTIALS**](#vsphere_vc_credentials)


**Note**


For more information, refer to the documentation on [Adding Variables to Hosts](https://docs.itrsgroup.com/docs/opsview/6.11.7/adding-a-new-variable/index.html#adding-a-variable-to-a-host).



### Apply Changes

Apply Changes and the system will now be monitored:

![View Output](https://docscdn.itrsgroup.com/opsview/images/opspacks-os-vmware-vsphere-output-os-vmware-vsphere-esxi-generic-mob.png)

## Available Variables

### VSPHERE_ESXI_HOST_NAME

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| N/A (Opsview UI Only) | Value | ESXi Host Display Name | Display Name for ESXi Host Service Checks |
| `--esxi-hostname` | Arg1 | ESXi Host Name | Name of the ESXi Host |

### VSPHERE_ESXI_MOB_GENERIC

MOB Paths must identify exact data inside the [Managed Object Browser](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-sdks-tools/7-0/web-services-sdk-programming-guide/managed-object-browser.html) - e.g. `rootFolder.childEntity[0].hostFolder.childEntity[0].host[0].summary.quickStats.uptime`

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| N/A (Opsview UI Only) | Value | Service Check Name | The name of your Generic Service Check |
| `--esxi-generic-mob-labels` | Arg1 | Generic MOB Labels | Comma separated labels for generic ESXi Managed Object Browser paths |
| `--esxi-generic-mob-paths` | Arg2 | Generic MOB Paths | Comma separated generic ESXi Managed Object Browser paths |
| `--esxi-generic-mob-uoms` | Arg3 | Generic MOB UOMs | Comma separated units of measurement for generic ESXi Managed Object Browser paths |

### VSPHERE_ESXI_CREDENTIALS

This variable is optional but either 'VSPHERE_ESXI_CREDENTIALS' or 'VSPHERE_VC_CREDENTIALS' needs to be set.

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| `--esxi-username` | Arg1 | ESXi Username | Username for the ESXi Host |
| `--esxi-password` | Arg2 | ESXi Password | Password for the ESXi Host |

### VSPHERE_VC_CREDENTIALS

This variable is optional but either 'VSPHERE_ESXI_CREDENTIALS' or 'VSPHERE_VC_CREDENTIALS' needs to be set.

Setting this variable allows for enhanced error handling when carrying out ESXi Service Checks.

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| `--vcenter-username` | Arg1 | vCenter Username | Username for vCenter instance |
| `--vcenter-password` | Arg2 | vCenter Password | Password for vCenter instance |
| `--vcenter-server` | Arg3 | vCenter Instance Name | Name of the vCenter instance |

### SSL Certificates: VSPHERE_CERTIFICATES


**Opsview Cloud**


For Opsview Cloud customers, please contact [ITRS Support](https://www.itrsgroup.com/about/contact) for assistance with setting up certificate files, as they require Orchestrator access.



Additionally, you can use the **VSPHERE_CERTIFICATES** variable to pass in your SSL certificates for use when connecting to the service provider to gather metrics.

| Parameter | Position in Variable | Name | Description |
|:---------:|:--------------------:|:-----|:------------|
| `--ca-path` | Arg1 | CA Certificate Path | Path to the CA Certificate |
| `--client-cert` | Arg2 | Client Certificate Path | Path to the Client Certificate |
| `--client-key` | Arg3 | Client Key Path | Path to the Client Key |

## Plugin help

Plugin: `check_vsphere`


**Secure Args**


This plugin uses the [Secure Args](https://docs.itrsgroup.com/docs/opsview/6.11.7/configuration/secure-arguments/index.html) feature for argument passing.



For mode-specific help, run the plugin with the `-h -m <mode>` flags. This will list the required and optional Variable Arguments for that mode.
The appropriate mode for each Service Check is listed here:

| Service&nbsp;Check&nbsp;Name | Mode |
|:-----------------------------|:-----|
| vSphere - Generic - MOB Path Metric | `ESXiGeneric.MOB.Paths` |


