btrsync.sync.root.ssh

Btrfs roots for remote access via SSH.

Functions

SSHRoot(host, *[, user, port, pkpath, ...])

Return an appropriate btrfs root class for accessing btrfs filesystems on remote machines using ssh.
btrsync.sync.root.ssh.SSHRoot(host, *, user=None, port=None, pkpath=None, compress=False, sudo=False)[source]

Return an appropriate btrfs root class for accessing btrfs filesystems on remote machines using ssh.

Parameters

  • host – the remote host to ssh into

  • user – the user to log in as

  • port – the port to connect to on host

  • pkpath – the local path to the private key (identity) file to use

  • compress – if True, enable compression on the ssh channel

  • sudo – if True, use sudo to execute btrfs commands on the remote machine