<commit_before>
=== VmwareMonitor

This monitor is part of the VMware integration provided in _Provisiond_ and test the power state of a virtual machine (VM) or a host system (host).
If the power state of a VM or host is _poweredOn_ the service is _up_.
For any other state like _standby_ or _off_ the service on the VM or Host is marked as _down_.

CAUTION: The information for the status of a virtual machine is collected from the responsible _VMware vCenter_ using the credentials from the 'vmware-config.xml'.
         It is also required to get specific asset fields assigned to an imported virtual machine and host system.
         The following asset fields are populated by the _VMware_ integration in _Provisiond_: _VMware Management Server_, _VMware Managed Entity Type_ and the _foreignId_ which contains an internal _VMware vCenter Identifier_.

WARNING: If you suspend VM and hosts, the service change to status _down_.
         This could cause some false alarms if you run in a dynamic environment where it is normal to put VMs or hosts in suspend state.

==== Monitor facts

[options="autowidth"]
|===
| Class Name     | `org.opennms.netmgt.poller.monitors.VmwareMonitor`
| Remote Enabled | false
|===

==== Configuration and Usage

.Monitor specific parameters for the VmwareMonitor
[options="header, autowidth"]
|===
| Parameter | Description                                                                        | Required | Default value
| `retry`   | Number of retries before the service is marked as _down_.                          | optional | `0`
| `timeout` | Time in milliseconds to wait for the _vCenter_ to get the power state information. | optional | `3000`
|===

==== Examples
Some example configuration how to configure the monitor in the 'poller-configuration.xml'.

[source, xml]
----
<service name="VMware-ManagedEntity" interval="300000" user-defined="false" status="on">
  <parameter key="retry" value="2"/>
  <parameter key="timeout" value="3000"/>
</service>

<monitor service="VMware-ManagedEntity" class-name="org.opennms.netmgt.poller.monitors.VmwareMonitor"/>
----<commit_msg>Update VmwareMonitor.adoc<commit_after>
=== VmwareMonitor

This monitor is part of the VMware integration provided in _Provisiond_ and test the power state of a virtual machine (VM) or a host system (host).
If the power state of a VM or host is _poweredOn_ the service is _up_.
For any other state like _standby_ or _off_ the service on the VM or Host is marked as _down_.

CAUTION: The information for the status of a virtual machine is collected from the responsible _VMware vCenter_ using the credentials from the 'vmware-config.xml'.
         It is also required to get specific asset fields assigned to an imported virtual machine and host system.
         The following asset fields are populated by the _VMware_ integration in _Provisiond_: _VMware Management Server_, _VMware Managed Entity Type_ and the _foreignId_ which contains an internal _VMware vCenter Identifier_.

WARNING: If you suspend VM and hosts, the service change to status _down_.
         This could cause some false alarms if you run in a dynamic environment where it is normal to put VMs or hosts in suspend state.

==== Monitor facts

[options="autowidth"]
|===
| Class Name     | `org.opennms.netmgt.poller.monitors.VmwareMonitor`
| Remote Enabled | false
|===

==== Configuration and Usage

.Monitor specific parameters for the VmwareMonitor
[options="header, autowidth"]
|===
| Parameter | Description                                                                        | Required | Default value
| `retry`   | Number of retries before the service is marked as _down_.                          | optional | `0`
| `timeout` | Time in milliseconds to wait for the _vCenter_ to get the power state information. | optional | `3000`
| `ignoreStandBy` | Treat power state _standBy_ as _up_.                                         | optional | `false` 
|===

==== Examples
Some example configuration how to configure the monitor in the 'poller-configuration.xml'.

[source, xml]
----
<service name="VMware-ManagedEntity" interval="300000" user-defined="false" status="on">
  <parameter key="retry" value="2"/>
  <parameter key="timeout" value="3000"/>
</service>

<monitor service="VMware-ManagedEntity" class-name="org.opennms.netmgt.poller.monitors.VmwareMonitor"/>
----
{'fraction_non_alphanumeric': 0.07957923622227304, 'fraction_numerical': 0.007317630916990624, 'mean_word_length': 3.436105476673428, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 13, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 6}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 8, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5629291', 'n_tokens_mistral': 1150, 'n_tokens_neox': 1118, 'n_words': 518}