sharing.smb.setacl

Set an ACL on share_name. This only impacts access through the SMB protocol.

share_name the name of the share

share_acl a list of ACL entries (dictionaries) with the following keys:

ae_who_sid who the ACL entry applies to expressed as a Windows SID

ae_who_id Unix ID information for user or group to which the ACL entry applies.

ae_perm string representation of the permissions granted to the user or group. FULL - grants read, write, execute, delete, write acl, and change owner. CHANGE - grants read, write, execute, and delete. READ - grants read and execute.

ae_type can be ALLOWED or DENIED.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: smb_setacl

smb_setacl

Type: object
No Additional Properties

share_name Required

Share Name

Type: string

Name of the SMB share.

Must be at least 1 characters long

share_acl

Share Acl

Type: array of object

Default:

[ { "ae_perm": "FULL", "ae_type": "ALLOWED", "ae_who_sid": "S-1-1-0", "ae_who_id": null, "ae_who_str": null } ]

List of SMB share ACL entries

No Additional Items

Each item of this array must be:

SMBShareAclEntry

Type: object
No Additional Properties

ae_perm Required

Ae Perm

Type: enum (of string)

Permissions granted to the principal.

Must be one of:

• "FULL"
• "CHANGE"
• "READ"

ae_type Required

Ae Type

Type: enum (of string)

The type of SMB share ACL entry.

Must be one of:

• "ALLOWED"
• "DENIED"

ae_who_sid

Ae Who Sid

Default: null

SID value of the principal to whom ACL entry applies.

Any of

• Option 1
• Option 2

Type: string

Type: null

ae_who_id

Default: null

Unix ID of the principal to whom ACL entry applies.

Any of

• SMBShareAclEntryWhoId
• Option 2

SMBShareAclEntryWhoId

Type: object
No Additional Properties

id_type Required

Id Type

Type: enum (of string)

Must be one of:

• "USER"
• "GROUP"
• "BOTH"

id Required

Id

Type: integer

Type: null

ae_who_str

Ae Who Str

Default: null

User or group name of the principal to whom the ACL entry applies

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

Return value

SMBShareAcl

Type: object
No Additional Properties

share_name Required

Share Name

Type: string

Name of the SMB share.

Must be at least 1 characters long

share_acl

Share Acl

Type: array of object

Default:

[ { "ae_perm": "FULL", "ae_type": "ALLOWED", "ae_who_sid": "S-1-1-0", "ae_who_id": null, "ae_who_str": null } ]

List of SMB share ACL entries

No Additional Items

Each item of this array must be:

SMBShareAclEntry

Type: object
No Additional Properties

ae_perm Required

Ae Perm

Type: enum (of string)

Permissions granted to the principal.

Must be one of:

• "FULL"
• "CHANGE"
• "READ"

ae_type Required

Ae Type

Type: enum (of string)

The type of SMB share ACL entry.

Must be one of:

• "ALLOWED"
• "DENIED"

ae_who_sid

Ae Who Sid

Default: null

SID value of the principal to whom ACL entry applies.

Any of

• Option 1
• Option 2

Type: string

Type: null

ae_who_id

Default: null

Unix ID of the principal to whom ACL entry applies.

Any of

• SMBShareAclEntryWhoId
• Option 2

SMBShareAclEntryWhoId

Type: object
No Additional Properties

id_type Required

Id Type

Type: enum (of string)

Must be one of:

• "USER"
• "GROUP"
• "BOTH"

id Required

Id

Type: integer

Type: null

ae_who_str

Ae Who Str

Default: null

User or group name of the principal to whom the ACL entry applies

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

Required roles: SHARING_SMB_WRITE