zfsa-remote-add(1)

NAME

zfsa-remote-add - Add a remote: confirm its host key, make a key and test the connection

SYNOPSIS

zfsa remote add [GLOBAL OPTIONS] [--port] [--user] [--root] [--source-address] [--fingerprint] [--basic] [--check-again] [-h|--help] <NAME> <HOST>

DESCRIPTION

Add a remote: confirm its host key, make a key and test the connection.

Compare the host key's fingerprint with the one the remote itself shows, over a route you trust, before you accept it. --yes never accepts a host key. A remote that runs ZFS Assistant gets a restricted key that reaches only the dataset --root and can't open a shell. In basic mode the remote needs only ZFS and SSH, but the key can open a shell and read and delete the backup user's data.

OPTIONS

--port <PORT> [default: 22]

The SSH port

--user <USER> [default: zfsbackup]

The user on the remote that receives backups

--root <DATASET>

The dataset on the remote that backups go under

--source-address <ADDRESSES>

This computer's address as the remote sees it (several separated by commas, networks as 192.168.1.0/24)

--fingerprint <SHA256:…>

The host key's fingerprint, as the remote shows it (SHA256:…): confirms the key without asking

--basic

Use basic mode when the remote does not run ZFS Assistant, without asking

--check-again

When the remote does not run ZFS Assistant, wait for it to be installed and test again

-h, --help

Print help (see a summary with '-h')

<NAME>

The remote's name, such as nas

<HOST>

Its host name or address

EXAMPLES

A remote that runs ZFS Assistant and accepts backups under backup/laptop:

zfsa remote add offsite nas.example --root backup/laptop

A remote with only ZFS and SSH, on another port:

zfsa remote add old-nas 192.0.2.10 --port 2222 --basic

SEE ALSO

zfsa(1) for the global options, authorization, confirmations and exit status, zfsa-remote(1).