List of filters for query results. See API documentation for "Query Methods" for more guidance.
No Additional Items[
[
"name",
"=",
"bob"
]
]
[
[
"OR",
[
[
[
"name",
"=",
"bob"
]
],
[
[
"name",
"=",
"larry"
]
]
]
]
]
Query options including pagination, ordering, and additional parameters.
No Additional PropertiesExtra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.
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).
[
"size",
"-devname",
"nulls_first:-expiretime"
]
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.
[
"username",
"Authentication.status"
]
Return a numeric value representing the number of items that match the specified query-filters.
Return the JSON object of the first result matching the specified query-filters. The query fails if there specified query-filters return no results.
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.
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 use of SQL for result filtering to reduce response time. May not work for all methods.
Unique identifier for this replication task.
Name for replication task.
Must be at least 1 characters long
Whether task will PUSH or PULL snapshots.
Method of snapshots transfer.
SSH transfers snapshots via SSH connection. This method is supported everywhere but does not achieve great performance.SSH+NETCAT uses unencrypted connection for data transfer. This can only be used in trusted networks and requires a port (specified by range from netcat_active_side_port_min to netcat_active_side_port_max) to be open on netcat_active_side.LOCAL replicates to or from localhost.Keychain Credential of type SSH_CREDENTIALS.
Unique identifier for this keychain credential.
Distinguishes this Keychain Credential from others.
Must be at least 1 characters long
Type of credential stored in the keychain.
SSH_KEY_PAIR: SSH public/private key pairSSH_CREDENTIALS: SSH connection credentials including host and authenticationCredential-specific configuration and authentication data.
At least one of the two keys must be provided on creation.
No Additional PropertiesSSH private key in OpenSSH format. null if only public key is provided.
Can be omitted and automatically derived from the private key.
SSH server hostname or IP address.
SSH server port number.
SSH username for authentication.
Keychain Credential ID.
Can be discovered with keychaincredential.remotesshhostkeyscan.
Connection timeout in seconds for SSH connections.
Which side actively establishes the netcat connection for SSH+NETCAT transport.
LOCAL: Local system initiates the connectionREMOTE: Remote system initiates the connectionnull: Not applicable for other transport typesIP address for the active side to listen on for SSH+NETCAT transport. null if not applicable.
Minimum port number in the range for netcat connections. null if not applicable.
Value must be greater or equal to 1 and lesser or equal to 65535
Maximum port number in the range for netcat connections. null if not applicable.
Value must be greater or equal to 1 and lesser or equal to 65535
IP address for the passive side to connect to for SSH+NETCAT transport. null if not applicable.
SSH and SSH+NETCAT transports should use sudo (which is expected to be passwordless) to run zfs command on the remote machine.
List of datasets to replicate snapshots from.
Must contain a minimum of 1 items
Dataset to put snapshots into.
Whether to recursively replicate child datasets.
Array of dataset patterns to exclude from replication.
No Additional ItemsSend dataset properties along with snapshots.
Array of dataset property names to exclude from replication.
No Additional ItemsMust be at least 1 characters long
Object mapping dataset property names to override values during replication.
Each additional property must conform to the following schema
Type: stringWhether to use full ZFS replication.
Whether to enable encryption for the replicated datasets.
Whether replicated datasets should inherit encryption from parent. null if encryption is disabled.
Encryption key for replicated datasets. null if not specified.
Format of the encryption key.
HEX: Hexadecimal-encoded keyPASSPHRASE: Text passphrasenull: Not applicable when encryption is disabledFilesystem path where encryption key is stored. null if not using key file.
List of periodic snapshot tasks that are sources of snapshots for this replication task. Only push replication tasks can be bound to periodic snapshot tasks.
No Additional ItemsThe dataset to take snapshots of.
Whether to recursively snapshot child datasets.
Number of time units to retain snapshots. lifetime_unit gives the time unit.
Unit of time for snapshot retention.
Whether this periodic snapshot task is enabled.
Array of dataset patterns to exclude from recursive snapshots.
No Additional ItemsNaming pattern for generated snapshots using strftime format.
Whether to take snapshots even if no data has changed.
Cron schedule for when snapshots should be taken.
No Additional PropertiesMinute when snapshots should be taken (cron format).
"00" - "23"
"1" - "31"
"1" (January) - "12" (December)
"1" (Monday) - "7" (Sunday)
Start time of the window when snapshots can be taken.
"00:00"
"06:30"
"18:00"
"23:00"
End time of the window when snapshots can be taken.
"00:00"
"06:30"
"18:00"
"23:00"
Unique identifier for the periodic snapshot task.
Current state of the task.
List of naming schemas for pull replication.
No Additional ItemsList of naming schemas for push replication.
No Additional ItemsReplicate all snapshots which names match specified regular expression.
Must be at least 1 characters long
Allow replication to run automatically on schedule or after bound periodic snapshot task.
Schedule to run replication task. Only auto replication tasks without bound periodic snapshot tasks can have a schedule.
"00" - "59"
"00" - "23"
"1" - "31"
"1" (January) - "12" (December)
"1" (Monday) - "7" (Sunday)
Start time for the time window in HH:MM format.
"00:00"
"06:30"
"18:00"
"23:00"
End time for the time window in HH:MM format.
"00:00"
"06:30"
"18:00"
"23:00"
Restricts when replication task with bound periodic snapshot tasks runs. For example, you can have periodic snapshot tasks that run every 15 minutes, but only run replication task every hour.
"00" - "59"
"00" - "23"
"1" - "31"
"1" (January) - "12" (December)
"1" (Monday) - "7" (Sunday)
Start time for the time window in HH:MM format.
"00:00"
"06:30"
"18:00"
"23:00"
End time for the time window in HH:MM format.
"00:00"
"06:30"
"18:00"
"23:00"
Will only replicate snapshots that match schedule or restrict_schedule.
Will destroy all snapshots on target side and replicate everything from scratch if none of the snapshots on target side matches source snapshots.
Controls destination datasets readonly property.
SET: Set all destination datasets to readonly=on after finishing the replication.REQUIRE: Require all existing destination datasets to have readonly=on property.IGNORE: Avoid this kind of behavior.Prevent source snapshots from being deleted by retention of replication fails for some reason.
How to delete old snapshots on target side:
SOURCE: Delete snapshots that are absent on source side.CUSTOM: Delete snapshots that are older than lifetime_value and lifetime_unit.NONE: Do not delete any snapshots.Number of time units to retain snapshots for custom retention policy. Only applies when retention_policy is CUSTOM.
Value must be greater or equal to 1
Time unit for snapshot retention for custom retention policy. Only applies when retention_policy is CUSTOM.
Array of different retention schedules with their own cron schedules and lifetime settings.
No Additional ItemsCron schedule for when snapshot retention policies are applied.
No Additional Properties"00" - "59"
"00" - "23"
"1" - "31"
"1" (January) - "12" (December)
"1" (Monday) - "7" (Sunday)
Number of time units to retain snapshots.
Value must be greater or equal to 1
Time unit for snapshot retention.
Compresses SSH stream. Available only for SSH transport.
Limits speed of SSH stream. Available only for SSH transport.
Value must be greater or equal to 1
Enable large block support for ZFS send streams.
Enable embedded block support for ZFS send streams.
Enable compressed ZFS send streams.
Number of retries before considering replication failed.
Value must be greater or equal to 1
Log level for replication task execution. Controls verbosity of replication logs.
Whether this replication task is enabled.
Current state information for the replication task.
Information about the currently running job. null if no job is running.
Whether this replication task has encrypted dataset keys available.
Unique identifier for this replication task.
Name for replication task.
Must be at least 1 characters long
Whether task will PUSH or PULL snapshots.
Method of snapshots transfer.
SSH transfers snapshots via SSH connection. This method is supported everywhere but does not achieve great performance.SSH+NETCAT uses unencrypted connection for data transfer. This can only be used in trusted networks and requires a port (specified by range from netcat_active_side_port_min to netcat_active_side_port_max) to be open on netcat_active_side.LOCAL replicates to or from localhost.Keychain Credential of type SSH_CREDENTIALS.
Which side actively establishes the netcat connection for SSH+NETCAT transport.
LOCAL: Local system initiates the connectionREMOTE: Remote system initiates the connectionnull: Not applicable for other transport typesIP address for the active side to listen on for SSH+NETCAT transport. null if not applicable.
Minimum port number in the range for netcat connections. null if not applicable.
Value must be greater or equal to 1 and lesser or equal to 65535
Maximum port number in the range for netcat connections. null if not applicable.
Value must be greater or equal to 1 and lesser or equal to 65535
IP address for the passive side to connect to for SSH+NETCAT transport. null if not applicable.
SSH and SSH+NETCAT transports should use sudo (which is expected to be passwordless) to run zfs command on the remote machine.
List of datasets to replicate snapshots from.
Must contain a minimum of 1 items
Dataset to put snapshots into.
Whether to recursively replicate child datasets.
Array of dataset patterns to exclude from replication.
No Additional ItemsSend dataset properties along with snapshots.
Array of dataset property names to exclude from replication.
No Additional ItemsMust be at least 1 characters long
Object mapping dataset property names to override values during replication.
Each additional property must conform to the following schema
Type: stringWhether to use full ZFS replication.
Whether to enable encryption for the replicated datasets.
Whether replicated datasets should inherit encryption from parent. null if encryption is disabled.
Encryption key for replicated datasets. null if not specified.
Format of the encryption key.
HEX: Hexadecimal-encoded keyPASSPHRASE: Text passphrasenull: Not applicable when encryption is disabledFilesystem path where encryption key is stored. null if not using key file.
List of periodic snapshot tasks that are sources of snapshots for this replication task. Only push replication tasks can be bound to periodic snapshot tasks.
No Additional ItemsList of naming schemas for pull replication.
No Additional ItemsList of naming schemas for push replication.
No Additional ItemsReplicate all snapshots which names match specified regular expression.
Must be at least 1 characters long
Allow replication to run automatically on schedule or after bound periodic snapshot task.
Schedule to run replication task. Only auto replication tasks without bound periodic snapshot tasks can have a schedule.
Restricts when replication task with bound periodic snapshot tasks runs. For example, you can have periodic snapshot tasks that run every 15 minutes, but only run replication task every hour.
Will only replicate snapshots that match schedule or restrict_schedule.
Will destroy all snapshots on target side and replicate everything from scratch if none of the snapshots on target side matches source snapshots.
Controls destination datasets readonly property.
SET: Set all destination datasets to readonly=on after finishing the replication.REQUIRE: Require all existing destination datasets to have readonly=on property.IGNORE: Avoid this kind of behavior.Prevent source snapshots from being deleted by retention of replication fails for some reason.
How to delete old snapshots on target side:
SOURCE: Delete snapshots that are absent on source side.CUSTOM: Delete snapshots that are older than lifetime_value and lifetime_unit.NONE: Do not delete any snapshots.Number of time units to retain snapshots for custom retention policy. Only applies when retention_policy is CUSTOM.
Value must be greater or equal to 1
Time unit for snapshot retention for custom retention policy. Only applies when retention_policy is CUSTOM.
Array of different retention schedules with their own cron schedules and lifetime settings.
No Additional ItemsCompresses SSH stream. Available only for SSH transport.
Limits speed of SSH stream. Available only for SSH transport.
Value must be greater or equal to 1
Enable large block support for ZFS send streams.
Enable embedded block support for ZFS send streams.
Enable compressed ZFS send streams.
Number of retries before considering replication failed.
Value must be greater or equal to 1
Log level for replication task execution. Controls verbosity of replication logs.
Whether this replication task is enabled.
Current state information for the replication task.
Information about the currently running job. null if no job is running.
Whether this replication task has encrypted dataset keys available.