You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

79 lines
1.4 KiB

.TH "LIGHTNING-DISCONNECT" "7" "" "" "lightning-disconnect"
.SH NAME
lightning-disconnect - Command for disconnecting from another lightning node
.SH SYNOPSIS
\fBdisconnect\fR \fIid\fR [\fIforce\fR]
.SH DESCRIPTION
The disconnect RPC command closes an existing connection to a peer,
identified by \fIid\fR, in the Lightning Network, as long as it doesn’t have
an active channel\. If \fIforce\fR is set then it will disconnect even with
an active channel\.
The \fIid\fR can be discovered in the output of the listpeers command, which
returns a set of peers:
.nf
.RS
{
"peers": [
{
"id": "0563aea81...",
"connected": true,
...
}
]
}
.RE
.fi
Passing the \fIid\fR attribute of a peer to \fIdisconnect\fR will terminate the
connection\.
.SH RETURN VALUE
On success, an empty object is returned\.
.SH ERRORS
If \fIid\fR is invalid, an error message will be returned:
.nf
.RS
{ "code" : -1, "message" : "Peer not connected" }
.RE
.fi
If the peer has an active channel and \fIforce\fR is not set, an error
message will be returned:
.nf
.RS
{ "code" : -1, "message" : "Peer is in state CHANNELD_NORMAL" }
.RE
.fi
.SH AUTHOR
Michael Hawkins \fI<michael.hawkins@protonmail.com\fR>\.
.SH SEE ALSO
\fBlightning-connect\fR(1), \fBlightning-listpeers\fR(1)
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR