Service Gateway 2.0 CLI Commands

A list of available CLI commands for managing the Service Gateway virtual appliance.

To access the CLI, connect to VMware ESXi (either directly or through SSH) and open the Service Gateway virtual appliance. Log on to the CLI with your account credentials.

Note:

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

To view basic information of the Service Gateway, such as network settings and service status, run the show command. For example, use show ipv4 address to check the network address. For a list of available commands, type show and then press the ? key.

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 #. The following tables list out the administrative commands you can use to manage the Service Gateway virtual appliance.

Table 1. Basic Commands
Command Syntax Description

configure endpoint

configure endpoint <hostname>

Configure the endpoint name

<hostname>: Endpoint name or FQDN

configure time

configure time <HH:MI:SS>

Configure the time for the Service Gateway virtual appliance

configure network

configure network primary ipv4.static <interface> <ip_cidr> <gateway> <dns1> [dns2] [cni]

Configure static IPv4 network settings for the primary network interface

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

<ip_cidr>: IPv4 address of the network interface in CIDR notation

<gateway>: Gateway router address

<dns1>: Primary DNS server address

[dns2]: Secondary DNS server address

[cni]: Internal network address pool (IP address ending in .0.0)

configure ntp

configure ntp <ntp_addr>

Configure the NTP server

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

configure password

configure password

Configure the account password

configure proxy

configure proxy delete

Delete proxy settings

configure proxy set http <addr>

Configure the proxy server for the Service Gateway virtual appliance

<addr>: Specify proxy settings as follows:

  • <ADDRESS>:<PORT>: IP address and port of proxy

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

configure storage

configure storage add <devname>

Add a physical storage device

<devname>: Physical storage device name (/dev/sdx)

configure storage extend data [size]

Extend data file system storage

[size]: Storage size for extension in GB. If not specified, all free space available on device is used.

configure storage extend image [size]

Extend image file system storage

[size]: Storage size for extension in GB. If not specified, all free space available on device is used.

configure storage status

Show storage status

configure verify

configure verify cli

Verify the command line status of the Service Gateway virtual appliance

configure verify dns

Verify DNS server configuration

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

configure verify images

Verify the Service Gateway virtual appliance images

configure verify iot

Verify the AWS server IOT settings

configure verify ntp

Verify NTP server settings

configure verify os

Verify the operating system status of the Service Gateway virtual appliance

configure verify plat

Verify the platform status of the Service Gateway virtual appliance

configure verify curl <URL>

Verify the HTTP request status of the Service Gateway virtual appliance

connect

connect

Test connection to Service Gateway Management

exit

exit

Exit the CLI

help

help

Display the CLI syntax

history

history [limit]

Display the session's command history

[limit]: The number of CLI commands to display

log collect

log collect

Collect Service Gateway debugging data for troubleshooting

ping

ping <address>

Check the connection to a specific address

reboot

reboot [time]

Restart the Service Gateway after a specified delay or immediately

[time]: Delay in minutes

register

register <regiatration_token>

Register the Service Gateway to Trend Micro Vision One

shutdown

shutdown [time]

Shut down the Service Gateway after a specified delay or immediately

[time]: Delay in minutes

Table 2. Configure Commands for Multiple Network Interfaces
Command Syntax Description

configure network

configure network additional ipv4.delete

Delete IPv4 network settings for the additional network interface

configure network additional ipv4.static <interface> <ip_cidr> <gateway> <dns1> [dns2]

Configure static IPv4 network settings for the additional network interface

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

<ip_cidr>: IPv4 address of the network interface in CIDR notation

<gateway>: Gateway router address

<dns1>: Primary DNS server address

[dns2]: Secondary DNS server address

configure network primary ipv4.static <interface> <ip_cidr> <gateway> <dns1> [dns2] [cni]

Configure static IPv4 network settings for the primary network interface

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

<ip_cidr>: IPv4 address of the network interface in CIDR notation

<gateway>: Gateway router address

<dns1>: Primary DNS server address

[dns2]: Secondary DNS server address

[cni]: Internal network address pool (IP address ending in .0.0)

configure network additional ipv6.delete

Delete IPv6 network settings for the additional network interface

configure network additional ipv6.static <ipl> <gateway> <dns1> [dns2]

Configure static IPv6 network settings for the additional network interface

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

<ipl>: IPv6 address of the network interface in CIDR notation

<gateway>: Gateway router address

<dns1>: Primary DNS server address

[dns2]: Secondary DNS server address

configure network primary ipv6.delete

Delete IPv6 network settings for the primary network interface

configure network primary ipv6.static <ipl> <gateway> <dns1> [dns2]

Configure static IPv6 network settings for the primary network interface

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

<ipl>: IPv6 address of the network interface in CIDR notation

<gateway>: Gateway router address

<dns1>: Primary DNS server address

[dns2]: Secondary DNS server address

configure route

configure route additional ipv4.add <destination> <gateway>

Add a new IPv4 route for the additional network interface

<destination>: Destination IPv4 addresses in CIDR notation

<gateway>: IPv4 address of the gateway

configure route additional ipv4.delete <destination> <gateway>

Delete an IPv4 route of the additional network interface

<destination>: Destination IPv4 addresses in CIDR notation

<gateway>: IPv4 address of the gateway

configure route primary ipv4.add <destination> <gateway>

Add a new IPv4 route for the primary network interface

<destination>: Destination IPv4 addresses in CIDR notation

<gateway>: IPv4 address of the gateway

configure route primary ipv4.delete <destination> <gateway>

Delete an IPv4 route of the primary network interface

<destination>: Destination IPv4 addresses in CIDR notation

<gateway>: IPv4 address of the gateway

configure route ipv4.default additional <gateway>

Configure the additional network interface as the default IPv4 route for the Service Gateway virtual appliance

<gateway>: IPv4 address of the gateway

configure route ipv4.default primary <gateway>

Configure the primary network interface as the default IPv4 route for the Service Gateway virtual appliance

<gateway>: IPv4 address of the gateway

configure route additional ipv6.add <destination> <gateway>

Add a new IPv6 route for the additional network interface

<destination>: Destination IPv4 addresses in CIDR notation

<gateway>: IPv6 address of the gateway

configure route additional ipv6.delete <destination> <gateway>

Delete an IPv6 route of the additional network interface

<destination>: Destination IPv4 addresses in CIDR notation

<gateway>: IPv6 address of the gateway

configure route primary ipv6.add <destination> <gateway>

Add a new IPv6 route for the primary network interface

<destination>: Destination IPv6 addresses in CIDR notation

<gateway>: IPv6 address of the gateway

configure route primary ipv6.delete <destination> <gateway>

Delete an IPv6 route of the primary network interface

<destination>: Destination IPv6 addresses in CIDR notation

<gateway>: IPv6 address of the gateway

configure route ipv6.default additional <gateway>

Configure the additional network interface as the default IPv6 route for the Service Gateway virtual appliance

<gateway>: IPv6 address of the gateway

configure route ipv6.default primary <gateway>

Configure the primary network interface as the default IPv6 route for the Service Gateway virtual appliance

<gateway>: IPv6 address of the gateway