Virtual Network Sensor CLI Commands

A list of available CLI commands for managing the Virtual Network Sensor.

Connect to VMware ESXi (either directly or through SSH) or VMware vCenter, and open the Virtual Network Sensor. To sign on with the default admin account, type admin for the user name and password.

To view a list of tasks you can perform and enable administrative commands, run the enable command. Enabling administrative commands changes the command prompt from > to #.

To view basic information of the Virtual Network Sensor, such as network settings and service status, run the show command. For a list of available commands, type show ?.

The following tables list out the basic and administrative commands you can use to manage the Virtual Network Sensor.

Important:
  • Make sure you disable the Scroll Lock key on your keyboard when using HyperTerminal.

  • Arguments with angle brackets (< >) are required. Arguments with square brackets ([ ]) are optional.

Table 1. Basic Commands
Command Syntax Description

enable

enable

Enable administrative commands

For details, see Administrative Commands.

exit

exit

Exit the CLI

help

help

Display the CLI syntax

show

show hostname

Show host name information

show interface <interface>

Show network interface information

<interface>: Name of NIC interface (for example, eth0)

show network management

Show network configuration

Note:

If the network is configured incorrectly, you can use the configure network primary ipv4.static command to reconfigure the settings.

show ntp

Show NTP information

show proxy

Show proxy information

show system

Show the Company ID

Note:
  • If the head of the command line is #, execute the exit command first.

  • If no Company ID is shown, contact your support provider to obtain a registration token.

show time

Show time and date information

show traffic

Show real time date traffic

Run the enable command to enable and perform administrative commands.

Table 2. Administrative Commands
Command Syntax Description

configure

configure hostname <hostname>

Configure the host name

<hostname>: Host name or FQDN

configure network primary ipv4.static <ip> <submask> <gateway> <dns1> [dns2]

Configure static IPv4 network settings for the primary network interface

<ip>: IPv4 address of the network interface

<submask>: Submask of IPv4

<gateway>: Gateway router address

<dns1>: Primary DNS server address

[dns2]: Secondary DNS server address (optional)

configure network primary ipv4.dhcp

Configure IPv4 network settings to DHCP

configure ntp <ntp_addr>

Configure the NTP server

<ntp_addr>: FQDN or IPv4 address of the NTP server

configure password

Configure the administrator account password

configure proxy delete

Delete proxy settings

configure proxy set http <addr>

Configure the proxy server for the Virtual Network Sensor

<addr>: Proxy server address

<ADDRESS>:<PORT>: Proxy server IP address and port

<USER>:<PASSWORD>@<ADDRESS>:<PORT>: Account credentials with the proxy server IP address and port

configure time <HH:MI:SS> [YYYY-MM-DD]

Configure the time and date for the Virtual Network Sensor

<HH:MI:SS>: Time in hour, minute, and second format

[YYYY-MM-DD]: (Optional) Date in year, month, and day format

configure verify dns

Verify DNS server configuration

[domain]: Domain used to verify DNS server (default: www.trendmicro.com)

configure interface <interface_name>

Enter the interface configuration mode to set up a network interface of the Virtual Network Sensor

<interface_name>: Name of the network interface (for example, eth0)

For details about the available commands in the interface configuration mode, see Interface Configuration Mode Commands.

connect

connect

Test connection to Trend Vision One

exit

exit

Exit administrative commands

help

help

Display the CLI syntax

log

log export [date_list]

Collect Virtual Network Sensor debugging data for troubleshooting

[date_list]: The log for a specific date list

log list-level

Display the log level of each component

log reset-level

Reset all log levels

log set-level <level> <indexes>

Set specific components to specific log levels

<level>: Target level (debug, info, warn, error, fatal, disable)

<indexes>: Target indexes (found in list-level)

ping

ping <address>

Check the connection to a specific address

Note:

Execute ping trendmicro.com to check the external network connection. If the ping fails, check the IP settings and firewall settings.

reboot

reboot

Restart Virtual Network Sensor immediately

register

register [registration_token]

Register Virtual Network Sensor to Trend Vision One

Note: You can execute the register <registration_token> command if your Company ID is empty initially, or the register command if your Company ID is displayed.

shutdown

shutdown

Shut down Virtual Network Sensor immediately

Run the enable command and then the configure interface command to enter and perform network interface configuration commands.

Table 3. Network Interface Configuration Mode Commands

Command

Syntax

Description

ip-encap

ip-encap enable <IPv4_address>

Enable Encapsulated Remote Mirroring on a network interface and assign an IPv4 address to the network interface

<IPv4_address>: IPv4 address to be assigned to the network interface

Encapsulated Remote Mirroring allows Virtual Network Sensor to receive network traffic through a supported network interface.

Note:

Encapsulated Remote Mirroring is supported on data ports only.

ip-encap disable

Disable Encapsulated Remote Mirroring on the network interface

mtu

mtu <int>

Configure the Maximum Transmission Unit (MTU) for a network interface

<int>: A positive integer greater than 0