rsynctask.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

RsyncTaskEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

path Required

Path

Type: string

See the comment in Rsyncmod about path length limits.

Must be at most 1023 characters long

user Required

User

Type: string

mode

Mode

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

different operating mechanisms for Rsync i.e Rsync Module mode / Rsync SSH mode

Must be one of:

• "MODULE"
• "SSH"

remotehost

Remotehost

Default: null

ip address or hostname of the remote system. If username differs on the remote host, "username@remote_host"
format should be used.

Any of

• Option 1
• Option 2

Type: string

Type: null

remoteport

Remoteport

Default: null

Any of

• Option 1
• Option 2

Type: integer

Type: null

remotemodule

Remotemodule

Default: null

name of remote module, this attribute should be specified when mode is set to MODULE.

Any of

• Option 1
• Option 2

Type: string

Type: null

ssh_credentials Required

In SSH mode, if ssh_credentials (a keychain credential of SSH_CREDENTIALS type) is specified then it is used
to connect to the remote host. If it is not specified, then keys in user's .ssh directory are used.

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

remotepath Required

Remotepath

Type: string

will automatically add remote host key to user's known_hosts file

direction

Direction

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

specifies if data should be PULLED or PUSHED from the remote system

Must be one of:

• "PULL"
• "PUSH"

desc

Desc

Type: string Default: ""

schedule

RsyncTaskSchedule

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)

recursive

Recursive

Type: boolean Default: true

times

Times

Type: boolean Default: true

compress

Compress

Type: boolean Default: true

when set reduces the size of the data which is to be transmitted.

archive

Archive

Type: boolean Default: false

when set makes rsync run recursively, preserving symlinks, permissions, modification times, group, and special
files.

delete

Delete

Type: boolean Default: false

when set deletes files in the destination directory which do not exist in the source directory.

quiet

Quiet

Type: boolean Default: false

preserveperm

Preserveperm

Type: boolean Default: false

when set preserves original file permissions.

preserveattr

Preserveattr

Type: boolean Default: false

delayupdates

Delayupdates

Type: boolean Default: true

extra

Extra

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

enabled

Enabled

Type: boolean Default: true

locked Required

Locked

Type: boolean

job Required

Job

Any of

• Option 1
• Option 2

Type: object

Type: null

Required roles: SNAPSHOT_TASK_READ