sharing.smb.setacl ================== Set an ACL on ``share_name``. This only impacts access through the SMB protocol. .. raw:: html
Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: smb_setacl

smb_setacl

Type: object

SharingSMBSetaclArgs parameters.

 No Additional Properties

Share Name

Type: string

Name of the SMB share.

Must be at least 1 characters long

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

An SMB Share ACL Entry that grants or denies specific permissions to a principal.
You can identify the principal by a SID (ae_who_sid), or Unix ID (ae_who_id).

No Additional Properties

Ae Perm

Type: enum (of string)

Permissions granted or denied to the principal: FULL grants read, write, execute, delete, write ACL, and change owner; CHANGE grants read, write, execute, and delete; READ grants read and execute. NOTE: this may appear as CUSTOM on read if user has manually edited the share ACL through unsupported means. In this case users will be required to set it to a supported value on update.

Must be one of:
  • "FULL"
  • "CHANGE"
  • "READ"
  • "CUSTOM"

Ae Type

Type: enum (of string)

The type of SMB share ACL entry. This value determines whether the permissions (ae_perm) are granted (ALLOWED) or denied (DENIED).

Must be one of:
  • "ALLOWED"
  • "DENIED"

Ae Who Sid

Default: null

The SID of the principal to whom this ACL entry applies.

Type: string
Type: null

Default: null

The Unix ID of the principal to whom this ACL entry applies.

SMBShareAclEntryWhoId

Type: object
No Additional Properties

Id Type

Type: enum (of string)

The type of Unix ID. If the type is USER, the xid value refers to a Unix UID. If the type is GROUP, the xid value refers to a Unix GID.

Must be one of:
  • "USER"
  • "GROUP"

Id

Type: integer

Unix user ID (UID) or group ID (GID) depending on the id_type field.

Value must be greater or equal to 0 and lesser or equal to 2147483647

Type: null

Ae Who Str

Default: null

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

Type: string

Must be at least 1 characters long

Type: null

SMBShareAcl

Type: object

The updated SMB share ACL configuration.

 No Additional Properties

Share Name

Type: string

Name of the SMB share.

Must be at least 1 characters long

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

An SMB Share ACL Entry that grants or denies specific permissions to a principal.
You can identify the principal by a SID (ae_who_sid), or Unix ID (ae_who_id).

No Additional Properties

Ae Perm

Type: enum (of string)

Permissions granted or denied to the principal: FULL grants read, write, execute, delete, write ACL, and change owner; CHANGE grants read, write, execute, and delete; READ grants read and execute. NOTE: this may appear as CUSTOM on read if user has manually edited the share ACL through unsupported means. In this case users will be required to set it to a supported value on update.

Must be one of:
  • "FULL"
  • "CHANGE"
  • "READ"
  • "CUSTOM"

Ae Type

Type: enum (of string)

The type of SMB share ACL entry. This value determines whether the permissions (ae_perm) are granted (ALLOWED) or denied (DENIED).

Must be one of:
  • "ALLOWED"
  • "DENIED"

Ae Who Sid

Default: null

The SID of the principal to whom this ACL entry applies.

Type: string
Type: null

Default: null

The Unix ID of the principal to whom this ACL entry applies.

SMBShareAclEntryWhoId

Type: object
No Additional Properties

Id Type

Type: enum (of string)

The type of Unix ID. If the type is USER, the xid value refers to a Unix UID. If the type is GROUP, the xid value refers to a Unix GID.

Must be one of:
  • "USER"
  • "GROUP"

Id

Type: integer

Unix user ID (UID) or group ID (GID) depending on the id_type field.

Value must be greater or equal to 0 and lesser or equal to 2147483647

Type: null

Ae Who Str

Default: null

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

Type: string

Must be at least 1 characters long

Type: null


*Required roles:* SHARING_SMB_WRITE