Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/cli/network/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Network",
"position": 4
}
44 changes: 44 additions & 0 deletions docs/cli/network/addnode.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: addnode
sidebar_label: addnode
description: "Syscoin Core CLI reference: addnode"
---

# `addnode`

Attempts to add or remove a node from the addnode list.
Or try a connection to a node once.
Nodes added using addnode (or -connect) are protected from DoS disconnection and are not required to be
full nodes/support SegWit as other outbound peers are (though such peers will not be synced from).
Addnode connections are limited to 8 at a time and are counted separately from the -maxconnections limit.

## Synopsis

```
addnode "node" "command" ( v2transport )
```

## Arguments

```
1. node (string, required) The address of the peer to connect to
2. command (string, required) 'add' to add a node to the list, 'remove' to remove a node from the list, 'onetry' to try a connection to the node once
3. v2transport (boolean, optional, default=false) Attempt to connect using BIP324 v2 transport protocol (ignored for 'remove' command)
```

## Result

```
null (json null)
```

## Examples

```
> syscoin-cli addnode "192.168.0.6:8369" "onetry" true
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "addnode", "params": ["192.168.0.6:8369", "onetry" true]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/rpc/net.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/net.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-20.*
32 changes: 32 additions & 0 deletions docs/cli/network/clearbanned.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: clearbanned
sidebar_label: clearbanned
description: "Syscoin Core CLI reference: clearbanned"
---

# `clearbanned`

Clear all banned IPs.

## Synopsis

```
clearbanned
```

## Result

```
null (json null)
```

## Examples

```
> syscoin-cli clearbanned
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "clearbanned", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/rpc/net.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/net.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-20.*
45 changes: 45 additions & 0 deletions docs/cli/network/disconnectnode.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: disconnectnode
sidebar_label: disconnectnode
description: "Syscoin Core CLI reference: disconnectnode"
---

# `disconnectnode`

Immediately disconnects from the specified peer node.

Strictly one out of 'address' and 'nodeid' can be provided to identify the node.

To disconnect by nodeid, either set 'address' to the empty string, or call using the named 'nodeid' argument only.

## Synopsis

```
disconnectnode ( "address" nodeid )
```

## Arguments

```
1. address (string, optional, default=fallback to nodeid) The IP address/port of the node
2. nodeid (numeric, optional, default=fallback to address) The node ID (see getpeerinfo for node IDs)
```

## Result

```
null (json null)
```

## Examples

```
> syscoin-cli disconnectnode "192.168.0.6:8369"
> syscoin-cli disconnectnode "" 1
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "disconnectnode", "params": ["192.168.0.6:8369"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "disconnectnode", "params": ["", 1]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/rpc/net.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/net.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-20.*
52 changes: 52 additions & 0 deletions docs/cli/network/getaddednodeinfo.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: getaddednodeinfo
sidebar_label: getaddednodeinfo
description: "Syscoin Core CLI reference: getaddednodeinfo"
---

# `getaddednodeinfo`

Returns information about the given added node, or all added nodes
(note that onetry addnodes are not listed here)

## Synopsis

```
getaddednodeinfo ( "node" )
```

## Arguments

```
1. node (string, optional, default=all nodes) If provided, return information about this specific node, otherwise all nodes are returned.
```

## Result

```
[ (json array)
{ (json object)
"addednode" : "str", (string) The node IP address or name (as provided to addnode)
"connected" : true|false, (boolean) If connected
"addresses" : [ (json array) Only when connected = true
{ (json object)
"address" : "str", (string) The syscoin server IP and port we're connected to
"connected" : "str" (string) connection, inbound or outbound
},
...
]
},
...
]
```

## Examples

```
> syscoin-cli getaddednodeinfo "192.168.0.201"
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getaddednodeinfo", "params": ["192.168.0.201"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/rpc/net.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/net.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-20.*
39 changes: 39 additions & 0 deletions docs/cli/network/getaddrmaninfo.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: getaddrmaninfo
sidebar_label: getaddrmaninfo
description: "Syscoin Core CLI reference: getaddrmaninfo"
---

# `getaddrmaninfo`

Provides information about the node's address manager by returning the number of addresses in the `new` and `tried` tables and their sum for all networks.

## Synopsis

```
getaddrmaninfo
```

## Result

```
{ (json object) json object with network type as keys
"network" : { (json object) the network (ipv4, ipv6, onion, i2p, cjdns, all_networks)
"new" : n, (numeric) number of addresses in the new table, which represent potential peers the node has discovered but hasn't yet successfully connected to.
"tried" : n, (numeric) number of addresses in the tried table, which represent peers the node has successfully connected to in the past.
"total" : n (numeric) total number of addresses in both new/tried tables
},
...
}
```

## Examples

```
> syscoin-cli getaddrmaninfo
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getaddrmaninfo", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Auto-generated from Syscoin Core 5.0.5 on 2026-05-20.*
32 changes: 32 additions & 0 deletions docs/cli/network/getconnectioncount.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: getconnectioncount
sidebar_label: getconnectioncount
description: "Syscoin Core CLI reference: getconnectioncount"
---

# `getconnectioncount`

Returns the number of connections to other nodes.

## Synopsis

```
getconnectioncount
```

## Result

```
n (numeric) The connection count
```

## Examples

```
> syscoin-cli getconnectioncount
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getconnectioncount", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/rpc/net.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/net.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-20.*
45 changes: 45 additions & 0 deletions docs/cli/network/getnettotals.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: getnettotals
sidebar_label: getnettotals
description: "Syscoin Core CLI reference: getnettotals"
---

# `getnettotals`

Returns information about network traffic, including bytes in, bytes out,
and current system time.

## Synopsis

```
getnettotals
```

## Result

```
{ (json object)
"totalbytesrecv" : n, (numeric) Total bytes received
"totalbytessent" : n, (numeric) Total bytes sent
"timemillis" : xxx, (numeric) Current system UNIX epoch time in milliseconds
"uploadtarget" : { (json object)
"timeframe" : n, (numeric) Length of the measuring timeframe in seconds
"target" : n, (numeric) Target in bytes
"target_reached" : true|false, (boolean) True if target is reached
"serve_historical_blocks" : true|false, (boolean) True if serving historical blocks
"bytes_left_in_cycle" : n, (numeric) Bytes left in current time cycle
"time_left_in_cycle" : n (numeric) Seconds left in current time cycle
}
}
```

## Examples

```
> syscoin-cli getnettotals
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getnettotals", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/rpc/net.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/net.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-20.*
71 changes: 71 additions & 0 deletions docs/cli/network/getnetworkinfo.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: getnetworkinfo
sidebar_label: getnetworkinfo
description: "Syscoin Core CLI reference: getnetworkinfo"
---

# `getnetworkinfo`

Returns an object containing various state info regarding P2P networking.

## Synopsis

```
getnetworkinfo
```

## Result

```
{ (json object)
"version" : n, (numeric) the server version
"subversion" : "str", (string) the server subversion string
"protocolversion" : n, (numeric) the protocol version
"localservices" : "hex", (string) the services we offer to the network
"localservicesnames" : [ (json array) the services we offer to the network, in human-readable form
"str", (string) the service name
...
],
"localrelay" : true|false, (boolean) true if transaction relay is requested from peers
"timeoffset" : n, (numeric) the time offset
"connections" : n, (numeric) the total number of connections
"connections_in" : n, (numeric) the number of inbound connections
"connections_out" : n, (numeric) the number of outbound connections
"connections_mn" : n, (numeric) the number of verified mn connections
"connections_mn_in" : n, (numeric) the number of inbound verified mn connections
"connections_mn_out" : n, (numeric) the number of outbound verified mn connections
"networkactive" : true|false, (boolean) whether p2p networking is enabled
"networks" : [ (json array) information per network
{ (json object)
"name" : "str", (string) network (ipv4, ipv6, onion, i2p, cjdns)
"limited" : true|false, (boolean) is the network limited using -onlynet?
"reachable" : true|false, (boolean) is the network reachable?
"proxy" : "str", (string) ("host:port") the proxy that is used for this network, or empty if none
"proxy_randomize_credentials" : true|false (boolean) Whether randomized credentials are used
},
...
],
"relayfee" : n, (numeric) minimum relay fee rate for transactions in SYS/kvB
"incrementalfee" : n, (numeric) minimum fee rate increment for mempool limiting or replacement in SYS/kvB
"localaddresses" : [ (json array) list of local addresses
{ (json object)
"address" : "str", (string) network address
"port" : n, (numeric) network port
"score" : n (numeric) relative score
},
...
],
"warnings" : "str" (string) any network and blockchain warnings
}
```

## Examples

```
> syscoin-cli getnetworkinfo
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getnetworkinfo", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/rpc/net.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/net.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-20.*
Loading