TrueNAS SCALE Version Documentation
This content follows the TrueNAS SCALE 23.10 (Cobia) releases. Use the Product and Version selectors above to view content specific to different TrueNAS software or major version.

Acltemplate

5 minute read.

Last Modified 2024-03-19 08:38 EDT

The SCALE CLI guide is a work in progress! New namespace and command documentation is continually added and maintained, so check back here often to see what is new!

The acltemplate namespace provides the ability to find existing ACL templates, create new or update exiting templates, or delete a template. The web UI refers to ACL templates as presets. This namesapce does not assign ACL permissions to a dataset. The storage namespace provides access to commands to assign dataset permissions.

Acltemplate Commands

The acltemplate namespace has six commands and is based on functions found in the SCALE API and web UI. It provides access to filesystem methods to list, create, edit, or delete ACL templates using the acltemplate commands.

You can enter commands from the main CLI prompt or from the filesystem acltemplate namespace prompt.

By_Path Command

The by_path command retrieves a list of available ACL templates for a given path.

Retrieve ACL Templates for a Path

Description

The by_path command has one required option value pair, acltemplate_ by_path. Use the default {} to display the list of preset SCALE ACL templates.

by_path supports query-filters and query-options. format-options provides additional options to alter the template query results.

Format.optionsadditional options:

Option	Description
canonicalize	Places ACL entries for NFSv4 ACLS in Microsoft canonical order.
ensure_builtins	Ensures all resutls contain entries for builtin_users and builtin_administrators groups.
resolve_names	Converts IDs in ACL entries to names.

Usage

From the CLI prompt, enter:

filesystem acltemplate by_path acltemplate= {}

Command Example

filesystem acltemplate by_path acltemplate= {}
+-----+-----------------+------------------------------------------------------------------+---------+--------+---------+
| id | name             | comment                                                          | acltype | acl    | bulitin |
+-----+-----------------+------------------------------------------------------------------+---------+----- --+---------+
| 1  | NFS4_OPEN        | Template that grants full control to owner@, group@, and ever... | NFS4    | <list> | true    |
| 2  | NFS4_RESTRICTED  | Template that omits access for the everyone@ special entry. T... | NFS4    | <list> | true    |
| 3  | NFS4_HOME        | Template for special Samba homes share that only grants read ... | NFS4    | <list> | true    |
| 4  | NFS4_DOMAIN_HOME | Template special Samba homes share in Active Directory(A...      | NFS4    | <list> | true    |
| 5  | POSIX_OPEN       | Template that grants read, write, and execute permissions to ... | POSIX1E | <list> | true    |
| 6  | POSIX_RESTRICTED | Template that grants read, write, and execute to owner and gr... | POSIX1E | <list> | true    |
| 7  | POSIX_HOME       | Template for special Samba homes share that only grants read ... | POSIX1E | <list> | true    |
| 8  | NFS4_ADMIN       | Template restricting access to local and domain administrators.  | NFS4    | <list> | true    |
| 9  | POSIX_ADMIN      | Template restricting access to local and domain administrators.  | POSIX1E | <list> | true    |
+-----+-----------------+------------------------------------------------------------------+---------+--------+---------+

Create Command

The create command creates a filesystem ACL template.

The TrueNAS CLI guide for SCALE is a work in progress! This command has not been fully tested and validated. Full documentation is still being developed. Check back for updated information.

Delete Command

The delete command deleted a filesystem acl template from the system.

The TrueNAS CLI guide for SCALE is a work in progress! This command has not been fully tested and validated. Full documentation is still being developed. Check back for updated information.

Get_Instance

The get_instance command returns the instance matching the value of the ID number of the ACL template or the query-options-get_instance value specified.

Find Instance Matching ID

Description

The get_instance command returns the instance matching the value of the id number or the query-options-get_instance value specified. Enter the command, then press Enter.

Usage

From the CLI prompt, enter:

filesystem acltemplate get_instance id=10

Where 10 is the ID number for the template.

Command Example

filesystem acltemplate get_instance id=1
+---------+------------------------------------------------------------------+
|      id |1                                                                 |
|    name | NFS4_OPEN                                                        |
| comment | Template that grants full control to owner@, group@, and ever... |
| acltype | NFS4                                                             |
|     acl | <list>                                                           |
| builtin | true                                                             |
+---------+------------------------------------------------------------------+

Query Command

The query command returns a list of filesystem ACL templates.

Query Filesystem ACL Templates

Description

The query command returns the list of filesystem ACL templates. Enter the command, then press Enter. The output from this command is the same as the acltemplate by_path acltemplate= {} command.

Usage

From the CLI prompt, enter:

filesystem acltemplate query

Command Example

filesystem acltemplate query
+-----+-----------------+------------------------------------------------------------------+---------+--------+---------+
| id | name             | comment                                                          | acltype | acl    | bulitin |
+-----+-----------------+------------------------------------------------------------------+---------+----- --+---------+
| 1  | NFS4_OPEN        | Template that grants full control to owner@, group@, and ever... | NFS4    | <list> | true    |
| 2  | NFS4_RESTRICTED  | Template that omits access for the everyone@ special entry. T... | NFS4    | <list> | true    |
| 3  | NFS4_HOME        | Template for special Samba homes share that only grants read ... | NFS4    | <list> | true    |
| 4  | NFS4_DOMAIN_HOME | Template special Samba homes share in Active Directory(A...      | NFS4    | <list> | true    |
| 5  | POSIX_OPEN       | Template that grants read, write, and execute permissions to ... | POSIX1E | <list> | true    |
| 6  | POSIX_RESTRICTED | Template that grants read, write, and execute to owner and gr... | POSIX1E | <list> | true    |
| 7  | POSIX_HOME       | Template for special Samba homes share that only grants read ... | POSIX1E | <list> | true    |
| 8  | NFS4_ADMIN       | Template restricting access to local and domain administrators.  | NFS4    | <list> | true    |
| 9  | POSIX_ADMIN      | Template restricting access to local and domain administrators.  | POSIX1E | <list> | true    |
+-----+-----------------+------------------------------------------------------------------+---------+--------+---------+

Update Command

The update command updates the filesystem ACL template for the id included in the command.

The TrueNAS CLI guide for SCALE is a work in progress! This command has not been fully tested and validated. Full documentation is still being developed. Check back for updated information.

Acltemplate

Acltemplate Commands

By_Path Command

Description

Usage

Create Command

Delete Command

Get_Instance

Description

Usage

Query Command

Description

Usage

Update Command

Related ACL Articles