Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bellackn/ansible-role-hass-control
Ansible role that sets and retrieves Home Assistant configuration files
https://github.com/bellackn/ansible-role-hass-control
Last synced: 21 days ago
JSON representation
Ansible role that sets and retrieves Home Assistant configuration files
- Host: GitHub
- URL: https://github.com/bellackn/ansible-role-hass-control
- Owner: bellackn
- License: mit
- Created: 2022-01-02T11:13:53.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-02T12:21:44.000Z (almost 3 years ago)
- Last Synced: 2024-10-04T14:41:34.512Z (about 1 month ago)
- Size: 7.81 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
bellackn.hass_control
===============
Use this role to easily set and retrieve configurations for Home Assistant.
How to Use
----------
The role checks for configuration files on your local machine, uploads them to Home Assistant and restarts it when
changes occurred. It can also just download the current configuration from your instance and update your local codebase
if you have made some changes manually in the Home Assistant UI.
> 💡 It works with the Terminal & SSH plugin since the role will install Python3 in the container.
It's pretty lightweight and doesn't depend on any specific role or library.
Role Variables
--------------
hass_control_home_assistant_base_url: http://homeassistant:8123
The URL on which your Home Assistant instance is listening.
hass_control_home_assistant_auth_token: ""
An API token for a profile that has admin access. Needed to restart Home Assistant. See [here][1] on how to obtain one.
hass_control_config_files: []
A list of config file names that you maintain. Check the example playbook.
hass_control_config_templates: []
A list of templates in your local repository that will be rendered and copied to Home Assistant. Check the example
playbook.
hass_control_mode: get
This controls whether you download the current configuration files from your Home Assistant instance, or if you want to
upload those currently living in your local repository. Can be set to either "get" or "set".
hass_control_config_local_root_files: files/home_assistant
The default directory where the role will look for your configuration files.
hass_control_config_local_root_templates: templates/home_assistant
The default directory where the role will look for your configuration templates.
hass_control_config_remote_root: /config
The root configuration directory on your Home Assistant machine.
Example Playbook
----------------
This will download a number of configuration files. If you run it with `-e hass_control_mode=set`, it will upload these
files and the rendered templates.
```yaml
---
- name: Set or get various Home Assistant configurations
hosts: home_assistant
gather_facts: no
vars:
hass_control_config_files:
- automations
- configuration # The main config file.
- frontend
- lights
- notify
- scenes
- scripts
- sensors
hass_control_config_templates:
- cameras
- secrets
- shell_commands
hass_control_home_assistant_auth_token: "{{ vault_hass_control_home_assistant_auth_token }}"
roles:
- bellackn.hass_control
```
License
-------
MIT
Author Information
------------------
[Nico Bellack](mailto:[email protected])
[1]: https://developers.home-assistant.io/docs/api/rest/