Available Commands in the Sensor CLI Access Window
This topic summarizes the commands available in the Sensor CLI Access window available from the System | DATA SOURCE MANAGEMENT | Sensors | Sensors page. See the following sections for details:
-
Arguments for the "show" command in the Sensor CLI Access Window
-
Arguments for the "set" Command in the Sensor CLI Access Window
-
Arguments for the "unset" Command in the Sensor CLI Access Window
-
Arguments for the "exec" Command in the Sensor CLI Access Window
Refer to Using the Sensor CLI for a summary of how to display and use the Sensor CLI Access window.
Sensor CLI Access Command Types 
The following types of commands are available in the Sensor CLI Access window:
-
show – See the settings and statuses for different options on the sensor.
-
set – Enable and configure options on the sensor.
-
unset – Disable options on the sensor.
-
copy – Copy specified trace files or support files.
-
exec – Execute a specified JSON task or a tcpreset-stop action.
You can use the ? or help parameter with any of these commands to see the available commands of the corresponding type. For example:
-
set ? or set help
You can also use the ? with a specific command to see its available arguments. For example:
mysensor > set ntp ?
<NTP server> Specify NTP server name or IP address
The Sensor CLI Access window supports copy-and-paste functionality. ![]()
When connected to the local CLI, you can also use the help, help all, and help <command> commands to see command descriptions and syntax. ![]()
The tables below summarize the available arguments for the show/set commands.
Additional Commands for IDS PCAP Capture
Refer to Capturing Trace Files for IDS Signature Matches for information on the CLI commands used with the IDS PCAP Capture feature. Additional copy captured_pcap and copy live_pcap commands are available to copy trace files to either the DP or an external host for further analysis.
About Logging for CLI Commands 
CLI commands that execute actions rather than displaying information are logged with timestamps. Each log entry records the executed command and parameters in JSON format with a timestamp, letting you review administrative activity for auditing and troubleshooting. Logs can be viewed through the CLI or accessed in the aella_cli_set.log file for offline analysis.
Filtering CLI Output 
You can filter the output of any show command in the Sensor CLI Access window (or the local CLI) by appending one or more filters with the pipe (|) character. The syntax is as follows:
show <command> | <filter> <argument>
The following filters are available:
-
include <text> – Displays only the lines that contain
text. -
exclude <text> – Removes the lines that contain
textfrom the display. -
regex <pattern> – Displays only the lines that match the specified regular expression.
-
top <number> – Displays only the first
numberlines of output. -
bottom <number> – Displays only the last
numberlines of output.
You can chain multiple filters together by adding additional pipes. Filters are applied in order from left to right, so the output of each filter becomes the input to the next filter in the chain. For example, the following command returns the first 20 lines of show asset output, removes any line containing the specified MAC address, and then further narrows the result to lines matching the specified regular expression:
Sensor> show asset | top 20 | exclude 00:50:56:97:c1:05 | regex 162\.159\.[0-9]+\.[0-9]+
Similarly, the following commands filter show aggregator output to lines containing a specified IP address, and then apply a second filter to that already-filtered result:
DataSensor> show aggregator | include 10.34.200.41
Primary Aggregator : 10.34.200.41 UP
Next hop : 10.34.200.41
DataSensor> show aggregator | include 10.34.200.41 | exclude Next hop
Primary Aggregator : 10.34.200.41 UP
If you chain an include filter with an exclude filter for the same text, no output is returned, since the exclude filter removes every line the include filter matched.
Some commands, such as show session, support additional field-specific include filters beyond the general-purpose filters described here. Refer to the Arguments for the "show" command in the Sensor CLI Access Window for details on filters specific to an individual command.
CLI filtering is not supported on Windows Server Sensors.
Running Long-Duration CLI Commands 
Some CLI commands can take several minutes to complete — for example, applying an OS package patch or collecting a full tech-support bundle. When you run one of the following commands from the Sensor CLI Access window (remote CLI), the sensor runs it as a background job instead of holding the connection open, so the command can no longer time out or block CLI sessions from other users:
-
show tech-support
-
exec cve check
-
exec cve patch
You can also manually detach any other command as a background job, in either the Sensor CLI Access window or the local CLI, using exec async. The syntax is as follows:
exec async <command>
For example:
Sensor> exec async show version
Job started: f8000c8591d34d88992590564073205a
Use 'show cli job f8000c85' to retrieve status and output.
Whenever a command runs as a background job — automatically, or because you used exec async — the CLI immediately returns a job ID instead of waiting for the command to finish. For example:
Sensor> exec cve patch all
Job started: bf5aba8c5b224007ad6f8f0cc79380b0
Use 'show cli job bf5aba8c' to retrieve status and output.
Use show cli job to check on and retrieve the results of background jobs. The syntax is as follows:
show cli job [<job-id> [status]]
-
show cli job – Lists recent jobs, with each job's ID, status, start time, duration, and the command that was run.
-
show cli job <job-id> – Shows the full status and output for one job. You can supply a unique prefix of the job ID instead of the full ID; if the prefix matches more than one job, the command lists the matching candidates instead.
-
show cli job <job-id> status – Shows just the status header for one job, without its output. This is useful when polling for completion from a script.
A job can have one of the following statuses:
-
running – The job is still in progress.
-
success – The job completed normally.
-
timeout – The job exceeded its allotted run time and was stopped.
-
aborted – The job was still running when the sensor's
aella_confservice restarted, and could not be resumed.
Keep the following in mind when working with background jobs:
-
The sensor keeps the 10 most recently run jobs; older jobs are pruned automatically.
-
Very large output is middle-truncated in the show cli job display (for example,
... [truncated, 3020 bytes removed] ...). The full, untruncated output is preserved on the sensor and is included automatically if you generate a phonehome/tech-support bundle. -
Background jobs do not persist across an
aella_confrestart. A job that was still running at restart time is marked aborted; re-run the command if you still need it. -
There is currently no way to cancel a running job.
This feature is available on Device Sensors and Linux Server Sensors. It is not currently available on Windows Server Sensors.
Arguments for the "show" command in the Sensor CLI Access Window
You can use the show command with any of the arguments listed and described in the table below.
Some of the show commands return a hardcoded maximum number of entries (for example, 128 for the show metalist command). In situations such as this, you can add the all parameter to ensure that the CLI returns all available entries in paged output. For example, the show metalist all command returns all entries across a set of pages, each of which has a maximum of 128 entries.
|
show command |
description |
|---|---|
| aflow | Shows AFIX AFlow Information. |
| aggregator | Shows information on Data Aggregators used by the sensor, if any. Also reports CM Controller IP address and connection status. |
|
asset |
Shows asset information. |
|
cm |
Shows CM Controller IP address and connection status. Include the The output reports the CM Controller the sensor is communicating with, the status of the last attempt, and the times of the last successful and last failed heartbeats, each with its message ID. For example:
The success and failure counts are reset each time the sensor's Include the The syntax is as follows: show cm probe [<port> | all] [<timeout>]
For example:
|
|
cli job |
Lists background CLI jobs, or shows the status and output of a specific job. Refer to Running Long-Duration CLI Commands for syntax and examples. |
|
customer_log |
Shows information on Customer Log Parsers, if applied. |
|
data-port-ip |
Shows MAC and IP address for sensor data port(s) (where data is ingested by the sensor). |
|
disk-monitor |
Shows actions being taken to limit disk usage. |
|
dns |
Shows the IP address of the sensor's DNS server. |
|
dpi |
Shows deep packet inspection information, including:
Note that the output for this command can be lengthy. Use the all parameter to see all entries in paged output (for example, show dpi all). You can include the
Use show dpi protocol custom metadata to list any user-defined DPI metadata entries that have been added with the set dpi protocol custom metadata command. |
|
drop |
Shows information on the number of packets dropped by the sensor broken out by Rx and Tx and interface. |
|
ethtool |
Modular Sensors only. Shows show ethtool <interface> [info | driver | stats | features | ring | coalesce | pause | channels]
For example:
|
|
flood |
Shows syn flood detection information. |
|
gateway |
Shows the IP address of the sensor's default gateway. |
|
grub |
Modular Sensors only. Shows the sensor's current GRUB For example:
This command is not available on other Device Sensor profiles (for example, security or network sensors) or on Server Sensors. |
|
history |
Shows a timestamped log of the most recent 25 CLI commands that executed actions. Show commands are excluded. |
|
hugepage_size |
Shows the |
|
ids |
Shows the status of the IDS PCAP capture feature on the Modular Sensor. When enabled, this feature captures trace files to the Sensor's storage when an IDS signature match is detected. The show ids output reports whether the IDS PCAP feature is enabled, and, if enabled, the filenames of any saved PCAP files so you can copy them off of the device for further analysis. This command only provides output when used with a virtual 6.0.0+ Modular Sensor with the IDS feature enabled in its Sensor Profile. Refer to Capturing Trace Files for IDS Signature Matches for more information on enabling and configuring the IDS PCAP feature. |
|
interface |
Shows equivalent output of the Linux ifconfig command with status, packets, drops, and bytes Rx and Tx broken out by interface. If a whitelist is configured for SSH connections to the Management port, allowed IP addresses/ranges appear in the show interface output for the management interface. |
|
ipfix |
Shows information on AFIX IPFIX classification engines. |
|
json |
Shows information on AFIX JSON metadata transfer. |
|
ldap-metadata |
Shows the state of the ldap-metadata feature is enabled (enabled or disabled). |
|
logcollector |
Shows information on the configuration of and records sent by different log collectors. |
|
logforwarder |
Shows information on logs received and forwarded, including the following:
You can include the Include the show logforwarder debug [<port>] Without a port, the command reports all of the following:
Supply a port to limit the Worker Load Distribution output to a single parser port. For example:
Interpret the Worker Load Distribution columns as follows:
Include the
For example (trimmed):
Include the Include the |
|
loglevel |
Shows the log level for different Stellar Cyber modules. Note that you can also set the log level for different modules from the CLI Access window using the set loglevel command; see the table below. |
|
maltrace |
Shows detailed statistics on malware sandbox usage, including the total number of IDS events broken out by the number of events buffered by the sensor and the number already sent to the DP. Note: When NFS file assembly is enabled, the output also shows the current NFS Assembly status. The output also reports the state of the sensor's IDS engine:
Capture Threads is the most reliable indicator that the sensor is actually inspecting traffic. The engine loads its ruleset before it starts capturing, so an engine can report a full set of loaded rules — and appear to be running — while no traffic is being inspected at all. A count of 0 means the engine is running but not capturing. Unavailable means the engine is still starting and is not yet a cause for concern. For example:
Include the The Active MPM line in the debug output identifies the multi-pattern matcher the engine is using.
The engine still inspects traffic in this state, but pattern matching is slower and uses more memory, which matters most on sensors with large rulesets or limited RAM. This is a property of the sensor's engine build rather than something you configure; contact Stellar Cyber Customer Success if you see this warning on a sensor where performance is a concern. |
|
meminfo |
Shows the sensor's memory usage, including a Hypervisor Memory section reporting whether the hypervisor is reclaiming memory from the sensor's virtual machine. When a virtualization host is short of memory, it can reclaim memory from a guest VM using a balloon driver. Reclaimed memory belongs to no process and does not appear in standard memory statistics, so a sensor can run short of memory — and terminate services such as
The Hypervisor Memory section appears only on sensors running under VMware, where the balloon driver reports this detail. On other platforms — including bare metal, KVM, and Proxmox — the section is omitted entirely, which does not by itself indicate that memory is or is not being reclaimed. If the Status reports that the hypervisor is reclaiming guest memory, reserve the sensor VM's memory on the hypervisor so that it cannot be taken back. Refer to Arguments for the "show" command in the Sensor CLI Access Window for a broader assessment of whether the host or the sensor itself is the constraint. Low Available Memory WarningWhen the memory available for new allocations falls to a small fraction of the sensor's usable memory, show meminfo reports a warning above the rest of the output. For example:
This warning means the sensor is close to the point at which the kernel terminates a process to recover memory. The second sentence appears when available memory has fallen below free memory, which indicates that most of what the sensor reports as free is held in reserve by the kernel and cannot actually be allocated. Treat the warning as a prompt to find out what is consuming memory. On a VMware sensor, check the Hypervisor Memory section first — memory reclaimed by the host is the most common cause and the least visible one. Hidden Fields in the Memory ReportThe detailed memory statistics end with a line reporting how many fields were hidden, for example |
|
memory |
Shows information on control and data plane memory availability and usage. |
|
metalist |
Shows information on the black list of metadata applications (traffic explicitly excluded from ingestion/evaluation in the sensor profile). Note that the output for this command can be lengthy. The following tips can help you see the entries that interest you:
|
|
mtu |
Shows the current Maximum Transmission Unit (MTU) setting for each interface on the sensor. |
|
mirror |
Shows information on configured traffic mirroring. |
|
module |
Modular Sensors only. Shows which modular features are enabled on a modular sensor (for example, log collector, aggregator, Tenable scanner, and so on), as well as its current CPU, RAM, and disk provisioning. |
|
module request |
Modular Sensors only. Shows the amount of CPU, RAM, and disk required to support different combinations of modular sensor features. |
|
netstat |
Modular Sensors only. Shows standard netstat output for the modular sensor's management port. The syntax is as follows:
|
|
nic |
Lists the NICs installed in the sensor along with their names, driver names, driver versions, firmware versions, and bus information. |
|
ntp |
Lists the configured NTP servers for this sensor in order of use. |
|
os |
Modular Sensors only. Shows the status of a kernel and package upgrade started with exec os update kernel-and-package. The syntax is as follows: show os kernel status Shows the current status of a kernel and package upgrade, including recent log output. If no upgrade has been started, reports whether the upgrade service has failed or was never started. show os kernel packages Shows a diff of package changes made by the last kernel and package upgrade, organized into three sections: packages that were updated (with old and new versions), packages newly installed as upgrade dependencies, and packages removed during the upgrade. |
|
packet |
Shows packet processing settings, including slicing and deduplication. |
|
pci ethernet |
Modular Sensors only. Lists the Ethernet PCI devices detected on the sensor, including each device's PCI bus address, current interface name, driver, and description. Use this command to identify interfaces before creating a persistent-naming rule. For example:
|
|
process |
Shows detailed information on internal AFIX process mapping, including NUMA register mapping. |
|
proxy |
Shows information on proxies configured for the sensor, if any. |
|
receiver |
Shows information on the configured data receiver for the sensor, including the following:
You can also use the expanded This command is supported for Windows Server Sensors as of the 6.2.0 release. |
|
ring |
Shows information on the AFIX ring. |
|
route |
Shows static route table entries. |
|
rules |
Shows information on configured maltrace rules. |
|
scan |
Shows detailed scan information on sensor. |
|
service |
Provides the service to AppID mapping for the sensor, including the NUMA register for each. Note that the output for this command can be lengthy. Use the all parameter to see all entries in paged output (for example, show service all). |
|
session |
Provides a session table for the sensor listing ongoing sessions and their NUMA mappings. The syntax is as follows: show session [detail | summary] [| include <field> <text>]
You can filter the output of show session by appending | include and one of the following fields:
The ip, src-ip, dst-ip, src-port, dst-port, protocol, and app-id filters all return up to 100 matching entries. This filtering is supported identically on Device Sensors and Server Sensors (agents). |
|
support |
Provides troubleshooting information for support purposes. The syntax is as follows: show support {upload | vm-resource-check [<seconds>]} show support uploadShows whether the sensor's support log bundle is reaching the CM Controller. The sensor uploads a diagnostic log bundle to the CM on a regular schedule. Use show support upload to confirm those uploads are succeeding — for example, when a proxy is unreachable or a bundle is rejected for being too large. The output reports the time and result of the last attempt, the time of the last success, the destination, and success and failure counts. For example:
The Last error line appears only when the most recent attempt failed, and reports the reason reported by the upload. The success and failure counts are reset each time the sensor's show support vm-resource-checkReports whether a slow or unstable sensor is being starved by its virtualization host or is saturating the resources it already has. These two conditions have opposite remedies, and cannot otherwise be told apart from inside the sensor. The command samples CPU steal, memory and I/O pressure, and host memory reclamation, then returns a verdict in JSON so you can paste it into a support ticket. Include a number of The
The
The The
The On VMware sensors, two additional fields report reclamation over time rather than at the moment you run the command:
These two fields matter because a host can reclaim memory in short bursts and then release it. A burst can last well under two minutes and leave The Each section also reports A field set to The checks used depend on the virtualization platform. On Hyper-V and Azure, CPU steal is not a reliable signal and is reported without driving the verdict; confirm host CPU on the hypervisor or in the portal instead. AWS and Azure do not overcommit memory, so they report a genuine clean rather than inconclusive. This command is available on Linux-based sensors. It is not available on Windows Server Sensors. Refer to Arguments for the "show" command in the Sensor CLI Access Window for the underlying hypervisor balloon detail on a single sensor. |
|
system |
Shows the status of key Stellar Cyber services on the sensor, including service uptime. If a given service is down, you can use the restart service <service_name> command to restart it. This command is supported for Windows Server Sensors as of the 6.2.0 release. |
|
task |
Shows information on JSON tasks requested on the sensor by the DP (for example, restarting an internal sensor service). |
|
tcpreset |
Shows information on tcpreset actions configured as part of scripts in ATH playbooks. The available commands are as follows:
|
|
tech-support |
Collects a tech-support diagnostic bundle for the sensor. When run from the Sensor CLI Access window, this command runs as a background job. Refer to Running Long-Duration CLI Commands for details on retrieving its output with show cli job. |
|
tenable |
Available if tenable nessus is enabled in the sensor profile. Shows status of the scanner. |
|
thread |
Shows information on CPU threads. |
|
time |
Shows system time. |
|
top |
Shows top resource usage by process. |
|
udev |
Modular Sensors only. Displays the sensor's active persistent (udev) interface-naming rules file. For example:
Refer to the set udev persistent-rule command below for details on creating and managing these rules. |
|
upgrade |
Shows information on upgrades for this sensor. The syntax is as follows: show upgrade Shows a history of upgrades along with log entries documenting their success or failure and details on the image applied. |
|
userapp |
Shows information on user-defined applications for this sensor. Note that the output for this command can be lengthy. The following tips can help you see the entries that interest you:
|
|
version |
Shows the sensor software version, license status, features, platform, basic configuration settings, and sensor up time. Note that values for some of these options can also be seen in the Sensor List, depending on which fields you add to the display. Note: The statistics displayed by the show version command can vary depending on your sensor type and version. The statistics listed below are current for the latest sensor software version. Note: Windows Server Sensors show only the following fields in their show version output – AOS Version, Product Model, License Status, Product EngineID, Internal ID, Running Mode, Running Feature, Aggregator, CM Controller,, Ctrl Plane Status, Platform OS, and Platform Type.
|
|
vtep |
Shows interfaces available for use as a VXLAN tunnel destination. |
|
vxlan |
Shows Information on VXLAN tunnel configuration. |
|
whitelist |
Shows information on whitelist configuration. |
Arguments for the "set" Command in the Sensor CLI Access Window
You can use the set command with any of the arguments listed and described in the table below. If you need help on command syntax, type set <command> ? to see the context-sensitive help.
|
set command |
description |
||||||
|---|---|---|---|---|---|---|---|
|
afix-ring-size |
Lets you configure the AFIX ring buffer size. AFIX is used on the sensor to extract flow and metadata information from sessions. Must be a specified as a power of 2 with a default size of 8192. |
||||||
|
aggregator |
Lets you specify the IP address of the aggregator for the sensor, if any. Specify the aggregator as an IP address. The sensor CLI accepts a fully qualified domain name or a hostname, but the sensor cannot then be authorized: authorization fails with |
||||||
|
cm |
Lets you set the IP address to reach the management interface of the Data Processor from the sensor or aggregator. For a DP cluster, this is the IP address of the DL-master's management interface. For a single DP deployment, this is simply the DP's management IP address. You can supply either an IP address or a hostname. Running this command from the Sensor CLI Access window can be useful when migrating sensors from one DP to another. Note: Using this command from the Sensor CLI Access window disconnects the sensor from its current DP. Because of this, you need to manually close the Sensor CLI Access window once the disconnection occurs. The syntax is as follows: set cm <cm_addr> [safe | force]
Stellar Cyber strongly recommends that you always use the |
||||||
|
data-port-ip |
Lets you assign an IP address to a data port on a sensor. For example, you can set the IP address of a data port using the following command: DataSensor> set data-port-ip 1 100.100.100.100/24 This command changes the data port IP configuration, setting the IP address of data port 1 to 100.100.100.100/24 |
||||||
|
dpi |
Adds a user-defined metadata attribute for the specified DPI protocol.The syntax is as follows: set dpi protocol custom metadata <proto> <attr> [<alias>] [<level>] Supported protocols and example attributes:
After adding entries, run restart service aella_flow for changes to take effect. A maximum of 100 user-defined entries are supported. Enabling additional metadata can increase ingestion volume and storage requirements. |
||||||
|
geneve |
Lets you configure options related to parsing of GENEVE-encapsulated traffic from Netskope's Cloud TAP stitcher. The Netskope Cloud TAP stitcher can be used to pull data stored by the Netskope Cloud TAP from AWS S3, stitching connections back together , performing TLS decryption, and exporting the traffic to a Stellar Cyber Modular Sensor in a GENEVE-encapsulated tunnel. As part of the configuration of the GENEVE tunnel, you can enable Netskope-proprietary Settings for GENEVE parsing on the sensor are preconfigured to match the Netskope defaults and only need to be changed in the rare situation where you have modified them on the Netskope side. You can configure the following options for this feature with set geneve <parameter> <value>:
|
||||||
|
grub |
Modular Sensors only. Lets you configure whether the sensor's ethernet interfaces use legacy eth-style names or predictable PCI bus names. The syntax is as follows: set grub net.ifnames <value>
This command updates the following files on the sensor:
Changes take effect only after you run restart system to reboot the sensor. Because this setting changes the interface names used elsewhere in this CLI (for example, with set interface and set mtu), run show interface after the reboot to confirm the new interface names before referencing them in other commands. This command is not available on other Device Sensor profiles (for example, standard or network sensors) or on Server Sensors. |
||||||
|
hostname |
Lets you specify the hostname for the sensor. You can also specify hostnames in the Sensor List. |
||||||
|
This is an advanced setting that you should only configure with the assistance of Stellar Cyber Customer Success team. Lets you change the The syntax is as follows:
The default is In Linux, a hugepage is a larger-than-normal memory page that helps reduce the overhead of managing memory. By mapping larger chunks of memory at once, hugepages can improve sensor performance In most deployments, you do not need to change the hugepage size from its default setting of |
|||||||
|
ids pcap |
Enables and configures the IDS PCAP capture feature on the Modular Sensor. When enabled, this feature captures trace files to the Sensor's storage when an IDS signature match is detected. Refer to Capturing Trace Files for IDS Signature Matches for more information on enabling and configuring the IDS PCAP feature. |
||||||
| interface <ifn_name> |
Lets you set IP configuration for a sensor interface by name, including its IP address, default gateway, and DNS server. Start by using show interface to get the name of the interface you want to configure. For example, to configure the management interface, you would use set interface management <arguments> This command is only supported on sensors running Ubuntu 22.04. The syntax is as follows: set interface <ifn_name>
Configuring an SSH Whitelist for the Management Port
|
||||||
|
ldap-metadata |
Enables structured handling for LDAP search and modify request fields. You must enable this option for generation of the Suspicious LDAP Search Request alert and its subtypes of Domain Trust Enumeration, All Object Enumeration, and Wildcard Query. You can turn off the feature with |
||||||
|
logforwarder |
Lets you configure the logforwarder feature. Use set logforwarder apply-custom-parser to force the Sensor log forwarder to redownload and apply custom parsers. This lets you refresh parser and configuration files without manual intervention, ensuring that updated or corrected parsers are immediately applied. If no custom parser exists or a parser is invalid, the command reports the condition and skips changes. This capability helps maintain parser consistency across tenants. |
||||||
|
logforwarder parser |
Lets you manage the list of active Log Forwarder parsers on the sensor. Use this command with Stellar Cyber personnel to reduce memory usage on hosts with limited resources by enabling only the parsers required for your environment. The syntax is as follows: set logforwarder parser add <parser> | remove <parser|all> | restore_default
After making changes, run restart service td-agent for the changes to take effect. Note that parser configuration changes may not persist across platform upgrades and can be overwritten by UI management. |
||||||
|
logforwarder tls-cipher-mode |
Lets you control which TLS 1.2 cipher suites the sensor's log forwarder ( The syntax is as follows: set logforwarder tls-cipher-mode {secure | legacy}
Use show logforwarder tls-cipher-mode to see the sensor's current setting. The sensor automatically restarts the |
||||||
|
loglevel |
Lets you set the log level for different modules. The syntax is as follows: set loglevel <service> <level>You can also set the loglevel timeout with the following command: set loglevel timeout <timeout value in minutes>Stellar Cyber recommends that you only change the log level for modules while working with Custom Success personnel. If you do decide to change log levels, a good way to start is by checking the current log levels with the show log level command. The default log level for all modules is info. The available modules (services) for which you can set the log level are as follows:
The available log levels are as follows, from least to most severe:
As an example, you can set the log level for aella_flow to warning with the following command:
When you specify a log level, Stellar Cyber records events of the specified severity and above. So, for example, if you specify a log level of error, only events with a severity of error and critical are logged. The log level setting also directly affects the quantity of events logged. For example, if you specify a log level of debug for a service, all events for that module are logged, regardless of severity. Log Level TipsKeep in mind the following tips when making changes to the log level:
|
||||||
|
maltrace |
Enables or disables NFS file assembly in Suricata for Sophos malware inspection. The syntax is as follows: set maltrace nfs-assembly {enable|disable} This feature is resource-intensive. Only enable when working with Stellar Cyber personnel. When enabled, Suricata reconstructs files transferred over NFS sessions and forwards them to Sophos for malware analysis. Supports NFSv3 and NFSv4; NFSv4 may not provide reliable file name metadata due to handle-based protocol operations. To ensure Suricata can detect the NFS application layer, start packet capture before the NFS client mounts the share. If capture begins after the mount, session establishment is not observed and application-layer detection may not initialize. This setting persists across sensor upgrades. |
||||||
|
malware_upload |
Lets you configure the malware upload feature. Refer to Forwarding Malware to an External HTTPS Server for details. |
||||||
|
mtu |
Lets you set the MTU for a specified interface. The syntax is as follows: set mtu <mtu_value> <ifn_name(s)> You can specify multiple interfaces in a single command. For example, the following command sets the MTU to 5500 bytes for eth0, eth1, and eth2: Sensor> set mtu 5500 interface eth0,eth1,eth2
|
||||||
| ntp |
Lets you specify an NTP server for the sensor. The syntax is as follows: set ntp <ntp server name or address>Specifying an NTP server does not configure a time zone for the sensor. During installation, the timezone for a sensor is automatically set to UTC+0. Since the logs for some security products may only include the local time without a timezone, Stellar Cyber recommends that you set the sensor timezone to the same timezone as your security product. Set the time zone for a sensor from the Sensor List. Refer also to Best Practices for NTP and Timezones . |
||||||
|
password |
Lets you change the password for the sensor. |
||||||
| proxy |
Lets you specify an HTTP proxy for the sensor. The syntax is as follows: set proxy http://[username:password@]<proxy_ip>[:<proxy_port>]Note: The CLI prevents you from entering non-printable characters as part of the username or password for the proxy, as well as the proxy itself. The set proxy command works differently depending on whether the sensor is operating in NG-SaaS mode or as an on-premises sensor:
|
||||||
|
receiver |
Lets you change the receiver configured for the sensor in its sensor profile. Configuring Event Log and FIM Timeouts for Windows Server Sensors
|
||||||
|
smb-meta-profile |
Lets you toggle the SMB Reduction feature. Enabling this option reduces the amount of metadata collected for SMB commands. This is especially helpful in increasing your compression ratio if your network has a great deal of SMB traffic. If you enable this, metadata is only collected for:
|
||||||
|
time |
Lets you set the system date and time in |
||||||
|
token |
Lets you apply a token to a sensor in a SaaS installation. The syntax is as follows:
|
||||||
|
udev persistent-rule |
Modular Sensors only. Lets you create persistent (udev) rules that keep the sensor's ethernet interface names stable across reboots and hardware changes. The syntax is as follows: set udev persistent-rule auto [pci | mac] [drivers <value>] Auto-generates a persistent-naming rule for every physical interface on the sensor.
set udev persistent-rule <interface> [keyword <mac-address>] [drivers <value>] Creates or updates a persistent-naming rule for a single interface, specified by its current interface name (for example,
Both forms accept an optional drivers <value> argument, which restricts the rule to interfaces using the specified driver (the default, Use show pci ethernet or show ethtool to identify interfaces before creating a rule, and show udev to see the sensor's current rules. For example:
Use unset udev persistent-rule <interface> to remove a rule for a specific interface. This command is not available on other Device Sensor profiles or on Server Sensors. |
Arguments for the "unset" Command in the Sensor CLI Access Window
You can use the unset command with any of the arguments listed and described in the table below. If you need help on command syntax, type unset <command> ? to see the context-sensitive help.
|
set command |
description |
|---|---|
|
aggregator |
Lets you remove aggregator settings from the sensor. |
|
dns |
Lets you remove DNS settings from the sensor. |
|
dpi |
Lets you remove a user-defined DPI metadata attribute for the specified protocol and attribute or removes all user-defined entries with the all argument. The syntax is as follows; unset dpi protocol custom metadata <proto> <attr> | all Run restart service aella_flow for changes to take effect. |
|
interface management ssh-whitelist |
Lets you remove the currently configured SSH whitelist for a sensor. |
|
ldap-metadata |
Lets you disable the Metadata Summarization feature. |
|
logforwarder |
Lets you unset logforwarder settings. |
|
malware_upload |
Lets you remove malware_upload settings. |
| ntp |
Lets you remove the configured NTP settings. |
|
password |
Lets you remove the configured password from the sensor, resetting it to its default of aella/changeme. |
| proxy |
Lets you remove the configured HTTP proxy for the sensor. |
|
receiver compression |
Lets you restore the compression settings for event and FIM logs from a Windows Server Sensor to the default level of 1. |
|
udev persistent-rule |
Modular Sensors only. Lets you remove a persistent (udev) interface-naming rule for the specified interface. The syntax is as follows: unset udev persistent-rule <interface> For example:
|
Arguments for the "exec" Command in the Sensor CLI Access Window 
The table below lists the exec commands available in the Sensor CLI Access window.
|
command |
description |
|---|---|
|
async |
Runs any command as a background job instead of waiting for it to finish. Refer to Running Long-Duration CLI Commands for syntax and examples. |
|
cve |
Runs the sensor's built-in CVE Checker to check the sensor's operating system and installed packages against a set of known CVEs, and lets you apply available remediations. The syntax is as follows: exec cve {check | summary | patch | update} [<argument>]
When run from the Sensor CLI Access window, exec cve check and exec cve patch run as background jobs. Refer to Running Long-Duration CLI Commands for details on retrieving their output with show cli job. Refer to Checking Device Sensors for Common Vulnerabilities and Exposures (CVEs) for the full list of supported CVEs, detailed command syntax, and sample output. |
|
os |
Lets you perform on-demand updates of operating system packages and the kernel on Modular Sensors, fixing OS-level vulnerabilities without affecting critical services, and lets you roll back those changes if needed. The syntax is as follows: exec os update kernel-and-package <kernel-version> [with-firmware]
Starts a background OS kernel and package upgrade on the sensor. The upgrade runs as a system service and continues even if the CLI session disconnects. Before proceeding, the command verifies internet connectivity, displays the number of pending package upgrades, and requires double confirmation. Critical sensor packages (suricata and squid) are held during the upgrade and released on completion. After the upgrade completes, reboot the Modular Sensor to apply kernel changes. Use show os kernel status to monitor progress and show os kernel packages to review what changed. Rolling Back a Kernel and Package Upgrade Use the following command to roll back a kernel and package upgrade: exec os update kernel packages rollback [<package> [<version>]] Rolls back package changes made by the last kernel and package upgrade. Double confirmation is required before the rollback proceeds.
This command is only available on Modular Sensors. |
|
task |
Lets you execute predefined tasks specified in JSON files. The JSON files specify actions such as downloading and executing scripts. Each tasks includes parameters and exception handling instructions. This command is only supported in the Sensor CLI Access window; it is not available in the local CLI. |
|
tcpreset-stop |
Lets you stop the tcpreset process for specified IP addresses. If you do not specify an IP address, all active tcpreset processes on the sensor are stopped. |
|
tenable reset uuid |
Regenerates the Tenable Nessus product UUID on the Modular SensorThis command helps prevent cloned Modular Sensor images from reusing the same Tenable Nessus UUID as the original sensor, reducing registration conflicts and simplifying redeployment from a golden image.The If the Tenable Nessus integration is not enabled on the sensor, this command returns an error. |
Upgrading Sensors from the CLI 
You can upgrade a sensor to a different software version directly from the sensor's CLI using the upgrade command. This is useful when a sensor cannot be upgraded from the Stellar Cyber user interface — for example, when it is unable to authenticate with its DP.
The syntax is as follows:
upgrade <version> [<package>]
The sensor retrieves the upgrade package from its DP. Supply just a version to let the sensor select the appropriate package automatically, or name a package explicitly to override that selection.
You cannot use this command to move a sensor to an older software version. If you specify a version older than the one the sensor is running, the sensor reports that the upgrade was aborted and takes no action. This applies to every sensor type. Reinstalling the version the sensor is already running is allowed on Linux-based sensors but is refused on Windows Server Sensors. Use the Arguments for the "show" command in the Sensor CLI Access Window command to confirm the installed version first.
-
upgrade <version> – Upgrades the sensor to the specified version, automatically selecting the appropriate package for the sensor's platform. For example,
upgrade 6.6.0. -
upgrade <version> <package> – Upgrades the sensor to the specified version using the package you name. For example,
upgrade 6.6.0 aellads_6.6.0_ubuntu2004-x64.tar.gz.
Upgrading from ACPS
If the sensor cannot obtain the package from its DP, you can have it download the package directly from Stellar Cyber's ACPS server instead. This form requires the credentials you use for ACPS downloads. The syntax is as follows:
upgrade <version> acps <account> <password> [<package>]
-
upgrade <version> acps <account> <password> – Upgrades the sensor to the specified version, automatically selecting the appropriate package from ACPS. For example,
upgrade 6.6.0 acps user password. -
upgrade <version> acps <account> <password> <package> – Upgrades the sensor to the specified version using the package you name from ACPS. For example,
upgrade 6.6.0 acps user password aellads_6.6.0_ubuntu2004-x64.tar.gz.
Contact Stellar Cyber support (support@stellarcyber.ai) for login credentials and a one-time password (also known as a License Key).
You type your ACPS credentials as part of the command. Stellar Cyber redacts them from the sensor's logs, but a shell running on the sensor records the command you typed. If you run this form from the sensor's local shell rather than the Sensor CLI Access window, clear the credentials from your shell history afterward.
If the account or password is not accepted, the sensor reports that the upgrade was aborted because the package source rejected the credentials, and no upgrade is attempted.
Use Arguments for the "show" command in the Sensor CLI Access Window after the upgrade completes to review the upgrade history and confirm that it succeeded.
Other Commands in the Sensor CLI Access Window
The table below lists other commands available in the Sensor CLI Access window.
|
command |
description |
|---|---|
|
restart service <service_name> |
Restarts the specified sensor service. To use this command, start by running the |
|
copy |
Sensor Management Commands in Local CLI
This section describes some useful sensor management commands that are only available in the sensor's local CLI.
Factory Resetting a Sensor 
Under some circumstances, you may want to reset a sensor to its factory settings before it was associated with a specific DP using either the set cm command or a token. You can do this with the factory_reset command.
Keep in mind the following when using the factory_reset command:
-
The factory_reset command is only available from the sensor's local CLI. It is not available from the DP in the Sensor CLI Access window.
-
The factory_reset command removes all configuration settings except basic network settings, allowing easy re-enrollment with a DP.
-
You must confirm the factory_reset when prompted before it is executed.
Uninstalling a Server Sensor 
You can uninstall both Linux and Windows Server Sensors from the sensor's local CLI with the uninstall command.
The uninstall command is not available for Modular Sensors.
