status¶

receptorctl status displays the status of the Receptor network.

Command syntax: receptorctl --socket=<socket_path> status [--json]

socket_path is the control socket address for the Receptor connection.: The default is unix: for a Unix socket. Use tcp:// for a TCP socket. The corresponding environment variable is RECEPTORCTL_SOCKET.

ss --listening --processes --unix 'src = unix:<socket_path>'
Netid         State          Recv-Q         Send-Q                   Local Address:Port                     Peer Address:Port        Process
u_str         LISTEN         0              4096                   /tmp/local.sock 38130170                            * 0            users:(("receptor",pid=3226769,fd=7))

ps -fp $(pidof receptor) lsof -p <pid>

--json option returns the output in JSON format.: The default output format is human-readable. Using this argument allows output to be machine consumable. For example, piping into jq.

The output is divided into sections listed below. Field values may be listed in their own section. Columns are the actual JSON node values.

Node section ¶

Node section¶
Column	Description
`."NodeID"`	Node identifier.
`."SystemCPUCount"`	Number of logical CPU cores on the node.
`.SystemMemoryMiB"`	Available memory (MiB) of the node.
`."Version"`	Receptor version.

Connections section ¶

Connections section¶
Column	Description
`."Connections"`	Connections.
`."Connections"."Cost"`	Metric (route preference) to reach NodeID.
`."Connections"."NodeID"`	Node ID.

Known connections section ¶

Known connections section¶
Column	Description
`"KnownConnectionCosts"`	Known Connections.
`"KnownConnectionCosts"."<NodeID 1>"`	Remote node ID.
`"KnownConnectionCosts"."<NodeID 1>"."<NodeID 2>"`	Cost to get to NodeID 1 through NodeID 2.

Routing Table Section ¶

Routing Table section¶
Column	Description
`."RoutingTable"`	Routing Table.
`."RoutingTable"."<NodeID>"`	List of NodeID(s) used to get to desired NodeID.

Service Advertisement Section ¶

Service Advertisement Section¶
Column	Description
`."Advertisements"`	Advertisements.
`."Advertisements"."ConnType"`	Connection type (see below for values).
`."Advertisements"."NodeID"`	Node identifier issuing advertisement.
`."Advertisements"."Service"`	Receptor services on node.
`."Advertisements"."Tags"`	Tags associated with node.
`."Advertisements"."Time"`	Timestamp when advertisement sent.

Execution Node Section ¶

Execution Node section¶
Column	Description
`."Advertisements"."WorkCommands"`	Execution Node work commands.
`."Advertisements"."WorkCommands"."Secure"`	Boolean indicating whether the work commands are signed.
`."Advertisements"."WorkCommands"."WorkType"`	Work command(s) supported.

Connection Type ¶

Connection Types¶
ConnType Value	Description
0	Datagram.
1	Stream.
2	StreamTLS.

Tags ¶

Tags¶
Tags	Description
network	Network name.
route_*	Route information for specified node.
type	Node type.