zfs.resource.userspace.list

List the space and object usage and limits ZFS accounts per user or group on filesystems.

A row is returned for every id ZFS has accounting for, including ids that only use space and have no limit. A usage or limit of 0 means none. Ids are not resolved to names.

Limits on the filesystem itself are the quota and refquota properties, read with zfs.resource.list and changed with zfs.resource.set. The limits given to ids that have none of their own are the defaultuserquota family of properties, also read with zfs.resource.list.

A path that does not exist is skipped, but the whole call fails with a validation error when:

  • a snapshot path is supplied (EINVAL)

  • a path is a volume (EINVAL)

  • a path is locked (EACCES). Unlike zfs.resource.processes, which reports nothing for a locked resource, the accounting exists here but cannot be read.

  • ZFS does not support a requested type on a filesystem (EINVAL)

Examples:

List the user and group rows of a filesystem:

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "zfs.resource.userspace.list",
    "params": [{"paths": ["tank/home"]}]
}
Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object

Which filesystems and kinds of accounting to read.

No Additional Properties

Paths

Type: array of string

Filesystem paths to read. A path that does not exist is skipped. An internal path is read when it is named here.

Must contain a minimum of 1 items

All items must be unique

No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Types

Type: array of enum (of string) Default: ["user", "group"]

Kinds of userspace accounting to read. Defaults to both users and groups.

Must contain a minimum of 1 items

All items must be unique

No Additional Items
Each item of this array must be:
Type: enum (of string)
Must be one of:
  • "user"
  • "group"

Result

Type: array of object
No Additional Items
Each item of this array must be:

ZFSResourceUserspaceEntry

Type: object
No Additional Properties

Dataset

Type: string

Path of the filesystem the row belongs to.

Type

Type: enum (of string)

Whether xid is a user or group id.

Must be one of:
  • "user"
  • "group"

Xid

Type: integer

The numeric user or group id. Names are not resolved.

Used

Type: integer

Bytes charged to xid. 0 means none.

Quota

Type: integer

Space limit of xid in bytes. 0 means no limit.

Objused

Type: integer

Number of objects charged to xid. 0 means none.

Objquota

Type: integer

Object count limit of xid. 0 means no limit.



Required roles: ZFS_RESOURCE_READ