rsynctask.create

Create a Rsync Task.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: rsync_task_create

rsync_task_create

Type: object
No Additional Properties

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) Default: "MODULE"

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

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

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.

Type: string
Type: null

Remoteport

Default: null

Type: integer
Type: null

Remotemodule

Default: null

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

Type: string
Type: null

Ssh Credentials

Default: null

the path on the remote system.

Type: integer
Type: null

Remotepath

Type: string

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

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

Type: string Default: ""

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 Default: true

Times

Type: boolean Default: true

Compress

Type: boolean Default: true

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

Archive

Type: boolean Default: false

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

Delete

Type: boolean Default: false

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

Quiet

Type: boolean Default: false

Preserveperm

Type: boolean Default: false

when set preserves original file permissions.

Preserveattr

Type: boolean Default: false

Delayupdates

Type: boolean Default: true

Extra

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

Enabled

Type: boolean Default: true

Validate Rpath

Type: boolean Default: true

boolean which when sets validates the existence of the remote path

Ssh Keyscan

Type: boolean Default: false

RsyncTaskEntry

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) Default: "MODULE"

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

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

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.

Type: string
Type: null

Remoteport

Default: null

Type: integer
Type: null

Remotemodule

Default: null

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) Default: "PUSH"

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

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

Desc

Type: string Default: ""

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 Default: true

Times

Type: boolean Default: true

Compress

Type: boolean Default: true

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

Archive

Type: boolean Default: false

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

Delete

Type: boolean Default: false

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

Quiet

Type: boolean Default: false

Preserveperm

Type: boolean Default: false

when set preserves original file permissions.

Preserveattr

Type: boolean Default: false

Delayupdates

Type: boolean Default: true

Extra

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

Enabled

Type: boolean Default: true

Locked

Type: boolean

Job


Type: object
Type: null


Required roles: SNAPSHOT_TASK_WRITE