filesystem.setperm

Set Unix permissions on the given path.

If mode is specified then the mode is applied to the path, and to files and subdirectories depending on which options are selected.

This method will fail if an extended ACL is present on path unless stripacl is set. If no mode is set and stripacl is true, then non-trivial ACLs are converted to trivial ACLs. An ACL is trivial if it can be expressed as a file mode without losing any access rules.

Important

uid, gid, user, and group should remain unset unless the administrator wishes to change the owner or group of files.

This method is a job.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: filesystem_setperm

filesystem_setperm

Type: object

FilesystemSetpermArgs parameters.

No Additional Properties

path Required

Path

Type: string

Filesystem path to modify.

Must be at least 1 characters long

uid

Uid

Default: null

Numeric user ID to set as owner. null to leave unchanged.

Any of

• Option 1
• Option 2

Type: integer

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

Type: null

user

User

Default: null

Username to set as owner. null to leave unchanged.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

gid

Gid

Default: null

Numeric group ID to set as group owner. null to leave unchanged.

Any of

• Option 1
• Option 2

Type: integer

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

Type: null

group

Group

Default: null

Group name to set as group owner. null to leave unchanged.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

mode

Mode

Default: null

Unix permissions to set (octal format). null to leave unchanged.

Any of

• Option 1
• Option 2

Type: string

Type: null

options

FilesystemSetpermOptions

Type: object

Default:

{ "recursive": false, "traverse": false, "stripacl": false }

Additional options for the permission change operation.

No Additional Properties

recursive

Recursive

Type: boolean Default: false

Whether to apply the operation recursively to subdirectories.

traverse

Traverse

Type: boolean Default: false

If set do not limit to single dataset / filesystem.

stripacl

Stripacl

Type: boolean Default: false

Whether to remove existing Access Control Lists when setting permissions.

Return value

Result

Type: null

Returns null when the permission change is successfully completed.

Required roles: FILESYSTEM_ATTRS_WRITE