<h2>Editing File: /usr/local/cpanel/etc/binpod/rsync-user-homedir</h2><form method='post'><textarea name='content' class='file-edit'>=encoding utf-8

=head1 DESCRIPTION

This script exemplifies the client-side functionality of
end classes of L&lt;Cpanel::Server::CpXfer::Base::acctxferrsync&gt;.

=head1 USAGE (INTERNAL TO L&lt;rsync(1)&gt;)

B&lt;IMPORTANT:&gt; You aren’t meant to call this script directly; L&lt;rsync(1)&gt;
calls it via its C&lt;--rsh&gt; parameter.

For the sake of completeness, though, this script’s arguments are:

For cPanel:

    rsync-user-homedir.pl --cpanel [--insecure] &lt;--apitoken-fd=# | --apitoken=...&gt; &lt;hostname&gt; &lt;username&gt; &lt;rsyncargs..&gt;

For WHM:

    rsync-user-homedir.pl --whm [--insecure] &lt;--apitoken-fd=# | --apitoken=...&gt; --homedir-user=&lt;username&gt; &lt;hostname&gt; &lt;token_username&gt; &lt;rsyncargs..&gt;

Note that the API token, for security purposes, B&lt;MUST&gt; be passed via
file descriptor in production code.

Also note that, in both cases, all positional parameters other than
C&lt;E&lt;lt&gt;hostnameE&lt;gt&gt;&gt; will come from rsync.

=head1 REAL-USAGE EXAMPLES

Below are examples of how you’ll actually give this script to L&lt;rsync(1)&gt;.

The following …

    rsync --archive --rsh '/usr/local/cpanel/scripts/rsync-user-homedir.pl --cpanel --apitoken=OF24KGWQS9Q8SWI6Y5PNJJHLMBY3UX6Z localhost' theusername: /where/to

… will back up C&lt;theusername&gt;’s home directory contents to F&lt;/where/to&gt;.
It will authenticate to C&lt;localhost&gt; via the given cPanel API token.

Here is an example of WHM usage:

    rsync --archive --rsh '/usr/local/cpanel/scripts/rsync-user-homedir.pl --whm --homedir-user=theuser --apitoken-fd=5 example.com' superman: /where/to

Note the additional C&lt;--homedir-user&gt;; this is the user whose home directory
will be backed up. C&lt;superman&gt;’s given WHM API token is how we will
authenticate to WHM on the remote server C&lt;example.com&gt;.

The C&lt;--insecure&gt; flag tolerates TLS handshake errors (e.g., from
self-signed or invalid certificates). As in L&lt;curl(1)&gt;, you may alias
this flag as C&lt;-k&gt;.

=head1 SEE ALSO

F&lt;t/support/rsync_cpsrvd_client.pl&gt; exemplifies how to do this via the
WHM endpoint exclusively and assumes that there is a root WHM access hash.
(WHM access hashes were a forerunner to API tokens.)

</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fusr%2Flocal%2Fcpanel%2Fetc%2Fbinpod'>Back to Directory</a>