Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/totaldebug/ansible-collection-hassio_cli
Ansible Collection for configuring HassIO (https://www.home-assistant.io/)
https://github.com/totaldebug/ansible-collection-hassio_cli
ansible collection hassio
Last synced: 6 days ago
JSON representation
Ansible Collection for configuring HassIO (https://www.home-assistant.io/)
- Host: GitHub
- URL: https://github.com/totaldebug/ansible-collection-hassio_cli
- Owner: totaldebug
- Created: 2021-02-13T17:23:34.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-29T18:54:10.000Z (over 1 year ago)
- Last Synced: 2023-07-29T19:43:33.139Z (over 1 year ago)
- Topics: ansible, collection, hassio
- Language: Python
- Homepage:
- Size: 38.1 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
An Ansible collection containing modules for executing HA CLI Commands.
About •
Features •
Configuration •
Contributing •
Author •
Support •
Donate •
License
---
## About
**ansible-module-hassio** is a **high-quality** _Ansible Collection Module_ that executes **HA CLI** commands on your hassio ansible clients.
Hass.io is an operating system that will take care of installing and updating Home Assistant, is managed from the Home Assistant UI, allows creating/restoring snapshots of your configuration and can easily be extended using Hass.io add-ons including Google Assistant and Let’s Encrypt.
## Features
| | 🔰 |
| -------------------------- | :----------------: |
| Manage Hassio addons | ✔️ |
| Manage Hassio Host | ✔️ |
| Manage Hassio Snapshots | ✔️ |
| Manage Hassio DNS | ✔️ |
| Add / Remove Addon Repos | ✔️ |
## Configuration
### Install
Include this collection as a requirement with your playbook.
```shell
ansible-galaxy collection install totaldebug.hassio_cli
```
### Usage
#### hassio_addons
| Option | Required | Description |
| --------------- | :------: | :---------: |
| name (alias: addon) | True | The name of the addon |
| state | True | The state of the addon ["present", "absent", "started", "stopped", "updated"] |
Examples
```yaml
# Install Samba share addon
- totaldebug.hassio_cli.hassio_addon:
state: present
name: core_samba
# Uninstall DHCP server and Grafana addons
- totaldebug.hassio_cli.hassio_addons:
state: absent
name: {{ item }}
with_items:
- core_dhcp_server
- core_mosquitto
# Start Samba share addon
- totaldebug.hassio_cli.hassio_addons:
state: started
addon: core_samba
# Stop Samba share addon
- totaldebug.hassio_cli.hassio_addons:
state: stopped
name: core_samba
# Update Samba share addon
- totaldebug.hassio_cli.hassio_addons:
state: updated
name: core_samba
```
#### hassio_host
| Option | Required | Description |
| --------------- | :------: | :---------: |
| state | True | ["rebooted", "updated", "shutdown"] |
Examples
```yaml
# Reboot HassIO OS
- totaldebug.hassio_cli.hassio_host:
state: rebooted
# Update HassIO OS
- totaldebug.hassio_cli.hassio_host:
state: updated
```
#### hassio_snapshot
| Option | Required | Description |
| --------------- | :------: | :---------: |
| name | False | The name of the snapshot |
| state | True | ["new", "remove", "restore", "reload"] |
Examples
```yaml
# Create snapshot with name snap-10-01-2021
- totaldebug.hassio_cli.hassio_snapshot:
state: new
name: "snap-10-01-2021"
# Remove snapshot with name snap-10-01-2021
- totaldebug.hassio_cli.hassio_snapshot:
state: remove
name: "snap-10-01-2021"
# Restore snapshot with name snap-10-01-2021
- totaldebug.hassio_cli.hassio_snapshot:
state: restore
name: "snap-10-01-2021"
# Reload the files on disk to check for new or removed snapshots
- totaldebug.hassio_cli.hassio_snapshot:
state: reload
```
#### hassio_addon_repos
| Option | Required | Description |
| --------------- | :------: | :---------: |
| name (alias: repo) | True | The URL of the repo to be added |
| state | True | ["present", "absent"] |
| src | False | File where config is stored, Default: `/usr/share/hassio/config.json` |
Examples
```yaml
# Addrepo to config
- totaldebug.hassio_cli.hassio_addon_repos:
state: present
repo: "https://github.com/helto4real/hassio-add-ons"
# Remove repo from config
- totaldebug.hassio_cli.hassio_snapshot:
state: absent
repo: "https://github.com/helto4real/hassio-add-ons"
src: "/usr/share/hassio/config.json"
```
## Contributing
Got **something interesting** you'd like to **share**? Learn about [contributing](https://github.com/totaldebug/.github/blob/main/.github/CONTRIBUTING.md).
### Versioning
This project follows semantic versioning.
In the context of semantic versioning, consider the role contract to be defined by the role variables.
- Breaking Changes or changes that require user intervention will increase the major version. This includes changing the default value of a role variable.
- Changes that do not require user intervention, but add new features, will increase the minor version.
- Bug fixes will increase the patch version.
## Author
| [](https://linkedin.com/in/marksie1988) |
|:--:|
| **marksie1988 (Steven Marks)** |
## Support
Reach out to me at one of the following places:
- via [Discord](https://discord.gg/6fmekudc8Q)
- Raise an issue in GitHub
## Donate
Please consider supporting this project by sponsoring, or just donating a little via [our sponsor page](https://github.com/sponsors/marksie1988)
## License
[](https://creativecommons.org/licenses/by-nc-sa/4.0/)
- Copyright © [Total Debug](https://totaldebug.uk "Total Debug").