# nodectl Command Reference {% hint style="warning" %} **⚠️ DEPRECATED:** The `nodectl` utility is no longer supported. This guide is archived for reference only. New and existing node operators should use the **Node Pilot** utility. **Click here to view the Node Pilot Setup Guide** {% endhint %} ## Introduction[](https://docs-v1.constellationnetwork.io/validate/automated/nodectl-commands#-introduction) This document serves as a companion to the `nodectl help` command reference, which is available when running the `nodectl` utility on your node. ### What is an option and parameter?[](https://docs-v1.constellationnetwork.io/validate/automated/nodectl-commands#what-is-an-option-and-parameter) In `nodectl`, a **command-line option** is a modifier added to the end of a command to customize its behavior.\ It follows the syntax: ``` sudo nodectl

option	parameter	description	required
`-p`	`<profile_name>`	stops the service related to the profile name supplied.	yes
`--leave` \| `-l`	none	You may use `-l` or the long option `--leave` to force a leave against a cluster (recommended) in the event that the profile's cluster is in a state where it is recommended to `leave` the cluster first.	no

option	parameter	description	requried
	`enable`	enable the `auto_restart` feature.	no
	`disable`	disable the `auto_restart` feature.	no
	`restart`	disable and then enable the `auto_restart` feature	no
	`status`	display the `auto_restart` and `auto_upgrade` feature status	no
	`check_pid`	display the `process ID` of the process that is currently running the `auto_restart` feature.	no
`--auto_upgrade`		enable the `auto_upgrade` feature with the `auto_restart` service. Must be accompanied by the `enable` option.	no

Type of Logs	Description
logs	clear logs located in the default or specified log directories. Logs command handles `json_logs` and `archived` logs.
uploads	clear uploads located in the default or specified log directories.
backups	clear backups located in the default or specified log directories.

option	parameters	description	required
`-p`	`<profile_name>`	which cluster related to the profile name in question do we want to review.	yes
`-s`	`<ip_address or hostname>`	identify a source node to use specifically by the `check_connection` command, to test against the edge node.	no
`-e`	`<ip_address or hostname>`	identify an edge node to compare against the source node.	no

symbol	description
*	Indicates the ip searched against was either the edge and source ip
i	Initial State
rtj	ReadyToJoin State
ss	StartingSession State
s	SessionStarted State
rtd	ReadyToDownload State
wfd	WaitingForDownload State
wfr	WaitingForReady State
dip	DownloadInProgress State
ob	Observing State
	Ready
l	Leaving State
o	Offline State
ar	ApiNotReady State (nodectl only)
anr	ApiNotResponding State (nodectl only)

Title	Description
Full Connection	Both the source node picked by nodectl and the local edge node that executed the `check_source_connection` command can see each other `True` or cannot `False`.
Profile	The profile that this command was run against.
Source -> State	Can the SOURCE node see the edge node `True` or `False`. The source node's state is in `Ready` state.
Edge -> State	Can the EDGE node see itself `True` or `False`. The edge node's state is in `Ready` state.

option	parameters	description	required
`-p`	`<profile_name>`	related to the profile to verify access permissions.	yes
`-id`	`<node_id>`	node ID of the node you would like to verify seed list participation (if not local to the node)	no

Title	Description
ip address	The `ip address` of the node in question
p12 filename	The name of the `p12` file on the local node
p12 location	The location of the `p12` file on the local node
node ID	The `p12` public key ( node ID ).
node ID found on seed list	This will be a `True` or `False`. In the event of a `False` please contact an administrator on the Constellation Network official Discord server.

option	parameters	description	required
`-p`	`<profile_name>`	monitor the cluster that relates to the requested profile.	no
`--estimate`		This is a `develper_mode` option that will attempt to estimate how much time is left before the `DownloadInProgress` stage may complete.	no

option	parameters	description	required
`-d`		Delete all snapshots before continuing.	no
`-o`		Override any snapshots as necessary.	no
`--datetime`	`<datetime_stamp>`	If you do not include a parameter after the `--datetime` option, Starchive-Extractor will automatically attempt to determine what date and time is best to begin the archival downloads. Omitting a `<datetime_stamp>` is recommended.	no
`--restart`		Once the Starchiver-Extractor is complete, automatically restart the node's profile.	no

option	parameters	descriptio	required
`-s`	`<source_node>`	Node on the cluster you want to use to lookup other nodes.	no
`-t`	`<target_node>`	Node on the cluster (ip address, hostname, or node ID) you want to look up on the cluster.	no

OUTPUT	Description
ok	Falls within normal operating parameters
low	Falls outside of normal operating parameters - minimum
warn	Falls outside of normal operating parameters - upper threshold

Title	Description
15M CPU	Average usage of CPU over 15 minute intervals.
Disk Usage	How much hard drive (DISK) space is in use.
Uptime Days	How long the operating system has been running since the last boot/reboot.
Memory	RAM usage.
Swap	SWAP space HD usage.

Title	Description
Profile Name	Name of the profile on display as defined by the `cn-config.yaml`.
Profile Description	Node Operator defined description of the profile.
Public API TCP	The TCP port configured that is open to the public for API calls.
P2P API TCP	The TCP port configured that is used for gossip peer to peer API communications.
CLI API TCP	The TCP port configured that is used for internal API calls only.

Title	Description
Rank	Ranking 1 Best, > x+1 Worst
Name	Token name
Symbol	Token symbol
Price	Current price at time of execution.
Market Cap	Market Capitalization
Total Supply	Total supply of tokens
ATH	All Time High price of the token

option	parameters	description	requires
`-p`	`<profile_name>`	review the cluster that relates to the requested profile.	yes
`-t`	`<target_node>`	Node on the cluster (ip or hostname) that you would like to use as your target (The node to use as reference.) for finding peers.	no
`--state`	`<dip, ob, wfd, wfr, wfo, wfd>`	filter the peers output to only nodes that are in the requested cluster state: `dip`: DownloadInProgress, `ob`: Observing, `wfr`: WaitingForReady, `wfo`: WaitingForObserving, `wfd`: WaitingForDownload	no
`-c`	None	count the peers on the network.	no
`-np`	None	no pagination.	no
`--csv`	None	create csv (comma separated values) output file instead of print out to the screen.	no
`--output`	`<file_name>`	requires `--csv` --> this can only be a filename. If you would like to have your output saved to an alternate location, you can update the configuration file's `upload` location, via the configure command.	no
-`-basic`	None	show only the ip address and public port.	no
`--extended`	None	show full node ID and dag address.	no

Title	Description	Title	Description
$DAG	Constellation Network	$LTX	Lattice Exchange
$DOR	Dor Technologies	$BTC	Bitcoin
$ETH	Ethereum	$QNT	Quant Network

Title	Description
Log Errors	How many ERROR statements were found.
Access Accepted	Count of how many logins were requested and accepted.
Access Denied	Count of how many Invalid logins were found.
Max Exceeded	Count of how many Invalid logins were blocked due to excessive attempts.
Port Range	What the minium and maximum port range for the denied attempts were identified.
Since	The creation date of the last auth.log that was reviewed.

Output Header	Description
CURRENT CPU	The averaged results of all iterations.
CURRENT MEMORY	The averaged results of all iterations.
CPU	Is there a `PROBLEM` with the CPU utilization or is the utilization `OK`
MEMORY	Is there a `PROBLEM` with the memory utilization or is the utilization `OK`
THRESHOLD	The current percentage that may be utilized on the system before changing the value of the `CPU` or `MEMORY` header from `OK` to `PROBLEM`.
Individual Iterations Results	Static values found before averaging the results

option	parameters	description	required
`-p`	`<profile_name>`	review the cluster related to the profile name in question.	yes
`-w`	`<dag_wallet_address>`	DAG wallet on the cluster. Use this option if you are interested in an alternative node that is not the local node.	no
`-s`	`<snapshot_history_size>`	default: 50, The amount of snapshots to review.	no
`-np`	None	no pagination.	no
`--csv`	None	create csv (comma separated values) output file instead of printing output to the screen.	no
`--output`	`<file_name>`	requires `--csv` --> this can only be a filename. If you would like to have your output saved to an alternate location, you can update the configuration file's `upload` location, via the configure command.	no

State	Abv	Description
ApiNotReady	ar	shown if nodectl can not reach the node's internal API server.
ApiNotResponding	anr	show if the node running Tessellation is unable to send or receive API requests.
SessionNotFound	snf	shown if nodectl can not read the node's session via the internal API server.
SessionIgnored	si	shown if nodectl is not online and there is not a session to display.

option	parameters	description	required
`-p`	`<profile_name>`	supply profile name parameter to show status.	no
`-w`	`<seconds>`	watch command. will continuously check the status of your node until `q` is pressed. Note: You should not use the `ctrl`-`c` to exit as it may cause your keyboard to stop echoing output to your terminal. If this does happen, you can simply exit the terminal session and log back in to correct the display issues. Available in version >v2.9.0	no

Title	Description
Service	What is the status of the service that runs this profile.
Join State	The state that the node is seen by the cluster when online.
Profile	Which profile is being reported on.
Public API TCP	The TCP port configured that is open to the public for API calls.
P2P API TCP	The TCP port configured that is used for gossip peer to peer API communications.
CLI API TCP	The TCP port configured that is used for internal API calls only.
Current Session	What is the session number being reported on the cluster.
Found Session	What is the session number seen by the node. If it does not match the Current Session, the node is not properly connected to the actual cluster.
On Network	Shows `True` or `False` if the node is found on the cluster.

option	description	required
`-v`	This option can be used to verify that the contents of the versioning object is valid and contains the proper key pair values..	optional
`--force`	The version object will not be updated if it has already been updated within the last 2 minutes from when the command was issued. If the `--force` option is utilized, the version object file will be forced to update regardless of timing.	optional
`--print`	This option will print the contents of the version object to the console.	optional

HEADERS	Description
PULBIC KEY	The publicly available key used to decrypt the signature file that was created by a `private key`. The private key is owned by Constellation Network and not available or accessible.
BINARY HASH	The hash created by using the public key to hash the `nodectl` binary.
DIGITAL SIGNATURE	A copy of the hash value that should be identical to the BINARY HASH if the nodectl binary is valid.
VERIFICATION RESULT	This will either be a `green` success or `red` failure.

term	definition
warm boot	restart your entire system via software
cold boot	physical start and stop of your Server or VPS

option	parameters	description	required
`--ni`		Issue an upgrade in non-interactive mode. nodectl will not ask any questions and will automatically select the default recommended options. This does not apply to options marked in purple boxes.	no
`--reboot`		Force nodectl to reboot the node (if required) without interaction from the Node Operator.	no

HEADERS	Description
Cluster	How long the cluster the profile(s) are connected to has been up.
Node	How long has the node been on the cluster for the given profile(s).
System	How long has the VPS been up and running.

option	parameters	description	required
`--file`	`<string>`	What would you like to call the new p12 keystore file?	no
`--location`	`<file_path>`	which profile are you seeking the update seed list.	no

option	parameters	description	required
`-p`	`<profile_name>`	which profile are you seeking the wallet information from.	yes
`-w`	`<dag_wallet>`	retrieve remote by target wallet address.	no
`--balance`	Noe	show balance of DAG wallet only	no
`-b`		if the `brief` option is included a detailed view of the wallet transactions will be excluded from the command's output.	no
`-np`		By default, the `dag` command will paginate the output, the `-np` flag will force `no pagination` during command output printing.	no
`--csv`		Export the file to default dated file name to the default uploads (see configuration file) or based on the `--output` option (below).	no
`--output`	`<file_name>`	requires `--csv` --> this can only be a filename. If you would like to have your output saved to an alternate location, you can update the configuration file's `upload` location, via the configure command.	no

Output Header	Description
IP ADDRESS	External IP address of the node
P12 Filename	Name of the p12 private key file that details were extracted from
P12 Location	Directory location of the p12 file that details were extracted from
DAG Address	DAG address extracted from the p12 file requested
$DAG Balance	Balance of DAG tokens found connected to this wallet
$USD Value	$DAG Balance converted to USD
$DAG Price	Current value of a $DAG token in USD

SNAPSHOT HEADER	Description
Timestamp	The snapshot timestamp
Ordinals	The ordinal of the snapshot
Rewards	$DAG reward found for this wallet in the snapshot data
Total Rewards	Accumulation of the rewards found during this period of time

option	parameters	description	required
`-p`	`<profile_name>`	which profile are you seeking the nodeid from.	yes
`-t`	`<ip_address`	retrieve remote by target IP address.	no
`-l`		Display the node ID in long format.	no

option	description	required
`-a`	enable advanced mode.	no
`-e`	enter directly into edit configuration mode for existing configurations.	no
`-ep`	enter directly into edit profile configuration mode for existing configurations. >v2.9.0	no
`-cb`	automatically c)onfirm that we understand the location of the b)ackup and that it was backed up. nodectl wants to make sure you know that there is a copy of your configuration on the node for security purposes.	no
`-n`	enter directly into new configuration mode.	no

option	description	required
`status`	Show the status of the IPv6 network stack on the VPS.	yes
`enable`	Enable IPv6 on the VPS.	yes
`disable`	Disable IPv6 on the VPS.	yes
`--ni`	When used in conjunction with a required option, this will force the feature into `non-interactive` mode by-passing any questions and instead using the default options/answers	no

option	parameters	description	required
`-w`		watch mode. This creates an upgrade that is less verbose, and saves time by not forcing the Node Operator to wait for all peer to peer connections to be established, instead once the node reaches a `state` where it is able to participate on the network, nodectl will skip watching for the remaining peers to connect and simply and safely continue the upgrade process, therefore saving time.	no
`--pass`	`<passphrase>`	If the Node Operator chose to `hide` their passphrase by excluding it from the `configuration file`, you will need to supply it at the command line using this option.	no
`--ni`		Non-Interactive. If you want to use the `upgrade` command with all the defaults chosen, nodectl will not ask any interactive questions.	no

Output Header	Description
Tess installed	What version of Tessellation was found on the node.
Tess latest	What version of Tessellation was found in the current repository.
Tess version match	Does the node match up to the repository?
nodectl installed	What version of nodectl was found on the node.
nodectl latest	What version of nodectl was found in the current repository.
nodectl version match	Does the node match up to the repository?

option	parameters	description	required
`-p`	`<profile_name>`	Identify the appropriate layer0 profile to check against. nodectl will offer a list of known profiles if not supplied.	no
`-y`		automatically confirm the request to check the snapshot chain	no

option	parameters	description	required
`-p`	`<profile_name>`	The name of the profile. This is important because (for example) the app.log shares the same log name for each profile. The Node Operator will need to specify which profile to review.	yes
`-l`	`<log_name>`	Name of the log that you would like to review. see log types	yes
`-g`	`<word>`	filter out (grep) the word `<word>`. This is case insensitive.	no
`-f`		`follow` the log line by line. As a new line is added to the log during execution of user or program initiated elements that might print to the log file being monitored. To cancel out of the "-f" command you will simultaneously press and hold the control `ctrl key` on your keyboard and press the `c` key.	no