Add documentation for ProxmoxVE integration (#10660)

* Added documentation for ProxmoxVE integration

* Fix ha_release version for ProxmoxVE integration

Co-Authored-By: Klaas Schoute <klaas_schoute@hotmail.com>

* ✏️ Tweak

* ✏️ Tweak

* Fix ha_release field for ProxmoxVE version


Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Jonas 2019-11-26 22:03:07 +01:00 committed by Franck Nijhof
parent a4e4e799ad
commit 52e01bdcef
2 changed files with 100 additions and 0 deletions

View File

@ -0,0 +1,100 @@
---
title: "Proxmox VE"
description: "Access your ProxmoxVE instance in Home Assistant."
logo: proxmoxve.png
ha_category:
- Binary Sensor
ha_release: 0.103
ha_iot_class: Local Polling
---
[Proxmox VE](https://www.proxmox.com/en/) is an open-source server virtualization environment. This integration allows you to poll various data from your instance.
After configuring this component, the binary sensors automatically appear.
## Configuration
<div class='note'>
You should have at least one VM or container entry configured, else this integration won't do anything.
</div>
To use the `proxmoxve` component, add the following config to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
proxmox:
- host: IP_ADDRESS
username: USERNAME
password: PASSWORD
nodes:
- node: NODE_NAME
vms:
- VM_ID
containers:
- CONTAINER_ID
```
{% configuration %}
host:
description: IP address of the Proxmox VE instance.
required: true
type: string
port:
description: The port number on which Proxmox VE is running.
required: false
default: 8006
type: integer
verify_ssl:
description: Whether to do strict validation on SSL certificates.
required: false
default: true
type: boolean
username:
description: The username used to authenticate.
required: true
type: string
password:
description: The password used to authenticate.
required: true
type: string
realm:
description: The authentication realm of the user.
required: false
default: pam
type: string
nodes:
description: List of the Proxmox VE nodes to monitor.
required: true
type: map
keys:
node:
description: Name of the node
required: true
type: string
vms:
description: List of the QEMU VMs to monitor.
required: false
type: list
containers:
description: List of the LXC containers to monitor.
required: false
type: list
{% endconfiguration %}
Example with multiple VMs and no containers:
```yaml
proxmox:
- host: IP_ADDRESS
username: USERNAME
password: PASSWORD
nodes:
- node: NODE_NAME
vms:
- VM_ID_1
- VM_ID_2
```
## Binary Sensor
The integration will automatically create a binary sensor for each tracked VM or container, the binary sensor will either be on if the VM's state is running or off if the VM's state is different.

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.2 KiB