Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

These docs describe unreleased changes on master. Read the latest stable documentation.

syq receiver

Manage restricted destinations for direct server-to-server copies. See access management and enrollment details for setup and upgrades.

syq receiver <COMMAND>
CommandPurpose
receiver enrollManually enroll or refresh a receiver
receiver listList local active and pending enrollments
receiver revokeStop active receivers and remove their enrollment from both machines

Help (also available on subcommands)

Argument / optionMeaning
-h, --helpShow common usage and options
--help-allShow all options and details

syq receiver enroll

The destination’s parent must exist. Repeating enrollment updates the receiver; stop active copies before updating it.

syq receiver enroll [OPTIONS] <[USER@]HOST:DESTINATION>

Arguments

Argument / optionMeaning
<[USER@]HOST:DESTINATION>Remote destination, e.g. alice@nas:/backup/photos

Options

Argument / optionMeaning
--via <ENDPOINT>Retry through this SSH jump host if the direct management connection fails

syq receiver list

syq receiver list

syq receiver revoke

syq receiver revoke [OPTIONS] <ENROLLMENT-ID>

Arguments

Argument / optionMeaning
<ENROLLMENT-ID>Enrollment ID printed by syq receiver list

Options

Argument / optionMeaning
--via <ENDPOINT>Retry through this SSH jump host if the direct management connection fails