Network Management Card with Modbus for the UPSB505 Uninterruptible Power Supply Caterpillar


Command Line Interface

Usage:

UPSB 505 YTM

How To Log On

Overview

You can use either a local (serial) connection, or a remote (Telnet or SSH) connection with a computer on the same network as the Network Management Card to access the "Command Line Interface".

Use case-sensitive user name and password entries to log on (by default, cat and cat for an Administrator, or device and cat for a Device User). A Read-Only User cannot access the "Command Line Interface".

ReferenceIf you cannot remember your user name or password, see the "How to Recover from a Lost Password" section in the, "General Information" chapter of this manual.

Remote Access To The Command Line Interface

You can access the "Command Line Interface" through Telnet or SSH. Telnet is enabled by default. Enabling SSH disables Telnet.

To enable or disable these access methods, use the "Web interface". On the "Administration" tab, select "Network" on the top menu bar, and then the access "option" under "Console" on the left navigation menu.

Telnet For Basic Access

Telnet provides the basic security of authentication by user name and password, but not the high-security benefits of encryption.

To use Telnet, to access the "Command Line Interface":

  1. From a computer that has access to network on which the Management Card is installed, at a command prompt, type "telnet", and the IP address for the Management Card (for example, telnet 139.225.6.133, when the Management Card uses the default Telnet port of 23), and press "ENTER".

    If the Management Card uses a non-default port number (from 5000 to 32768), include a colon or a space, depending on your Telnet client, between the IP address (or DNS name) and the port number. These are commands for general usage: some clients do not allow you to specify the port as an argument and some types of Linux might want extra commands.

  1. Enter the user name and password (by default, cat and cat for an Administrator, or device and cat for a Device User).

Ssh for High-Security Access

If you use the high security of SSL for the "Web interface", use SSH for access to the "Command Line Interface". SSH encrypts user names, passwords, and transmitted data. The interface, user accounts, and user access rights are the same whether you access the "Command Line Interface" through SSH or Telnet. To use SSH configure SSH and have an SSH client program installed on your computer first.

Local Access to the "Command Line Interface"

For local access, use a computer that connects to the Management Card through the serial port to access the "Command Line Interface":

  1. Select a serial port at the computer and disable any service that uses the port.

  1. Connect the provided serial cable from the selected port on the computer to the configuration port at the Management Card.

  1. Run a terminal program, and configure the selected port for 9600 bps, eight data bits, no parity, one stop bit, and no flow control.

  1. Press "ENTER" twice. At the prompts, enter your user name and password.

Main Screen

Following is an example of the screen displayed when you log on to the "Command Line Interface" at the Management Card.




Illustration 1g02552117

Information and Status Fields

Main Screen Information Fields

  • Two fields identify the operating system (AOS) and application (APP) firmware versions. The application firmware name identifies the device that connects to the network through this Management Card.

AOS ... vx.x.x

APP ... vx.x.x

  • Three fields identify the system name, contact person, and location of the Management Card. (In the "Web interface", select the "Administration" tab, "General" in the top menu bar, and "Identification" in the left navigation menu to set these values.)

"Name : Test Lab"

"Contact: Don Adams"

"Location: Building 3"

  • The Up Time field reports how long the Management Card has been running since the NMC was last turned on or reset.

"Up Time: 0 Days 21 Hours 21 Minutes"

  • Two fields report when you logged in, by date and time.

"Date : 10/30/2009"

"Time : 5:58:30"

  • The "User" field reports whether you logged in through the "Administrator" or "Device Manager" account. (The "Read Only User" account cannot access the "Command Line Interface".) When you log on as Device Manager (equivalent to Device User in the "Web interface"), you can access the event log and view the number of active alarms.

"User : Administrator"

Main Screen Status Fields

  • The Stat field reports the Management Card status.

"Stat : P+ N+ A+"

Table 1
P+     The operating system (AOS) is functioning properly.    
N+     The network is functioning properly.    
N?     A BOOTP request cycle is in progress.    
N-     The Management Card failed to connect to the network.    
N!     Another device is using the IP address of the Management Card.    
A+     The application is functioning properly.    
A-     The application has a bad checksum.    
A?     The application is initializing.    
A!     The application is not compatible with the AOS.    

If P+is not displayed, contact your Caterpillar dealer.

ReferenceTo view the status of the UPS, access the "Web interface" of the Management Card. For more information, refer to the, "Web Interface" chapter of this manual.

Using the Command Line Interface

Overview

The "Command Line Interface" provides options to configure the network settings and monitor the Management Card.

ReferenceTo view the status of the UPS, access the "Web interface" of the Management Card. For more information, refer to the, "Web Interface" chapter of this manual.

Entering Commands

At the "Command Line Interface", use commands to configure the Management Card. To use a command, type the command and press "ENTER". Commands and arguments are valid in lowercase, uppercase, or mixed case. Options are case-sensitive.

At the "Command Line Interface", you can also use these keyboard shortcuts:

  • Type "?" and press "ENTER" to view a list of available commands, based on your account type.

To obtain information about the purpose and syntax of a specified command, type the command, a space, and "?" or the word "help". For example, to view "RADIUS" configuration options, type:

"radius ?"

or

"radius help"

  • Press the "UP" arrow key to view the command that was entered most recently in the session. Use the "UP" and "DOWN" arrow keys to scroll through a list of up to ten previous commands.

  • Type at least one letter of a command, then press the "TAB" key to scroll through a list of valid commands that match the text you typed in the "Command Line".

  • Type "exit" or "quit" to close the connection to the "Command Line Interface".

Command Syntax

Table 2
Item     Description    
-     Options are preceded by a hyphen.    
< >     Definitions of options are enclosed in angle brackets. (1)    
[ ]     If a command accepts multiple options or an option accepts mutually exclusive arguments, the values may be enclosed in brackets.    
l     A vertical line between items enclosed in brackets or angle brackets indicates that the items are mutually exclusive. Use of one of the items is required.    
( 1 ) For example: -dp <device password>

Syntax Examples

A Command That Supports Multiple Options

user [ -an <admin name> ] [ -ap <admin password> ]

In the preceding example, the user command accepts the option "-an", which defines the Administrator user name, and the option "-ap", which defines the Administrator password. To change the Administrator user name and password to "XYZ":

  1. Type the user command, one option, and the argument XYZ:

    "user -ap XYZ"

  1. After the first command succeeds, type the user command, the second option, and the argument XYZ:

    "user -an XYZ"

A Command That Accepts Mutually Exclusive Arguments For An Option

"alarmcount -p [ all Iwarning Icritical ]"

In the preceding example, the option "-p" accepts only three arguments: all, warning, or critical. For example, to view the number of active critical alarms, type:

"alarmcount -p critical"

The command will fail if you type an argument that is not specified.

Command Response Codes

The command response codes enable scripted operations to detect error conditions reliably without having to match error message text.

The CLI reports all command operations with the following format:

"E [0–9] [0–9] [0–9] : Error message"

Table 3
Code     Error message    
E000     Success    
E100     Command failed    
E101     Command not found    
E102     Reserved    
E103     Reserved    
E104     Reserved    
E200     Reserved    

Command Descriptions

?

Access - Administrator, Device User

Description - View a list of all the CLI commands available to your account type. To view help text for a specific command, type the command followed by a question mark.

Example - To view a list of options that are accepted by the "alarmcount" command, type:

"alarmcount ?"

about

Access - Administrator, Device User

Description - View hardware and firmware information. This information is useful in troubleshooting and enables you to determine if updated firmware is available.

"alarmcount"

Access - Administrator, Device User

Description -

Table 4
Option     Arguments     Description    
-p     all     View the number of active alarms reported by the NMC. Information about the alarms is provided in the event log.    
warning View the number of active warning alarms.    
critical View the number of active critical alarms.    

Example - To view all active warning alarms, type:

"alarmcount -p warning"

boot

Access - Administrator only

Description - Define how the NMC will obtain network settings, including the IP address, subnet mask, and default gateway. Then configure the BOOTP or DHCP server settings.

Table 5
Option     Argument     Description    
-b <boot mode>     dhcp l bootp l manual     Define how the TCP/IP settings will be configured when the NMC turns on, resets, or restarts.
Refer to the "TCP/IP and Communication Settings" section in the, "Administration:Network Features" chapter of this manual.    
-c     enable l disable     dhcp boot modes only. Enable or disable the requirement that the DHCP server provides the cookie.    
The default values for these three settings do not need changing:
-v <vendor class> :
-i <client id> : The MAC address of the NMC, which uniquely identifies the NMC on the network
-u <user class> :The name of the application firmware module    

Example - To use a DHCP server, to obtain network settings:

  1. Type "boot -b dhcp"

  1. Enable the requirement that the DHCP server provides the cookie:

    "boot -c enable"

cd

Access - Administrator, Device User

Description - Navigate to a folder in the directory structure of the NMC.

Example 1 - To change to the ssh folder, and confirm that an SSH security certificate was uploaded to the NMC:

  1. Type "cd ssh" and press "ENTER".

  1. Type "dir" and press "ENTER" to list the files stored in the SSH folder.

Example 2 - To return to the main directory folder, type:

"cd .."

console

Access - Administrator only

Description - Define whether users can access the "Command Line interface" using Telnet, which is enabled by default, or Secure SHell (SSH), which provides protection by transmitting user names, passwords, and data in encrypted form. You can change the Telnet or SSH port setting for additional security. Alternately, disable network access to the "Command Line interface".

Table 6
Option     Argument     Description    
-S     disable l telnet l ssh     Configure access to the "Command Line interface", or use the disable command to prevent access.. Enabling SSH enables SCP and disables Telnet.    
-pt     <telnet port n>     Define the Telnet port used to communicate with the NMC (23 by default).    
-ps     <SSH port n>     Define the SSH port used to communicate with the NMC (22 by default).    
-b     2400 l 9600 l 19200 l 38400     Configure the speed of the serial port connection (9600 bps by default).    

Example 1 - To enable SSH access to the "Command Line interface", type:

"console -S ssh"

Example 2 - To change the Telnet port to 5000, type:

"console -pt 5000"

date

Access - Administrator only

Description - Configure the date used by the NMC.

ReferenceTo configure an NTP server to define the date and time for the NMC, refer to the "Set the Date and Time" section in the, "Administration: General Options" chapter of this manual.

Table 7
Option     Argument     Description    
-d     <datestring>     Set the current date. Use the date format specified by the date -f command.    
-t     <00:00:00>     Configure the current time, in hours, minutes, and seconds. Use the 24-hour clock format.    
-f     mm/dd/yy l dd.mm.yyyy l mm-dd-yy l dd-mm-yy l yyyy-mm-dd     Select the numerical format in which to display all dates in this user interface. Each letter m (for month), d (for day), and y (for year) represents one digit. Single-digit days and months are displayed with a leading zero.    
-z     <time zone offset>     Set the difference with GMT in order to specify your time zone. Enables you to synchronize with other people in different time zones.    

Example 1 - To display the date using the format yyyy-mm-dd, type:

"date -f yyyy-mm-dd"

Example 2 - To define the date as October 30, 2009, using the format configured in the preceding example, type:

"date -d 2009-10-30"

Example 3 - To define the time as 5:21:03 p.m., type:

"date -t 17:21:03"

delete

Access - Administrator only

Description - Delete the event or data log, or delete a file in the file system.

Table 8
Argument     Description    
<file name>     Type the name of the file to delete.    

Example - To delete the event log:

  1. Navigate to the folder that contains the file to delete. For example, to navigate to the "logs" folder, type:

    "cd logs"

  1. To view the files in the logs folder, type:

    "dir"

    The file event ".txt" is listed.

  1. Type

    "delete event.txt."

dir

Access - Administrator, Device User

Description - View the files and folders stored on the NMC.

dns

Access - Administrator

Description - Configure the manual Domain Name System (DNS) settings.

Table 9
Parameter     Argument     Description    
-OM     enable l disable     Override the manual DNS.    
-p     <primary DNS server>     Set the primary DNS server.    
-s     <secondary DNS server>     Set the secondary DNS server.    
-d     <domain name>     Set the domain name.    
-n     <domain name IPv6>     Set the domain name IPv6.    
-h     <host name>     Set the host name.    

eventlog

Access - Administrator, Device User

Description - View the date and time you retrieved the event log, the status of the UPS, and the status of sensors connected to the NMC. View the most recent device events, and the date and time the event occurred. Use the following keys to navigate the event log:

Table 10
Key     Description    
ESC     Close the event log and return to the "command line interface".    
ENTER     Update the log display. Use this command to view events that were recorded after you last retrieved and displayed the log.    
SPACEBAR     View the next page of the event log.    
B     View the preceding page of the event log. This command is not available at the main page of the event log.    
D     Delete the event log. Follow the prompts to confirm or deny the deletion. Deleted events cannot be retrieved.    

exit

Access - Administrator, Device User

Description - Exit from the "Command Line Interface" session.

format

Access - Administrator only

Description - Reformat the file system of the NMC and erase all security certificates, encryption keys, configuration settings, and the event and data logs. Be careful with this command.

Note: To reset the NMC to the default configuration, use the "resetToDef" command.

ftp

Access - Administrator only

Description - Enable or disable access to the FTP server. Optionally, change the port setting to the number of any unused port from 5001 to 32768 for added security.

Table 11
Option     Argument     Definition    
-p     <port number>     Define the TCP/IP port that the FTP server uses to communicate with the NMC (21 by default). The FTP server uses both the specified port and the port one number lower than the specified port.    
-S     enable l disable     Configure access to the FTP server.    

Example - To change the TCP/IP port to 5001, type:

"ftp -p 5001"

help

Access - Administrator, Device User

Description - View a list of all the CLI commands available to your account type. To view help text for a specific command, type the command followed by "help".

Example 1 - To view a list of commands available to someone logged on as a Device User, type:

"help"

Example 2 - To view a list of options that are accepted by the "alarmcount" command, type:

"alarmcount help"

modbus

Access - Administrator only

Description - Manually configure these Modbus settings for the Management Card:

Table 12
Option     Argument     Description    
-p         Display the configured Modbus parameters.    
-a     enable l disable     Enable or disable the Modbus feature.    
-o     master l slave     Define the mode of operation for the Modbus feature.    
-br     9600 l 19200     Set the baud rate.    
-pr     even l odd l none     Set the parity bit.    
-s     <slave # in hex>     Set the Modbus slave address.    
-rt     <timeout in mSec>     Set the response timeout in milliseconds for query packets in Master mode.    
-sr     <scan rate in mSec>     Set the scan rate for query packets in Master mode.    
-rep     <# of repetitions>     Set the number of repetitions for query packets in Master mode.    

netstat

Access - Administrator, Device User

Description - View the status of the network and all active IPv4 and IPv6 addresses.

ntp

Access - Administrator, Device User

Description - View and configure the network time protocol parameters.

Table 13
Option     Argument     Definition    
-OM     enable l disable     Override the manual settings.    
-p     <primary NTP server>     Specify the primary server.    
-s     <secondary NTP server>     Specify the secondary server.    

Example 1 - To enable the override of manual setting, type:

"ntp -OM enable"

Example 2 - To specify the primary NTP server, type:

"ntp -p 150.250.6.10"

ping

Access - Administrator, Device User

Description - Determine whether the device with the IP address or DNS name you specify is connected to the network. Four inquiries are sent to the address.

Table 14
Argument     Description    
<IP address or DNS name>     Type an IP address with the format xxx.xxx.xxx.xxx, or the DNS name configured by the DNS server.    

Example - To determine whether a device with an IP address of 150.250.6.10 is connected to the network, type:

"ping 150.250.6.10"

portSpeed

Access - Administrator

Description -

Table 15
Option     Arguments     Description    
-s     auto l 10H l 10F l 100H l 100F     Define the communication speed of the Ethernet port. The "auto" command enables the Ethernet devices to negotiate to transmit at the highest possible speed.
Refer to the "Port Speed" section in the, "Administration : Network Features" chapter of this manual for more information about the port speed settings.    

Example - To configure the TCP/IP port to communicate using 100 Mbps with half-duplex communication (communication in only one direction at a time), type:

"portspeed -s 100H"

prompt

Access - Administrator, Device User

Description - Configure the "Command Line Interface" prompt to include or exclude the account type of the currently logged-in user. Any user can change this setting, all user accounts will be updated to use the new setting.

Table 16
Option     Argument     Description    
-s     long     The prompt includes the account type of the currently logged-in user.    
short The default setting. The prompt is four characters long.    

Example - To include the account type of the currently logged-in user in the command prompt, type:

"prompt -s long"

quit

Access - Administrator, Device User

Description - Exit from the "Command Line Interface" session ( works the same as the exit command).

radius

Access - Administrator only

Description - View the existing RADIUS settings, enable or disable RADIUS authentication, and configure basic authentication parameters for up to two RADIUS servers.

ReferenceFor a summary of RADIUS server configuration and a list of supported RADIUS servers, refer to the "Configuring the RADIUS Server" section in the, "Administration : Security" chapter of this manual.

Additional authentication parameters for RADIUS servers are available at the" Web interface" of the NMC.

Table 17
Option     Argument     Description    
-a     local l radiusLocal l radius     -Configure RADIUS authentication:
"local" - RADIUS is disabled. Local authentication is enabled.
"radiusLocal" - RADIUS, then Local Authentication. RADIUS and local authentication are enabled. Authentication is requested from the RADIUS server first. If the RADIUS server fails to respond, local authentication is used.
"radius" - RADIUS is enabled. Local authentication is disabled.    
-p1
-p2    
<server IP>     The server name or IP address of the primary or secondary RADIUS server
 (1)    
-s1
-s2    
<server secret>     The shared secret between the primary or secondary RADIUS server and the NMC.    
-t1
-t2    
<server timeout>     The time in seconds that the NMC waits for a response from the primary or secondary RADIUS server.    
( 1 ) RADIUS servers use port 1812 by default to authenticate users. To use a different port, add a colon followed by the new port number to the end of the RADIUS server name or IP address.

Example 1 - To view the existing RADIUS settings for the NMC, type "radius" and press "ENTER".

Example 2 - To enable RADIUS and local authentication, type:

"radius -a radiusLocal"

Example 3 - To configure a 10 - second timeout for a secondary RADIUS server, type:

"radius -t2 10"

reboot

Access - Administrator

Description - Restart the interface of the NMC.

resetToDef

Access - Administrator only

Description - Reset all parameters to default.

Table 18
Option     Arguments     Description    
-p     all l keepip     Reset all configuration changes, including event actions, device settings, and, optionally, TCP/IP configuration settings.    

Example - To reset all of the configuration changes except the TCP/IP settings for the NMC, type:

"resetToDef -p keepip"

snmp, snmp3

Access - Administrator only

Description - Enable or disable SNMP 1 or SNMP 3.

Table 19
Option     Arguments     Description    
-S     enable l disable     Enable or display the respective version of SNMP, 1 or 3.    

Example - To enable SNMP version 1, type:

"snmp -S enable"

system

Access - Administrator only

Description - View and set the system name, the contact, the location and view up time as well as the date and time, the logged-on user, and the high-level system status P, N, A.

Table 20
Option     Arguments     Description    
-n     <system name>     Define the device name, the name of the person responsible for the device, and the physical location of the device.
Note: If you define a value with more than one word, the value in quotation marks must be enclosed.
These values are also used by InfraStruxure Central and the NMCs SNMP agent.    
-c     <system contact>    
-l     <system location>    

Example 1 - To set the device location as "Test Lab", type:

"system -l Test Lab"

Example 2 - To set the system name as "Don Adams", type:

"system -n Don Adams"

tcpip

Access - Administrator only

Description - View and manually configure these network settings for the NMC:

Table 21
Option     Arguments     Description    
-i     <IP address>     Type the IP address of the NMC, using the format xxx.xxx.xxx.xxx    
-s     <subnet mask>     Type the subnet mask for the NMC.    
-g     <gateway>     Type the IP address of the default gateway. Do not use the loopback address (127.0.0.1) as the default gateway.    
-d     <domain name>     Type the DNS name configured by the DNS server.    
-h     <host name>     Type the host name that the NMC will use.    

Example 1 - To view the network settings of the NMC, type "tcpip" and press "ENTER".

Example 2 - To configure an IP address of "150.250.6.10"manually for the NMC, type:

"tcpip -i 150.250.6.10"

tcpip6

Access - Administrator only

Description - Enable IPv6 and view and manually configure these network settings for the NMC (NMC):

Table 22
Option     Argument     Description    
-S     enable l disable     Enable or disable IPv6.    
-man     enable l disable     Enable manual addressing for the IPv6 address of the NMC.    
-auto     enable l disable     Enable the NMC to configure the IPv6 address automatically.    
-i     <IPv6 address>     Set the IPv6 address of the NMC.    
-g     <IPv6 gateway>     Set the IPv6 address of the default gateway.    
-d6     router l stateful l stateless l never     Set the DHCPv6 mode, with parameters of router controlled, stateful (for address and other information, to maintain status), stateless (for information other than address, the status is not maintained ), never.    

Example 1 - To view the network settings of the NMC, type "tcpip6" and press "ENTER".

Example 2 - To configure an IPv6 address of "2001:0:0:0:0:FFD3:0:57ab"manually for the NMC, type:

"tcpip -i 2001:0:0:0:0:FFD3:0:57ab"

tls

Access - Administrator only

Description - Manually configure the TLS settings for the Management Card. TLS is an optional remote monitoring service available on some UPSs :

Table 23
Option     Argument     Description    
-p         Display the configured parameters for the tls command    
-a     enable l disable     Enable or disable the TLS feature.    
-m     <slave number in hex>     Identify the valid alarms that cause an alert to be sent to the TLS service.    
<call cause mask in hex>
-t     <primary l secondary>     Determine what primary or secondary number to call to establish a TLS connection. The telephone number should be configured with country code, area code, and number. Only used for master configuration - a slave UPS can store the information, but it will not be used.    
<telephone#>
-si     <# of connected UPS>     Store the number of UPS systems connected to the Master system, and the slave IDs of each connected UPS in hexadecimal format.    
<slave ID1 in hex> <slave ID2 in hex> <slave ID3 in hex>
-id     <slave ID in hex>     Store the slave ID of the UPS in hexadecimal format.    
<id> 5 character unique ID of the UPS.    
-d     <delay in seconds>     Specify delay before second connection if first attempt is unsuccessful.    
-test     <appearance l disappearance>     Create a test alarm. Only alarms specified by the Call Cause mask will be raised.    
<bit position> Specify the bit position (0 - 15) that will be set in the appearance and disappearance register.    
-initstr     <cat l mge l any other string>     Set the modem INIT string.    
-fialstr     <cat l mge l any other string>     Set the modem DIAL string.    
-resetToDef         Restore the default settings for the TLS feature.    

uio

Access - Administrator, Device User

Description - This command is available for a Network Management Card With Modbus Monitoring with a connected Dry Contact I/O Accessory.

Table 24
Option     Argument     Description    
-rc <UIO port #>     open l close     Change the state of a connected output, and specify the UIO (universal input/ output) port number.    
-st     <UIO port #> l
<UIO port #>,
<UIO port #> l
<UIO port #>_<UIO port #>    
View the status of the sensors connected to the Dry Contact I/O Accessory. To view the status of a specific sensor or several sensors, type the UIO port numbers.    
-disc     <UIO port #> l
<UIO port #>,
<UIO port #> l
<UIO port #> _ <UIO port #>    
Identify new input contact or output relay connections.    

Example 1 - To open the output, type:

"uio -rc 2 open"

Example 2 - To view the status of the devices connected to a Dry Contact I/O Accessory that is installed in universal input/ output port 2, type:

"uio -st 2"

ups

Note: Some ups options are dependent on the UPS model. Not all configurations may support all options of the ups command.

Access - Administrator, Device User

Description - Control the UPS and view status information.

Table 25
Option     Argument     Description    
-input     <phase#> l all     Display the input measurements for the chosen phase of the UPS. Typing "all" displays the information for all phases of the UPS.    
voltage l current l frequency l all Specify the input measurement for the ups command.
Example: ups -input two frequency Displays the frequency for phase 2 of the UPS.    
-bypass     <phase#> l all     Display the input measurements for the chosen phase of the bypass main. Typing "all" displays all phases of the bypass main.    
voltage l current l frequency l all Specify the input measurement for the ups command.
Example: ups -bypass two current Displays the current for phase 2 of the bypass main.    
-output     <phase#> l all     Display the output measurements for the chosen phase of the UPS. Typing "all" displays the information for all phases of the UPS.    
voltage l current l load l power l percload l pf l frequency l all Specify the output measurement for the ups command.
Example: ups -output two percload Displays the percentage of load for phase 2 of the UPS.    
-batt         Display the battery status of the UPS    
-about         Displays information about the UPS.    
-al     <c l w>     Display all existing alarms. Specifying "c" or "w" limits the display to either Critical (c) or Warning (w) alarms.    

user

Access - Administrator only

Description - Configure the user name and password for each account type, and configure the inactivity timeout.

ReferenceFor information on the permissions granted to each account type (Administrator, Device User, and Read-Only User), refer to the "Types of user accounts" in the, "General Information" chapter of this manual.

Table 26
Option     Argument     Description    
-an
-dn
-rn    
<admin name>
<device name>
<read-only name>    
Set the case-sensitive user name for each account type. The maximum length is ten characters.    
-ap
-dp
-rp    
<admin password>
<device password>
<read-only password>    
Set the case-sensitive password for each account type. The maximum length is 32 characters. Blank passwords (passwords with no characters) are not allowed.    
-t     <minutes>     Configure the time (3 minutes by default) that the system waits before logging off an inactive user.    

Example 1 - To change the Administrator user name to XYZ, type:

"user -an XYZ"

Example 2 - To change the log-off time to 10 minutes, type:

"user -t 10"

web

Access - Administrator

Description - Enable access to the "Web interface" using HTTP or HTTPS.

For additional security, you can change the port setting for HTTP and HTTPS to any unused port from 5000 – 32768. Users must then use a colon in the address field of the browser to specify the port number. For example, for a port number of 5000 and an IP address of 152.214.12.114: "http://152.214.12.114:5000"

Table 27
Option     Argument     Definition    
-S     disable l http l https     Configure access to the" Web interface". When HTTPS is enabled, data is encrypted during transmission and authenticated by digital certificate.    
-ph     <http port #>     Specify the TCP/IP port used by HTTP to communicate with the NMC (80 by default).    
-ps     <http port #>     Specify the TCP/IP port used by HTTPS to communicate with the NMC (443 by default).    

Example - To prevent all access to the "Web interface", type:

"web -S disable"

xferINI

Access - Administrator only. This command only works through serial CLI.

Description - Use XMODEM to upload an .ini file while you are accessing the "Command Line Interface" through a serial connection. After the upload completes:

  • If there are any system or network changes, the "Command Line Interface" restarts, and log on again.

  • If you selected a baud rate for the file transfer that is not the same as the default baud rate for the NMC, reset the baud rate to the default to re-establish communication with the NMC.

xferStatus

Access - Administrator only

Description - View the result of the last file transfer.

ReferenceRefer to the "Verifying Upgrades and Updates" section in the, "File Transfer" chapter for descriptions of the transfer result codes.

Caterpillar Information System:

C13, C15, and C18 Tier 4 Final Engines Valve Mechanism Cover
3500 Engines Air Lines - Air Starting Lines
C15 Petroleum Engines Indicator Lamp - Test
C9.3 Tier 4 Final Engines Compression Brake
Network Management Card and Network Management Card with Environmental Monitoring for the UPSB505 Uninterruptible Power Supply Web Interface
Network Management Card and Network Management Card with Environmental Monitoring for the UPSB505 Uninterruptible Power Supply General Information
Network Management Card with Modbus for the UPSB505 Uninterruptible Power Supply General Information
C15 Petroleum Engines Air Shutoff - Test
3500 Engines Engine Air Cleaner Service Indicator
3500 Engines Engine Air Cleaner Service Indicator
C13, C15, and C18 Tier 4 Final Engines Housing (Front)
3500 Engines Air Cleaner
CG137-08 and CG137-12 Engines Sensors and Electrical Components
NEHS1126: 370-8570 Bulk Fuel Filtration Group 200 GPM Flow Rate {0599, 0680, 0706, 0782, 1250, 1280} NEHS1126: 370-8570 Bulk Fuel Filtration Group 200 GPM Flow Rate {0599, 0680, 0706, 0782, 1250, 1280}
C13, C15, and C18 Tier 4 Final Engines Exhaust Gas Valve (NRS)
2011/05/26 New Cylinder Pack Assemblies Are Available in Sets for Certain Machines Equipped with C18 Engines {1201, 1216, 1225, 1239}
2015/09/17 New Cylinder Pack Assemblies Are Available in Sets for Certain C18 Engines {1201, 1216, 1225, 1239}
C15 Petroleum Engine General Information
C27 Generator Set Engine Oil and Filter - Change
C15 Petroleum Generator Set Maintenance Interval Schedule
2012/11/14 A New Check Valve Is Used for the Fuel Return on C175-16 Generator Set Engines {1250}
3500 Engines Air Lines
C9.3 Tier 4 Final Engines Electronic Unit Injector Wiring
C15 Petroleum Engines Exhaust Manifold
Back to top
The names Caterpillar, John Deere, JD, JCB, Hyundai or any other original equipment manufacturers are registered trademarks of the respective original equipment manufacturers. All names, descriptions, numbers and symbols are used for reference purposes only.
CH-Part.com is in no way associated with any of the manufacturers we have listed. All manufacturer's names and descriptions are for reference only.