totaldebug.hassio_cli.hassio_addons (3.1.0) — module

Manage Home Assistant (HassIO) addons

| "added in version" 2.0.1 of totaldebug.hassio_cli"

Authors: marksie1988 / TotalDebug (@marksie1988)

Install collection

Install with ansible-galaxy collection install totaldebug.hassio_cli:==3.1.0


Add to requirements.yml

  collections:
    - name: totaldebug.hassio_cli
      version: 3.1.0

Description

Manage Home Assistant (HassIO, hass.io) addons - install, uninstall, start, stop, update addons

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Install Samba share addon
- hassio_addon:
    state: present
    name: core_samba
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Uninstall DHCP server and Grafana addons
- hassio_addon:
    state: absent
    name: "{{ item }}"
  with_items:
    - grafana
    - core_dhcp_server
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Start Samba share addon
- hassio_addon:
    state: started
    addon: core_samba
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Stop Samba share addon
- hassio_addon:
    state: stopped
    name: core_samba
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Update Samba share addon
- hassio_addon:
    state: updated
    name: core_samba

Inputs

    
name:
    aliases:
    - addon
    description:
    - Name of addon to install.
    required: true

state:
    choices:
    - present
    - absent
    - started
    - stopped
    - updated
    description:
    - State of addon
    required: true