Getting started¶
Example inventory¶
Add the hosts on which should shutdown if the build-in battery is low to the
ypid_shutdown_if_battery_low
Ansible inventory group:
[ypid_shutdown_if_battery_low]
hostname
Example playbook¶
Here's an example playbook that uses the ypid.shutdown_if_battery_low role:
---
- name: Configure shutdown if battery low
hosts: [ 'ypid_shutdown_if_battery_low' ]
become: True
environment: '{{ inventory__environment | d({})
| combine(inventory__group_environment | d({}))
| combine(inventory__host_environment | d({})) }}'
roles:
- role: ypid.shutdown_if_battery_low
tags: [ 'role::shutdown_if_battery_low' ]
The playbooks is shipped with this role under
docs/playbooks/shutdown_if_battery_low.yml
from which you can symlink it to your
playbook directory.
In case you use multiple roles maintained by ypid, consider
using the ypid-ansible-common.
Ansible tags¶
You can use Ansible --tags
or --skip-tags
parameters to limit what
tasks are performed during Ansible run. This can be used after a host was first
configured to speed up playbook execution, when you are sure that most of the
configuration is already in the desired state.
Available role tags:
role::shutdown_if_battery_low
- Main role tag, should be used in the playbook to execute all of the role tasks as well as role dependencies.