zfs.tier.rewrite_job_failures ============================= List files that failed to be rewritten during a rewrite job. .. raw:: html
Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: zfs_tier_rewrite_job_failures

zfs_tier_rewrite_job_failures

Type: object

ZfsTierRewriteJobFailuresArgs parameters.

 No Additional Properties

Tier Job Id

Type: string

Rewrite job to query, in dataset_name@job_uuid format.

Must be at least 1 characters long

Query-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"
                ]
            ]
        ]
    ]

QueryOptions

Type: object
Default:
{ "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

Options controlling sort order, pagination, and result format.

 No Additional Properties

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

Force use of SQL for result filtering to reduce response time. May not work for all methods.

Result


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

ZfsTierRewriteJobFailureQueryResultItem

Type: object
No Additional Properties

Filename

Type: string

Name of the file that failed to migrate storage tier.

ZfsTierRewriteJobFailureError

Type: object

Error details for the failed storage tier migration.

 No Additional Properties

Errno

Type: integer

Error number from the failed storage tier migration.

Strerror

Type: string

Human-readable description of the error.

Path


Absolute path of the file resolved via its file handle, or null if the file no longer exists on the filesystem.

Type: string
Type: null

ZfsTierRewriteJobFailureQueryResultItem

Type: object
No Additional Properties

Filename

Type: string

Name of the file that failed to migrate storage tier.

Type: object

Error details for the failed storage tier migration.

Path


Absolute path of the file resolved via its file handle, or null if the file no longer exists on the filesystem.

Type: string
Type: null
Type: integer


*Required roles:* DATASET_READ