Trend Micro TippingPoint
TM

TM

Security Management System (SMS)
Command Line Interface ReferencePrivacy and Personal Data Collection Disclosure
Certain features available in Trend Micro products collect and send feedback regarding product usage and detection information to Trend Micro.
Some of this data is considered personal in certain jurisdictions and under certain regulations. If you do not want Trend Micro to collect personaldata, you must ensure that you disable the related features.
The following link outlines the types of data that the Security Management System collects and provides detailed instructions on how to disable thespecific features that feedback the information.
https://success.trendmicro.com/data-collection-disclosure
Data collected by Trend Micro is subject to the conditions stated in the Trend Micro Privacy Policy:
https://www.trendmicro.com/en_us/about/legal/privacy-policy-product.html

Legal Notice© Copyright 2021 Trend Micro Incorporated. All rights reserved.
Trend Micro, the Trend Micro t-ball logo, TippingPoint, and Digital Vaccine are trademarks or registered trademarks of Trend Micro Incorporated.
All other product or company names may be trademarks or registered trademarks of their owners.
Publication: November 2021

CLI Reference
The following sections help you get started with the CLI Reference:
Using the Command Line Interface (CLI)
SMS command reference
SMS attributes and objects

Using the Command Line Interface (CLI)
The command line interface (CLI) can be used to configure many aspects of the Trend Micro™ TippingPoint™
SMS. It includes wizards, high level commands, and low level commands.
Note
To use the SMS CLI, you must be logged in with an account that has SuperUser rights or the Access SMS CLI
capability enabled (on the SMS, go to Admin > Authentication and Authorization > Roles > Capabilities > Admin).

This section includes the following topics:- Explains the general format of the CLI commands.
- Returns documentation about the specified command, object, or attribute.

Usage
Most SMS commands consist of the following elements:
command — the name of the command you want to issue
object — the name of a collection of related attributes (attribs)
attrib — the name of a data variable or parameter on which you want to run the command[=value] — optional syntax you can use with the set command and other writable commands to define thevalue of the attrib you specify. If you do not use this syntax, the system goes into interactive mode andprompts you for the value. See Command types for more information about interactive commands.
Note
To clear the value of any attribute type a period (.) after the equal sign (=) or when prompted.

These elements are case-sensitive. You can use any of the following syntax to run an SMS command:commandcommand objectcommand object.attrib
command object.attrib=value

Other SMS commands use a syntax similar to standard UNIX commands, as shown in the following example:
command -option value

1

SMS Command Line Interface Reference

Command types
SMS commands are either read, write, or read and write. In addition, commands are either interactive, noninteractive, or might support both options.
•Interactive commands — automatically prompt you for attribute values if you use the appropriate syntax.
Interactive commands also provide you with the current values of their attributes.

•

Non-interactive commands — are either read-only or require you to specify the values you want to set.
For example, the get command is non-interactive because it is read-only. As another example, the datecommand is non-interactive. If you want to set the date, you must type date value.

Interactive mode syntax
You can use any of the following syntax options to initiate an interactive CLI command:command — If you type the command name, the CLI prompts you to set values for all attribs associated withthat command.
command object — If you specify the object of a particular command, the CLI prompts you to set values for
all attribs associated with that object.
command object.attrib — If you specify an object and attribute of a particular command, the CLI prompts

you to set the value of the attribute you specified.

To see an example of how to use the set command, see Set all system information using interactive mode.
Set all system information using interactive mode

Following is an example of the set command in interactive mode. Items in bold are typed by the user. Items
in brackets ([ ]) indicate the current value of the attribute specified.
Procedure
1.

Type the following command: set sys
The system returns prompts for information. Default values are listed in brackets. To use the default
value, press Enter.

2.

The system prompts you to set the value for the contact attribute: System contact(sys.contact=[Customer Contact]) = Brit

3.

Type a value for the location attribute and press Enter: System location (sys.location=[First

4.

Type a value for the name attribute and press Enter: System name (sys.name=[sms25]) =5.

The system returns the following confirmation message:

floor lab]) =Result: Success
System contact(sys.contact ) = Brit
System location(sys.location ) = First floor lab
System name(sys.name) = sms25
System serial number (sys.serialNum) = X-SMA-ST-SMS25-0001

Remote paths
Several commands accept remote paths as input. The remote paths specify a resource on an external serverthat can be accessed by the SMS server. Remote files that can be specified as input to an operation may beaccessed using HTTPS, FTP, NFS, or SMB (Samba) protocols.
2

SMS Command Line Interface Reference

Remote directories that are used for saving SMS-based files to a remote server can be accessed through the
NFS or SMB protocols. Files are always mounted with read-only access. Directories are mounted read-only
when possible.
Remote paths are specified as a single string value. The details for each protocol are listed in the following
sections. In each example, items in italics are variables. When using the path syntax, you must replace themwith the appropriate values for your paths. Items in brackets ([ ]) are optional.
FTP

You can use the following formats for the FTP protocol:•

Complete specification: ftp://[username:password@]server[:port]/directory/filename•

Anonymous FTP: ftp://server/directory/filename•

Specifying a user name and password: ftp://username:password@server/directory/filename•

FTP Examples:

ftp://10.11.12.13/pub/sms-0.0-0.500.pkg
ftp://steve:password@10.11.12.13/pub/sms-0.0-0.500.pkg
HTTPS

You can use the following format for the HTTPS protocol:
Complete specification: https://[username:password@]server[:port]/directory/filename•

NFS

You can use the following formats for the NFS protocol:•

Remote directory specification — server:/exportedDirectory•

Remote file specification — server:/exportedDirectory/filename•

NFS Example: nfsserver.domain.com:/public/upgrades/sms-0.0-0.500.pkg

SMB (Samba)

You can use the following formats for the SMB protocol:•

Remote file specification: //server/sharename/directory/filename•

Complete specification: //server/sharename[/directory][/filename] [-o option-list]

Options can be provided to the SMB mount operation by appending them to the end of the mount point value,
and using a space character to separate the values. Options might include the username, password, andworkgroup. Options can be joined together using a comma as a separator.
•

SMB Example: //winbox/pub/sms.pkg -o workgroup=mydomn,username=steve,password=ps111

The help command
The help command returns documentation about the specified command, object, or attribute.
Syntaxhelp
help --full3

SMS Command Line Interface Reference

help --attribs
help object.attrib
help --cmds
help cmd
help --objs
help object
help --backgroundhelp backgroundhelp --topic
help topic

Description
The help command is a non-interactive, read command that returns documentation about a command,
object, or attribute that you specify.
Note
In the help command syntax, you can use the question mark (?) interchangeably with the word “help.” For example,
you could type the following to view documentation about all commands: ? --cmds

Objects and attributes
The following objects and attributes can be used with the help command.
Description

Commandhelp --fullLists all commands, objects, and attributes

help --attribs

List all attributes

help --objs

Lists all objects or collections of attributes

help --cmds

Lists all commands

help --background

Lists background topics

ExampleTo see documentation about the sys object, type help sys. The system returns the following results:
sys: System information
System information can be viewed and updates using the “sys” object.
Read-write:
name, contact, location
Read-only:
serialNum

SMS command referenceThis section describes the SMS commands and the options available for each command.
Note
To use the SMS CLI, you must be logged in with an account that has SuperUser rights or the Access SMS CLI
capability enabled (on the SMS, go to Admin > Authentication and Authorization > Roles > Capabilities > Admin).

4

SMS Command Line Interface Reference

clear
Clears the screen.
Usage
clear

Aliasesclear

cls
Clears the screen.
Usage
cls

Aliasesclear

consoleShows a list of messages that have been sent to the console since the last reboot.
Usageconsoledate
Displays and sets the system time.
Description
Without a parameter, date will return the current system date and time. The parameter allows a new date tobe specified.
Usagedate [MMDDhhmm[[CC]YY][.ss]]

Related objects
time

deleteDeletes user files.
Description
User files are archived and exported. The files are generated from the database contents.
Usage
delete file [...]

5

SMS Command Line Interface Reference

Related objects
dir, view, vi

diags
Runs diagnostics tests and checks system health.
Description
The --force option will run diagnostics without prompting for confirmation. Runs tests for the system,
database, network, tmc, and password and provides status. For tmc, tests the connection to the tmc and the
package server.
Usage
diags[--force]

dir
Returns a listing of files contained in the user directory.
Usage
dir

Related commands
delete, view, vi

dns
Prompts for DNS settings.
Description
The dns command interactively prompts for DNS (Domain Name Service) settings used to resolve host names
to IP address values. To clear server values, use a period (.). The dns object contains default domain name,DNS search list, and DNS server information.
Usage
dns

Related commands
nic, ntp

Related objects
dns

exit
Closes the session.
Usage
exit

6

SMS Command Line Interface Reference

Aliasesquit, Ctrl-D

factoryreset
Resets the system to factory defaults.
Description
This command is an interactive command that resets the system to the factory defaults. The SMS version is
not changed, however, all other system settings are restored to the factory defaults and all data is lost. You
MUST reboot the SMS for this command to complete.
The factory reset command also resets this system network settings. You CAN NOT access the system via
networking after the reboot is completed. A VGA console, or serial port access is required to reconfigure
networking.
Usagefactoryreset

Related commands
setup

fips-mode
Description
This command is used to configure the SMS into one of two levels of FIPS operation:
Disabled – When placed into this mode, no additional FIPS compliance actions/restrictions are activated on
the SMS.
FIPS crypto core – When placed into this mode, it uses FIPS-approved algorithm implementations for both
SSH and TLS connections for the SMS.
Usage

fips-mode

For more information about FIPS mode, see the Security Management System User Guide.

ftp
Moves files to and from the user directory for the SMS server.
Description
The FTP (File Transfer Protocol) client is used to move files to and from the user directory for the SMS server.
The contents of the user directory can be listed with the dir command. Files can be viewed with the viewcommand, and deleted with the delete command.
Usage

ftp [hostName|hostAddress]

After starting the ftp client, issue the command lcd/tmp.
Caveats
The dir/delete/view commands all operate over the contents of the user directory (/tmp). The cd orchange-directory command is disabled from the shell for reasons of security. For the ftp program to see and7

SMS Command Line Interface Reference

have access to the contents of the user directory it is important to first change the local directory with thecommand lcd /tmp. After this point, files can be copied both to and from the SMS server.
Related commands
dir, view, delete, vi

getRetrieves the value of one or more attribs or a list of attribs contained within an object.
Usage
get <attrib|object> [...]

Description
The get command can use any read-write or read-only attribute.
Related commands
list, sethelp
Returns background information on various topics and command syntax.
Usage
help [--full | --attribs | --cmds | --objs | --background | topic]

Alias?
Description

Option--fullLists all commands, objects and attribs.

--attribs

Lists all attribs.

--objsLists all objects (collections of attribs).

--cmdsLists all commands (default).

--background

Lists background topics.

ifconfig
Displays the network settings for the box.
Usage
ifconfig

Description
The ifconfigcommand is an alias for the command get net, which displays the values of the attribs
contained in the net object. To change the values, use the set net command. See XXX.
Aliases
get net, ipconfig

8

SMS Command Line Interface Reference

Related objects
net

ipconfig
Displays the network settings for the box.
Usage
ipconfig

Description
The ipconfigcommand is an alias for the command get net, which displays the values of the attribs
contained in the net object. To change the values, use the set net command. See XXX.
Aliases
get net, ifconfig

Related objects
net

kbdcfgLoads the kernel keymap for the console.
Description
The kbdcfgcommand is useful if the console is using a non-QWERTY keyboard. This command leads you
through the configuration of a new keyboard layout.
WARNING!
Do not use this option if you are using a standard QWERTY keyboard. Setting your keyboard layout to a value withwhich you are not familiar could render your system inaccessible.

See also
kbd.layout (attrib)

key
Updates the license key for the server.
Usage
key

Alias
licenseRelated objects
license9

SMS Command Line Interface Reference

list
Lists the objects or the attribs contained in an object.
Usage
list [object|object attrib] [...]

Description
If no arguments are specified, the list command will return all defined objects. If an object is specified, thelist command will return all attribs contained within the object. If an attribute is specified, the list
command will confirm the attribute by listing the attribute in the response.
Related objects
See SMS attributes and objects for a list of objects and attribs you can use with the list command.
See also
get, set

mgmtsettings
Provides prompts to configure IPv4 and IPv6 management addresses, along with the DNS server.
Usage
mgmtsettings

Related objects
net

monitorShows utilization and uptime information every five seconds (by default).
Usage
monitor [delay]

Where delay is the number of seconds between polls.
Related objects
healthmore
Lists output one screen at a time.

nic
Interactively prompts for configuration of the SMS server network settings.
Usage
nic

10

SMS Command Line Interface Reference

Description
The nic command is useful for the Ethernet 10/100/1000Mbps interface management. It Interactively
prompts for configuration of the SMS server network settings. The bottom-most (NIC1) is enabled by default
and is the recommended connection to the management network.
Related commands
dns, ntp

nicsettings
Interactively prompts for the SMS NIC configuration settings.
Usagenicsettings

Description
The nicsettings command is an interactive command that prompts for the SMS NIC configuration settingsand is available through the CLI and OBE. If you want to make changes individually to any of the NIC settings,
the SMS provides options for setting auto negotiation, port speed, and duplex mode.
Examplesms110 SMS=> nicsettings
The Ethernet NIC used for the network management interface is configurable.
Please verify the port configuration of the network device that this SMS isconnected to before making changes.
These values may be changed at a later time with the 'set net' command.
Host autoneg: yes
Host speed: 1000
System duplex: fullEnter: [A]ccept, [C]hange, or [E]xit without saving? <[A],C,E>:

Related objects
net

notifyManages the SMS notification service.
Usage
notifyDescription
The notify command is used to manage the SMS notification service. It interactively prompts for SMTP email addresses and SNMPv1 traps to a remote trap server.
Related objects
smtp, snmp

Related commands
snmp

11

SMS Command Line Interface Reference

ntpManages the NTP (Network Time Protocol) client that synchronizes the SMS server time with a list of
specified servers SMS notification service.
Usage
ntp

Description
The ntp command is used to manage the NTP (Network Time Protocol) client that synchronizes the SMS
server time with a list of specified servers. NTP is enabled by default and is configured with a list of Stratum 1
servers available on the internet. The list of servers can be customized to installation requirements. The SMS
server can also act as a NTP server for your devices. The agent can be disabled, but the server cannot. To
clear server values, use a period (.).
Related objects
svc

Related commands
snmp

ntp-authUsage
ntp-auth

Description
The ntp-auth command is used to manage the NTP (Network Time Protocol) authentication settings. Thesesettings are used with the SMS NTP client and server. The SMS can act as an NTP server for devices.
Related commands
ntp

password
Changes the password for the current user.
Usage
password

Description
The password command changes the password for the current user. The security level and restrictions forentering user names and passwords. The default setting is 2 from the following options.
Description

Level
Level 0 (None)•

User names cannot contain spaces.

•

Password length and complexity are not restricted.
Note
Do not use spaces in the password.

12

SMS Command Line Interface Reference

Level
Level 1 (Low)

Level 2 (Medium)

Level 3 (High)Description
Passwords must meet Level 0 (None) restrictions and the following:•

User names must be at least six characters.

•

Passwords must be at least eight characters.

•

New password must be different from the previous password.

Passwords must meet Level 1 (Low) restrictions and the following:•Must contain at least two alphabetic characters.

•

Must contain at least one numeric character.

•Must contain at least one non-alphanumeric character (examples include ! ? $ * #).

Passwords must meet Level 2 (Medium) restrictions and the following:•Must contain at least 15 alphabetic characters.

•

Must contain at least one uppercase character.

•Must contain at least one lowercase character.

•Must be different from the previous password in at least half of the corresponding character positions.

ping
Checks network connectivity.
Usage
ping [-options] hostNameOrAddress

Description
The ping command checks network connectivity by sending a ICMP request to the specified destination, andthen checking on an echoed response.
Description

Option-6Required to use IPv6.

-c count

Stop after sending count packets.

-i wait

Wait wait seconds between sending each packet. The default is to
wait for one second between each packet.

-nNumeric output only. No attempt will be made to lookup symbolic
names for host addresses.

-q

Quiet output. Nothing is displayed except the summary lines atstartup time and when finished.

-r

Bypass the normal routing tables and send directly to a host on an
attached network. If the host is not on a directly-attachednetwork, an error is returned. This option can be used to ping a
local host through an interface that has no route through it.

-s packetsize

Specifies the number of data bytes to be sent. The default is 56,
which translates into 64 ICMP data bytes when combined with the
8 bytes of ICMP header data.

-v

Verbose output.

13

SMS Command Line Interface Reference

ping6
Checks network connectivity.
Usage
ping6 [-options] hostNameOrAddress

Description
The ping6 command checks network connectivity by sending a ICMP request to the specified IPv6
destination, and then checking on an echoed response.
Option-6Required to use IPv6.

-c count

Stop after sending count packets.

-lSpecifies the interface; for example eth0.

-i wait

Wait wait seconds between sending each packet. The default is to
wait for one second between each packet.

-nNumeric output only. No attempt will be made to lookup symbolic
names for host addresses.

-q

Quiet output. Nothing is displayed except the summary lines atstartup time and when finished.

-r

Bypass the normal routing tables and send directly to a host on an
attached network. If the host is not on a directly-attachednetwork, an error is returned. This option can be used to ping a
local host through an interface that has no route through it.

-s packetsize

Specifies the number of data bytes to be sent. The default is 56,
which translates into 64 ICMP data bytes when combined with the
8 bytes of ICMP header data.

-v

Verbose output.

quit
Closes the session.
Usage
quit

Alias
exit, Ctrl-D

radiusLists and manages the RADIUS servers.
Usage
radius14

Description

SMS Command Line Interface Reference

Description
The radius command lists and manages the RADIUS servers. You can create, edit, and view the RADIUS
servers.

rebootReboots the system.
Usage
reboot [--force] [cancel]

Description
The reboot command reboots the system. The --force option reboots the system without prompting for
confirmation. The cancel option aborts an in-progress reboot.

resolve
Resolves a hostname to an IP address using the DNS settings.
Usage
resolve <hostname>

Description
The resolve command resolves a hostname to an IP address using the DNS settings. If the name cannot be
resolved, it is returned as-is.
See also
reverserestartRestarts the network stack.
Usage
restart [--force]

Description
The restart command restarts the network stack. The -force option restarts the network stack without aconfirmation prompt.

reverse
Performs a reverse-lookup on an IP address or a relative hostname using the DNS settings.
Usagereverse <ip-address|hostname>

Description
The reverse command performs a reverse-lookup on an IP address or a relative hostname using the DNS
settings. If the value cannot be resolved, it is returned as-is.
15

SMS Command Line Interface Reference

See also
resolveroutesAllows static routes to be added or deleted.
UsageroutesDescription
The routes command allows static routes to be added or deleted for the network management interface.
Note
Whether or not static route entries are included in routing tables depends on several topology factors. These
include network specificity, metrics, and whether the next hop IP is on the associated interface. Other routing
types, redistributions, and firewall rules also impact static route entries in the routing tables.

See alsonic (cmd), net (object)

scp
Allows a file to be securely copied to or from the SMS CLI.
Usage
scp

Description
The scp (Secure Copy) command is a remote file copy program that allows a file to be securely copied to orfrom the SMS CLI. The scp command is only supported when you run it from the CLI.
To copy a file using scp, you must supply values to the following prompts:
Enter file transfer mode [G]et or [P]ut <G,[P]>:Enter scp server IP address or host name:Enter fully qualified remote file name:Enter local directory or file name: [/]:
Enter login id:
Enter password:

See also
logs (object), delete (cmd), dir (cmd)service-access
Enables or disables service access to the SMS.
Usage
service-access

16

SMS Command Line Interface Reference

Description
The service-access command is used to enable or disable service access to the SMS. The SMS version
serial number and salt is displayed when enabling.
See also
pwd (object)

set
Assigns values to one or more attribs or to a list of attribs contained within an object.
Usage
set <attrib|object|attrib=value> [...]

Description
The set command assigns values to one or more attribs or to a list of attribs contained within an object. The
list may be a one or more attribute names, object names, or attrib/object pairs. To accept the current or
default value, type the return key. To clear a String or IP Address value, enter a period (.), and then the returnkey.
The set command can use any read-write or write-only attribute. See SMS attributes and objects.
See also
list, getsetup
Provides essential configuration settings for the SMS server.
Usage
setup

Description
The setup command opens an initial setup wizard for providing essential configuration settings for the SMS
server. Non-essential values can be configured with other commands.
The setup command is automatically invoked with the first CLI login session. It is repeated with each newlogin session until the entire setup procedure is finally completed. To repeat the procedure, execute the setup
command at any time. The setup procedure prompts you to enter the following information:•

Network type (IPv4 default): IPv[4], IPv[6], or [B]oth <4,6,B>•

Management IPv4 Address•

Network Mask•

IPv4 Default Gateway (optional)•

Management IPv6 Address•

IPv6 Default Route (optional)•

DNS Server-1 (optional)
17

SMS Command Line Interface Reference

shutdown
Shuts down and powers off the system.
Usage

shutdown [--force] [cancel]

Description
The shutdown command shuts down and powers off the system. To restart the system, physically press the
POWER button on the front of the unit. The --force option will reboot the system without prompting for
confirmation. The cancel option aborts an in-progress shutdown operation.

snmp
Manages the SNMP (Simple Network Management Protocol) values.
Usage
snmp

snmp-request
Manages the SNMP (Simple Network Management Protocol) request agent.
Usage

snmp-request

Description
The snmp-request command is used to manage the SNMP (Simple Network Management Protocol) request
agent. When enabled, the SMS agent responds to the SNMP system request. This command prompts you toenable the SNMP request agent and enter the following information:
Enter the SNMP version: V[2], V[3], or [B]oth <2,3,[B]>:Enter community string []:Enter User Name []:Enter Auth Protocol (None, MD5, or SHA): []:Enter Auth Key: ********************************
Confirm Key:********************************
Enter Privacy Protocol (None, AES-128, AES-192, AES-256, DES or Triple_DES): []:Enter Priv Key: ********************************
Confirm Key:********************************
Version: Both
Community String:
User Name:
Auth Protocol:
Privacy Protocol:

See also
snmp, snmp-trap

snmp-trap
Manages the SNMP (Simple Network Management Protocol) traps.
Usage
18

SMS Command Line Interface Referencesnmp-trap

Description
The snmp-trap command is used to manage the SNMP (Simple Network Management Protocol) traps. The
SMS sends SNMP traps to NMS destinations. This command prompts you to enable configuration for an NMS
trap destination and enter the following information:
Commands: [A]dd [D]elete [V]ersion [C]ommunity [P]ort [E]ngine[U]ser Au[T]hProto Auth[K]ey P[R]ivProto Pr[I]vKey[L]ist [?]help [Q]uit
Command? <A,D,V,C,P,E,U,T,K,R,I,[L],?,Q>: a
Add=> Enter trap destination address []: 192.168.1.1
Add=> Enter SNMP version: v[2] or v[3] <2,3>: 3
Add=> Enter port number [162]:
Add=> Enter Engine ID []:Add=> Enter User Name []:Enter Auth Protocol (None, MD5, or SHA): []:Enter Auth Key: ********************************
Add=> Confirm Key:********************************
Enter Privacy Protocol (None, AES-128, AES-192, AES-256, DES or Triple_DES): []:Enter Priv Key: ********************************
Add=> Confirm Key:********************************IP Address: 192.168.1.1
Version: v3
Port: 162
Engine ID:
User Name:
Auth Protocol:
Privacy Protocol:

See also
snmp, snmp-request

snmpgetRequests a single OID from the specified agent.
Usage

snmpget hostNameOrAddress communityName OID

Example (IPv6)
snmpget -v 2c -c public udp6:[fc01:a63:1:0:214:22ff:fe1e:1d87] system.sysName.0

Example (IPv4)
snmpget -v 2c -c public 10.99.1.110 system.sysName.0

See also
snmpwalk

snmpwalk
Traverses the SNMP MIB of the agent running at the specified address.
19

SMS Command Line Interface Reference

Usage

snmpwalk [hostNameOrAddress [communityName [OID]]]

Description
The snmpwalk command traverses the SNMP MIB of the agent running at the specified address. If the address
OID is not provided, the walk begins at the first OID, if the community name is not provided, walk with use
public and if the hostNameOrAddress is not provided, walk uses localhost.
Example (IPv6)
snmpwalk -v 2c -c public udp6:[fc01:a63:1:0:214:22ff:fe1e:1d87] system

Example (IPv4)
snmpwalk -v 2c -c public 10.99.1.110 system

Example (IPv3)
snmpwalk -v 3 -u user -l authPriv -a SHA -A authKey -x AES -X privKey 192.168.1.1 system

See also
snmpgetssh
Logs into a remote machine and executes remote commands from within the SMS CLI.
Usage
ssh [-1246AaCfgKkMNnqsTtVvXxYyZ] [-b bind_address] [-c cipher_spec][-D [bind_address:]port] [-e escape_char] [-F configfile] [-i identity_file][-L [bind_address:]port:host:hostport] [-l login_name] [-m mac_spec] [-O ctl_cmd][-o option] [-p port] [-R [bind_address:]port:host:hostport] [-S ctl_path][-w local_tun[:remote_tun]] [user@]hostname [command]tacacsLists and manages the TACACS+ servers.
Usage

tacacsDescription
The tacacs command lists and manages the TACACS+ servers. You can create, edit, and view the TACACS+
servers.

time
Runs the specified program command with the given arguments.
Usage

time <command> [arguments...]Description
The time command runs the specified program command with the given arguments. When the commandfinishes, time writes a message to standard output giving timing statistics about this program run. These20

SMS Command Line Interface Reference

statistics consist of the elapsed real time between invocation and termination, the user CPU time, and thesystem CPU time.
For information about the time object, see time.

touch
Creates user files, which are archived files generated from database content.
Usagetouch fle [...]

See also
delete, dir, view, vi

traceroute
Traces the route an IP packet would follow to a remote host.
Usage
traceroute [-dFInrvx] [-f first_ttl] [-g gateway][-i iface] [-m max_ttl] [-p port][-q queries][-s src_addr] [-t tos] [-w waittime] [-z pausemsecs] host

Description
The traceroute command attempts to trace the route an IP packet would follow to a remote host by
launching UDP probe packets with a small ttl (time to live) then listening for an ICMP time exceeded reply
from a gateway.
Probes start with a ttl of one and increase by one until we get an ICMP port unreachable (which means wegot to host) or hit a max (which defaults to 30 hops and can be changed with the -m flag). Three probes(change with -q flag) are sent at each ttl setting and a line is printed showing the ttl, address of thegateway and round trip time of each probe. If the probe answers come from different gateways, the address ofeach responding system is printed. If there is no response within a five second timeout interval (changed
with the -w flag), an asterisk (*) is printed for that probe.
For IPv4 (-4 flag) or IPv6 (-6 flag) tracerouting can be forced using the appropriate flag. By default, theprogram tries to resolve the name given and automatically choose the appropriate protocol. If resolving ahost name returns both IPv4 and IPv6 addresses, traceroute uses IPv4.
Description

Option-4

Force IPv4 tracerouting.

-6

Force IPv6 tracerouting.

-f

Set the initial time-to-live used in the first outgoing probe packet.

-F

Set the don’t fragment bit.

-d

Enable socket level debugging.

-gSpecify a loose source route gateway (8 maximum).

-i

Specify a network interface to obtain the source IP address for outgoing probe packets. This is normally only usefulon a multi-homed host. (See the -s flag for another way to do this).

21

SMS Command Line Interface Reference

OptionDescription-I

Use ICMP ECHO instead of UDP datagrams.

-m

Set the max time-to-live (max number of hops) used in outgoing probe packets. The default is 30 hops (the samedefault used for TCP connections).

-n

Print hop addresses numerically rather than symbolically and numerically (saves a nameserver address-to-namelookup for each gateway found on the path).

-p

Set the base UDP port number used in probes (default is 33434). Traceroute hopes that nothing is listening on UDP
ports base to base + nhops - 1 at the destination host (so an ICMP PORT_UNREACHABLE message will be returned
to terminate the route tracing). If something is listening on a port in the default range, this option can be used topick an unused port range.

-r

Bypass the normal routing tables and send directly to a host on an attached network. If the host is not on a
directly-attached network, an error is returned. This option can be used to ping a local host through an interface
that has no route through it (e.g., after the interface was dropped by routed).

-s

Use the specified IP address as the source address in outgoing probe packets. This is usually given as an IP
address, not a hostname. On multi-homed hosts with more than one IP address, this option can force the source
address to be a different IP address than the interface from which the probe packet is sent. If the IP address is not
one of the host’s interface addresses, an error is returned and nothing is sent.

-t

Set the type-of-service in probe packets to the following value (default zero). The value must be a decimal integer
in the range 0 to 255. This option can be used to see if different types-of-service result in different paths. (If you are
not running 4.4bsd, this may be academic since the normal network services like ftp don’t let you control the TOS).
Not all values of TOS are legal or meaningful - see the IP spec for definitions. Useful values are probably ‘-t 16’ (lowdelay) and ‘-t 8’ (high throughput).

-v

Use Verbose output. Received ICMP packets other than TIME_EXCEEDED and UNREACHABLE values are listed.

-w

Set the time (in seconds) to wait for a response to a probe (default five seconds).

-z

Set the time (in seconds) to pause for a response to a probe.

updateUpgrades the SMS server software.
Usage
updateDescription
The update command leads you through upgrading SMS server software:1.

Acquire the latest upgrade package from the TMC website.

2.

Save it to a local HTTPS or FTP server that can be accessed by the SMS server.

3.

Provide the URL to this downloaded file.

After the package is transferred and installed, the update procedure prompts for a reboot.
Aliases
ctl.upgrade-source

users
Lists and manages the SMS user accounts.
22

SMS Command Line Interface Reference

Usage
users

Description
The users command lists and manages the SMS user accounts. You can create new users and assign orchange passwords, roles, disable settings, and force password changes.
Related object
pwd

version
Displays the system and component versions.
UsageversionRelated object
sw

vi
Edits plain text.
Usagevi [options] [file ...]

Description
vi is a text editor that is comparable to Vi. It can be used to edit all kinds of plain text. It is especially usefulfor editing programs. While running vi, a lot of help can be obtained from the on-line help system, with
the :help command.

Caveats/tmp and its contents are the only files and directories that the SuperUser account has permission to modify.
When accessing files you must specify the complete path name (for example: vi /tmp/FileName.txt). Afterseven days without modification, files in this directory are removed.

Options
The options may be given in any order, before or after filenames. Options without an argument can be
combined after a single dash.
OptionDescription+num

For the first file the cursor will be positioned on line num. If num is missing, the cursor will be positioned on the lastline.

+/{pat}

For the first file the cursor will be positioned on the first occurrence of {pat}. See “:help search-pattern” for theavailable search patterns.

-hGive a bit of help about the command line arguments and options. After this, Vi exits.

-mModifying files is disabled. Resets the write option, so that writing files is not possible.

23

SMS Command Line Interface Reference

OptionDescription-n

No swap file will be used. Recovery after a crash will be impossible. Handy if you want to edit a file on a very slow
medium (e.g. floppy). Can also be done with :set uc=0.Can be undone with :set uc=200.

-R

Read-only mode. The read-only option will be set. You can still edit the buffer, but will be prevented from
accidently overwriting a file. If you do want to overwrite a file, add an exclamation mark to the Ex command, as
in:w!. The -R option also implies the -n option (see below). The read-only option can be reset with :set noro.
See :help ‘read-only’.

-r {file}

Recovery mode. The swap file is used to recover a crashed editing session. The swap file is a file with the same
filename as the text file with .swp appended. See :help recovery.

--

Denotes the end of the options. Arguments after this will be handled as a file name. This can be used to edit afilename that starts with a dash (-).

--help

Give a help message and exit, just like -h.

--version

Print version information and exit.

See also
ftp, dir, delete, view

view
Displays the contents of the directory.
Usage
view

Description
The view command allows you to view the contents of the directory. Internal help is available by typing aquestion mark (?)
See also
delete, dir, ftp, vi

webInteractively prompts for configuration of web server settings.
Usage
web

Description
The web command interactively prompts for configuration of web server settings. HTTPS services can be
enabled through the web command. Additionally, a single password can be assigned to the content to limit
access to reports, archived data, documentation, and client downloads. The user name used for access is web
and the password is assigned with the web command.
See also
snmp

who
Displays a list of CLI users, where and when the users originated.
24

SMS Command Line Interface Reference

Usage
who

See also
health.who

SMS attributes and objects
This section describes each object and attribute used by the SMS CLI. For more detailed information about
each element, see the individual commands described in SMS command reference.
Note
To use the SMS CLI, you must be logged in with an account that has SuperUser rights.

Attribute types
Describes each type of attribute (attrib) that you can view or edit in the CLI. The following table describes
each type of attribute (attrib) that you can view or edit in the CLI.
Definition

Type
Bool

Boolean. Value can be true or false.

String [#]String. Can have a maximum size of #.

Password

String. Uses asterisk (*) to mask out the value as it is entered.

IPaddrIP address. Uses dotted notation.

Name [#]

String. Can contain alpha-numeric characters with a maximum size of #.

cac
Disables the CAC authentication mode and sets the mode to SMS local authentication.
Attribute
cac.disable

Description
Setting the cac.disable attrib to the value of true willcause the system to disable the CAC authentication mode,
which sets the SMS back to the default authentication
mode (local authentication).

Type
Bool

Accesswrite-only

Range
0

This command should only be used when users with
SuperUser capabilities are not able to log in to the SMS
client using the CAC card reader.

cli
Adjusts CLI behavior. Collection of CLI-related attribs. The attribs are used to adjust CLI behavior, including
the inactivity timeout value.

25

SMS Command Line Interface Reference

Attribute
cli.sessionTimeout

Description
Attribute used to control the auto-logout time. By
adjusting the value, you can control the number ofminutes before the CLI will automatically log out
due to inactivity. Set the value to 0 to disable thetimeout function.
Example:Type
Int

Accessread-write

Range
0-32000

set cli.
sessionTimeout=30

ctl
Restart, reboot, shut down the system, or accesses the upgrade capability. Collection of system control
operations. The attributes contained in ctl can be used to reboot or shutdown the system, or access the
upgrade capability.
See Remote paths for more information about entering path names for attributes that require them.
Attribute

Description

Type

AccessRange

ctl.power-off

Setting the ctl.power-off attrib to the value of true
will cause the system to shutdown and power-off. To
restart the system, it is necessary to physically press thePower button on the front panel of the box.

Boolwrite-only0

ctl.reboot

Setting the ctl.reboot attrib to the value of true willcause your entire system to reboot. The operation will be
immediate with no warning given to other users using theclient or the CLI.

Bool

write-only0

ctl.restart

Setting the ctl.restart attrib to the value of true willcause the system to immediately restart. Set a value (inseconds) for the SMS to delay before restarting.

Stringwrite-only

true/false,
0-9

ctl.reboot-needed

Returns the state of the system, indicating whether there
are pending configuration settings that require a reboot toapply those changes.

Boolread-only0

ctl.pre-upgrade-cleanup

Performs any system cleanup necessary for an SMS
upgrade. Updates that the upgrade can occur. This
command is also run automatically when an SMS upgrade
is requested. The upgrade will fail if this command fails.

Boolwrite-only0

ctl.upgrade-source

Setting the ctl.upgrade-source attrib to a string
representing a URL will cause the system to retrieve andapply the update package to the system. Normally, areboot will be required for the update to become effective.
The URL can reference http or ftp protocols.

Stringwrite-only

5-128

Stringread-only

5-128

Example:set ctl.upgrade-source=https://www.
tippingpoint.com/SMS-UPDATE-1.0.pkg
ctl.patch-releasenotes

Used to display the release notes for currently installed
Patch.
Note
This attribute is used by the UI to retrieve release
notes and is of little interest to general cli users.

26

SMS Command Line Interface Reference

Attribute

Description

Type

AccessRange

ctl.patch-restart

Used to display restart flag for currently installed Patch.
This attribute is used by the UI to retrieve restart flag andis of little interest to general cli users.

Stringread-only

5-128

ctl.patch-rollback

Used to roll back to previous patch version. Displays true
if the currently installed Patch can be rolled back, else
false. If set to the version of the currently installed Patch,
it rolls it back, to either the previously installed Patch orno Patch if it was the first Patch installed.

Stringread-write

5-128

Note
This attribute is used by the UI to retrieve this value
and is of little interest to general cli users.
ctl.patch-source

Used by the UI for installing Patches. Similar to set
ctl.upgrade-source, this takes a path or url to the Patch
package file, then validates and installs that Patch.

Stringwrite-only

5-128

ctl.previous-patchversion

Used to display the version of the Patch previous to this,for example the Patch a rollback would install, or None if
there is no previous Patch.

Stringread-only

5-128

sw.patch-version

Used to display the version number of the currently
installed Patch, or None if no patch is installed.

Stringread-only

5-128

db
Collection of database control operations.
The attribs contained in db can be used to backup, restore or re-initialize the system database. See Remote
paths for more information about entering path names for attribs that require them.
On startup, the sequence performed is (1) if requested, backup the database, (2) if requested, restore thedatabase, (3) if requested, reinit the database, (4) if needed, migrate the database. Therefore, within a single
restart, a current database can be saved to a remote system, and a new database can replace the old one. To
clear a current value, set the attribute to a period (.).
Attribute

Description

Type

Accessdb.attackCount

Displays the number of attack records stored in the
database.

Int

read-only

db.backup

Setting the db.backup attrib to yes creates a local databasebackup with default options. This file can be downloaded
from the Exports and Archives link from the SMS Server
home page.

Boolwrite-only

db.check

Verifies the integrity of the database.

Boolread-write

db.clear-export

Deletes files in the export directory.

Bool

read-write

Range
0

27

SMS Command Line Interface Reference

Attributedb.export-files

Description

Type

AccessRange

Files to be saved and transported to a remote system can be
stored in the export directory. To transfer the entire contentsof the export directory this attrib must be provided with thename of a Samba (SMB) mount point.
The destination mount point must be writable by the SMS
server. SMB can be secured by providing an access list on theserver that prevents all machines except for the SMS server
to access it. The export directory can be cleared by setting
the db.clear-export attrib.

Stringwrite-only

4-132

Example:set db.export-files=server:/export/
directory

db.initTime

The time that the database was re-initialized.

Stringread-only

0-32

db.reinit

Setting the db.reinit attrib to true will schedule thedatabase to be cleared upon system startup the next time
the system is rebooted.

Bool

read-write0

Related commands
database

dns
Contains default domain name, DNS search list and DNS server information. The dns object contains default
domain name, DNS search list and DNS server information.
Attribute

Description

Type

AccessRange

dns.domain

Default DNS domain used to resolve hostnames. If a fullyqualified hostname is not provided, the domain is appended
to the hostname and the result is passed for resolution.

Name

read-write

2-64

dns.search

DNS domain search list used to resolve hostnames. If a fullyqualified hostname is not provided, each member of thesearch list is appended to the hostname and the result ispassed for resolution.

Stringread-write

2-128

dns.server1

Attribs used to specify name resolution servers. The value
must be a dotted IP address, and the first entry(dns.server1) will be assigned a preferred role.

IPaddrread-write

7-15

dns.server2
dns.server3

To clear this value, use a period (.).

Related objects
nic, ntp

high availability
Retrieves HA information. Collection of system High Availability (HA) attribs. The attribs are used to retrieve
HA information.

28

SMS Command Line Interface Reference

Attribute

Description
Attribute returning the status of HA.
The status messages include the following:ha.status•

Disabled: High Availability is notconfigured.

•

Enabled.

•Error: The system could not determine local
status.

•Error: Unable to communicate with peer.

•

Error: Peer system state is invalid.

•

Error: Configuration out of sync with peer.

•

Error: Peer system failure.

•

Configured: Synchronization required.

•

Configured: Attempting synchronization.

•

Configured: Synchronizing.

•

Degraded: Peer takeover pending.

•

Degraded: Unable to communicate with peer.

•

Degraded: Synchronization required.

•Degraded: Peer system failure.

ha.disable

Attribute that disables HA.

ha.configured

Attribute returning the status of the HA configuration.

ha.ports-enabled

Attribute returning the status of the HA ports. By default, HA
ports are open. To disable, use set ha.ports-enable = no.

TypeAccessStringread-only

Stringwrite-only

Range

1-1024read-only
Stringread-write

Note
If any of your SMS devices are currently configured for HA,
the HA ports on those systems cannot be disabled. If the
HA ports are disabled, that SMS can not be used in an HA
configuration.
ha.cluster-info

Attribute returning the detailed status for the Passive and Active
systems in the SMS HA cluster.

read-only

healthRetrieve system health information, including utilization values, and system uptime statistics. Collection ofsystem health-related attribs. The attribs are used to retrieve system health information, including utilization
values, and system uptime statistics.
Attributehealth.cpu-util

Description

Type

AccessRange

Attribute returning the CPU (Processor) utilization. 0%
represents a near-idle system, and 100% is fullyutilized.

Stringread-only

2-4

29

SMS Command Line Interface Reference

Attribute

Description

Type

AccessRange

health.db-valid

Attribute reporting the status of the database. If true,
then the database is considered valid and fully
operational, if false, the system should be restarted,and other corrective steps taken.

Stringread-only

1-32

health.diskIo

Disk I/O statistics.

Stringread-only

0-128

blocks-read•blocks-written

health.disk-util

Attribute returning the disk system utilization. As disk
utilization approaches 100%, database management
operations should be performed to reduce disk usage.

Stringread-only

2-4

health.loadAvg

CPU load statistics.

Stringread-only

0-128

Stringread-only

0-128

health.memInfo

30

•

•

load-avg-1min•load-avg-5min•load-avg-15min•

runnable-processes/total-processes•

current-pid

Physical memory statistics.
•

total

•

used

•

free

•

buffers•

cachedhealth.mem-util

Attribute returning the memory (RAM) utilization. 0%
represents a near-idle system, and 100% is fullyutilized.

Stringread-only

2-4

health.raid

Attribute returns the status of the physical disks in your
RAID configuration on the H3 and H3 XL platforms.

Stringread-only

0-128

health.net-valid

Attribute reporting the status of the communication
paths. Checks to see if network is configured andenabled. If enabled, checks the status of the gateway,
DNS, and NTP.

read-only

SMS Command Line Interface Reference

Attributehealth.port-healthhealth.swapInfo

health.swapIo

Description

Type

AccessAttribute returning Port Statistics of the SMS. This
information corresponds to the Ports Statistics table on
the Port Health screen (SMS Health) in the UI with all 12
numbers printed in a single line. The six numbers arefor the primary port and the second six numbers are forthe secondary port. Each set of numbers corresponds
to the following table headings:

Stringread-only

Stringread-only

0-128

Stringread-only

0-128

•

total input bytes•

total output bytes•

total input discards•

total output discards•

total input errors•

total output errors

Swap memory statistics.
•

total

•

used

•

free

Swap I/O statistics.
•

blocks-read•blocks-written

Range

health.sys-valid

Attribute reporting the status of the SMS server
application. If true, then the system is consideredvalid and fully operational, if false, the system should
be restarted, and other corrective steps taken.

Stringread-only

1-32

health.temperature

Attribute returning the temperature of the SMS (indegrees Celsius). This information corresponds to the
SMS Health Statistics table in the UI. NOTE: The number
is displayed with no indication for Celsius.

Stringread-only

1-3

health.tmc-valid

Attribute reporting the status of the communication
paths to the TMC and each of the configured devices.
The message will indicate the nature of the problem.
Usually, the problem can be addressed by confirmingthat the network settings permit the SMS tocommunicate with https://tmc.tippingpoint.com,
available through the internet. See also diags.

read-only

If the SMS cannot establish a TMC connection, see error
messages in the SMS User Guide.
health.uptime

Attribute reporting the amount of time since the lastsystem boot.

Stringread-only

2-56

health.who

Attribute reporting a list of currently logged-in users.
Pipe (|) characters are used in place of carriage-return
characters.

Stringread-only

0-1024

kbd
Keyboard-related attribute.
31

SMS Command Line Interface Reference

WARNING!
Do not use this option if you are using a standard QWERTY keyboard. Setting your keyboard layout to a value withwhich you are not familiar could render your system inaccessible.

Attribute
kbd.layout

Description
Specifies the console keyboard layout. Usage: set
kbd.layout=keyboard designation<>
Example setting: fr for French keyboard layout.
The default setting is kbd.layout=us

The following console keyboard layouts are available.

32

Type
StringAccessread-write

Range
0-64

SMS Command Line Interface Reference

Related command
kbdcfglogs
Manages log files that are used for troubleshooting.
Collection of log-related attribs. The attribs are used to manage log files that are used for troubleshooting.
The logs zip file, sms_logs.zip, is managed in the /mgmt/client/tmp directory. This is the standard location
for cli data files and also allows access from the Exports and Archives link on the SMS web page. Creating a
new logs zip file overwrites the old one.
Description

AttributeType

AccessRange

set logs.create=yes

Creates the logs zip file sms_logs.zip.

Boolwrite-only0

set logs.del=yes

Deletes the zip file.

Boolwrite-only0

set logs.create-peer=yes

Attribute used to create a compressed filecontaining the HA peer SMS log files. This
file can be downloaded from the Exports
and Archives link from the SMS server
home page. Only the latest compressed file
are retained.

Stringwrite-only0

Stringread-only

0-1024

Note: This attribute can be used only when
HA has been configured.
get logs.info

If the zip file exists, lists name, size, date andtime of creation.

Related objects
scp

netCollection of network-related attribs.
Collection of network-related attribs. The attribs are used to configure the two Ethernet 10/100/1000
interfaces for access to the local network. Unless identified as a net-only attrib, each attrib listed as net.*
below can use the prefixnet to specify the correct Ethernet10/100/1000 interface.
ExampleTo change the IP address and gateway for the SMS server, you must complete the following:
1.

Change the IP address by entering the command:
set net.ipaddr = smsip4addr

OR
set net.ipaddr6 = smsip6addr

where smsip4addr is the new IPv4 address, smsip6addr is the new IPv6 address.
2.

Change the gateway by entering the command:
Restart the network stack by entering the command:
set net.gateway = ipv4gateway33

SMS Command Line Interface ReferenceOR
set net.gateway6 = ipv6gateway

where ipv4gateway is the IP address of the new gateway, ipv6gateway is the IPv6 address of the new
IPv6 gateway.
3.

Restart the network stack by entering the command:
set net.restart = yes

The system prompts you to confirm that you want to restart the network stack. Your changes are applied
when the network stack is restarted.
Note
You must issue the set net.restart=yes command when you modify the IP address or gateway using the set net
command. Changes to these attributes do not take effect until you issue this command. A reboot (reboot
command) should be done after you issue the above command.

For information on set net, see set.
Related commands
ifconfig, ipconfig, mgmtsettings

Related objects
dns

net attributes
Attribute
net.autoneg

Description
Attribute used to view, and enable/disable autonegotiation for the Ethernet 10/100/1000 interface.

Type

Access

Range

Bool

read-write0

Valid values are: yes or no.

34

net.duplex

Attribute used to view and change the duplex setting
for the Ethernet 10/100/1000 interface.
Valid values are: half or full.

Stringread-write

4

net.gateway

Attribute used to provide the gateway (default route)value. To clear this value, use a period (.). Applies only
the net object.
The network interface must be restarted (net.restart)
for setting to take effect.

IPaddrread-write0

net.gateway6

Attribute used to provide the IPv6 gateway value. To
clear this value, use a period (.). Applies only the net
object.
The network interface must be restarted (net.restart)
for setting to take effect.

IPaddrread-write0

net.hwaddr

Attribute used to return the Hardware / MAC (Media
Access Control) address for the Ethernet10/100/1000
interface.

Stringread-only

17

net.ifc-enable

Attrib used to enable/disable the NIC. Normally, thisshould not be done. To enable the NIC set the value totrue, to disable the value should be set to false.

Bool

read-write0SMS Command Line Interface Reference

Attribute

Description

Type

AccessRange

net.ipaddr

Attribute used to view and change the IP address for
the Ethernet10/100/1000 interface. To clear this value,
use a period (.). Applies only the net object. The
network interface must be restarted (net.restart) for
setting to take effect. When you employ thiscommand, the CLI may not reflect the change with aconfirmation message.

IPaddrread-write0

net.ipaddr6

Attribute used to view and change the IPv6 address.
To clear this value, use a period (.). Applies only thenet object.
The network interface must be restarted (net.restart)
for setting to take effect. When you employ thiscommand, the CLI may not reflect the change with aconfirmation message.

IPaddrread-write0

Note
The IP address uses IPv6 notation.
net.mask

Attribute used to provide the subnet mask value. To
clear this value, use a period (.).

IPaddrread-write0

net.mtu

Attribute used to view the MTU (Maximum
Transmission Unit) for the SMS Ethernet 10/100/1000
interface.

Boolread-only0

net.ready

Returns "true" if the primary network interface isconfigured and ready.

Bool

read-only0

net.restart

Attribute used restart the Ethernet10/100/1000
interface with the current network settings. Set totrue to restart immediately. (false has no effect.)Boolwrite-only0

Stringread-only0

Bool

read-write

0

WARNING!
restarting the network interface may cause
connections to be lost, including SMS client
sessions, and remote CLI sessions. Applies only
the net object.
net.scope-link

Attribute used to return the IPv6 Scope Link address
for theEthernet 10/100/1000 interface. See net and theassociated net.ipaddr6 attribute).
See also ifconfig and ipconfig.

net.autoneg

Attribute used to view, and enable/disable autonegotiation for the Ethernet 10/100/1000 interface.
Valid values are: yes or no.

ntp
Collection of NTP (Network Time Protocol) settings used to synchronize the system time with a remote time
server. NTP allows machines within a network to be synchronized on a common time.

35

SMS Command Line Interface Reference

Related objects
svc, snmp

ntp attributes
Attribute

Description

ntp.auth-client-enable

Attribute used to enable/disable the NTP (Network Time
Protocol) client authentication. It allows the SMS torequest authenticated time as an NTP client where the
NTP server is verified as known and trusted and not an
intruder intending accidentally or on purpose tomasquerade as that server. Only NTP V3 (symmetric key)authentication is supported.
To enable the NTP client authentication, set the value to'yes', and a key id and key value should be provided with
the ntp.auth-clientKeyId and ntp.auth-keyValue attribs or
ntp-auth command. Set the value to no to disable.

Type

Access

Range

Bool

read-write0

Example: set ntp.auth-client-enable=yes
ntp.auth-clientKeyId

The key id used by the SMS to request authenticated timeas an NTP client from an NTP server that is configured
with an associated key.

Int

read-write

1-65535

ntp.auth-keyId-add

Attribute used to create a new key ID that can be usedwith an authenticated NTP.

Int

write-only

1-65535

ntp.auth-keyId-delAttribute used to delete a key ID that can be used with anauthenticated NTP.

Int

write-only

1-65535

ntp.auth-keyIds

Lists all the key IDs used with NTP authentication. The
existence of the keys will automatically allow the SMS toprovide authenticated time to NTP clients that are
configured to request authenticated time with anassociated key. Optionally, ntp.auth-clientKeyId canbe set to one of these key ids to allow the SMS to request
authenticated time as an NTP client (set ntp.authclient-enable=yes).

Intread-only

1-65535

ntp.auth-keyValue

The key value associated with a key ID that can be usedwith client and server authenticated NTP requests.

Password

write-only

1-255

ntp.server1

Attributes used to specify a list of NTP time servers. The
value may be a dotted IP address or a hostname. The firstentry (ntp.server1) will be assigned the preferred time
server role. The preferred time server is also used as astep ticker, which adjusts the time immediately uponsystem boot.

IPaddrread-write

7-15

ntp.server2
ntp.server3

To clear this value, use a period (.).

pkg
Collection of attribs used to control package management.
Related objects
tmc (object)

36

SMS Command Line Interface Reference

pkg attributes
Attribute

Description

Type

AccessRange

auto-download

Attrib used to control whether new packages available atthe TMC are automatically downloaded. Email will be
generated to notify the administrator of the action (ifconfigured).

Bool

read-write0

auto-install

Attrib used to control whether the SMS database is updatedwith the newly downloaded package.

Boolread-write0

dv-activate

Attrib used to activate a DV package.

Stringwrite-only

dv-delete

Attrib used to delete a DV package.

Stringwrite-only

dv-import

Attrib used to import a DV package to the SMS using a URL.

Stringwrite-only

dv-info

Attrib used to list all of the DV packages installed on the
SMS.

Stringread-only

auto-distrib

Attrib used to control whether the new package will be
distributed to the managed devices.

Bool

read-write0

tmc-poll-rate

Attrib used to control the frequency of the check for new
TMC packages. The SMS polls the Threat Management
Center (TMC) at regular intervals (factory default is 30
minutes). Communication is attempted over TCP port 4043
to the host tmc.tippingpoint.com. A follow-up request thatpulls the file may be made to another server using port 443.

Int

read-write

0-9999The poll rate can be adjusted by providing the pkg.tmcpoll-rate attrib with a new value and then rebooting the
SMS.
Assigning the attrib the value of '0' disables polling. (Thissetting may be desirable when the SMS is behind a firewall
which prevents outbound communication with the TMC.)
proxy-tmc

Attrib used to control whether an HTTP/HTTPS proxy serveris used to make TMC connections.

Bool

read-write0

tmc-proxy-hostAttrib used to control which proxy server to use to make
TMC connections.

Stringread-write

1-128

tmc-proxy-port

Attrib used to control which proxy server port to use to
make TMC connections.

Int

read-write

1-65535

proxy-tmc-authenticate

Attrib used to control whether authentication is requiredwith the HTTP/HTTPS proxy server.

Bool

read-write0

pwd
Collection of password-related attribs. Collection of password-related attribs. The attribs are used to confirm
the SuperUser password and enable the service mode used by support personnel. For information about
managing users including user groups, passwords, and security levels, see the “Administration” chapter in
the SMS User Guide.
Related command
users

37

SMS Command Line Interface Reference

pwd attributes
Attribute

Description

Type

Accesspwd.group-adduser

Used to add a user to a user group.

Stringwrite-only

pwd.group-deluser

Used to remove a user from a user group.

Stringwrite-only

pwd.group-list

Used to list all groups, or groups with users.

Stringread-only

pwd.level

Attribute used to set the security level for the password.

Int

read-write

pwd.service-enable

Used to enable/disable the service mode password for thesystem.
To protect customer security, the service mode is deactivatedat the factory. To enable the service mode account, thecustomer must log in with an account that has SuperUser
rights and set this attrib to yes. After service mode is enabled,a service professional can log in to the system with a secret
one-time password. To disable service mode, set the attrib to
no.

Bool

read-write

Stringwrite-only

Range

0

To clear this value, use a period (.).
Example: set pwd.service-enable=false
pwd.user-add

Used to add a user and specify the user’s default user group.
User names must comply with the rules defined by
pwd.level. You must also specify a user group in the form of ?
usergroup=username.
Example: set pwd.user-add?superuser= johnsmith

pwd.user-age

Attribute used to set the maximum age for a password.

Int

read-write

pwd.user-del

Used to delete a user.

Stringwrite-only

pwd.user-desc

Attribute used to describe the user account.

Stringread-write

pwd.user-email

Attribute used for the user account email address.

Emailread-write

pwd.user-expires

Attribute used to enable password expiration.

Bool

read-write

pwd.user-expiredays

Attribute used to set the amount of days to check the accountfor expiration.

Stringread-only

pwd.user-force-pwd

Attribute used to force a user to change their password at next
login

Bool

read-write

pwd.user-pager

Attribute used to include the user account pager number.

Stringread-write

pwd.user-phone

Attribute used to include the user account phone number.

Stringread-write

pwd.user-pwd

Attribute used for the user account password.

Stringwrite-only

pwd.user-state

Attribute for the state for the user ID.

Stringread-write

radiusCollection of radius-related attribs. The attribs are used to enable and configure RADIUS for the SMS. For
information about managing users including user groups, passwords, and security levels, see the“Administration” chapter in the SMS User Guide.

38

SMS Command Line Interface Reference

Radius attributes
Attribute

Description

Type

AccessRange

Attribute used to enable/disable RADIUS.

Bool

read-write

radius1.secret

Attrib used to enter the RADIUS secret set by the
RADIUS server administrator. This entry is used byeach RADIUS client, including the SMS server.

Stringread-write

radius1.server

Attrib used to set the IP address of the RADIUS
server.

IPaddrread-write0

radius1.port

Attrib used to set the port on the RADIUS serverthat listens for authentication requests

Intread-write

1-65535

radius1.timeout

Attrib used to set the maximum timeout period inseconds.

Int

read-write

1-14

radius1.auth

Attrib to set the authentication method (PAP and
EAPMD5)Stringread-write

radius2.secret

Attrib used to enter the RADIUS secret set by the
RADIUS server administrator. This entry is used byeach RADIUS client, including the SMS server.

Stringread-write

radius2.server

Attrib used to set the IP address of the RADIUS
server.

IPaddrread-write0

radius2.port

Attrib used to set the port on the RADIUS serverthat listens for authentication requests

Intread-write

1-65535

radius2.timeout

Attrib used to set the maximum timeout period inseconds.

Int

read-write

1-14

radius2.auth

Attrib to set the authentication method (PAP and
EAPMD5)Stringread-write

radius.enable

Primary RADIUS Server

Backup RADIUS Server

routeCollection of network-related attribs. Collection of network-related attribs. The attribs are used to used toconfigure the Ethernet 10/100/1000 interface for access to the local network.
Usage
route.add
route.add <destination> <mask> <gateway>
route.del <destination> <mask> <gateway>

Related objects
route6, net

Related commands
ifconfig, ipconfig, routes

39

SMS Command Line Interface Reference

route attributes
Attribute
route.add

Description

Type

AccessRange

Attribute used to add a static route to the IP routing
table.Usage: route.add <destination>

IPaddrs

write-only0

Attribute used to delete a static route from the IP
routing table.Usage: route.del <destination>

IPaddrs

write-only0

Attribute used to list all routes in the IP routing table.

Stringread-only

0-1024<mask> <gateway>

route.del<mask> <gateway>

route.inforoute6
Collection of attribs used to add, delete and display IPv6 static routes for the management interface.
Usage
route6.add
route6.add <destination> <next hop>route6.del <destination> <next hop>Related objects
route, net

Related commands
ifconfig, ipconfig,

route6 attributes
Description

Type

Accessroute6.add

Attribute used to add a static route to the IP routing
table.
Usage: route6.add <destination><next hop>

IPaddrs

write only

0route6.delAttribute used to delete a static route from the IP
routing table.
Usage: route6.del <destination> <next hop>

IPaddrs

write only

0route6.info

Attribute used to list all routes in the IP routing
table.

Stringread-only

0-1024Attribute

Range

smtp
Used to configure the smtp service.
Collection of SMTP (Simple Mail Transfer Protocol) -related attribs. The attribs are used to configure the smtp
service.

40

SMS Command Line Interface Reference

smtp attributes
Attributesmtp.aggregation

Description
Amount of time (in seconds) that the SMS
aggregates the device email notifications before it
sends the notifications in a single email.

Type

AccessIntegerread-write

Range

If you set the aggregation to zero (default), the SMS
will immediately disable the email aggregation.
The maximum number of emails the SMS cancollect for a single aggregation period is 10,000.
When the SMS reaches this limit, it will discard new
device email notifications received.
This setting only applies to device notifications. Allother SMS emails are sent immediately.
smtp.send-mailSends a mail message from the SMS. Other SMTP
configuration settings are required to successfully
send mail.

Stringwrite-only

smtp.notify-list

List of e-mail addresses used to deliver notification
messages when a notifiable event occurs. The list
should be one or more e-mail addresses separated
by comma or semicolons.

Emailread-write

snmp
Collection of SNMP (Simple Network Management Procotol) related attribs. Collection of SNMP (Simple
Network Management Procotol) related attribs. The attribs are used to configure the SNMP trap service and
SMS SNMP request agent.
Related objects
svc

Related commands
snmp-request, snmap-trap

snmp-request attributes
Description

Type

AccessAttrib used to specify the authentication key for
the SNMP request agent. When enabled, the SMS
responds to the SNMP system request.

Stringwrite-onlyStringread-write

Attributesnmp.request-auth-key

Range

Example:set snmp.request-auth-key=mykey
snmp.request-auth-proto

Attrib used to specify the authentication protocol
for the SNMP request agent. When enabled, the
SMS responds to the SNMP system request.
Valid protocol values are: None, MD5, and SHA.
Example:set snmp.request-auth-proto=MD5

41

SMS Command Line Interface Reference

Attributesnmp.request-community

Description

Type

AccessAttrib used to specify the community string for the
SNMP request agent. When enabled, the SMS
responds to the SNMP system request.
Example:Stringread-write

Bool

read-write

Stringread-write

Stringwrite-onlyStringread-write

Stringread-write

Stringwrite-only

set snmp.request-community=public
snmp.request-enable

Attrib used to enable/disable the SMS SNMP
request agent. When enabled, the SMS responds
to SNMP system requests.
Example:set snmp.request-enable=true

snmp.request-engine

Attrib used to specify the engine ID for the SNMP
request agent. When enabled, the SMS responds
to the SNMP system request.
Example:set snmp.request-engine=012345

snmp.request-priv-key

Attrib used to specify the privacy key for the SNMP
request agent. When enabled, the SMS responds
to the SNMP system request.
Example:set snmp.request-priv-key=mykey

snmp.request-priv-proto

Attrib used to specify the privacy protocol for the
SNMP request agent. When enabled, the SMS
responds to the SNMP system request. Valid
protocol values are:
•

None

•

AES-128•

AES-192•

AES-256•

DES•

Triple_DES

Example:set snmp.request-priv-proto=AES-128
snmp.request-user

Attrib used to specify the user name for the SNMP
request agent. When enabled, the SMS responds
to the SNMP system request.
Example:set snmp.request-user=myuser

snmp.request-version

Attrib used to change the version for the SNMP
request agent. When enabled, the SMS responds
to the SNMP system request. Valid version values
are: v2 or v3.
Example:set snmp.request-version=v2

42

Range

SMS Command Line Interface Referencesnmp-trap attributes
Attributesnmp.trap-add

Description

Type

AccessAttrib used to add a new SNMP trap destination. An IP
address and SNMP version uniquely identify adestination. The IP address must be specified. The SNMP
version is optional and can be specified when separated
by a comma.
Examples:Stringwrite-onlyStringwrite-onlyStringread-write

Stringread-write

Stringwrite-onlyStringread-write

Range

set snmp.trap-add=1.1.1.1
set snmp.trap-add=1.1.1.1,v3
snmp.trap-auth-key

Attrib used to specifiy the authentication protocol for an
SNMP trap destination. The IP address must be specified.
The SNMP version is optional and can be specified whenseparated by a comma.
Examples:set snmp.trap-auth-key?1.1.1.1=mkey
set snmp.trap-auth-key?1.1.1.1,v3= mykey

snmp.trap-auth-proto

Attrib used to specifiy the authentication key for an SNMP
trap destination. The IP address must be specified. The
SNMP version is optional and can be specified whenseparated by a comma.
Valid protocol values are: None, MD5, and SHA.
Examples:set snmp.trap-auth-proto?1.1.1.1=MD5
set snmp.trap-auth-proto?1.1.1.1,v3= MD5

snmp.trap-community

Attrib used to specifiy the community string for an SNMP
trap destination. The IP address must be specified. The
SNMP version is optional and can be specified whenseparated by a comma.
Examples:set snmp.trap-community?1.1.1.1= public
set snmp.trap-community?1.1.1.1,v2= public

snmp.trap-delAttrib used to remove an SNMP trap destination. The IP
address must be specified. The SNMP version is optionaland can be specified when separated by a comma.
Examples:set snmp.trap-del=1.1.1.1
set snmp.trap-del=1.1.1.1,v3

snmp.trap-engine

Attrib used to specify the engine ID for an SNMP trap
destination. The IP address must be specified. The SNMP
version is optional and can be specified when separated
by a comma.
Examples:set snmp.trap-engine?1.1.1.1=012345
set snmp.trap-engine?1.1.1.1,v3= 012345

43

SMS Command Line Interface Reference

Attributesnmp.trap-info

Description
Attrib used to list the SNMP trap destination
Example:Type

AccessStringread-onlyInt

read-write

Stringwrite-onlyStringread-write

Stringread-write

Stringwrite-only

get snmp.trap-info
snmp.trap-port

Attrib used to specify the port for an SNMP trap
destination. The IP address must be specified. The SNMP
version is optional and can be specified when separated
by a comma.
Examples:set snmp.trap-port?1.1.1.1=162
set snmp.trap-port?1.1.1.1,v2=162

snmp.trap-priv-key

Attrib used to specify the privacy key for an SNMP trap
destination. The IP address must be specified. The SNMP
version is optional and can be specified when separated
by a comma.
Examples:set snmp.trap-priv-key?1.1.1.1=mkey
set snmp.trap-priv-key?1.1.1.1,v3= mykey

snmp.trap-priv-proto

Attrib used to specify the privacy protocol for an SNMP
trap destination. The IP address must be specified. The
SNMP version is optional and can be specified whenseparated by a comma. Valid protocol values are:
•

None

•

AES-128•

AES-192•

AES-256•

DES•

Triple_DES

Examples:set snmp.trap-priv-proto?1.1.1.1= AES-128
set snmp.trap-priv-proto?1.1.1.1,v3= AES-128
snmp.trap-user

Attrib used to specify the user name for an SNMP trap
destination. The IP address must be specified. The SNMP
version is optional and can be specified when separated
by a comma.
Examples:set snmp.trap-user?1.1.1.1=testuser
set snmp.trap-user?1.1.1.1,v3= testuser

snmp.trap-version

Attrib used to change the version for an SNMP trap
destination. The IP address must be specified. The SNMP
version is optional and can be specified when separated
by a comma. Valid version values are: v2 or v3.
Examples:set snmp.trap-version?1.1.1.1=v3
set snmp.trap-version?1.1.1.1,v2=v3

44

Range

SMS Command Line Interface Reference

svc
Collection of attribs used to enable various services that execute within the system. While the system
implements an internal firewall to protect against attacks, further security can be implemented by disabling
unneeded services.
Related commands
ntp, snmp, pwd

svc attributes
Attributesvc.fips-enable

Description
Attribute used to enable/disable SMS FIPS mode. In thismode, only FIPS 140-2 approved cryptographic
algorithms are used when allowing SSH connections.

Type

Access

Range

Bool

read-write

0

Bool

read-write

0

Note
FIPS mode cannot be enabled if SSH has not beenenabled. Also, disabling SSH automaticallydisables FIPS mode.
Example: set svc.fips-enable=yes
svc.https-enable

Attribute used to enable/disable the HTTPS (Secure
HTTP protocol) service.
The HTTPS service is used to download the SMS client
during the installation process. The service is configured
to prevent CGI and other active server processing. Oncethe client is downloaded, the service can be disabled
until an updated client is available.
To enable HTTPS, set the svc.https-enable attrib totrue. To disable, set to false.

svc.ping-enable

Attribute used to enable/disable incoming ping support.
Responding to pings can be considered a security
weakness for systems. When disabled, the SMS will not
respond to ICMP Echo Requests.
Example: set svc.ping-enable=true

Bool

read-write0

svc.ntp-enable

Attrib used to enable/disable the NTP (Network Time
Protocol) client. The NTP client can be used tosynchronize system time with a list of remote time
servers.
To enable the NTP client, set the value to true, and a listof servers should be provided with the ntp.server1 (...)
attribs. To disable the value should be set to false.

Bool

read-write

0

Bool

read-write0

Example: set svc.ntp-enable=true
svc.snmp-enable

Attribute used to enable/disable the SNMP (Simple
Network Management Protocol) agent.
The SNMP service provides limited, read-only
management support to a remote SNMP manager. To
enable SNMP, set the svc.snmp-enable attrib to true.
To disable, set to false. The community name for get
requests can be set with the snmp.get-community
attrib.
Example: set svc.snmp-enable=true

45

SMS Command Line Interface Reference

Attribute
svc.ssh-enable

Description

Type

Attribute used to enable/disable the SSH (Secure Shell)
service. The SSH service is used to provide secured,
remote CLI (Command Line Interface) access to thesystem. If SSH is disabled, the CLI can still be accessed byconnecting a terminal or a keyboard/monitor to thechassis. The SMS server supports SSH protocol version 2.
To enable SSH, set the svc.ssh-enable attrib to true.
To disable, set to false.

Access

Range

Bool

read-write0Int

read-write

30-600Int

read-write

3-6

Bool

read-write0

Example: set svc.ssh-enable=true
svc.ssh-loginGraceTime

Attribute used to set the SSH Login Grace time.
The Login Grace Time is used to set the amount of time auser has to enter a password and establish a connection.
The SMS disconnects after this time if the user has not
successfully logged in. The default is 60 seconds, but you
can set the time from 30 to 600 seconds.
Example: set svc.ssh-loginGraceTime=60

svc.ssh-maxAuthTries

Attribute used to reset the connection after the max
authentication attempts value has been reached. The
default value is 6. The sshd process will be restarted
when this value is changed.
Example: set svc.ssh-maxAuthTries=3

svc.taxii-enable

Attribute used to enable/disable the TAXII service. The
TAXII service is used to transfer Structured Threat
Information Expression (STIX™) Indicator data to the
SMS. This data can be used to detect suspicious or
malicious cyber activity.
Example: set svc.taxii-enable=truesw
Collection of software versioning attribs. The attribs are used to report the system software version, and tolist the software packages and their individual versions.
sw attributes
Attribute

Description

Type

AccessRange

sw.components

Returns a list of installed software packages
and their versions.

Stringread-only

0-1024sw.version

Attribute returning the system software
version.

Stringread-only

1-32

sys
Collection of system-related attribs. The attribs retain system values, including the system name, locationand contact

46

SMS Command Line Interface Reference

sys attributes
Attribute

Description

Type

AccessRange

sys.contact

Attribute holding the system contact. Normally,
this file contains the name and/or address of theadministrator of this system.

Stringread-write

0-64

sys.hypervisor

Attribute holding the system hypervisor.

Nameread-only

1-32

sys.location

Attribute holding the system location. Normally,
this field contains the physical location of thesystem.

Stringread-write

0-64

sys.model

Attribute returning the model of the SMS. Provide
this model in interactions with support staff.

Stringread-only

1-32

sys.name

Attribute holding the system name. The systemname must be set. It will be used in systemprompts.

Name

read-write

1-32

sys.platform

Attribute returning the platform name. Provide
this model number in interactions with support
professionals.

Stringread-only

1-32

sys.serialNum

Attribute returning the unique ${PRODUCT}
system serial number. Provide this serial number
in interactions with support professionals.

Stringread-only

20

tacacs+Collection of tacacs+-related attribs. The attribs are used to enable and configure TACACS+ for the SMS. For
information about managing users including user groups, passwords, and security levels, see the“Administration” chapter in the SMS User Guide.
Tacacs+ attributes
Attribute

Description

Type

AccessRange

tacacs.enable

Attribute used to enable/disable TACACS+.

Bool

read-write

tacacs.reset

Attribute used to reset remote authentication to
local authentication.

Bool

read-write

tacacs1.attempts

Attrib used to set the number of password
attempts allowed.

Intread-write

tacacs1.authmethod

Attrib to set the authentication method (ASCII,
PAP, CHAP, MS_CHAP)

Stringread-write

tacacs1.hostname

Attrib used to set the TACACS+ server hostname.

Stringread-write

tacacs1.port

Attrib used to set the port on the TACACS+ serverthat listens for authentication requests

Intread-write

1-65535

tacacs1.secret

Attrib used to enter the TACACS+ secret set by the
TACACS+ server administrator. This entry is usedby each TACACS+ client, including the SMS server.

Stringread-write

1-63

tacacs1.server

Attrib used to set the IP address of the TACACS+
server.

IPaddrread-write0

Primary TACACS+ Server
1-10

47

SMS Command Line Interface Reference

Attribute

Description

Type

AccessRange

Attrib used to set the maximum timeout period inseconds.

Int

read-write

1-15

tacacs2.attempts

Attrib used to set the number of password
attempts allowed.

Intread-write

1-10

tacacs2.authmethod

Attrib to set the authentication method (ASCII,
PAP, CHAP, MS_CHAP)

Stringread-write

tacacs2.hostname

Attrib used to set the TACACS+ server hostname.

Stringread-write

tacacs2.port

Attrib used to set the port on the TACACS+ serverthat listens for authentication requests

Intread-write

1-65535

tacacs2.secret

Attrib used to enter the TACACS+ secret set by the
TACACS+ server administrator. This entry is usedby each TACACS+ client, including the SMS server.

Stringread-write

1-63

tacacs2.server

Attrib used to set the IP address of the TACACS+
server.

IPaddrread-write0tacacs2.timeout

Attrib used to set the maximum timeout period inseconds.

Int

read-write

1-15

tacacs3.attempts

Attrib used to set the number of password
attempts allowed.

Intread-write

1-10

tacacs3.authmethod

Attrib to set the authentication method (ASCII,
PAP, CHAP, MS_CHAP)

Stringread-write

tacacs3.hostname

Attrib used to set the TACACS+ server hostname.

Stringread-write

tacacs3.port

Attrib used to set the port on the TACACS+ serverthat listens for authentication requests

Intread-write

1-65535

tacacs3.secret

Attrib used to enter the TACACS+ secret set by the
TACACS+ server administrator. This entry is usedby each TACACS+ client, including the SMS server.

Stringread-write

1-63

tacacs3.server

Attrib used to set the IP address of the TACACS+
server.

IPaddrread-write0tacacs3.timeout

Attrib used to set the maximum timeout period inseconds.

Int

read-write

1-15

tacacs1.timeout

Secondary TACACS+ Server

Tertiary TACACS+ ServertimeCollection of system time attribs. The attribs are used to configure the local time zone and the current systemtime.
See also
ntp

48

SMS Command Line Interface Referencetime attributes
Attribute

Description

Type

Accesstime.dateTime

Displays the current system time in a readable format.

Stringread-only

32

time.setTime

Displays and sets the current system time. The date andtime is specified in the format: [MMDDhhmm[[CC]YY][.ss]]

Stringread-write

32

time.setTimeZone

Displays and sets the current local time zone. Timezones can be represented in several forms. For example,
US Eastern Time can be represented as either of thefollowing:

Stringread-write

2-48

•

EST5EDT•

America/Newark

Range

The first format is the preferred format: a three-letterzone, followed by a time offset from GMT, and anotherthree-letter zone for the daylight savings time.
Examples:set time.setTimeZone= America/
New_York set time.setTimeZone=CST6CDT

49