home-assistant.io/source/_components/binary_sensor.vultr.markdown
Jorim Tielemans 5c852edbde More various improvements - letter b (#6990)
* More various fixed - letter b

Adds titles (and make other linkable)
Improved indentation
Reorder configuration keys
Remove empty lines and trailing spaces

* No idea why this happened

* String can't start with *
2018-10-21 17:05:53 +02:00

57 lines
1.4 KiB
Markdown

---
layout: page
title: "Vultr Binary Sensor"
description: "Instructions on how to set up Vultr binary sensors within Home Assistant."
date: 2017-10-17 21:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: System Monitor
logo: vultr.png
ha_release: "0.58"
ha_iot_class: "Cloud Polling"
---
The `vultr` binary sensor platform allows you to monitor your [Vultr](https://www.vultr.com/) subscription to see if it is powered on or not.
## {% linkable_title Configuration %}
To use this binary sensor, you first have to set up your [Vultr hub](/components/vultr/).
<p class='note'>
The following examples assume a subscription that has an ID of `123456` and a label of `Web Server`
</p>
Minimal `configuration.yaml` (produces `binary_sensor.vultr_web_server`):
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: vultr
subscription: 123456
```
{% configuration %}
subscription:
description: The subscription you want to monitor, this can be found in the URL when viewing a server.
required: true
type: string
name:
description: The name you want to give this binary sensor.
required: false
default: "Vultr {subscription label}"
type: string
{% endconfiguration %}
## {% linkable_title Full example %}
Full `configuration.yaml` (produces `binary_sensor.totally_awesome_server`):
```yaml
binary_sensor:
- platform: vultr
name: totally_awesome_server
subscription: 12345
```