arensb.truenas.systemdataset module – Manage the system dataset.

Note

This module is part of the arensb.truenas collection (version 1.11.4).

To install it, use: ansible-galaxy collection install arensb.truenas.

To use it in a playbook, specify: arensb.truenas.systemdataset.

New in arensb.truenas 0.5.0

Synopsis

  • Manage the system dataset, including migrating it from one pool to another.

Parameters

Parameter

Comments

pool

string

Name of the pool that should hold the system dataset.

syslog

boolean

Whether to store system logs on the system dataset.

If unset, logs will be stored in /var.

Choices:

  • false

  • true

Examples

- name: Migrate system dataset to ZFS pool mypool2
  arensb.truenas.systemdataset:
    pool: mypool2

- name: Don't store system logs on the system dataset.
  arensb.truenas.systemdataset:
    syslog: no

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

status

dictionary

An object describing the new state of the system dataset.

This is in the same format as the value returned by systemdataset.config

Returned: success

Sample: "{\n  \"id\": 1,\n  \"pool\": \"mypool2\",\n  \"uuid\": \"abcdef123456\",\n  \"uuid_a\": \"abcdef123456\",\n  \"uuid_b\": null,\n  \"is_decrypted\": true,\n  \"basename\": \"mypool2/.system\",\n  \"syslog\": true\n  \"path\": \"/var/db/system\",\n}\n"