.. _orb-node-ssh-wizard:

orb node ssh-wizard
===================

Usage:
-----

.. code::

   $ orb node ssh-wizard   [OPTIONS]


Options:
---------

* --hostname TEXT: IP address or DNS-resolvable name for this host.  [required]
* --node-type TEXT: cln or lnd.  [required]
* --ssh-cert-path PATH: Certificate to use for the SSH session.
* --ssh-password TEXT: Password to use for the SSH session.
* --ln-cert-path PATH: Path of the node certificate on the target host.
* --ln-macaroon-path PATH: Path of the node macaroon on the target host.
* --network TEXT: IP address or DNS-resovable name for this host.  [required]
* --protocol TEXT: rest or grpc.  [required]
* --rest-port INTEGER: REST port.  [default: 8080]
* --grpc-port INTEGER: GRPC port.  [default: 10009]
* --ssh-user TEXT: Username for SSH session.  [default: ubuntu]
* --ssh-port INTEGER: Port for SSH session.  [default: 22]
* --use-node / --no-use-node: Whether to set as default.  [default: True]
* --help: Show this message and exit.

Description:
-----------

SSH into the node, copy the cert and mac, and create the node.

The command sshes into a host, and copies the certificate and macaroon from the paths specified with `--ln-cert-path=...` and `--ln-macaroon-path=...` flags.

The remainder of the operations is invoking the :ref:`orb_node_create` command.

.. asciinema:: /_static/orb-node-ssh-wizard.cast