filesystem.acltemplate.query¶
No Additional Items
Tuple Validation
Parameter 1: filters
filters
Type: array Default: []List of filters for query results. See API documentation for "Query Methods" for more guidance.
No Additional ItemsEach item of this array must be:
[
    [
        "name",
        "=",
        "bob"
    ]
]
[
    [
        "OR",
        [
            [
                [
                    "name",
                    "=",
                    "bob"
                ]
            ],
            [
                [
                    "name",
                    "=",
                    "larry"
                ]
            ]
        ]
    ]
]
Parameter 2: options
options
Type: objectQuery options customize the results returned by a query method. More complete documentation with examples
 are covered in the "Query methods" section of the TrueNAS API documentation. 
Extra
Type: object Default: {}Extra options are defined on a per-endpoint basis and are described in the documentation for the associated
 query method. 
Order By
Type: array of string Default: []An array of field names describing the manner in which query results should be ordered. The field names may
 also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place
 any null values at the head of the results list), nulls_last: (place any null values at the tail of the
 results list). 
Each item of this array must be:
[
    "size",
    "-devname",
    "nulls_first:-expiretime"
]
Select
Type: array Default: []An array of field names specifying the exact fields to include in the query return. The dot character .
 may be used to explicitly select only subkeys of the query result. 
Each item of this array must be:
No Additional Items
Each item of this array must be:
[
    "username",
    "Authentication.status"
]
Count
Type: boolean Default: falseReturn a numeric value representing the number of items that match the specified query-filters. 
Get
Type: boolean Default: falseReturn the JSON object of the first result matching the specified query-filters. The query fails
 if there specified query-filters return no results. 
Offset
Type: integer Default: 0This specifies the beginning offset of the results array. When combined with the limit query-option
 it may be used to implement pagination of large results arrays. WARNING: some query methods provide
 volatile results and the onus is on the developer to understand whether pagination is appropriate
 for a particular query API method. 
Limit
Type: integer Default: 0This specifies the maximum number of results matching the specified query-filters to return. When
 combined wtih the offset query-option it may be used to implement pagination of large results arrays.
 WARNING: some query methods provide volatile results and the onus is on the developer to understand whether
 pagination is appropriate for a particular query API method. 
Force Sql Filters
Type: boolean Default: falseResult
No Additional Items
Each item of this array must be:
AclTemplateQueryResultItem
Type: objectNo Additional Properties
Id
Type: integerBuiltin
Type: booleanName
Type: stringAcltype
Type: enum (of string)Must be one of:
- "NFS4"
- "POSIX1E"
Acl
No Additional Items
Each item of this array must be:
NFS4ACE
Type: objectNo Additional Properties
Tag
Type: enum (of string)Must be one of:
- "owner@"
- "group@"
- "everyone@"
- "USER"
- "GROUP"
Type
Type: enum (of string)Must be one of:
- "ALLOW"
- "DENY"
Perms
NFS4ACE_AdvancedPerms
Type: objectNo Additional Properties
Read Data
Type: boolean Default: falseWrite Data
Type: boolean Default: falseAppend Data
Type: boolean Default: falseRead Named Attrs
Type: boolean Default: falseWrite Named Attrs
Type: boolean Default: falseExecute
Type: boolean Default: falseDelete
Type: boolean Default: falseDelete Child
Type: boolean Default: falseRead Attributes
Type: boolean Default: falseWrite Attributes
Type: boolean Default: falseRead Acl
Type: boolean Default: falseWrite Acl
Type: boolean Default: falseWrite Owner
Type: boolean Default: falseSynchronize
Type: boolean Default: falseNFS4ACE_BasicPerms
Type: objectNo Additional Properties
Basic
Type: enum (of string)Must be one of:
- "FULL_CONTROL"
- "MODIFY"
- "READ"
- "TRAVERSE"
Flags
NFS4ACE_AdvancedFlags
Type: objectNo Additional Properties
File Inherit
Type: boolean Default: falseDirectory Inherit
Type: boolean Default: falseNo Propagate Inherit
Type: boolean Default: falseInherit Only
Type: boolean Default: falseInherited
Type: boolean Default: falseNFS4ACE_BasicFlags
Type: objectNo Additional Properties
Basic
Type: enum (of string)Must be one of:
- "INHERIT"
- "NOINHERIT"
Id
Default: nullValue must be greater or equal to -1 and lesser or equal to 2147483647
Who
Default: nullMust be at least 1 characters long
No Additional Items
Each item of this array must be:
POSIXACE
Type: objectNo Additional Properties
Tag
Type: enum (of string)Must be one of:
- "USER_OBJ"
- "GROUP_OBJ"
- "OTHER"
- "MASK"
- "USER"
- "GROUP"
POSIXACE_Perms
Type: objectNo Additional Properties
Read
Type: booleanWrite
Type: booleanExecute
Type: booleanDefault
Type: booleanId
Default: nullValue must be greater or equal to -1 and lesser or equal to 2147483647
Who
Default: nullMust be at least 1 characters long
Comment
Type: stringAclTemplateQueryResultItem
Type: objectNo Additional Properties
Id
Type: integerBuiltin
Type: booleanName
Type: stringAcltype
Type: enum (of string)Must be one of:
- "NFS4"
- "POSIX1E"
Acl
No Additional Items
Each item of this array must be:
No Additional Items
Each item of this array must be:
Comment
Type: stringRequired roles: FILESYSTEM_ATTRS_READ