Back to the list of connectors[1]

VMware ESXi 5 LUN (esxcli)

Description

This connector discovers the LUNs of an VMware ESX5i server. It requires HTTPS access to the ESX host.

This connector supersedes:

enterprise[3] hardware[4] linux[5] vmware[6]

Target

Typical platform: VMware ESXi

Operating systems: Linux, Out-Of-Band

Prerequisites

Leverages: ESX excli utility (installed locally on the agent host)

Technology and protocols: Command Lines

This connector requires advanced privileges on the managed host for the command below:

  • vcenter

This connector therefore needs to run as root or you need to configure a privilege-escalation mechanism like sudo on the managed host to allow the monitoring account to run the command listed above.

Sample of /etc/sudoers to allow the above command to be run as root by the metricshub account:

metricshub ALL=(root) NOPASSWD: vcenter

This connector is not available for the local host (it is applicable to remote hosts only).

Examples

CLI

metricshub HOSTNAME -t linux -c +VMwareESX5iLUNesxcli --ssh -u USER --sudo-command-list vcenter

metricshub.yaml

resourceGroups:
  <RESOURCE_GROUP>:
    resources:
      <HOSTNAME-ID>:
        attributes:
          host.name: <HOSTNAME> # Change with actual host name
          host.type: linux
        connectors: [ +VMwareESX5iLUNesxcli ] # Optional, to load only this connector
        protocols:
          ssh:
            username: <USERNAME> # Change with actual credentials
            password: <PASSWORD> # Encrypted using metricshub-encrypt
            useSudo: true
            useSudoCommands: [ "vcenter" ]

Connector Activation Criteria

The VMware ESXi 5 LUN (esxcli) connector will be automatically activated, and its status will be reported as OK if all the below criteria are met:

  • The command below succeeds on the agent host
    • Command: esxcli -s %{HOSTNAME} -u %{USERNAME} -p %{PASSWORD} system version get
    • Output contains: Version: [567] (regex)
  • The command below succeeds on the agent host
    • Command: esxcli -s %{HOSTNAME} -u %{USERNAME} -p %{PASSWORD} storage core path list
    • Output contains: Transport: fc (regex)

Metrics

Type Collected Metrics Specific Attributes
lun
  • hw.lun.paths
  • array_name
  • hw.parent.type
  • id
  • name
other_device
  • hw.status{hw.type="other_device", state="degraded|failed|ok"}
  • hw.status{hw.type="other_device", state="present"}
  • device_type
  • hw.parent.type
  • id
  • info
  • name
No results.