replication.get_instance

Returns instance matching id. If id is not found, Validation error is raised.

Please see query method documentation for options.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

Parameter 2: options

options

Type: object Default: {}

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

Relationships

Type: boolean Default: true

extend

Extend

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extend_fk

Extend Fk

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

Each item of this array must be:

Type: string

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: {}

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

order_by

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

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:

Any of

• Option 1
• Option 2

Type: string

Type: array
No Additional Items

Each item of this array must be:

Type: object

Example:

[
    "username",
    "Authentication.status"
]

count

Count

Type: boolean Default: false

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

get

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

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

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

Force Sql Filters

Type: boolean Default: false

Return value

ReplicationEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

name Required

Name

Type: string

name for replication task

Must be at least 1 characters long

direction Required

Direction

Type: enum (of string)

whether task will PUSH or PULL snapshots

Must be one of:

• "PUSH"
• "PULL"

transport Required

Transport

Type: enum (of string)

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

Must be one of:

• "SSH"
• "SSH+NETCAT"
• "LOCAL"

ssh_credentials

Default: null

Keychain Credential of type SSH_CREDENTIALS

Any of

• KeychainCredentialEntry
• Option 2

KeychainCredentialEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

name Required

Name

Type: string

Distinguishes this Keychain Credential from others.

Must be at least 1 characters long

type Required

Type

Type: enum (of string)

Must be one of:

• "SSH_KEY_PAIR"
• "SSH_CREDENTIALS"

attributes Required

Attributes

Any of

• SSHKeyPair
• SSHCredentials

SSHKeyPair

Type: object

At least one of the two keys must be provided on creation.

No Additional Properties

private_key

Private Key

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

public_key

Public Key

Default: null

Can be omitted and automatically derived from the private key.

Any of

• Option 1
• Option 2

Type: string

Type: null

SSHCredentials

Type: object
No Additional Properties

host Required

Host

Type: string

port

Port

Type: integer Default: 22

username

Username

Type: string Default: "root"

private_key Required

Private Key

Type: integer

Keychain Credential ID.

remote_host_key Required

Remote Host Key

Type: string

Can be discovered with keychaincredential.remotesshhostkeyscan.

connect_timeout

Connect Timeout

Type: integer Default: 10

Type: null

netcat_active_side

Netcat Active Side

Default: null

Any of

• Option 1
• Option 2

Type: enum (of string)

Must be one of:

• "LOCAL"
• "REMOTE"

Type: null

netcat_active_side_listen_address

Netcat Active Side Listen Address

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

netcat_active_side_port_min

Netcat Active Side Port Min

Default: null

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

Type: null

netcat_active_side_port_max

Netcat Active Side Port Max

Default: null

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

Type: null

netcat_passive_side_connect_address

Netcat Passive Side Connect Address

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

sudo

Sudo

Type: boolean Default: false

whether SSH and SSH+NETCAT transports should use sudo (which is expected to be passwordless) to run zfs
command on the remote machine.

source_datasets Required

Source Datasets

Type: array of string

list of datasets to replicate snapshots from

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

target_dataset Required

Target Dataset

Type: string

dataset to put snapshots into

recursive Required

Recursive

Type: boolean

exclude

Exclude

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

Each item of this array must be:

Type: string

properties

Properties

Type: boolean Default: true

whether we should send dataset properties along with snapshots

properties_exclude

Properties Exclude

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

Each item of this array must be:

Type: string

Must be at least 1 characters long

properties_override

Properties Override

Type: object Default: {}

Additional Properties

Each additional property must conform to the following schema

Type: string

replicate

Replicate

Type: boolean Default: false

encryption

Encryption

Type: boolean Default: false

encryption_inherit

Encryption Inherit

Default: null

Any of

• Option 1
• Option 2

Type: boolean

Type: null

encryption_key

Encryption Key

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

encryption_key_format

Encryption Key Format

Default: null

Any of

• Option 1
• Option 2

Type: enum (of string)

Must be one of:

• "HEX"
• "PASSPHRASE"

Type: null

encryption_key_location

Encryption Key Location

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

periodic_snapshot_tasks Required

Periodic Snapshot Tasks

Type: array of object

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 Items

Each item of this array must be:

PoolSnapshotTaskDBEntry

Type: object
No Additional Properties

dataset Required

Dataset

Type: string

recursive

Recursive

Type: boolean Default: false

lifetime_value

Lifetime Value

Type: integer Default: 2

lifetime_unit

Lifetime Unit

Type: enum (of string) Default: "WEEK"

Must be one of:

• "HOUR"
• "DAY"
• "WEEK"
• "MONTH"
• "YEAR"

enabled

Enabled

Type: boolean Default: true

exclude

Exclude

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

Each item of this array must be:

Type: string

naming_schema

Naming Schema

Type: string Default: "auto-%Y-%m-%d_%H-%M"

allow_empty

Allow Empty

Type: boolean Default: true

schedule

PoolSnapshotTaskCron

Type: object
No Additional Properties

minute

Minute

Type: string Default: "00"

hour

Hour

Type: string Default: "*"

"00" - "23"

dom

Dom

Type: string Default: "*"

"1" - "31"

month

Month

Type: string Default: "*"

"1" (January) - "12" (December)

dow

Dow

Type: string Default: "*"

"1" (Monday) - "7" (Sunday)

begin

Begin

Type: string Default: "00:00"

end

End

Type: string Default: "23:59"

id Required

Id

Type: integer

state Required

State

Type: string

naming_schema

Naming Schema

Type: array of string Default: []

list of naming schemas for pull replication

No Additional Items

Each item of this array must be:

Type: string

also_include_naming_schema

Also Include Naming Schema

Type: array of string Default: []

list of naming schemas for push replication

No Additional Items

Each item of this array must be:

Type: string

name_regex

Name Regex

Default: null

replicate all snapshots which names match specified regular expression

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

auto Required

Auto

Type: boolean

allows replication to run automatically on schedule or after bound periodic snapshot task

schedule

Default: null

schedule to run replication task. Only auto replication tasks without bound periodic snapshot tasks can have a
schedule

Any of

• ReplicationTimeCronModel
• Option 2

ReplicationTimeCronModel

Type: object
No Additional Properties

minute

Minute

Type: string Default: "00"

hour

Hour

Type: string Default: "*"

"00" - "23"

dom

Dom

Type: string Default: "*"

"1" - "31"

month

Month

Type: string Default: "*"

"1" (January) - "12" (December)

dow

Dow

Type: string Default: "*"

"1" (Monday) - "7" (Sunday)

begin

Begin

Type: string Default: "00:00"

end

End

Type: string Default: "23:59"

Type: null

restrict_schedule

Default: null

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.

Any of

• ReplicationTimeCronModel
• Option 2

ReplicationTimeCronModel

Type: object
No Additional Properties

minute

Minute

Type: string Default: "00"

hour

Hour

Type: string Default: "*"

"00" - "23"

dom

Dom

Type: string Default: "*"

"1" - "31"

month

Month

Type: string Default: "*"

"1" (January) - "12" (December)

dow

Dow

Type: string Default: "*"

"1" (Monday) - "7" (Sunday)

begin

Begin

Type: string Default: "00:00"

end

End

Type: string Default: "23:59"

Type: null

only_matching_schedule

Only Matching Schedule

Type: boolean Default: false

will only replicate snapshots that match schedule or restrict_schedule

allow_from_scratch

Allow From Scratch

Type: boolean Default: false

will destroy all snapshots on target side and replicate everything from scratch if none of the snapshots on
target side matches source snapshots

readonly

Readonly

Type: enum (of string) Default: "SET"

controls destination datasets readonly property:
* SET will set all destination datasets to readonly=on after finishing the replication
* REQUIRE will require all existing destination datasets to have readonly=on property
* IGNORE will avoid this kind of behavior

Must be one of:

• "SET"
• "REQUIRE"
• "IGNORE"

hold_pending_snapshots

Hold Pending Snapshots

Type: boolean Default: false

will prevent source snapshots from being deleted by retention of replication fails for some reason

retention_policy Required

Retention Policy

Type: enum (of string)

specifies how to delete old snapshots on target side:
* SOURCE deletes snapshots that are absent on source side
* CUSTOM deletes snapshots that are older than lifetime_value and lifetime_unit
* NONE does not delete any snapshots

Must be one of:

• "SOURCE"
• "CUSTOM"
• "NONE"

lifetime_value

Lifetime Value

Default: null

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to 1

Type: null

lifetime_unit

Lifetime Unit

Default: null

Any of

• Option 1
• Option 2

Type: enum (of string)

Must be one of:

• "HOUR"
• "DAY"
• "WEEK"
• "MONTH"
• "YEAR"

Type: null

lifetimes

Lifetimes

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

Each item of this array must be:

ReplicationLifetimeModel

Type: object
No Additional Properties

schedule Required

CronModel

Type: object

Each field can either be a single value or a comma-separated list of values.
A "*" represents the full list of values.

No Additional Properties

minute

Minute

Type: string Default: "*"

"00" - "59"

hour

Hour

Type: string Default: "*"

"00" - "23"

dom

Dom

Type: string Default: "*"

"1" - "31"

month

Month

Type: string Default: "*"

"1" (January) - "12" (December)

dow

Dow

Type: string Default: "*"

"1" (Monday) - "7" (Sunday)

lifetime_value Required

Lifetime Value

Type: integer

Value must be greater or equal to 1

lifetime_unit Required

Lifetime Unit

Type: enum (of string)

Must be one of:

• "HOUR"
• "DAY"
• "WEEK"
• "MONTH"
• "YEAR"

compression

Compression

Default: null

compresses SSH stream. Available only for SSH transport

Any of

• Option 1
• Option 2

Type: enum (of string)

Must be one of:

• "LZ4"
• "PIGZ"
• "PLZIP"

Type: null

speed_limit

Speed Limit

Default: null

limits speed of SSH stream. Available only for SSH transport

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to 1

Type: null

large_block

Large Block

Type: boolean Default: true

embed

Embed

Type: boolean Default: false

compressed

Compressed

Type: boolean Default: true

retries

Retries

Type: integer Default: 5

number of retries before considering replication failed

Value must be greater or equal to 1

logging_level

Logging Level

Default: null

Any of

• Option 1
• Option 2

Type: enum (of string)

Must be one of:

• "DEBUG"
• "INFO"
• "WARNING"
• "ERROR"

Type: null

enabled

Enabled

Type: boolean Default: true

state Required

State

Type: object

job Required

Job

Any of

• Option 1
• Option 2

Type: object

Type: null

has_encrypted_dataset_keys Required

Has Encrypted Dataset Keys

Type: boolean

Required roles: REPLICATION_TASK_READ