rsynctask.create ================ Create a Rsync Task. .. raw:: html
Configuration for creating a new rsync task.
No Additional PropertiesLocal filesystem path to synchronize.
Must be at most 1023 characters long
Username to run the rsync task as.
Operating mechanism for Rsync, i.e. Rsync Module mode or Rsync SSH mode.
IP address or hostname of the remote system. If username differs on the remote host, "username@remote_host" format should be used.
Port number for SSH connection. Only applies when mode is SSH.
Name of remote module, this attribute should be specified when mode is set to MODULE.
Keychain credential ID for SSH authentication. null to use user's SSH keys.
Path on the remote system to synchronize with.
Specify if data should be PULLED or PUSHED from the remote system.
Description of the rsync task.
Cron schedule for when the rsync task should run.
No Additional PropertiesMinute when the rsync task should run (cron format).
"00" - "23"
"1" - "31"
"1" (January) - "12" (December)
"1" (Monday) - "7" (Sunday)
Recursively transfer subdirectories.
Preserve modification times of files.
Reduce the size of the data to be transmitted.
Make rsync run recursively, preserving symlinks, permissions, modification times, group, and special files.
Delete files in the destination directory that do not exist in the source directory.
Suppress informational messages from rsync.
Preserve original file permissions.
Preserve extended attributes of files.
Delay updating destination files until all transfers are complete.
Array of additional rsync command-line options.
No Additional ItemsWhether this rsync task is enabled.
Validate the existence of the remote path.
Automatically add remote host key to user's known_hosts file.
The newly created rsync task configuration.
No Additional PropertiesUnique identifier for the rsync task.
Local filesystem path to synchronize.
Must be at most 1023 characters long
Username to run the rsync task as.
Operating mechanism for Rsync, i.e. Rsync Module mode or Rsync SSH mode.
IP address or hostname of the remote system. If username differs on the remote host, "username@remote_host" format should be used.
Port number for SSH connection. Only applies when mode is SSH.
Name of remote module, this attribute should be specified when mode is set to MODULE.
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.
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.
Path on the remote system to synchronize with.
Specify if data should be PULLED or PUSHED from the remote system.
Description of the rsync task.
Cron schedule for when the rsync task should run.
No Additional PropertiesMinute when the rsync task should run (cron format).
"00" - "23"
"1" - "31"
"1" (January) - "12" (December)
"1" (Monday) - "7" (Sunday)
Recursively transfer subdirectories.
Preserve modification times of files.
Reduce the size of the data to be transmitted.
Make rsync run recursively, preserving symlinks, permissions, modification times, group, and special files.
Delete files in the destination directory that do not exist in the source directory.
Suppress informational messages from rsync.
Preserve original file permissions.
Preserve extended attributes of files.
Delay updating destination files until all transfers are complete.
Array of additional rsync command-line options.
No Additional ItemsWhether this rsync task is enabled.
Whether this rsync task is currently locked (running).
Information about the currently running job. null if no job is running.