core-lightning/doc/lightning-disconnect.7.md
Christian Decker d680e3b158 doc: Remove non-ASCII character from docs
mrkd doesn't like non-ASCII characters in ubuntu:18.04, used for
repro-builds. This is the easiest way to sidestep this issue until we
deprecate the old ubuntu version.
2021-10-31 16:57:56 +01:00

1.5 KiB

lightning-disconnect -- Command for disconnecting from another lightning node

SYNOPSIS

disconnect id [force]

DESCRIPTION

The disconnect RPC command closes an existing connection to a peer, identified by id, in the Lightning Network, as long as it doesn't have an active channel. If force is set then it will disconnect even with an active channel.

The id can be discovered in the output of the listpeers command, which returns a set of peers:

{
     "peers": [
          {
               "id": "0563aea81...",
               "connected": true,
               ...
          }
     ]
}

Passing the id attribute of a peer to disconnect will terminate the connection.

RETURN VALUE

On success, an empty object is returned.

On error the returned object will contain code and message properties, with code being one of the following:

  • -32602: If the given parameters are wrong.
  • -1: Catchall nonspecific error.

AUTHOR

Michael Hawkins <michael.hawkins@protonmail.com>.

SEE ALSO

lightning-connect(1), lightning-listpeers(1)

RESOURCES

Main web site: https://github.com/ElementsProject/lightning