filesystem.acltemplate.create

Create a new filesystem ACL template.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: acltemplate_create

acltemplate_create

Type: object

ACL template configuration data for the new template.

No Additional Properties

name Required

Name

Type: string

Human-readable name for the ACL template.

acltype Required

Acltype

Type: enum (of string)

ACL type this template provides.

Must be one of:

• "NFS4"
• "POSIX1E"

acl Required

Acl

Array of Access Control Entries defined by this template.

Any of

• Option 1
• Option 2

Type: array of object
No Additional Items

Each item of this array must be:

NFS4ACE

Type: object
No Additional Properties

tag Required

Tag

Type: enum (of string)

Subject type for this ACE.

• owner@: File/directory owner
• group@: File/directory primary group
• everyone@: All users
• USER: Specific user account
• GROUP: Specific group

Must be one of:

• "owner@"
• "group@"
• "everyone@"
• "USER"
• "GROUP"

type Required

Type

Type: enum (of string)

Access control type.

• ALLOW: Grant the specified permissions
• DENY: Explicitly deny the specified permissions

Must be one of:

• "ALLOW"
• "DENY"

perms Required

Perms

Permissions granted or denied by this ACE.

Any of

• NFS4ACE_AdvancedPerms
• NFS4ACE_BasicPerms

NFS4ACE_AdvancedPerms

Type: object
No Additional Properties

READ_DATA

Read Data

Type: boolean Default: false

Permission to read file data or list directory contents.

WRITE_DATA

Write Data

Type: boolean Default: false

Permission to write file data or create files in directory.

APPEND_DATA

Append Data

Type: boolean Default: false

Permission to append data to files or create subdirectories.

READ_NAMED_ATTRS

Read Named Attrs

Type: boolean Default: false

Permission to read named attributes (extended attributes).

WRITE_NAMED_ATTRS

Write Named Attrs

Type: boolean Default: false

Permission to write named attributes (extended attributes).

EXECUTE

Execute

Type: boolean Default: false

Permission to execute files or traverse directories.

DELETE

Delete

Type: boolean Default: false

Permission to delete the file or directory.

DELETE_CHILD

Delete Child

Type: boolean Default: false

Permission to delete child files within a directory.

READ_ATTRIBUTES

Read Attributes

Type: boolean Default: false

Permission to read basic file attributes (size, timestamps, etc.).

WRITE_ATTRIBUTES

Write Attributes

Type: boolean Default: false

Permission to write basic file attributes.

READ_ACL

Read Acl

Type: boolean Default: false

Permission to read the Access Control List.

WRITE_ACL

Write Acl

Type: boolean Default: false

Permission to modify the Access Control List.

WRITE_OWNER

Write Owner

Type: boolean Default: false

Permission to change the file owner.

SYNCHRONIZE

Synchronize

Type: boolean Default: false

Permission to use the file/directory as a synchronization primitive.

NFS4ACE_BasicPerms

Type: object
No Additional Properties

BASIC Required

Basic

Type: enum (of string)

Basic permission level for NFS4 ACE.

• FULL_CONTROL: Full read, write, execute, and administrative permissions
• MODIFY: Read, write, and execute permissions
• READ: Read-only permissions
• TRAVERSE: Execute/traverse permissions only

Must be one of:

• "FULL_CONTROL"
• "MODIFY"
• "READ"
• "TRAVERSE"

flags Required

Flags

Inheritance and other behavioral flags for this ACE.

Any of

• NFS4ACE_AdvancedFlags
• NFS4ACE_BasicFlags

NFS4ACE_AdvancedFlags

Type: object
No Additional Properties

FILE_INHERIT

File Inherit

Type: boolean Default: false

Apply this ACE to files within directories.

DIRECTORY_INHERIT

Directory Inherit

Type: boolean Default: false

Apply this ACE to subdirectories within directories.

NO_PROPAGATE_INHERIT

No Propagate Inherit

Type: boolean Default: false

Do not propagate inheritance beyond immediate children.

INHERIT_ONLY

Inherit Only

Type: boolean Default: false

This ACE only affects inheritance, not the object itself.

INHERITED

Inherited

Type: boolean Default: false

This ACE was inherited from a parent directory.

NFS4ACE_BasicFlags

Type: object
No Additional Properties

BASIC Required

Basic

Type: enum (of string)

Basic inheritance behavior for NFS4 ACE.

• INHERIT: Apply to child files and directories
• NOINHERIT: Do not apply to child objects

Must be one of:

• "INHERIT"
• "NOINHERIT"

id

Id

Default: null

UID or GID when tag is "USER" or "GROUP". null for special entries.

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to -1 and lesser or equal to 2147483647

Type: null

who

Who

Default: null

Username or group name when tag is "USER" or "GROUP". null for special entries.

Any of

• Option 1
• Option 2
• Option 3

Type: string

Type: string

Must be at least 1 characters long

Type: null

Type: array of object
No Additional Items

Each item of this array must be:

POSIXACE

Type: object
No Additional Properties

tag Required

Tag

Type: enum (of string)

Subject type for this POSIX ACE.

• USER_OBJ: File/directory owner
• GROUP_OBJ: File/directory primary group
• OTHER: All other users
• MASK: Maximum permissions for named users and groups
• USER: Specific user account
• GROUP: Specific group

Must be one of:

• "USER_OBJ"
• "GROUP_OBJ"
• "OTHER"
• "MASK"
• "USER"
• "GROUP"

perms Required

POSIXACE_Perms

Type: object

Read, write, and execute permissions for this ACE.

No Additional Properties

READ Required

Read

Type: boolean

Permission to read file contents or list directory contents.

WRITE Required

Write

Type: boolean

Permission to write file contents or create/delete files in directory.

EXECUTE Required

Execute

Type: boolean

Permission to execute files or traverse directories.

default Required

Default

Type: boolean

Whether this is a default ACE that applies to newly created child objects.

id

Id

Default: null

Numeric user or group ID when tag is USER or GROUP. null for object entries.

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to -1 and lesser or equal to 2147483647

Type: null

who

Who

Default: null

Username or group name when tag is USER or GROUP. null for object entries.

Any of

• Option 1
• Option 2
• Option 3

Type: string

Type: string

Must be at least 1 characters long

Type: null

comment

Comment

Type: string Default: ""

Optional descriptive comment about the template's purpose.

Return value

AclTemplateEntry

Type: object

The created ACL template configuration.

No Additional Properties

id Required

Id

Type: integer

Unique identifier for the ACL template.

builtin Required

Builtin

Type: boolean

Whether this is a built-in system template or user-created.

name Required

Name

Type: string

Human-readable name for the ACL template.

acltype Required

Acltype

Type: enum (of string)

ACL type this template provides.

Must be one of:

• "NFS4"
• "POSIX1E"

acl Required

Acl

Array of Access Control Entries defined by this template.

Any of

• Option 1
• Option 2

Type: array of object
No Additional Items

Each item of this array must be:

NFS4ACE

Type: object
No Additional Properties

tag Required

Tag

Type: enum (of string)

Subject type for this ACE.

• owner@: File/directory owner
• group@: File/directory primary group
• everyone@: All users
• USER: Specific user account
• GROUP: Specific group

Must be one of:

• "owner@"
• "group@"
• "everyone@"
• "USER"
• "GROUP"

type Required

Type

Type: enum (of string)

Access control type.

• ALLOW: Grant the specified permissions
• DENY: Explicitly deny the specified permissions

Must be one of:

• "ALLOW"
• "DENY"

perms Required

Perms

Permissions granted or denied by this ACE.

Any of

• NFS4ACE_AdvancedPerms
• NFS4ACE_BasicPerms

NFS4ACE_AdvancedPerms

Type: object
No Additional Properties

READ_DATA

Read Data

Type: boolean Default: false

Permission to read file data or list directory contents.

WRITE_DATA

Write Data

Type: boolean Default: false

Permission to write file data or create files in directory.

APPEND_DATA

Append Data

Type: boolean Default: false

Permission to append data to files or create subdirectories.

READ_NAMED_ATTRS

Read Named Attrs

Type: boolean Default: false

Permission to read named attributes (extended attributes).

WRITE_NAMED_ATTRS

Write Named Attrs

Type: boolean Default: false

Permission to write named attributes (extended attributes).

EXECUTE

Execute

Type: boolean Default: false

Permission to execute files or traverse directories.

DELETE

Delete

Type: boolean Default: false

Permission to delete the file or directory.

DELETE_CHILD

Delete Child

Type: boolean Default: false

Permission to delete child files within a directory.

READ_ATTRIBUTES

Read Attributes

Type: boolean Default: false

Permission to read basic file attributes (size, timestamps, etc.).

WRITE_ATTRIBUTES

Write Attributes

Type: boolean Default: false

Permission to write basic file attributes.

READ_ACL

Read Acl

Type: boolean Default: false

Permission to read the Access Control List.

WRITE_ACL

Write Acl

Type: boolean Default: false

Permission to modify the Access Control List.

WRITE_OWNER

Write Owner

Type: boolean Default: false

Permission to change the file owner.

SYNCHRONIZE

Synchronize

Type: boolean Default: false

Permission to use the file/directory as a synchronization primitive.

NFS4ACE_BasicPerms

Type: object
No Additional Properties

BASIC Required

Basic

Type: enum (of string)

Basic permission level for NFS4 ACE.

• FULL_CONTROL: Full read, write, execute, and administrative permissions
• MODIFY: Read, write, and execute permissions
• READ: Read-only permissions
• TRAVERSE: Execute/traverse permissions only

Must be one of:

• "FULL_CONTROL"
• "MODIFY"
• "READ"
• "TRAVERSE"

flags Required

Flags

Inheritance and other behavioral flags for this ACE.

Any of

• NFS4ACE_AdvancedFlags
• NFS4ACE_BasicFlags

NFS4ACE_AdvancedFlags

Type: object
No Additional Properties

FILE_INHERIT

File Inherit

Type: boolean Default: false

Apply this ACE to files within directories.

DIRECTORY_INHERIT

Directory Inherit

Type: boolean Default: false

Apply this ACE to subdirectories within directories.

NO_PROPAGATE_INHERIT

No Propagate Inherit

Type: boolean Default: false

Do not propagate inheritance beyond immediate children.

INHERIT_ONLY

Inherit Only

Type: boolean Default: false

This ACE only affects inheritance, not the object itself.

INHERITED

Inherited

Type: boolean Default: false

This ACE was inherited from a parent directory.

NFS4ACE_BasicFlags

Type: object
No Additional Properties

BASIC Required

Basic

Type: enum (of string)

Basic inheritance behavior for NFS4 ACE.

• INHERIT: Apply to child files and directories
• NOINHERIT: Do not apply to child objects

Must be one of:

• "INHERIT"
• "NOINHERIT"

id

Id

Default: null

UID or GID when tag is "USER" or "GROUP". null for special entries.

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to -1 and lesser or equal to 2147483647

Type: null

who

Who

Default: null

Username or group name when tag is "USER" or "GROUP". null for special entries.

Any of

• Option 1
• Option 2
• Option 3

Type: string

Type: string

Must be at least 1 characters long

Type: null

Type: array of object
No Additional Items

Each item of this array must be:

POSIXACE

Type: object
No Additional Properties

tag Required

Tag

Type: enum (of string)

Subject type for this POSIX ACE.

• USER_OBJ: File/directory owner
• GROUP_OBJ: File/directory primary group
• OTHER: All other users
• MASK: Maximum permissions for named users and groups
• USER: Specific user account
• GROUP: Specific group

Must be one of:

• "USER_OBJ"
• "GROUP_OBJ"
• "OTHER"
• "MASK"
• "USER"
• "GROUP"

perms Required

POSIXACE_Perms

Type: object

Read, write, and execute permissions for this ACE.

No Additional Properties

READ Required

Read

Type: boolean

Permission to read file contents or list directory contents.

WRITE Required

Write

Type: boolean

Permission to write file contents or create/delete files in directory.

EXECUTE Required

Execute

Type: boolean

Permission to execute files or traverse directories.

default Required

Default

Type: boolean

Whether this is a default ACE that applies to newly created child objects.

id

Id

Default: null

Numeric user or group ID when tag is USER or GROUP. null for object entries.

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to -1 and lesser or equal to 2147483647

Type: null

who

Who

Default: null

Username or group name when tag is USER or GROUP. null for object entries.

Any of

• Option 1
• Option 2
• Option 3

Type: string

Type: string

Must be at least 1 characters long

Type: null

comment

Comment

Type: string Default: ""

Optional descriptive comment about the template's purpose.

Required roles: FILESYSTEM_ATTRS_WRITE