From 8ca565119c580b971c558dd35da27ad057c23b96 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 16 Jul 2024 16:58:12 +0200 Subject: [PATCH] backups: rename 'service' to 'action' (#33807) --- source/_includes/common-tasks/backups.md | 4 +-- source/_integrations/hassio.markdown | 42 ++++++++++++------------ 2 files changed, 23 insertions(+), 23 deletions(-) diff --git a/source/_includes/common-tasks/backups.md b/source/_includes/common-tasks/backups.md index 2dd8a4e8d2b..b30858e475d 100644 --- a/source/_includes/common-tasks/backups.md +++ b/source/_includes/common-tasks/backups.md @@ -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. -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: @@ -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. - [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: - [Google Drive Backup](https://github.com/sabeechen/hassio-google-drive-backup) - [Dropbox Sync](https://github.com/danielwelch/hassio-dropbox-sync) diff --git a/source/_integrations/hassio.markdown b/source/_integrations/hassio.markdown index 9d1107739b9..bcf45a94402 100644 --- a/source/_integrations/hassio.markdown +++ b/source/_integrations/hassio.markdown @@ -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. -## Services +## Actions -### Service hassio.addon_start +### Action hassio.addon_start Start an add-on. -| Service Data Attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `addon` | no | Add-on slug -### Service hassio.addon_stop +### Action hassio.addon_stop Stop an add-on. -| Service Data Attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `addon` | no | Add-on slug -### Service hassio.addon_restart +### Action hassio.addon_restart Restart an add-on. -| Service Data Attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `addon` | no | Add-on slug -### Service hassio.addon_stdin +### Action hassio.addon_stdin Write data to add-on stdin. -| Service Data Attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `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. -| Service Data Attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `addon` | no | Add-on slug -### Service hassio.host_reboot +### Action hassio.host_reboot Reboot the host system. -### Service hassio.host_shutdown +### Action hassio.host_shutdown Shutdown the host system. -### Service hassio.backup_full +### Action hassio.backup_full 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. | `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 | `homeassistant_exclude_database` | yes | Exclude the Home Assistant database file from backup -### Service hassio.backup_partial +### Action hassio.backup_partial Create a partial backup. -| Service Data Attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `addons` | yes | List of add-on slugs 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_exclude_database` | yes | Exclude the Home Assistant database file from backup -### Service hassio.restore_full +### Action hassio.restore_full Restore from full backup. -| Service Data Attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `slug` | no | Slug of backup to restore from | `password` | yes | Optional password for backup -### Service hassio.restore_partial +### Action hassio.restore_partial Restore from partial backup. -| Service Data Attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `slug` | no | Slug of backup to restore from | `homeassistant` | yes | Whether to restore Home Assistant, `true` or `false`