pool.dataset.get_quota

Return a list of the specified quota_type of quotas on the ZFS dataset ds. Support query-filters and query-options.

Note: SMB client requests to set a quota granting no space will result in an on-disk quota of 1 KiB.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: dataset

dataset

Type: string
Parameter 2: quota_type

quota_type

Type: enum (of string)
Must be one of:
  • "USER"
  • "GROUP"
  • "DATASET"
  • "PROJECT"
Parameter 3: filters

filters

Type: array Default: []

List of filters for query results. See API documentation for "Query Methods" for more guidance.

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

Examples:

[
    [
        "name",
        "=",
        "bob"
    ]
]

[
    [
        "OR",
        [
            [
                [
                    "name",
                    "=",
                    "bob"
                ]
            ],
            [
                [
                    "name",
                    "=",
                    "larry"
                ]
            ]
        ]
    ]
]
Parameter 4: options

options

Type: object

Query options customize the results returned by a query method. More complete documentation with examples
are covered in the "Query methods" section of the TrueNAS API documentation.

No Additional Properties

Relationships

Type: boolean Default: true

Extend

Default: null

Type: string
Type: null

Extend Fk

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

Extend Context

Default: null

Type: string
Type: null

Prefix

Default: null

Type: string
Type: null

Extra

Type: object Default: {}

Extra options are defined on a per-endpoint basis and are described in the documentation for the associated
query method.

Order By

Type: array of string Default: []

An array of field names describing the manner in which query results should be ordered. The field names may
also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place
any null values at the head of the results list), nulls_last: (place any null values at the tail of the
results list).

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

Example:

[
    "size",
    "-devname",
    "nulls_first:-expiretime"
]

Select

Type: array Default: []

An array of field names specifying the exact fields to include in the query return. The dot character .
may be used to explicitly select only subkeys of the query result.

No Additional Items
Each item of this array must be:

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

Example:

[
    "username",
    "Authentication.status"
]

Count

Type: boolean Default: false

Return a numeric value representing the number of items that match the specified query-filters.

Get

Type: boolean Default: false

Return the JSON object of the first result matching the specified query-filters. The query fails
if there specified query-filters return no results.

Offset

Type: integer Default: 0

This specifies the beginning offset of the results array. When combined with the limit query-option
it may be used to implement pagination of large results arrays. WARNING: some query methods provide
volatile results and the onus is on the developer to understand whether pagination is appropriate
for a particular query API method.

Limit

Type: integer Default: 0

This specifies the maximum number of results matching the specified query-filters to return. When
combined wtih the offset query-option it may be used to implement pagination of large results arrays.
WARNING: some query methods provide volatile results and the onus is on the developer to understand whether
pagination is appropriate for a particular query API method.

Force Sql Filters

Type: boolean Default: false

Result

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

PoolDatasetUserGroupQuota

Type: object
No Additional Properties

Used Bytes

Type: integer

The number of bytes the user has written to the dataset. A value of zero means unlimited. May not instantly
update as space is used.

Quota

Type: integer

The quota size in bytes. Absent if no quota is set.

Quota Type

Type: enum (of string)
Must be one of:
  • "USER"
  • "GROUP"

Id

Type: integer

The UID or GID to which the quota applies.

Name


The user or group name to which the quota applies. Value is null if the id in the quota cannot be resolved to a
user or group. This indicates that the user or group does not exist on the server.

Type: string
Type: null

Obj Used

Type: integer

The number of objects currently owned by id.

Obj Quota

Type: integer

The number of objects that may be owned by id. A value of zero means unlimited. Absent if no objquota is
set.

PoolDatasetDatasetQuota

Type: object
No Additional Properties

Used Bytes

Type: integer

The number of bytes the user has written to the dataset. A value of zero means unlimited. May not instantly
update as space is used.

Quota

Type: integer

The quota size in bytes. Absent if no quota is set.

Quota Type

Type: const
Must be one of:
  • "DATASET"
Specific value: "DATASET"

Id

Type: string

Name of the dataset.

Name

Type: string

Name of the dataset.

Refquota

Type: integer

PoolDatasetProjectQuota

Type: object
No Additional Properties

Used Bytes

Type: integer

The number of bytes the user has written to the dataset. A value of zero means unlimited. May not instantly
update as space is used.

Quota

Type: integer

The quota size in bytes. Absent if no quota is set.

Quota Type

Type: const
Must be one of:
  • "PROJECT"
Specific value: "PROJECT"

Id

Type: integer

Obj Used

Type: integer

The number of objects currently owned by id.

Obj Quota

Type: integer

The number of objects that may be owned by id. A value of zero means unlimited. Absent if no objquota is
set.


Required roles: DATASET_READ