Manage a TrueNAS machine.
This collection consists primarily of a set of Ansible modules to configure a TrueNAS machine, using the TrueNAS API to control the Middleware Daemon.
It aims to be intuitive to use, and to avoid unpleasant surprises.
See the online documentation for the list of included modules, and how to use them.
The easiest way to install this collection is through Ansible Galaxy:
ansible-galaxy collection install arensb.truenas
- name: Example tasks
collections:
- arensb.truenas
hosts: truenas-box
become: yes
tasks:
- name: Set the hostname
hostname:
name: new-hostname
- name: Turn on sshd
service:
name: sshd
Note that since several of the module names are the same as builtin ones, you may want to use the full name to avoid confusion:
- hosts: truenas-box
become: yes
tasks:
- arensb.truenas.hostname:
name: new-hostname
There are two ways of communicating with the middleware daemon on
TrueNAS, referred to here as midclt and client. midclt is older
and better-tested, while client is faster but less-well-tested. The
default is client.
Set the middleware_method environment variable to either client or
midclt at either the play or task level in your playbook to manually
select how this module communicates with the middleware daemon.
Example:
- collections: arensb.truenas
hosts: my-nas
become: yes
environment:
middleware_method: client
tasks:
- name: Create a jail
jail:
name: my-jail
release: 13.1-RELEASE
state: running
The best way to contribute a patch or feature is to create a pull request.
If you'd like to write your own module, the extras/template file
provides a good starting point.
The HACKING file has some tips on how to get around.
- Tested with 2.10.8
See the user-friendly docs, or the latest changelog.yaml.
- Andrew Arensburger (@arensb)
- Ed Hull (https://github.com/edhull)
- Mozzie (https://github.com/MozzieBytes)
- bmarinov (https://github.com/bmarinov)