mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Adding in docs for Vultr platform and sensors (#3663)
* Added Vultr logo * Added v1 Vultr hub * Added init sensor docs for Vultr * Updated Vultr components to next version * Updating Vultr components * Added more details to vultr sensors * Updated Vultr component docs * Corrected Vultr name default values, added vultr sensor {} name option
This commit is contained in:
parent
df50d51452
commit
e32f1cdabd
42
source/_components/binary_sensor.vultr.markdown
Normal file
42
source/_components/binary_sensor.vultr.markdown
Normal file
@ -0,0 +1,42 @@
|
||||
---
|
||||
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.57"
|
||||
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.
|
||||
|
||||
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
|
||||
binary_sensor:
|
||||
- platform: vultr
|
||||
subscription: 123456
|
||||
```
|
||||
|
||||
Full `configuration.yaml` (produces `binary_sensor.totally_awesome_server`):
|
||||
```yaml
|
||||
binary_sensor:
|
||||
- platform: vultr
|
||||
name: totally_awesome_server
|
||||
subscription: 12345
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **subscription** (*Required*): The subscription you want to monitor, this can be found in the URL when viewing a server
|
||||
- **name** (*Optional*): The name you want to give this binary sensor, defaults to `Vultr {subscription label}`
|
59
source/_components/sensor.vultr.markdown
Normal file
59
source/_components/sensor.vultr.markdown
Normal file
@ -0,0 +1,59 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Vultr Sensor"
|
||||
description: "Instructions on how to integrate Vultr sensor within Home Assistant."
|
||||
date: 2017-10-17 21:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: vultr.png
|
||||
ha_release: "0.57"
|
||||
ha_category: System Monitor
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
|
||||
The `vultr` sensor will allow you to view current bandwidth usage and pending charges against your [Vultr](https://www.vultr.com/) subscription.
|
||||
|
||||
To use this sensor, you must 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 `sensor.vultr_web_server_current_bandwidth_used` and `sensor.vultr_web_server_pending_charges`):
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: vultr
|
||||
subscription: 123456
|
||||
```
|
||||
|
||||
Full `configuration.yaml` using `{}` to format condition name (produces `sensor.server_current_bandwidth_used` and `sensor.server_pending_charges`):
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: vultr
|
||||
name: Server {}
|
||||
subscription: 123456
|
||||
monitored_conditions:
|
||||
- current_bandwidth_used
|
||||
- pending_charges
|
||||
```
|
||||
|
||||
Custom `configuration.yaml` with only one condition monitored (produces `sensor.web_server_bandwidth`):
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: vultr
|
||||
name: Web Server Bandwidth
|
||||
subscription: 123456
|
||||
monitored_conditions:
|
||||
- current_bandwidth_used
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **subscription** (*Required*): The Vultr subscription to monitor, this can be found in the URL when viewing a subscription
|
||||
- **name** (*Optional*): The name to give this sensor, defaults to `Vultr {Vultr subscription label} {monitored condition name}`.
|
||||
- **monitored_conditions** array (*Optional*): List of items you want to monitor for each subscription. Defaults to all of them if omitted.
|
||||
- **current_bandwidth_used**: The current (invoice period) bandwidth usage in Gigabytes (GB).
|
||||
- **pending_charges**: The current (invoice period) charges that have built up for this subscription. Value is in US Dollars (US$).
|
42
source/_components/switch.vultr.markdown
Normal file
42
source/_components/switch.vultr.markdown
Normal file
@ -0,0 +1,42 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Vultr Switch"
|
||||
description: "Instructions on how to set up Vultr switches within Home Assistant."
|
||||
date: 2017-10-17 21:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: vultr.png
|
||||
ha_category: Switch
|
||||
ha_release: "0.57"
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `vultr` switch platform allows you to control (start/stop) your [Vultr](https://www.vultr.com/) subscription.
|
||||
|
||||
To control your Vultr subscription, 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 `switch.vultr_web_server`):
|
||||
```yaml
|
||||
switch:
|
||||
- platform: vultr
|
||||
subscription: 123456
|
||||
```
|
||||
|
||||
Full `configuration.yaml` (produces `switch.amazing_server`):
|
||||
```yaml
|
||||
switch:
|
||||
- platform: vultr
|
||||
name: Amazing Server
|
||||
subscription: 123456
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **subscription** (*Required*): List of droplets you want to control.
|
||||
- **name** (*Optional*): The name you want to give this switch, defaults to `Vultr {subscription label}`
|
35
source/_components/vultr.markdown
Normal file
35
source/_components/vultr.markdown
Normal file
@ -0,0 +1,35 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Vultr"
|
||||
description: "Instructions on how to integrate Vultr within Home Assistant."
|
||||
date: 2017-10-17 21:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
featured: false
|
||||
ha_category: Hub
|
||||
ha_release: "0.57"
|
||||
logo: vultr.png
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
|
||||
The `vultr` component allows you to access information about and interact with your [Vultr](https://www.vultr.com) subscriptions (Virtual Private Servers) from Home Assistant.
|
||||
|
||||
Obtain your API key from your [Vultr Account](https://my.vultr.com/settings/#settingsapi).
|
||||
|
||||
<p class='note'>
|
||||
Ensure you allow the public IP of Home Assistant under the Access Control heading.
|
||||
</p>
|
||||
|
||||
To integrate your Vultr subscriptions with Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
vultr:
|
||||
api_key: ABCDEFG12345
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **api_key** (*Required*): Your Vultr API key.
|
BIN
source/images/supported_brands/vultr.png
Normal file
BIN
source/images/supported_brands/vultr.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 6.2 KiB |
Loading…
x
Reference in New Issue
Block a user