jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-17 14:26:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

backups: rename 'service' to 'action' (#33807)

Browse Source
This commit is contained in:
c0ffeeca7 2024-07-16 16:58:12 +02:00 committed by GitHub
parent 4dd909a857
commit 8ca565119c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
source/_includes/common-tasks/backups.md
View File

@ -2,7 +2,7 @@
Backup of your Home Assistant, add-on data, and configuration. Backups are used to [restore](#restoring-a-backup) a system or parts of it if a rollback is needed or to migrate your Home Assistant to new hardware. It is good practice to create a backup before updating. Backup of your Home Assistant, add-on data, and configuration. Backups are used to [restore](#restoring-a-backup) a system or parts of it if a rollback is needed or to migrate your Home Assistant to new hardware. It is good practice to create a backup before updating.
Backups are made from the backups panel under {% my supervisor_backups title="**Settings** > **System** > **Backups**" %}. There is also a [service](/integrations/hassio/#service-hassiobackup_full) available that allows you to trigger the creation of a backup from an automation. Backups are stored in a compressed archive file (.tar) and by default, stored locally in the `/backup` directory. Backups are made from the backups panel under {% my supervisor_backups title="**Settings** > **System** > **Backups**" %}. There is also an [action](/integrations/hassio/#action-hassiobackup_full) available that allows you to trigger the creation of a backup from an automation. Backups are stored in a compressed archive file (.tar) and by default, stored locally in the `/backup` directory.
A full backup includes the following directories: A full backup includes the following directories:
@ -59,7 +59,7 @@ There are multiple ways to store the backup on another device:
- [Add a network storage location](/common-tasks/{{page.installation}}/#network-storage) for backups. - [Add a network storage location](/common-tasks/{{page.installation}}/#network-storage) for backups.
- [Change the default location](/common-tasks/{{page.installation}}/#change-default-backup-location) for backups. - [Change the default location](/common-tasks/{{page.installation}}/#change-default-backup-location) for backups.
- **Option 4**: Or even better, create an automation to handle that, using one of the [backup services](/integrations/hassio/#service-hassiobackup_full). - **Option 4**: Or even better, create an automation to handle that, using one of the [backup actions](/integrations/hassio/#action-hassiobackup_full).
- **Option 5**: Make use of a third-party add-on: - **Option 5**: Make use of a third-party add-on:
- [Google Drive Backup](https://github.com/sabeechen/hassio-google-drive-backup) - [Google Drive Backup](https://github.com/sabeechen/hassio-google-drive-backup)
- [Dropbox Sync](https://github.com/danielwelch/hassio-dropbox-sync) - [Dropbox Sync](https://github.com/danielwelch/hassio-dropbox-sync)

42
source/_integrations/hassio.markdown
View File

@ -86,61 +86,61 @@ For Home Assistant OS Supervisor provides following binary sensors:
For all your installed add-ons, Home Assistant Core, Home Assistant Supervisor, and for the Home Assistant Operating System (if you are running that), this integration will provide [update](/integrations/update) entities that provide information about pending updates, and will allow you to update to them. For all your installed add-ons, Home Assistant Core, Home Assistant Supervisor, and for the Home Assistant Operating System (if you are running that), this integration will provide [update](/integrations/update) entities that provide information about pending updates, and will allow you to update to them.
## Services ## Actions
### Service hassio.addon_start ### Action hassio.addon_start
Start an add-on. Start an add-on.
| Service Data Attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `addon` | no | Add-on slug | `addon` | no | Add-on slug
### Service hassio.addon_stop ### Action hassio.addon_stop
Stop an add-on. Stop an add-on.
| Service Data Attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `addon` | no | Add-on slug | `addon` | no | Add-on slug
### Service hassio.addon_restart ### Action hassio.addon_restart
Restart an add-on. Restart an add-on.
| Service Data Attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `addon` | no | Add-on slug | `addon` | no | Add-on slug
### Service hassio.addon_stdin ### Action hassio.addon_stdin
Write data to add-on stdin. Write data to add-on stdin.
| Service Data Attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `addon` | no | Add-on slug | `addon` | no | Add-on slug
### Service hassio.addon_update ### Action hassio.addon_update
Update add-on. This service should be used with caution since add-on updates can contain backward-incompatible changes. It is highly recommended that you review release notes/change logs before updating an add-on. Update add-on. This service should be used with caution since add-on updates can contain backward-incompatible changes. It is highly recommended that you review release notes/change logs before updating an add-on.
| Service Data Attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `addon` | no | Add-on slug | `addon` | no | Add-on slug
### Service hassio.host_reboot ### Action hassio.host_reboot
Reboot the host system. Reboot the host system.
### Service hassio.host_shutdown ### Action hassio.host_shutdown
Shutdown the host system. Shutdown the host system.
### Service hassio.backup_full ### Action hassio.backup_full
Create a full backup. Create a full backup.
| Service Data Attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `name` | yes | By default, the current date and time are used in your local time, which you have set in your general settings. | `name` | yes | By default, the current date and time are used in your local time, which you have set in your general settings.
| `password` | yes | Optional password for backup | `password` | yes | Optional password for backup
@ -148,11 +148,11 @@ Create a full backup.
| `location` | yes | Alternate backup location instead of using the default location for backups | `location` | yes | Alternate backup location instead of using the default location for backups
| `homeassistant_exclude_database` | yes | Exclude the Home Assistant database file from backup | `homeassistant_exclude_database` | yes | Exclude the Home Assistant database file from backup
### Service hassio.backup_partial ### Action hassio.backup_partial
Create a partial backup. Create a partial backup.
| Service Data Attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `addons` | yes | List of add-on slugs to backup | `addons` | yes | List of add-on slugs to backup
| `folders` | yes | List of directories to backup | `folders` | yes | List of directories to backup
@ -163,20 +163,20 @@ Create a partial backup.
| `homeassistant` | yes | Include Home Assistant and associated config in backup | `homeassistant` | yes | Include Home Assistant and associated config in backup
| `homeassistant_exclude_database` | yes | Exclude the Home Assistant database file from backup | `homeassistant_exclude_database` | yes | Exclude the Home Assistant database file from backup
### Service hassio.restore_full ### Action hassio.restore_full
Restore from full backup. Restore from full backup.
| Service Data Attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `slug` | no | Slug of backup to restore from | `slug` | no | Slug of backup to restore from
| `password` | yes | Optional password for backup | `password` | yes | Optional password for backup
### Service hassio.restore_partial ### Action hassio.restore_partial
Restore from partial backup. Restore from partial backup.
| Service Data Attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `slug` | no | Slug of backup to restore from | `slug` | no | Slug of backup to restore from
| `homeassistant` | yes | Whether to restore Home Assistant, `true` or `false` | `homeassistant` | yes | Whether to restore Home Assistant, `true` or `false`