disconnect
Command
cleos net disconnect [OPTIONS] host
Where:
- [OPTIONS] = See Optionssection TBD
Note: The arguments and options enclosed in square brackets are optional.
Description
Close an existing connection to a specified peer. A node operator can use this command to instruct a node to disconnect from another peer without restarting the node.
Command Usage
The following information shows the different positionals and options you can use with the cleos net disconnect
command:
Positionals
host
TEXT REQUIRED - The hostname:port to disconnect from
Options
-h,--help
- Print this help message and exit
Requirements
Make sure you meet the following requirements:
- Install the currently supported version of
cleos
. [[info | Note]] |cleos
is bundled with the Antelope software. Installing Antelope will also install thecleos
andkeosd
command line tools. - You have access to a producing node instance with the
net_api_plugin
loaded.
Examples
The following examples demonstrate how to use the cleos net disconnect
command:
- Instruct default local node (listening at default http address
http://127.0.0.1:8888
) to disconnect from peer node listening at p2p addresslocalhost:9002
:
cleos net disconnect localhost:9002
Output:
"connection removed"
- Instruct local node listening at http address
http://127.0.0.1:8001
to disconnect from peer node listening at p2p addresslocalhost:9002
:
cleos -u http://127.0.0.1:8001 net disconnect localhost:9002
Output:
"connection removed"
Note: If any of the above commands are re-executed, cleos
returns the following message as expected:
"no known connection for host"