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.
Group
8 minute read.
Last Modified 2024-03-19 08:38 EDTThe TrueNAS CLI guide for SCALE 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 group namespace contains eight commands and is based on functions found in the SCALE API and web UI. It provides access to group account creation, configuration, and management functions.
The following group namespace commands allow you to manage group settings.
You can enter commands from the main CLI prompt or from the account namespace prompt.
The create
command creates a new group.
The delete
command erases an existing group.
The get_group_obj
command returns dictionary containing information from struct grp including group name, identification number, and group members.
The get_instance
command retrieves information about a group.
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.
The get_next_gid
command displays the next available group identification (GID) number.
The has_password_enabled_user
command checks whether at least one local user with a password enabled is a member of one or more provided groups.
The query
command retrieves information about a group or groups or the query-options-get_instance value specified.
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.
The update
command updates the attributes of an existing group.