filesystem.listdir

Get the contents of a directory.

The select option may be used to optimize listdir performance. Metadata-related fields that are not selected will not be retrieved from the filesystem.

For example {“select”: [“path”, “type”]} will avoid querying an xattr list and ZFS attributes for files in a directory.

NOTE: an empty list for select (default) is treated as requesting all information.

Each entry of the list consists of: name(str): name of the file path(str): absolute path of the entry realpath(str): absolute real path of the entry (if SYMLINK) type(str): DIRECTORY | FILE | SYMLINK | OTHER size(int): size of the entry allocation_size(int): on-disk size of entry mode(int): file mode/permission uid(int): user id of entry owner gid(int): group id of entry owner acl(bool): extended ACL is present on file is_mountpoint(bool): path is a mountpoint is_ctldir(bool): path is within special .zfs directory attributes(list): list of statx file attributes that apply to the file. See statx(2) manpage for more details. xattrs(list): list of extended attribute names. zfs_attrs(list): list of ZFS file attributes on file

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: path

path

Type: string

Must be at least 1 characters long

Parameter 2: query_filters

query_filters

Type: array Default: []
No Additional Items

Each item of this array must be:

Type: object

Parameter 3: query_options

query_options

Type: object

Default:

{ "relationships": true, "extend": null, "extend_context": null, "prefix": null, "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

No Additional Properties

relationships

Relationships

Type: boolean Default: true

extend

Extend

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extend_context

Extend Context

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

prefix

Prefix

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extra

Extra

Type: object Default: {}

order_by

Order By

Type: array of string Default: []
No Additional Items

Each item of this array must be:

Type: string

select

Select

Type: array Default: []
No Additional Items

Each item of this array must be:

Any of

• Option 1
• Option 2

Type: string

Type: array
No Additional Items

Each item of this array must be:

Type: object

count

Count

Type: boolean Default: false

get

Get

Type: boolean Default: false

offset

Offset

Type: integer Default: 0

limit

Limit

Type: integer Default: 0

force_sql_filters

Force Sql Filters

Type: boolean Default: false

Return value

Result

Any of

• Option 1
• FilesystemDirQueryResultItem
• Option 3

Type: array of object
No Additional Items

Each item of this array must be:

FilesystemDirQueryResultItem

Type: object
No Additional Properties

name

Name

Type: string

Entry's base name.

Must be at least 1 characters long

path

Path

Type: string

Entry's full path.

Must be at least 1 characters long

realpath

Realpath

Type: string

Canonical path of the entry, eliminating any symbolic links

Must be at least 1 characters long

type

Type

Type: enum (of string)

Must be one of:

• "DIRECTORY"
• "FILE"
• "SYMLINK"
• "OTHER"

size

Size

Type: integer

Size in bytes of a plain file. This corresonds with stx_size.

allocation_size

Allocation Size

Type: integer

Allocated size of file. Calculated by multiplying stx_blocks by 512.

mode

Mode

Type: integer

Entry's mode including file type information and file permission bits. This corresponds with stx_mode.

mount_id

Mount Id

Type: integer

The mount ID of the mount containing the entry. This corresponds to the number in first
field of /proc/self/mountinfo and stxmntid.

acl

Acl

Type: boolean

Specifies whether ACL is present on the entry. If this is the case then file permission
bits as reported in mode may not be representative of the actual permissions.

uid

Uid

Type: integer

User ID of the entry's owner. This corresponds with stx_uid.

gid

Gid

Type: integer

Group ID of the entry's owner. This corresponds with stx_gid.

is_mountpoint

Is Mountpoint

Type: boolean

Specifies whether the entry is also the mountpoint of a filesystem.

is_ctldir

Is Ctldir

Type: boolean

Specifies whether the entry is located within the ZFS ctldir (for example a snapshot).

attributes

Attributes

Type: array of enum (of string)

Extra file attribute indicators for entry as returned by statx. Expanded from stx_attributes.

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

• "COMPRESSED"
• "APPEND"
• "NODUMP"
• "IMMUTABLE"
• "AUTOMOUNT"
• "MOUNT_ROOT"
• "VERIFY"
• "DAX"

xattrs

Xattrs

Type: array of string

List of xattr names of extended attributes on file.

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

zfs_attrs

Zfs Attrs

List of extra ZFS-related file attribute indicators on file. Will be None type if filesystem is not ZFS.

Any of

• Option 1
• Option 2

Type: array of enum (of string)
No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

• "READONLY"
• "HIDDEN"
• "SYSTEM"
• "ARCHIVE"
• "IMMUTABLE"
• "NOUNLINK"
• "APPENDONLY"
• "NODUMP"
• "OPAQUE"
• "AV_QUARANTINED"
• "AV_MODIFIED"
• "REPARSE"
• "OFFLINE"
• "SPARSE"

Type: null

FilesystemDirQueryResultItem

Type: object
No Additional Properties

name

Name

Type: string

Entry's base name.

Must be at least 1 characters long

path

Path

Type: string

Entry's full path.

Must be at least 1 characters long

realpath

Realpath

Type: string

Canonical path of the entry, eliminating any symbolic links

Must be at least 1 characters long

type

Type

Type: enum (of string)

Must be one of:

• "DIRECTORY"
• "FILE"
• "SYMLINK"
• "OTHER"

size

Size

Type: integer

Size in bytes of a plain file. This corresonds with stx_size.

allocation_size

Allocation Size

Type: integer

Allocated size of file. Calculated by multiplying stx_blocks by 512.

mode

Mode

Type: integer

Entry's mode including file type information and file permission bits. This corresponds with stx_mode.

mount_id

Mount Id

Type: integer

The mount ID of the mount containing the entry. This corresponds to the number in first
field of /proc/self/mountinfo and stxmntid.

acl

Acl

Type: boolean

Specifies whether ACL is present on the entry. If this is the case then file permission
bits as reported in mode may not be representative of the actual permissions.

uid

Uid

Type: integer

User ID of the entry's owner. This corresponds with stx_uid.

gid

Gid

Type: integer

Group ID of the entry's owner. This corresponds with stx_gid.

is_mountpoint

Is Mountpoint

Type: boolean

Specifies whether the entry is also the mountpoint of a filesystem.

is_ctldir

Is Ctldir

Type: boolean

Specifies whether the entry is located within the ZFS ctldir (for example a snapshot).

attributes

Attributes

Type: array of enum (of string)

Extra file attribute indicators for entry as returned by statx. Expanded from stx_attributes.

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

• "COMPRESSED"
• "APPEND"
• "NODUMP"
• "IMMUTABLE"
• "AUTOMOUNT"
• "MOUNT_ROOT"
• "VERIFY"
• "DAX"

xattrs

Xattrs

Type: array of string

List of xattr names of extended attributes on file.

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

zfs_attrs

Zfs Attrs

List of extra ZFS-related file attribute indicators on file. Will be None type if filesystem is not ZFS.

Any of

• Option 1
• Option 2

Type: array of enum (of string)
No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

• "READONLY"
• "HIDDEN"
• "SYSTEM"
• "ARCHIVE"
• "IMMUTABLE"
• "NOUNLINK"
• "APPENDONLY"
• "NODUMP"
• "OPAQUE"
• "AV_QUARANTINED"
• "AV_MODIFIED"
• "REPARSE"
• "OFFLINE"
• "SPARSE"

Type: null

Type: integer

Required roles: FILESYSTEM_ATTRS_READ