NDR Sensor CLI Guide

NDR Sensor 5.1.0

Overview

The NDR Sensor Command-Line Interface Reference describes how to use the NDR Sensor Command-Line Interface (CLI) and includes examples and command overviews.

Intended Audience

The information in this guide is written for experienced systems and network administrators who are familiar with virtual machine technology and virtual datacenter operations.

Introduction to the NDR Sensor CLI

Each NDR Sensor virtual appliance contains a command-line interface (CLI). The command syntax and output format of NDR Sensor commands are not guaranteed to be the same from release to release.

Logging In and Out of the CLI

Before you can run CLI commands, you must connect to an NDR Sensor virtual appliance. You can connect to the console or through SSH.

If you did not enable SSH while installing the appliance, you can use the set service ssh start-on-boot command to enable the SSH service.

CLI Command Output Modifiers

You can apply output modifiers on some NDR Sensor CLI commands which provides modified command output per usage.

For example, get files | sort, sorts the output of the get files command.

Entering | ? after a command shows applicable output modifiers command supports. If command does not support any output modifiers, an % Output modifiers are not supported for this command error message is displayed upon execution.

List of available modifiers:

count: Count number of specified entities

find: Only show lines that contain regex pattern

first: Show first N lines of output

ignore: Ignore lines that contain regex pattern

json: Show output in JSON format

last: Show last N lines of output

more: Show output one page at a time

sort: Sort command output

Note, Command Output modifier more is not supported in Windows Physical Server.

CLI Exit Codes

Following are different types of Exit Codes NDR Sensor CLI session can return on command execution:

Return Value	Type	Details
`0`	`CMD_EXECUTED`	Command Executed successfully
`1`	`CMD_UNEXPECTED_ERROR`	Command executed with unexpected error
`2`	`CMD_NOT_EXECUTED`	Unable to execute command
`3`	`CMD_EXECUTED_REQUESTED_EXIT`	Exit command executed successfully
`4`	`CMD_EXECUTED_WITH_ERROR_RESULT`	Command executed with error output
`10`	`CMD_SESSION_TIMEOUT`	CLI Session timed-out
`11`	`CMD_UNEXPECTED_EXCEPTION`	Command executed with unexpected exception
`12`	`CMD_UNSUPPORTED_MODE`	CLI request unsupported
`99`	`CLI_START_ERROR`	Unable to launch CLI

CLI Command Markers

As per the behaviour or functionality of command it might be marked with one or more icons as represent in legend below:

Icon	Flag	Details
	Output Modifiers Unsupported	Specifies whether usage of Command Output Modifiers is not supported on particular NDR Sensor-CLI command

The Command-Line Interface Reference describes how to use the Command-Line Interface (CLI) and includes examples and command overviews.