rsynctask.query

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: 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 2: options

options

Type: object
Default:
{ "relationships": true, "extend": null, "extend_fk": [], "extend_context": null, "prefix": null, "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

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 of object
No Additional Items
Each item of this array must be:

RsyncTaskQueryResultItem

Type: object
No Additional Properties

Id

Type: integer

Path

Type: string

See the comment in Rsyncmod about path length limits.

Must be at most 1023 characters long

User

Type: string

Mode

Type: enum (of string)

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

Must be one of:
  • "MODULE"
  • "SSH"

Remotehost


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

Type: string
Type: null

Remoteport


Type: integer
Type: null

Remotemodule


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

Type: string
Type: null


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.

KeychainCredentialEntry

Type: object
No Additional Properties

Id

Type: integer

Name

Type: string

Distinguishes this Keychain Credential from others.

Must be at least 1 characters long

Type

Type: enum (of string)
Must be one of:
  • "SSH_KEY_PAIR"
  • "SSH_CREDENTIALS"

Attributes


SSHKeyPair

Type: object

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

 No Additional Properties

Private Key

Default: null

Type: string
Type: null

Public Key

Default: null

Can be omitted and automatically derived from the private key.

Type: string
Type: null

SSHCredentials

Type: object
No Additional Properties

Host

Type: string

Port

Type: integer Default: 22

Username

Type: string Default: "root"

Private Key

Type: integer

Keychain Credential ID.

Remote Host Key

Type: string

Can be discovered with keychaincredential.remotesshhostkeyscan.

Connect Timeout

Type: integer Default: 10
Type: null

Remotepath

Type: string

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

Direction

Type: enum (of string)

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

Must be one of:
  • "PULL"
  • "PUSH"

Desc

Type: string

RsyncTaskSchedule

Type: object
No Additional Properties

Minute

Type: string Default: "00"

Hour

Type: string Default: "*"

"00" - "23"

Dom

Type: string Default: "*"

"1" - "31"

Month

Type: string Default: "*"

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

Dow

Type: string Default: "*"

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

Recursive

Type: boolean

Times

Type: boolean

Compress

Type: boolean

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

Archive

Type: boolean

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

Delete

Type: boolean

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

Quiet

Type: boolean

Preserveperm

Type: boolean

when set preserves original file permissions.

Preserveattr

Type: boolean

Delayupdates

Type: boolean

Extra

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

Enabled

Type: boolean

Locked

Type: boolean

Job


Type: object
Type: null

RsyncTaskQueryResultItem

Type: object
No Additional Properties

Id

Type: integer

Path

Type: string

See the comment in Rsyncmod about path length limits.

Must be at most 1023 characters long

User

Type: string

Mode

Type: enum (of string)

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

Must be one of:
  • "MODULE"
  • "SSH"

Remotehost


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

Type: string
Type: null

Remoteport


Type: integer
Type: null

Remotemodule


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

Type: string
Type: null


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.

Type: object
Type: null

Remotepath

Type: string

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

Direction

Type: enum (of string)

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

Must be one of:
  • "PULL"
  • "PUSH"

Desc

Type: string

Type: object

Recursive

Type: boolean

Times

Type: boolean

Compress

Type: boolean

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

Archive

Type: boolean

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

Delete

Type: boolean

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

Quiet

Type: boolean

Preserveperm

Type: boolean

when set preserves original file permissions.

Preserveattr

Type: boolean

Delayupdates

Type: boolean

Extra

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

Enabled

Type: boolean

Locked

Type: boolean

Job


Type: object
Type: null
Type: integer


Required roles: SNAPSHOT_TASK_READ