filesystem.getacl ================= Return ACL of a given path. This may return a POSIX1e ACL or a NFSv4 ACL. The acl type is indicated by the `acltype` key. `simplified` - effect of this depends on ACL type on underlying filesystem. In the case of NFSv4 ACLs simplified permissions and flags are returned for ACL entries where applicable. NFSv4 errata below. In the case of POSIX1E ACls, this setting has no impact on returned ACL. `resolve_ids` - adds additional `who` key to each ACL entry, that converts the numeric id to a user name or group name. In the case of owner@ and group@ (NFSv4) or USER_OBJ and GROUP_OBJ (POSIX1E), st_uid or st_gid will be converted from stat() return for file. In the case of MASK (POSIX1E), OTHER (POSIX1E), everyone@ (NFSv4), key `who` will be included, but set to null. In case of failure to resolve the id to a name, `who` will be set to null. This option should only be used if resolving ids to names is required. Errata about ACLType NFSv4: `simplified` returns a shortened form of the ACL permset and flags where applicable. If permissions have been simplified, then the `perms` object will contain only a single `BASIC` key with a string describing the underlying permissions set. `TRAVERSE` sufficient rights to traverse a directory, but not read contents. `READ` sufficient rights to traverse a directory, and read file contents. `MODIFIY` sufficient rights to traverse, read, write, and modify a file. `FULL_CONTROL` all permissions. If the permisssions do not fit within one of the pre-defined simplified permissions types, then the full ACL entry will be returned. .. raw:: html
Absolute filesystem path to get ACL information for.
Must be at least 1 characters long
Whether to return simplified/basic permission sets instead of advanced permissions.
Whether to resolve numeric user/group IDs to names in the response.
ACL information for the requested filesystem path.
Absolute filesystem path this ACL information applies to.
Must be at least 1 characters long
Username of the file/directory owner or null if unresolved.
Must be at least 1 characters long
Group name of the file/directory group or null if unresolved.
Must be at least 1 characters long
Numeric user ID for file/directory ownership or null to preserve existing.
Value must be greater or equal to -1 and lesser or equal to 2147483647
Numeric group ID for file/directory ownership or null to preserve existing.
Value must be greater or equal to -1 and lesser or equal to 2147483647
ACL type identifier for NFS4 access control lists.
Specific value:"NFS4"
Array of NFS4 Access Control Entries defining permissions.
No Additional ItemsSubject type for this ACE.
owner@: File/directory ownergroup@: File/directory primary groupeveryone@: All usersUSER: Specific user accountGROUP: Specific groupAccess control type.
ALLOW: Grant the specified permissionsDENY: Explicitly deny the specified permissionsPermissions granted or denied by this ACE.
Permission to read file data or list directory contents.
Permission to write file data or create files in directory.
Permission to append data to files or create subdirectories.
Permission to read named attributes (extended attributes).
Permission to write named attributes (extended attributes).
Permission to execute files or traverse directories.
Permission to delete the file or directory.
Permission to delete child files within a directory.
Permission to read basic file attributes (size, timestamps, etc.).
Permission to write basic file attributes.
Permission to read the Access Control List.
Permission to modify the Access Control List.
Permission to change the file owner.
Permission to use the file/directory as a synchronization primitive.
Basic permission level for NFS4 ACE.
FULL_CONTROL: Full read, write, execute, and administrative permissionsMODIFY: Read, write, and execute permissionsREAD: Read-only permissionsTRAVERSE: Execute/traverse permissions onlyInheritance and other behavioral flags for this ACE.
Apply this ACE to files within directories.
Apply this ACE to subdirectories within directories.
Do not propagate inheritance beyond immediate children.
This ACE only affects inheritance, not the object itself.
This ACE was inherited from a parent directory.
Basic inheritance behavior for NFS4 ACE.
INHERIT: Apply to child files and directoriesNOINHERIT: Do not apply to child objectsUID or GID when tag is "USER" or "GROUP". null for special entries.
Value must be greater or equal to -1 and lesser or equal to 2147483647
Username or group name when tag is "USER" or "GROUP". null for special entries.
Must be at least 1 characters long
NFS4 ACL behavioral flags for inheritance and protection.
No Additional PropertiesWhether inheritance is automatically applied from parent directories.
Whether the ACL is protected from inheritance modifications.
Whether this ACL was created by default rules rather than explicit configuration.
Whether this ACL is a simple/trivial ACL equivalent to POSIX permissions.
Absolute filesystem path this ACL information applies to.
Must be at least 1 characters long
Username of the file/directory owner or null if unresolved.
Must be at least 1 characters long
Group name of the file/directory group or null if unresolved.
Must be at least 1 characters long
Numeric user ID for file/directory ownership or null to preserve existing.
Value must be greater or equal to -1 and lesser or equal to 2147483647
Numeric group ID for file/directory ownership or null to preserve existing.
Value must be greater or equal to -1 and lesser or equal to 2147483647
ACL type identifier for POSIX.1e access control lists.
Specific value:"POSIX1E"
Array of POSIX Access Control Entries defining permissions.
No Additional ItemsSubject type for this POSIX ACE.
USER_OBJ: File/directory ownerGROUP_OBJ: File/directory primary groupOTHER: All other usersMASK: Maximum permissions for named users and groupsUSER: Specific user accountGROUP: Specific groupRead, write, and execute permissions for this ACE.
No Additional PropertiesPermission to read file contents or list directory contents.
Permission to write file contents or create/delete files in directory.
Permission to execute files or traverse directories.
Whether this is a default ACE that applies to newly created child objects.
Numeric user or group ID when tag is USER or GROUP. null for object entries.
Value must be greater or equal to -1 and lesser or equal to 2147483647
Username or group name when tag is USER or GROUP. null for object entries.
Must be at least 1 characters long
Whether this ACL is a simple/trivial ACL equivalent to standard POSIX permissions.
Absolute filesystem path this ACL information applies to.
Must be at least 1 characters long
Username of the file/directory owner or null if unresolved.
Must be at least 1 characters long
Group name of the file/directory group or null if unresolved.
Must be at least 1 characters long
Numeric user ID for file/directory ownership or null to preserve existing.
Value must be greater or equal to -1 and lesser or equal to 2147483647
Numeric group ID for file/directory ownership or null to preserve existing.
Value must be greater or equal to -1 and lesser or equal to 2147483647
ACL type identifier indicating access control lists are disabled.
Specific value:"DISABLED"
Always null when ACLs are disabled on the filesystem.
Always true when ACLs are disabled - only basic POSIX permissions apply.
true