NDR Sensor Command-Line Interface Reference
Copyright © 2025 Broadcom Inc. and/or its subsidiaries. All Rights Reserved.
EN-002526-00
NDR Sensor Command-Line Interface Reference
NDR Sensor 5.1.0
Table of Contents
About This Book
Intended Audience
Introduction to the NDR Sensor CLI
Logging In and Out of the CLI
set service ssh start-on-boot command to enable
      the SSH service.
    NDR Sensor CLI Commands
| Option | Description | 
|---|---|
| <username> | Username of user | 
| Option | Description | 
|---|---|
| <username> | Username of user | 
| Option | Description | 
|---|---|
| <filepath> | Path of generated core dump file | 
| <url> | Remote file url (e.g. scp://username@ip_address/filepath/filename) | 
| Option | Description | 
|---|---|
| <filename> | Existing file argument | 
| <url> | Remote file url (e.g. scp://username@ip_address/filepath/filename) | 
file argument to specify a different destination file name.To specify IPv6 remote addresses, url server should be enclosed between square brackets.
| Option | Description | 
|---|---|
| <url> | Remote file url (e.g. scp://username@ip_address/filepath/filename) | 
| <filename> | Filename argument Allowed pattern: ^[^/ *;&|]+$ | 
| Option | Description | 
|---|---|
| <url> | Remote file url (e.g. scp://username@ip_address/filepath/filename) | 
| <thumbprint> | Remote host thumbprint | 
| Option | Description | 
|---|---|
| <filepath> | Path of generated core dump file | 
| Option | Description | 
|---|---|
| <filepattern> | Existing file or pattern argument | 
| Option | Description | 
|---|---|
| <management-interface> | Management interface argument. | 
| Option | Description | 
|---|---|
| <ip-address> | Name server IP v4 or v6 address argument | 
| Option | Description | 
|---|---|
| <hostname-or-ip-address> | A hostname or IP address | 
| Option | Description | 
|---|---|
| <prefix-ipv46> | CIDR notation argument for IPv4/IPv6 address | 
| <ip-route-metric> | IP route metric argument Allowed pattern: ^[0-9]+$ | 
| <gateway-ipv46> | Gateway IPv4/IPv6 address argument | 
| <interface-name> | Configurable network interface argument | 
| Option | Description | 
|---|---|
| <domain> | Search domain argument | 
| Option | Description | 
|---|---|
| <sniffing-interface> | Sniffing interface argument. | 
| Option | Description | 
|---|---|
| <sniffing-interface> | Sniffing interface argument. | 
| Option | Description | 
|---|---|
| <hostname-or-ip-address[:port]> | A hostname or IPv4 or IPv6 address with optional port delimited by a colon | 
| Option | Description | 
|---|---|
| <username> | Username of user | 
| <key-label> | Unique label for SSH key | 
| <password> | Password of user | 
| Option | Description | 
|---|---|
| <certificate-entity> | Entity for which the certificate will be updated. Allowed values: SENSOR, SSP-INGRESS, SSP-KAFKA | 
To show all command history set size to 0.
| Option | Description | 
|---|---|
| <filename> | Existing file argument | 
| Option | Description | 
|---|---|
| <filename> | Existing file argument | 
| Option | Description | 
|---|---|
| <interface-name> | Network interface argument | 
| Option | Description | 
|---|---|
| <filename> | Log file name | 
| Option | Description | 
|---|---|
| <filename> | Log file name | 
| Option | Description | 
|---|---|
| <prefix-ipv46> | CIDR notation argument for IPv4/IPv6 address | 
| Option | Description | 
|---|---|
| <ip-address-type> | IP address type argument Allowed values: ipv4, ipv6 | 
| Option | Description | 
|---|---|
| <service-name> | Node service argument | 
| Option | Description | 
|---|---|
| <component> | Sensor uploading service logging component argument. | 
| Option | Description | 
|---|---|
| <component> | sniffing service logging component argument. | 
file argument to save the bundle to a file with the specified file name in the file store. This support bundle does not contain core or audit log files. To include those files, specify the all argument. Core files contain system information and all information stored in memory at the time of the dump (this may include confidential, sensitive or personal information such as passwords and encryption keys, if they are being processed in memory at that time). If you choose to send the support bundle to VMware, it will be processed in accordance with VMware's standard processes and policies, to provide you with support, fix problems and improve the product and services.
| Option | Description | 
|---|---|
| <filename> | Name of file to generate, for example support-bundle.tgz Allowed pattern: ^[^/ *;&|]+$ | 
| Option | Description | 
|---|---|
| <bundle-name> | Name of NDR Sensor upgrade bundle in the file store | 
| <playbook-file> | Name of Playbook file to use | 
| Option | Description | 
|---|---|
| <username> | Username of user | 
| Option | Description | 
|---|---|
| <username> | Username of user | 
| Option | Description | 
|---|---|
| <username> | Username of user | 
| Option | Description | 
|---|---|
| <hostname-or-ip-address> | A hostname or IP address | 
repeat argument to specify how many packets to transmit.| Option | Description | 
|---|---|
| <hostname-or-ip-address> | A hostname or IP address | 
| <number> | Number argument Allowed pattern: ^[0-9]+$ | 
force argument, the system will reboot immediately without prompting for confirmation.
| Option | Description | 
|---|---|
| <registration-manifest> | Registration token created from Security Services Platform (SSP) | 
| <sensor-name-string-arg> | Sensor name (maximum 64 chars consisting of uppercase letters (A-Z),
lowercase letters (a-z), numbers (0-9), and special characters _:.- Allowed pattern: ^([A-Za-z0-9_:.-]{1,64})$ | 
| Option | Description | 
|---|---|
| <service-name> | Node restartable service argument | 
start upgrade-bundle <bundle-name> playbook <playbook-file> and the system was rebooted.| Option | Description | 
|---|---|
| <bundle-name> | Name of NDR Sensor upgrade bundle in the file store | 
| Option | Description | 
|---|---|
| <lockout-period> | Lockout period in seconds | 
| Option | Description | 
|---|---|
| <auth-failures> | Number of authentication failures to trigger lockout | 
| Option | Description | 
|---|---|
| <password-length> | Password length argument | 
| Option | Description | 
|---|---|
| <certificate-entity> | Entity for which the certificate will be updated. Allowed values: SSP-INGRESS, SSP-KAFKA | 
| <x509-encoded-certificate-text> | X509 Encoded certificate argument Allowed pattern: ^(-{5}BEGIN CERTIFICATE-{5}(.+?)-{5}END CERTIFICATE-{5})+$ | 
| Option | Description | 
|---|---|
| <datetime-arg> | DateTime stamp status argument Allowed values: disable, enable | 
| Option | Description | 
|---|---|
| <timeout> | Number of seconds before timeout or 0 to disable timeout | 
Note, disabling config may consume higher disk space and can cause disk space exhaustion.
| Option | Description | 
|---|---|
| <core-dump-limit> | Core dump numeric argument (0-4) | 
Note, disabling config may consume higher disk space and can cause disk space exhaustion.
| Option | Description | 
|---|---|
| <core-dump-threshold-freq> | Threshold value in the range of 0 - 1200 seconds. | 
Note, disabling config may consume higher disk space and can cause disk space exhaustion.
| Option | Description | 
|---|---|
| <process-name> | Core dump process name | 
| <core-dump-limit> | Core dump numeric argument (0-4) | 
| Option | Description | 
|---|---|
| <grub-menu-timeout> | GRUB menu timeout in seconds | 
| Option | Description | 
|---|---|
| <grub-username> | Username of GRUB user | 
| <grub-password> | Password for the GRUB user | 
| Option | Description | 
|---|---|
| <history-size> | Integer value for history size or 0 to display all commands | 
| Option | Description | 
|---|---|
| <hostname> | System hostname argument | 
| Option | Description | 
|---|---|
| <interface-name> | Configurable network interface argument | 
gateway argument, or set a route using the set route command. IPv6 based functionality is not supported in this release.| Option | Description | 
|---|---|
| <interface-name> | Configurable network interface argument | 
| <prefix-ipv46> | CIDR notation argument for IPv4/IPv6 address | 
| <gateway-ipv46> | Gateway IPv4/IPv6 address argument | 
| Option | Description | 
|---|---|
| <available-for-management-interface> | Network interfaces available for management interface configuration. | 
| Option | Description | 
|---|---|
| <available-for-management-interface> | Network interfaces available for management interface configuration. | 
| <available-for-sniffing-interface> | Network interfaces available for sniffing interface configuration. | 
| <sniffing-mode> | Sniffing mode argument. Allowed values: NATIVE, COMPAT | 
| <sniffing-mtu> | MTU for sniffing interface (NATIVE mode MTU range 2048-9000, COMPAT mode MTU range 1400-1500) | 
| <sniffing-if-prefix-ipv46-or-skip> | CIDR notation argument for IPv4/IPv6 address or use "skip" to skip setting (Loopback, unspecified and broadcast addresses are not allowed for sniffing interface IPs) | 
| <hostname-or-skip> | System hostname argument or use "skip" to skip setting | 
| <ip-address-or-skip> | Network IP address argument or use "skip" to skip setting | 
| <hostname-or-ip-address-or-skip> | A hostname or IP address or use "skip" to skip setting | 
| <timezone-or-skip> | Timezone (e.g. UTC, America/New_York) or use "skip" to skip setting | 
| <domain-or-skip> | Search domain argument or use "skip" to skip setting | 
| Option | Description | 
|---|---|
| <ip-address> | Name server IP v4 or v6 address argument | 
| Option | Description | 
|---|---|
| <hostname-or-ip-address> | A hostname or IP address | 
- Minimum password length: minimum number of characters expected in password; user can not set their password of length lesser than this parameter. Default: 12, Minimum: 8, Maximum: 128
- Maximum password length: maximum number of characters allowed in password; user can not set their password of length greater than this parameter. Default: 128, Minimum: 8, Maximum: 128
- Lower characters: number of lower case characters (a..z) expected in user password.
  N < 0, to set minimum credit for having lower case character in the new password, i.e. this is the minimum number of lower case characters that must be met for a new password. N > 0, to set maximum credit for having lower case character in the new password, i.e. per occurrence of lower case character in password will attribute additional credit of +1 towards meeting the current minimum password length value up to N lower case characters. N = 0, to disable the policy check. Default: -1, Minimum: -128, Maximum: 128
- Upper characters: number of upper case characters (A..Z) expected in user password.
  N < 0, to set minimum credit for having upper case character in the new password, i.e. this is the minimum number of upper case characters that must be met for a new password. N > 0, to set maximum credit for having upper case characters in the new password, i.e. per occurrence of upper case character in password will attribute additional credit of +1 towards meeting the current minimum password length value up to N upper case characters. N = 0, to disable the policy check. Default: -1, Minimum: -128, Maximum: 128
- Numeric characters: number of digits (0..9) expected in user password.
  N < 0, to set minimum credit for having digits in the new password, i.e. this is the minimum number of digits that must be met for a new password. N > 0, to set maximum credit for having digits in the new password, i.e. per occurrence of digit in password will attribute additional credit of +1 towards meeting the current minimum password length value up to N digits. N = 0, to disable the policy check. Default: -1, Minimum: -128, Maximum: 128
- Special characters: number of special characters (!@#$&*..) expected in user password.
  N < 0, to set minimum credit for having special characters in the new password, i.e. this is the minimum number of special characters that must be met for a new password. N > 0, to set maximum credit for having special characters in the new password, i.e. per occurrence of special case character in password will attribute additional credit of +1 towards meeting the current minimum password length value up to N special case characters.. N = 0, to disable the policy check. Default: -1, Minimum: -128, Maximum: 128
- Minimum unique characters: number of character changes in the new password that differentiate it from the old password. To disable the check, value should be set to 0. Default: 0, Minimum: 0, Maximum: 128
- Allowed similar consecutive characters: reject passwords which contain more than N same consecutive characters. To disable the check, value should be set to 0. Default: 0, Minimum: 0, Maximum: 128
- Allowed monotonic sequence: reject passwords which contain more than N monotonic character sequences. Monotonic sequences can be '12345' or 'fedcb'. To disable the check, value should be set to 0. Default: 0, Minimum: 0, Maximum: 128
- Hash algorithm: sets hash/cryptographic algorithm type for new passwords. Default: sha512. Enum: [ sha512, sha256 ]
- Password remembrance: limit using a password that was used in past; users can not set the same password within the N generations. To disable the check, value should be set to 0. Default: 0, Minimum: 0
Note, passwords less than 8 characters are never allowed.
prefix value of 0.0.0.0/0 for IPv4 and ::/0 for IPv6. Default value for the IPv6 route metric is 1024.| Option | Description | 
|---|---|
| <prefix-ipv46> | CIDR notation argument for IPv4/IPv6 address | 
| <ip-route-metric> | IP route metric argument Allowed pattern: ^[0-9]+$ | 
| <gateway-ipv46> | Gateway IPv4/IPv6 address argument | 
| <interface-name> | Configurable network interface argument | 
| Option | Description | 
|---|---|
| <domain> | Search domain argument | 
| Option | Description | 
|---|---|
| <level> | Sensor logging level argument. Allowed values: critical, error, warn, info, debug | 
| Option | Description | 
|---|---|
| <level> | Sensor logging level argument. Allowed values: critical, error, warn, info, debug | 
| Option | Description | 
|---|---|
| <level> | Sensor logging level argument. Allowed values: critical, error, warn, info, debug | 
| Option | Description | 
|---|---|
| <level> | Sensor logging level argument. Allowed values: off, fatal, error, warn, info, debug, trace | 
| Option | Description | 
|---|---|
| <component> | Sensor uploading service logging component argument. | 
| <level> | Sensor logging level argument. Allowed values: critical, error, warn, info, debug | 
| Option | Description | 
|---|---|
| <level> | Sensor logging level argument. Allowed values: critical, error, warn, info, debug | 
| Option | Description | 
|---|---|
| <level> | Sensor logging level argument. Allowed values: critical, error, warn, info, debug | 
| Option | Description | 
|---|---|
| <component> | sniffing service logging component argument. | 
| <level> | Sensor logging level argument. Allowed values: critical, error, warn, info, debug | 
| Option | Description | 
|---|---|
| <available-for-sniffing-interface> | Network interfaces available for sniffing interface configuration. | 
| <sniffing-mode> | Sniffing mode argument. Allowed values: NATIVE, COMPAT | 
| <sniffing-mtu> | MTU for sniffing interface (NATIVE mode MTU range 2048-9000, COMPAT mode MTU range 1400-1500) | 
| Option | Description | 
|---|---|
| <sniffing-interface> | Sniffing interface argument. | 
| <sniffing-if-prefix-ipv46> | CIDR notation argument for IPv4/IPv6 address. (Loopback, unspecified and broadcast addresses are not allowed for sniffing interface IPs) | 
| Option | Description | 
|---|---|
| <timezone> | Timezone (e.g. UTC, America/New_York, Asia/Tokyo, Europe/Zurich) | 
| Option | Description | 
|---|---|
| <username> | Username of user | 
| <password-expiration-days> | Number of days password valid after change (1 - 9999) | 
| Option | Description | 
|---|---|
| <username> | Username of user | 
| <password-expiration-warn-days> | Number of days password warn messages before change (1 - 9999) | 
| Option | Description | 
|---|---|
| <username> | Username of user | 
| <new-username> | Username of user | 
| Option | Description | 
|---|---|
| <username> | Username of user | 
| <password> | Password of user | 
| <old-password> | Current password of user | 
| Option | Description | 
|---|---|
| <username> | Username of user | 
| <key-label> | Unique label for SSH key | 
| <key-type> | SSH key type Allowed values: ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, ecdsa-sha2-nistp521, ssh-dss, ssh-ed25519, ssh-rsa | 
| <key-value> | SSH key value | 
| <password> | Password of user | 
force argument, the system will shut down immediately without prompting for confirmation.
| Option | Description | 
|---|---|
| <service-name> | Node startable and stoppable service argument | 
| Option | Description | 
|---|---|
| <bundle-name> | Name of NDR Sensor upgrade bundle in the file store | 
| <playbook-file> | Name of Playbook file to use | 
| Option | Description | 
|---|---|
| <service-name> | Node startable and stoppable service argument | 
| Option | Description | 
|---|---|
| <hostname-or-ip-address> | A hostname or IP address | 
| Option | Description | 
|---|---|
| <bundle-name> | Name of NDR Sensor upgrade bundle in the file store | 
