Tripp Lite S3M30KX-NIB Bedienungsanleitung

Tripp Lite Nicht kategorisiert S3M30KX-NIB

Lesen Sie kostenlos die 📖 deutsche Bedienungsanleitung fĂŒr Tripp Lite S3M30KX-NIB (219 Seiten) in der Kategorie Nicht kategorisiert. Dieser Bedienungsanleitung war fĂŒr 7 Personen hilfreich und wurde von 2 Benutzern mit durchschnittlich 4.5 Sternen bewertet

Download PDF
Seite 1/219
User’s Guide
PowerAlertÂź Device Manager
(PADM) 20.0.0
Command Line Interface
1111 W. 35th Street, Chicago, IL 60609 USA ‱ tripplite.com/support
Copyright © 2021 Tripp Lite. All rights reserved.
WARRANTY REGISTRATION
Register your product today and be
automatically entered to win an ISOBARÂź
surge protector in our monthly drawing!
tripplite.com/warranty
2
Table of Contents
1. Overview 4
2. Logging In 5
3. Entering Commands 6
3.1 General CLI Commands 6
3.2 Keyboard Shortcuts 7
4. Log Navigation 8
5. CLI Commands 9
aaa 9
action 10
contact 11
count 12
delay 13
enable 13
interval 14
load 15
load-group 16
name 17
output-contact 17
show 18
snmp-set 19
target-device 20
trigger 21
alert 22
apply 25
autoprobe 25
authentication 26
community 27
description 27
enable 28
interval 29
name 29
primary 30
privacy 31
retry 32
secondary 33
security-mode 34
show 35
username 36
version 36
backup 37
clock 37
contact 39
default 39
device 43
<keyword> 44
apply 45
asset-tag 46
auto-restart 46
avr 48
battery 49
buzzer 52
bypass 53
cold-start 54
date-installed 54
db9 55
dehumidifying 56
details 57
energy 57
fault 58
id 59
input 59
last-reason 60
load 61
load-group 67
location 72
mute 72
name 73
off 74
off-mode 74
on 75
on-battery 75
output 76
power 78
ramp 79
remote 79
region 80
reset 81
restart 81
restore-hardware 82
sensor 82
set-point 92
shed 93
show 94
shutdown 95
watt-hours 96
dns 96
email 98
address 99
enable 99
name 100
show 101
test 101
3
Table of Contents
event 102
acknowledge 104
enable 105
logging 105
name 107
severity 107
show 108
exit 108
ïŹrmware 109
help 110
host 110
http 111
https 112
ipv4 113
ipv6 115
Idap-server 117
anonymous 118
attribute 118
bind 119
domain 120
enable 121
host 121
name 122
object-class 123
port 123
priority 124
search 125
show 126
test 126
type 127
log 128
autoexport 129
export 130
interval 131
max-size 132
metrics 133
severity 134
show 134
man 138
password 138
password-policy 139
radius-server 141
accounting 142
authentication 143
enable 144
host 145
name 145
password 146
priority 146
show 147
test 148
reboot 148
restore 149
role 149
description 150
name 151
privilege 152
show 153
schedule 154
enable 155
frequency 156
load 157
load-group 158
name 159
output-contact 160
recurrence 161
restart 162
run-on 163
show 164
target-device 165
scp 165
session 166
sftp 167
show 168
sms 169
contact 170
enable 171
name 171
show 172
test 173
smtp 174
snmp 178
snmp-server 180
authentication 181
community 182
enable 182
host 183
name 183
privacy 184
security-mode 185
set 186
show 187
trap 188
username 189
snmp-user 190
authentication 191
community 192
contact 192
description 193
enable 194
ïŹlter 195
privacy 196
role 197
security-mode 197
show 198
username 199
ssh 199
syslog-server 201
enable 202
facility 202
host 203
log 204
name 204
port 205
severity 206
show 207
telnet 207
user 209
contact 210
description 210
enable 211
ïŹlter 212
fullname 213
password 213
password-age 214
role 215
show 216
timeout 216
username 217
4
Beginning with ïŹrmware version 20.0.0, LX Platform devices support a full-featured Command Line Interface (CLI). Nearly all
functions and controls available through the web interface are accessible via CLI. Additionally, CLI allows for the use of scripts
to facilitate operation and integration with third-party systems.
The CLI can be accessed on LX Platform devices through the RJ45 network port, Micro USB port or RJ45 CONFIG port.
Once connected, use a terminal emulator application – (such as PuTTY) – to access the CLI via Secure Shell (SSH) on default
port 22. Enter the Host Name or IP address of the LX Platform device in the applicable ïŹeld, then click “Open.”
Figure 1-1: PuTTY terminal emulator
1. Overview
5
In the terminal window that opens, enter the login credentials. The default login and password credentials are both
localadmin. Note that the initial login to the device may require a password change. In this case, prompts will be provided for
changing the password. Upon successful log in, a welcome message appears, followed by the root-level command prompt.
Figure 2-1: CLI Login
Note: PADM supports a maximum of two concurrent CLI sessions. If a third session is attempted, a warning message will appear that the
session limit has been reached. The exception to this is if the third session is logging in with the default localdmin/localadmin credentials, in
which case the oldest active session will be terminated.
2. Logging In
6
Commands can be entered individually by typing the command at the prompt.
console> snmp port 165
console> no snmp v1 enable
console> snmp v3 enable
PADM also supports command-chaining, whereby related commands and parameters can be sequentially added in a single
line, separated by a semi-colon (;)
console> snmp port 165;no snmp v1 enable;snmp v3 enable
If using command-chaining with a nested command, end the line with “end” to exit from the nested command format.
Otherwise, the prompt will remain in the nested format
console> email user1;address user1@company.com;enable;end
For quick-reference information on the usage of a command, enter the command name at the prompt. For detailed
information about a command, view its manual page by entering “man” followed by the command name at the prompt.
When displayed log reports exceed one page, the bottom of the screen will display a pagination indicator. The numbers
appearing in brackets are the current page number and the total number of pages. The numbers appearing in carets (<>)
indicate horizontal continuation of the current page. At the cursor, enter the desired page number or a letter designating the
support navigation commands: [f]irst, [p]rev, [n]ext, [l]ast, [r]efresh, [q]uit. Enter the left or right caret to display the respective
horizontal continuation of the page.
[1/56], <1/2>:q
3.1 General CLI Commands
? Displays a list of commands.
help Displays a list of commands.
end Exits a nested command section and returns to the previous section.
exit Exits a nested command section and returns to the previous section. Terminates the CLI session,
if entered at the root level.
man Displays the manual page (description) of a command.
no Disables, removes or deletes content.
show Displays command or keyword details.
<> Indicates a required value in place of the brackets and text within.
[] Indicates an optional parameter.
{} Indicates a required parameter; an item from the list of choices must be selected.
| Separates mutually exclusive choices.
[{}] Indicates a required choice within an optional element.
3. Entering Commands
7
3. Entering Commands
3.2 Keyboard Shortcuts
Ctrl A Moves the cursor to the beginning of the command line.
Ctrl B / Left Arrow Moves the cursor one character to the left.
Ctrl C Exits from the current command and provides a new prompt.
Del Key Deletes the character to the right of the cursor.
Ctrl D Exits from CLI, if entered at the root level. Exits a nested command section.
Ctrl E Moves the cursor to the end of the command line.
Ctrl F / Right Arrow Moves the cursor one character to the right.
Ctrl K Deletes all characters to the right of the cursor.
Ctrl N / Down Arrow Shows the next command in history, for the current log session.
Ctrl P / Up Arrow Shows the previous command in history, for the current log session.
Ctrl U Deletes the whole line.
Backspace Key Moves the cursor back one space, deleting that character.
Tab Key Auto-completes the text (command) being entered.
8
When viewing the Accounting, Data or Event Log in CLI, the prompt will change to allow navigation of the log contents,
displayed in the following format:
[4/25], <1/2>:
In this example, the log is currently at page 4 of 25, and on the ïŹrst of two pages, horizontally. Use the following letters and
characters, followed by the <Enter> key to navigate logs:
# Enter a page number to go directly to that page.
f Go to the ïŹrst page of the log.
p Go to the previous page.
n Go to the next page.
l Go to the last page.
< Move horizontally to the left.
> Move horizontally to the right.
r Refresh the page.
q Quit. Return to the regular CLI command prompt.
? Display the list of navigation options.
4. Log Navigation
9
5. CLI Commands
The following section provides a detailed description of each command and its nested commands, including syntax and
examples.
All commands that follow are presented in alphabetical order.
aaa
aaa accounting
Use the command to modify the default setting for the Accounting Scheme. Accounting activity can be aaa accounting
logged to the local system or to a remote server, such as RADIUS. The default Accounting Scheme is local-only. The other
available choices are: “log activity to the remote server only” ( ), “try logging to the local system ïŹrst, then the remote-only
remote server, if necessary” ( ), and “try logging to the remote system ïŹrst, then the local, if necessary” ( ).local ïŹrst remote ïŹrst
Syntax
aaa accounting {local-only | remote-only | local-ïŹrst | remote-ïŹrst}
Examples
The following command changes the Accounting Scheme to “try local ïŹrst, then try remote”:
console> aaa accounting local-rst
Update complete
aaa authentication
Use the command to modify the default setting for the Authentication Scheme. Authentication and aaa authentication
authorization can be performed on users entered into either the local system or a remote server, such as RADIUS or LDAP.
The default Authentication Scheme is . The other available choices are: “authenticate using the remote server only” local-only
( ), “try authenticating using the local system ïŹrst, then the remote server, if necessary” ( ), and “try remote-only local-ïŹrst
authenticating using the remote system ïŹrst, then the local, if necessary” ( ).remote-ïŹrst
Syntax
aaa authentication {local-only | remote-only | local-ïŹrst | remote-ïŹrst}
Examples
The following command changes the Authentication Scheme to local authentication only:
console> aaa authentication local-only
Update complete
show aaa
Use the command to display the current settings for AAA.show aaa
Syntax
show aaa [accounting | authentication]
Examples
The following command displays all AAA settings:
console> show aaa
Accounting Scheme : try local-rst, then try-remote if necessary
Authentication Scheme : local only
10
5. CLI Commands
action
action
Use the command to create and/or manage an action entry. The must be speciïŹed when creating a new action action-type
action entry; action types are dependent upon the device(s) connected. Certain action types also require specifying a target
device. Use the command to display a list of available action types and their target device dependence. show action-types
Use the form of this command to delete an action. To exit from the command format, use either no action (<action-name>)
the or end exit commands. When conïŹguring an action, be sure to enter all parameters speciïŹc to the selected action-type. If
required, change the default values for , and .count delay interval
Note: When creating an SNMP action, all SNMP contacts will automatically be assigned to the action. To assign individual SNMP contacts to
the action, ïŹrst delete all contacts using the command. See the command for details.no contact all action: contact
Syntax
action <action-name>
‱ – SpeciïŹes the action entry to be managed. action-name
action <action-name> <action-type> [<device-name>]
‱ – SpeciïŹes the name of the action entry to be created. If spaces are required, bookend the name with action-name
quotation marks (“).
‱ – SpeciïŹes the action type for the entry.action-type
‱ – SpeciïŹes the target device. Use the show action-types command to identify which action types require device-name
specifying a target device.
no action <action-name>
‱ – SpeciïŹes the action entry to be deleted. If spaces are required, bookend the name with quotation marks (“).action-name
Examples
The following command creates an action entry titled “Load Control” with an action type of “load”, applied to target device
“PDU123”:
console> action “Loads Control” load PDU123
Created Loads Control
console> action (Loads Control)>
The following command deletes entry “Cycle-Load-4”:
console> no action Cycle-Load-4
Deleted Cycle-Load-4
11
5. CLI Commands
show action
Use the command to display a summary table of all action entries or the details of a speciïŹed action entry.show action
Syntax
show action [<action-name>]
‱ – SpeciïŹes the entry for which action details are to be displayed. action-name
Examples
The following command displays a summary table of all action entries:
console> show action
NAME TYPE STATUS DELAY INTERVAL
---------------------------- ------------ -------- ----- --------
Default Device Shutdown turn-o-device enabled 120 0
Default Email Notication email enabled 30 0
Default Reboot LX Card reboot-weblx enabled 30 0
Default SMS Notication sms enabled 30 0
Default SNMP Trap Notication snmp-trap disabled 30 0
action: contact
contact
Use the command to assign one or more notiïŹcation recipients to the action entry. Use the form of this command contact no
to remove one or more contacts from the entry. This command applies only to action types “email”, “sms”, “snmp-set-oid”
and “snmp-trap”. Note that contacts for each of these action types are created using the corresponding commands: , email
sms snmp-user and .
Syntax
contact {all | <contact-1>[,<contact-2>,...<contact-N>]}
‱ – Sets all contacts as notiïŹcation recipientsall
‱ – SpeciïŹes a comma-delimited list of contacts as notiïŹcation recipientscontact-x
no contact {all | <contact-1>[,<contact-2>,...<contact-N>]}
‱ – Sets all contacts to be removed as notiïŹcation recipientsall
‱ – Removes a comma-delimited list of contacts as notiïŹcation recipientscontact-x
Examples
The following command sets all email contacts to be recipients of entry “Send Email”:
console> action (Send Email)> contact all
Update complete
The following command speciïŹes contacts “jdoe”, “Mary Smith” and “bjones” as the recipients or entry “Send Email”:
console> action (Send Email)> contact jdoe,”Mary Smith”,bjones
Update complete
The following command removes “Billy Jones” as a recipient for entry “Send Email”:
console> action (Send Email)> no contact “Billy Jones”
Update complete
12
5. CLI Commands
show contact
Use the command to display the list of recipients for a notiïŹcation action entry. show contact
Syntax
show contact
Examples
The following command displays the recipients for entry “Send Email”:
console> action (Send Email)> show contact
jdoe,Mary Smith,bjones
action: count
count
Use the command to set the number of times an On Set action will execute, when a single trigger condition occurs. count
Actions will stop executing once the trigger condition clears. The default value for is (1), meaning that the action will count
execute once when triggered. A of zero (0) conïŹgures the action to execute indeïŹnitely, until the trigger condition clears. count
Use the command to set the amount of time, in seconds, that must elapse between successive action executions. An interval
interval count of zero (0) conïŹgures the action to execute once, regardless of the . This command applies only to action types
“email”, “sms”, “snmp-set-oid” and “snmp-trap”.
Syntax
count <count>
‱ – SpeciïŹes the number of times that the action will execute, when triggered (Range: 0-65535).count
Examples
The following command conïŹgures entry “Send Email” to execute indeïŹnitely until the trigger condition clears:
console> action (Send Email)> count 0
Update complete
show count
Use the command to display the number of times an action will execute until the trigger condition clears.show count
Syntax
show count
Examples
The following command displays the number of times entry “Send Email” will execute when triggered:
console> action (Send Email)> show count
5
13
5. CLI Commands
action: delay
delay
Use the command to set the time that a triggered On Set action must wait before it executes. Actions will not execute if delay
the trigger condition clears before the delay time elapses. The default value for is zero (0), which will cause the action to delay
execute immediately when triggered.
Syntax
delay <delay>
‱ – SpeciïŹes the delay time, in seconds, for the action entry.delay
Examples
The following command sets a delay time of 30 seconds for entry “Send Email”:
console> action (Send Email)> delay 30
Update complete
show delay
Use the command to display the delay time for the action entry.show delay
Syntax
show delay
Examples
The following command displays the delay time for entry “Send Email”:
console> action (Send Email)> show delay
30
action: enable
enable
Use the command to activate the action entry. Use the form of this command to disable the entry. A disabled enable no
action will not execute when a trigger condition occurs.
Syntax
enable
no enable
Example
The following command disables entry “UPS Check”:
console> action (UPS Check)> no enable
Update complete
14
5. CLI Commands
show enable
Use the command to display the enabled/disabled status for the action entry.show enable
Syntax
show enable
Examples
The following command displays the status of entry “UPS Check”:
console> action (UPS Check)> show enable
disabled
action: interval
interval
Use the command to set the amount of time, in seconds, between successive executions of a triggered On Set interval
action. Actions will stop executing once the trigger condition clears. Use the command to set the number of times the count
action will execute. This command applies only to action types “email”, “sms”, “snmp-set-oid” and “snmp-trap”.
Syntax
interval <interval>
‱ – SpeciïŹes the interval time, in seconds, for the entry (Range: 0-65535). interval
Examples
The following command sets the interval time at 2 minutes for entry “Send Email”:
console> action (Send Email)> interval 120
Update complete
show interval
Use the command to display the interval time for the action entry.show interval
Syntax
show interval
Examples
The following command displays the interval time, in seconds, for entry “Send Email”:
console> action (Send Email)> show interval
120
15
5. CLI Commands
action: load
load
Use the command to assign one or more loads to an action. Loads can be assigned as a series of numbers (i.e. load
“3,4,5,6”), as a range of numbers (i.e. “3-6”), or in combination (i.e. “3,5-8,10,12-15”). Note that the list of loads is
additive. Use the form of this command to remove one or more loads from the action. This command applies only to action no
type “load”.
Syntax
load <load-1>[,<load-2>...<load-N>]
‱ – SpeciïŹes a comma-delimited list of loads to be assigned to the action entry.load-x
no load [<load-1>[,<load-2>...<load-N>]]
‱ – SpeciïŹes a comma-delimited list of loads to be removed from the action entry.load-x
Examples
The following two commands clear the action of loads, then assign loads 1, 5, 6, 7, 8 and 12 to entry “Cycle Routers”:
console> action (Cycle Routers)> no load
Update complete
console> action (Cycle Routers)> load 1,5-8,12
Update complete
load state
Use the command to specify load behavior when the action is executed. This command applies only to action type load state
“load”.
Syntax
load state {cycle | off | on}
Examples
The following command conïŹgures the loads speciïŹed in entry “Cycle Routers” to cycle when triggered:
console> action (Cycle Routers)> load state cycle
Update complete
show load
Use the command to display the load details for the action entry. This command applies only to action type “load”. show load
Syntax
show load [state]
Examples
The following command displays the load details for entry “Cycle Routers”:
console> action (Cycle Routers)> show load
Load Action : cycle
Loads : 1,5,6,7,8,12________________________________________
16
5. CLI Commands
action: load-group
load-group
Use the command to assign one or more load groups to an action. Note that load groups are created using the load-group
device-level command. Use the form of this command to remove one or more load groups from the action. load-group no
This command applies only to action type “load-group”.
Syntax
load-group <group-1>[,<group-2>...<group-N>]
‱ – SpeciïŹes a comma-delimited list of load groups to be assigned to the action.group-x
no load-group [<group-1>[,<group-2>...<group-N>]]
‱ – SpeciïŹes a comma-delimited list of load groups to be removed from the action.group-x
Examples
The following two commands clear the action of load groups, then assign load groups “Routers1” and “Routers2” to entry
“Cycle Router”:
console> action (Cycle Router)> no load-group
Update complete
console> action (Cycle Router)> load-group Routers1,Routers2
Update complete
load-group state
Use the command to specify the load group behavior when the action is executed. This command applies load-group state
only to action type “load-group”.
Syntax
load-group state {cycle | off | on}
Examples
The following command conïŹgures the load groups speciïŹed in entry “Cycle Router” to cycle when triggered:
console> action (Cycle Router)> load-group state cycle
Update complete
show load-group
Use the command to display the load group details for the action entry. This command applies only to show load-group
action type “load-group”.
Syntax
show load-group [state]
Examples
The following command displays the load group details for entry “Cycle Router”:
console> action (Cycle Router)> show load-group
Load Action : cycle
Load Groups : Routers1,Routers2________________________________________
17
5. CLI Commands
action: name
name
Use the name command to modify the name of the action entry.
Syntax
name <new-name>
‱ – SpeciïŹes the new name for the entry. If spaces are required, bookend the name with quotation marks (“).new-name
Examples
The following command changes the entry’s name from “Send Email” to “Email Manager”:
console> action (Send Email)> name “Email Manager”
Update complete
console> action (Email Manager)>
show name
Use the show name command to display the name of the action entry.
Syntax
show name
Examples
The following command displays the name of the entry:
console> action (Email Manager)> show name
Email Manager
action: output-contact
output-contact
Use the command to specify the output contact behavior for the action entry – to either turn or turn , output-contact on off
when triggered. This command is applicable only to action type “sensor” and, speciïŹcally, sensor model E2MTDO. Ensure that
the speciïŹc E2MTDO is selected using the command.target-device
Syntax
output-contact <number> {on | off}
‱ – SpeciïŹes the output contact number of the sensor.number
Examples
The following command sets the #2 contact to turn on when triggered, for entry “Fan On”:
console> action (Fan On)> output-contact 2 on
Update complete
18
5. CLI Commands
show output-contact
Use the show output-contact command to display the output settings of the entry.
Syntax
show output-contact
Examples
The following command displays the output settings of entry “Fan Off”:
console> action (Fan On)> show show output contact
Contact Number : 2
Action : on
action: show
show
Use the command, with optional keywords, to display details about the action entry. To view all keywords applicable to show
the entry, enter show [Tab][Tab].
Syntax
show [keyword]
‱ keyword – SpeciïŹes the attribute to be displayed.
Examples
The following command displays all keywords for entry “Email Manager”:show
This example should appear second, since it was mentioned second in the deïŹnition above.show
console> action (Email Manager)> show [Tab][Tab]
contact delay interval status
count help name trigger
show
The following command displays all settings for entry “Email Manager”:
console> action (Email Manager)> show
Name : UPS Check
Type : battery-test
Status : enabled
Delay : 30
Interval : 0
Count : 1
Target : UPS123
19
5. CLI Commands
show targets
Use the command to display a list of devices and sensors available for selection as targets for action entries.show targets
Syntax
show targets
Examples
The following command displays a list of devices and sensors available for selection as targets:
console> action (Email Manager)> show targets
NAME TYPE
--------- --------
UPS123 device
E2MTHDI sensor
E2MT-A sensor
E2MT-B sensor
action: snmp-set
snmp-set oid
Use the command to specify the Object IdentiïŹer (OID) to set when an SNMP Set action is executed. This snmp-set oid
command is applicable only to action type “snmp-set oid”.
Syntax
snmp-set oid <oid>
‱ – SpeciïŹes the OID to set for the entry, in numeric notation.oid
Examples
The following command sets “1.3.6.1.4.1.123.4.5.6.0” as the OID for entry “Notify Server #1” :
console> action (Notify Server #1)> snmp-set oid 1.3.6.1.4.1.123.4.5.6.0
Update complete
snmp-set value
Use the command to conïŹgure the value set to the speciïŹed OID when the action is executed. The OID type snmp-set value
must be speciïŹed: or . This command is applicable only to action type “snmp-set oid”.integer string
Syntax
snmp-set value <value> {integer | string}
‱ – SpeciïŹes the set value for the entry. For strings, if spaces are required, bookend the string with quotation marks (“).value
Examples
The following command conïŹgures entry “Notify Server #1” with an SNMP Set integer value of 1:
console> action (Notify Server #1)> snmp-set value 1 integer
Update complete
The following command conïŹgures entry “Notify Server #1” with an SNMP Set string value of “Load 1 is Off”:
console> action (Notify Server #1)> snmp-set value “Load 1 is O” string
Update complete
20
5. CLI Commands
show snmp-set
Use the command to display the OID details for an SNMP Set action entry. This command is applicable only show snmp-set
to action type “snmp-set oid”.
Syntax
show snmp-set [oid | value]
Examples
The following command displays the OID details for entry “Notify Server #1”:
console> action (Notify Server #1)> show snmp-set
OID : 1.3.6.1.4.1.123.4.5.6.0
Type : integer
Value : 1
action: target-device
target-device
Use the command to specify the device or sensor undergoing the action, as deïŹned by the action entry. Note target-device
that changing the target device of an action entry will require re-entering all action parameters; the parameters associated with
the previous target device will be erased. Use the command to display a list of devices and sensors available for show targets
selection as target devices.
Syntax
target-device {<device-name> | <sensor-name>}
‱ – SpeciïŹes the new target device associated with the entry.device-name
‱ – SpeciïŹes the new target sensor associated with the entry.sensor-name
Examples
The following command sets “Sensor-E2MTDO” as the new target device for entry “Indicator”:
console> action (Indicator)> target-device Sensor-E2MTDO
Update complete
show target-device
Use the command to display the name of the device or sensor selected to undergo the action. show target-device
Syntax
show target-device
Examples
The following command displays the target device for entry “Indicator”:
console> action (Indicator)> show target-device
Sensor-E2MTDO
21
5. CLI Commands
action: trigger
trigger
Use the command to assign one or more trigger conditions to the action entry. Use the form of this command to trigger no
remove one or more triggers from the entry. Use the command to display an enumerated list of all applicable show trigger
trigger events. The enumeration and/or keywords are used when selecting events as triggers. Due to the variance of events
by device type and model, the enumeration will not be sequential. Within the list, an asterisk ( ) denotes that the event is *
selected as a trigger.
Syntax
trigger {on-clear | on-set} {all | <event-1>[,<event-2>...<event-N>]}
‱ – SpeciïŹes a comma-delimited list of event names or enumerations that will act as triggers for the action entry. (see event-x
the command).show trigger
‱ – ConïŹgures the action entry to execute when any of the selected On Clear events occur.on-clear
‱ – ConïŹgures the action entry to execute when any of the selected On Set events occur. on-set
no trigger {on-clear | on-set} {all | <event-1>[,<event-2>...<event-N>]}
no trigger {<device-name> | <sensor-name>}
‱ – Removes all trigger events assigned to the speciïŹed device.device-name
‱ – SpeciïŹes a comma-delimited list of event names or enumerations to be removed from the action entry. event-x
‱ – Removes On Clear events as triggers for the action entry; if no enumerated events are speciïŹed, all On Clear on-clear
events will be removed.
‱ – Removes On Set events as triggers for the action entry; if no enumerated events are speciïŹed, all On Set events on-set
will be removed.
‱ – Removes all trigger events assigned to the speciïŹed sensor.sensor-name
Examples
The following command sets “Battery Low” and “Communications Lost” – enumerated as 4 and 6, respectively – as the On
Set triggers for entry “Notify Server #1”:
console> action (Notify Server #1)> trigger on-set 4,6
Update complete
The following command sets “Battery Low” and “Communications Lost” – listed by name – as the On Set triggers for entry
“Notify Server #1”:
console> action (Notify Server #1)> trigger on-set “Battery Low”,”Communication Lost”
Update complete
The following command sets “Battery Normal” and “Communications Restored” – enumerated as 4 and 6, respectively – as
the On Clear triggers for entry “Notify Server #1”:
console> action (Notify Server #1)> trigger on-clear 4,6
Update complete
The following command removes all On Clear triggers for entry “Notify Server #1”:
console> action (Notify Server #1)> no trigger on-clear all
Update complete
22
5. CLI Commands
show trigger
Use the command to display an enumerated list of all applicable events. Within the list, an asterisk ( ) denotes show trigger *
that the event is selected as a trigger.
Syntax
show trigger [<name-pattern>]
‱ – a string of characters by which the displayed list of trigger events will be ïŹltered.name-pattern
Examples
The following command displays all applicable trigger events for entry “Notify Server #1”:
console> action (Notify Server #1)> show trigger
# EVENT TYPE ON SET ON CLEAR SOURCE
---- ----------------------------------- --------- ------ -------- ------
1 Watchdog NTP Probe Failed autoprobe no no Watchdog NTP
2 Watchdog Ping Probe Failed autoprobe no no Watchdog Ping
3 Battery Bad device no no UPS123
* 4 Battery Capacity Below Warning Level device yes no UPS123
* 5 Battery Low device yes no UPS123
38 Contact Output 2 in Alarm device no no Sensor07
* 39 Temperature Beyond Limits device yes yes Sensor07
alert
alert acknowledge
Use the command to acknowledge one or more alerts. Alerts can be acknowledged as a series of alert acknowledge
numbers (i.e. “3,4,5,6”), as a range of numbers (i.e. “3-6”), or in combination (i.e. “3,5-8,10,12-15”).
Syntax
alert acknowledge {all | <alert-1>[,<alert-2>...<alert-N>]}
‱ – Sets a comma-delimited list of record numbers to be acknowledged.alert-x
‱ – Sets all alerts to be acknowledged.all
Examples
The following command acknowledges all alerts:
console> alert acknowledge all
Update complete
The following command acknowledges alert log records 1, 5, 6, 7, 8 and 12:
console> alert acknowledge 1,5-8,12
Update complete
23
5. CLI Commands
alert export
Use the alert export command to conïŹgure and execute an on-demand alert log export. The alert log can be exported as an
email to a single recipient (refer to the command for creating email recipients). The default ïŹle format for exported alert email
logs is CSV; use the option to change the exported ïŹle format to XML. xml
Syntax
alert export email <contact-name> [xml] [purge]
‱ – IdentiïŹes a single email contact as the recipient of the exported alert log.contact-name
Examples
The following command exports the Alert Log in XML format to email recipient johnd:
console> alert export email johnd xml
Update complete
show alert
Use the command to view the Alert Log in its entirety or ïŹltered by record number, range of record numbers or show alert
quantity of sorted records. Use the format to display a single record, speciïŹed byshow alert <record-num> <record-
num> show alert from <start-num> to <end-num> <start-num>. Use the format to display a range of records, where
is the ïŹrst record number and is the last. Use the show alert limit format to display a set quantity of <end-num> <limit>
records, speciïŹed by ; this format always begins with the ïŹrst record. Use the ... command <limit> show alert last <period>
format to display a range of the most recent records, specifying the end limit of the range (e.g. the last three weeks). Use
the ... command format to display a range of the most recent records, specifying the end limit show alert last <period>
of the range (e.g. the last three weeks). Note that these three formats are mutually exclusive. A retrieved range of records
is inherently ordered by record number and cannot be sorted otherwise. If the time format being used contains a space (for
example, h:mm:ss tt), ensure that the entire time period is bookended in quotes. Example: “10:11:22 PM”
Syntax
show alert <record-num>
show alert size
show alert count [{ critical | info | warning }]
show alert [{ acknowledged | unacknowledged }] [{ cleared | uncleared }] [device <device-name>] [event <event-
name>] [severity <severity>] [from <start-#> [to <end-#>]] [sort [date [{ asc | desc }]] [device [{ asc | desc }]]
[event [{ asc | desc }]]
show alert [{ acknowledged | unacknowledged }] [{ cleared | uncleared }] [device <device-name>] [event <event-
name>] [severity <severity>] [start-date <start-date> [start-time <start-time>]] [end-date <end-date> [end-time
<end-time>]] [sort [date [{ asc | desc }]] [device [{ asc | desc }]] [event [{ asc | desc }]]
show alert [{ acknowledged | unacknowledged }] [{ cleared | uncleared }] [device <device-name>] [event <event-
name>] [severity <severity>] [last <period> {second | minute | hour | day | week | month | year}] [sort [date [{
asc | desc }]] [device [{ asc | desc }]] [event [{ asc | desc }]]
show alert [{ acknowledged | unacknowledged }] [{ cleared | uncleared }] [device <device-name>] [event <event-
name>] [severity <severity>] [limit <qty>] [sort [date [{ asc | desc }]] [device [{ asc | desc }]] [event [{ asc |
desc }]]
‱ – Filters the log to display only entries that are acknowledged.acknowledged
‱ – Filters the log to display only entries that are cleared. cleared
‱ – Filters the log to display only entries associated with the speciïŹed device. device-name
‱ – SpeciïŹes the number of the last log record to be displayed (must be a number greater than ).end-num start-num
‱ – Filters the log to display all entries that occurred on or before this date; use the date format set using the end-date
default date-format default user date-formator command.
continued
24
5. CLI Commands
‱ – Filters the log to display all entries that occurred on or before this time; use the time format set using the end-time
default time-format default user time-formator command.
‱ – Filters the log to display only entries associated with the specied event.event-name
‱ – Species the number of log entries to be displayed. limit
‱ – Species the quantity of the selected time period of entries to be displayed.period
‱ – Species the record number to be displayed.record-num
‱ – Species the number of the rst log record to be displayed, when displaying a range of records. start-num
‱ – Filters the log to display all entries that occurred on or after this date; use the date format set using the start-date
default date-format default user date-format or command.
‱ – Filters the log to display all entries that occurred on or after this time; use the time format set using the start-time
default time-format default user time-format or command.
‱ – Filters the log to display only entries that are not acknowledged.unacknowledged
‱ – Filters the log to display only entries that are not cleared.uncleared
Examples
The following command displays all active alerts:
console> show alert
ID EVENT DEVICE DATE/TIME TYPE ACKNOWLEDGED
--- --------------- ---------- ------------------------ -------- ------------
3 On Battery UPS01 3/31/2020 11:15:47 AM critical no
2 Temperature High Sensor 1 3/31/2020 10:33:07 AM warning no
1 Loads All O UPS01 3/31/2020 10:12:22 AM critical yes
show alert count
Use the command to view the quantity of active alerts by severity.show alert count
Syntax
show alert count [critical | info | warning]
Examples
The following command displays the quantity of active alerts:
console> show alert count
Critical : 2
Warning : 1
Info : 0
The following command displays the quantity of active critical alerts.
console> show alert count critical
2
show alert size
Use the command to display the total number of alerts currently stored in the log le.show alert size
Syntax
show alert size
Examples
The following example displays the number of alerts stored:
console> show alert size
18
25
5. CLI Commands
apply
apply network
Use the command to apply network-speciïŹc changes, which includes changes to Internet settings, DNS and apply network
network services. Applying network changes may require terminating all active user sessions. Ensure that all network changes
are made prior to applying them.
Syntax
apply network
Examples
The following command applies any changes made to network settings:
console> apply network
Applying changes to network settings on the device. Note that this may cause a system
reboot.
autoprobe
autoprobe
Use the command to create and manage automatic network probe (AutoProbe) entries. The probe type must be autoprobe
speciïŹed when creating a new action. The available choices are “probe an NTP server” ( ), “ping a network device” ( ) ntp ping
and “perform an SNMP GET” ( ). If is chosen as the probe type, the SNMP version must be speciïŹed – v1, v2 or snmp snmp
v3. Use the form of this command to delete the entry. When creating an entry, select an easily remembered name as a no
label for the entry; this name will be used in the command format when conïŹguring the entry’s autoprobe <probe-name>
status and settings. To exit from the command format, use either the or autoprobe <probe-name> end exit commands.
Refer to the command for conïŹguring an AutoProbe entry as an action trigger. Once this has been completed, refer to event
the command for assigning an action to the AutoProbe event.action
Syntax
autoprobe <probe-name>
‱ – SpeciïŹes the probe entry to be managed.probe-name
autoprobe <probe-name> {ntp | ping | snmp {v1 | v2 | v3}}
‱ – SpeciïŹes the name of the probe to be created. If spaces are required, bookend the name with quotation probe-name
marks (“).
no autoprobe <probe-name>
‱ – SpeciïŹes the probe entry to be deleted.probe-name
Examples
The following command creates “Probe Get” as an SNMP (version v3) GET probe entry:
console> autoprobe “Probe Get” snmp v3
Created Probe Get
console> autoprobe (Probe Get)>
The following command deletes “old probe”:
console> no autoprobe “old probe”
Deleted old probe
26
5. CLI Commands
show autoprobe
Use the command to view a summary table of all AutoProbe entries or the details of a speciïŹed AutoProbe show autoprobe
entry.
Syntax
show autoprobe [ntp | ping | snmp]
Examples
The following command displays a summary table of all AutoProbe entries:
console> show autoprobe
NAME TYPE DESCRIPTION STATUS PRIMARY IP P PORT
-------- ----- --------------- --------- ------------- ------
probe ABC ping Monitor switch enabled 172.17.77.77 161
probe 123 ntp NTP server disabled 192.168.5.100 162
SnmpProbe snmp Get status enabled 172.17.77.88 163
autoprobe: authentication
authentication passphrase
Use the command to enter an authentication passphrase for the SNMP (v3) GET AutoProbe authentication passphrase
entry. A passphrase is required if is set to either or . Two options are available for entering security-mode authnopriv authpriv
the password. The ïŹrst option will prompt the entry of a password followed by a password conïŹrmation, neither of which will be
echoed to the terminal. The second option allows entry of a plain text password on the command line by using the plaintext
keyword.
Syntax
authentication passphrase [plaintext <passphrase>]
‱ – SpeciïŹes the authentication passphrase for the SNMP GET AutoProbe entry, in plain text.passphrase
Examples
The following command sets the Authentication Passphrase to “a1b2c3” for entry “Probe Get”:
console> autoprobe (Probe Get)> authentication passphrase plaintext a1b2c3
Update complete
authentication protocol
Use the command to select an Authentication Protocol for the SNMP (v3) GET AutoProbe entry. A authentication protocol
protocol selection is required if is set to either or . The available options are MD5 and security-mode authnopriv authpriv
SHA1.
Syntax
authentication protocol {md5 | sha1}
Examples
The following command sets the Authentication Protocol to SHA1 for entry “Probe Get”:
console> autoprobe (Probe Get)> authentication protocol sha1
Update complete
27
5. CLI Commands
show authentication protocol
Use the command to display the selected authentication protocol for the SNMP (v3) GET show authentication protocol
AutoProbe entry.
Syntax
show authentication protocol
Examples
The following command displays the authentication protocol for entry “Probe Get”:
console> autoprobe (Probe Get)> show authentication protocol
sha1
autoprobe: community
community
Use the command to enter a community string for an SNMP (v1 or v2) GET AutoProbe entry. A community string community
must be speciïŹed prior to enabling the entry. Two options are available for entering the community string. The ïŹrst option will
prompt the entry of a password followed by a password conïŹrmation, neither of which will be echoed to the terminal. The
second option allows entry of a plain text community string on the command line by using the plaintext keyword.
Syntax
community [plaintext <community-string>]
‱ – SpeciïŹes the community string for the entry, in plain text.community-string
Examples
The following command sets “public” as the community string for SNMP GET probe entry “ProbeGet”:
console> autoprobe (ProbeGet)> community plaintext public
Update complete
autoprobe: description
description
Use the command to optionally enter a description for the AutoProbe entry. Use the form of this command to description no
clear the description.
Syntax
description <description>
no description
‱ – SpeciïŹes a description for the entry. If spaces are required, bookend the description with quotation marks (“).description
Examples
The following command sets “Monitor network switch” as the description for entry “probe ABC”:
console> probe (probe ABC)> description “Monitor network switch”
Update complete
28
5. CLI Commands
show description
Use the command to display the description entered for the AutoProbe entry.show description
Syntax
show description
Examples
The following command displays the description for entry “probe ABC”:
console> probe (probe ABC)> show description
Monitor network switch
autoprobe: enable
enable
Use the command to activate the AutoProbe entry. Use the form of this command to disable the AutoProbe. enable no
Syntax
enable
no enable
Example
The following command disables “probe ABC”:
console> probe (probe ABC)> no enable
Update complete
show enable
Use the command to display the enabled/disabled status of the AutoProbe entry.show enable
Syntax
show enable
Examples
The following command displays the status of entry “probe ABC”:
console> probe (probe ABC)> show enable
enabled
29
5. CLI Commands
autoprobe: interval
interval
Use the command to set the time between successive AutoProbe tests.interval
Syntax
interval <value>
‱ – SpeciïŹes the period (in seconds) between successive probe tests (Range: 0-999).value
Examples
The following command sets an interval time of 30 seconds between each test of entry “probe ABC”:
console> probe (probe ABC)> interval 30
Update complete
show interval
Use the command to display the interval entered for the AutoProbe entry. show interval
Syntax
show interval
Examples
The following command displays the interval entered for entry “probe ABC”:
console> probe (probe ABC)> show interval
30
autoprobe: name
name
Use the command to modify the name of the AutoProbe entry.name
Syntax
name <new-name>
‱ – SpeciïŹes the new name for the entry. If spaces are required, bookend the name with quotation marks (“).new-name
Examples
The following command changes the entry’s name from “probe ABC” to “probeXYZ”:
console> probe (probe ABC)> name probeXYZ
Update complete
console> probe (probeXYZ)>
30
5. CLI Commands
show name
Use the command to display the name entered for the AutoProbe entry.show name
Syntax
show name
Examples
The following command displays the entry’s name:
console> probe (probe ABC)> show name
probe ABC
autoprobe: primary
primary address
Use the command to set the IP address of the primary network device that the AutoProbe entry will probe. primary address
Both IPv4 and IPv6 addresses are supported.
Syntax
primary address <address>
‱ – SpeciïŹes the primary IPv4 or IPv6 address of the entry.address
Examples
The following command speciïŹes “172.17.77.88” as the primary address of entry “SnmpProbe”:
console> probe (SnmpProbe)> primary address 172.17.77.88
Update complete
primary oid
Use the command to set the SNMP OID that the AutoProbe entry will probe. This command applies only to SNMP primary oid
probes.
Syntax
primary oid <oid>
‱ – SpeciïŹes the OID that the entry will use for probe tests. oid
Examples
The following command speciïŹes “1.3.6.1.2.1.1.3.0” as the OID to use for entry “SnmpProbe”:
console> probe (SnmpProbe)> primary oid 1.3.6.1.2.1.1.3.0
Update complete
31
5. CLI Commands
primary port
Use the command to set the port number of the primary network device that the AutoProbe entry will probe. This primary port
command applies only to NTP and SNMP probes.
Syntax
primary port <port-number>
‱ – SpeciïŹes the primary port number that the entry will use for probe tests (Range: 1-65535).port-number
Examples
The following command speciïŹes “161” as the primary port for entry “SnmpProbe”:
console> probe (SnmpProbe)> primary port 161
Update complete
show primary
Use the command to display the primary address, OID and port settings for the AutoProbe entry.show primary
Syntax
show primary [address | oid | port]
Examples
The following command displays the primary address, OID and port settings for entry “SnmpProbe”:
console> probe (SnmpProbe)> show primary
Primary Address : 172.17.77.88
Primary Oid : 1.3.6.1.2.1.1.3.0
Primary Port : 161
autoprobe: privacy
privacy passphrase
Use the command to enter a privacy passphrase for the SNMP (v3) GET AutoProbe entry. A passphrase privacy passphrase
is required if is set to . Two options are available for entering the password. The ïŹrst option, which is security-mode authpriv
using the command without additional parameters, will prompt the entry of a password and password conïŹrmation, neither of
which will be echoed to the terminal. The second option allows entry of a plain text password on the command line by using
the plaintext keyword.
Syntax
privacy passphrase [plaintext <passphrase>]
‱ – SpeciïŹes the passphrase for the entry, in plain text.passphrase
Examples
The following command sets the Privacy Passphrase to “g2h3j4” for entry “Probe Get”:
console> autoprobe (Probe Get)> privacy passphrase plaintext g2h3j4
Update complete
32
5. CLI Commands
privacy protocol
Use the command to select a Privacy Protocol for the SNMP GET AutoProbe entry. A protocol selection is privacy protocol
required if is set to . The available options are and .security-mode authpriv DES AES
Syntax
privacy protocol {des | aes}
Examples
The following command sets the Privacy Protocol to AES for entry “Probe Get”
console> autoprobe (Probe Get)> privacy protocol aes
Update complete
show privacy protocol
Use the command to display the selected privacy protocol for the SNMP GET AutoProbe entry.show privacy protocol
Syntax
show privacy protocol
Examples
The following command displays the privacy protocol for entry “Probe Get”:
console> autoprobe (Probe Get)> show privacy protocol
aes
autoprobe: retry
retry
Use the command to set the number of consecutive AutoProbe tests that must fail before an alarm is triggered.retry
Syntax
retry <retry>
‱ – SpeciïŹes the number of probe tests that must fail before the entry triggers an alarm (Range: 0-999).retry
Examples
The following command sets the retry count to two for entry “probe ABC”:
console> probe (probe ABC)> retry 2
Update complete
33
5. CLI Commands
show retry
Use the command to display the retry value entered for the AutoProbe entry.show retry
Syntax
show retry
Examples
The following command displays the retry value of entry “probe ABC”:
console> probe (probe ABC)> show retry
2
autoprobe: secondary
secondary address
Use the command to set the IP address of the second network device that the AutoProbe entry will secondary address
probe. Both IPv4 and IPv6 addresses are supported.
Syntax
secondary address <ip-address>
‱ – SpeciïŹes the IPv4 or IPv6 address of the second network device that the entry will probe.ip-address
Examples
The following command speciïŹes “172.17.77.89” as the secondary IP address for entry “SnmpProbe”:
console> probe (SnmpProbe)> secondary address 172.17.77.89
Update complete
secondary oid
Use the command to set the secondary SNMP OID that the AutoProbe entry will probe. This command applies secondary oid
only to SNMP probes.
Syntax
secondary oid <oid>
‱ – SpeciïŹes the secondary OID that the entry will use for probe tests.oid
Examples
The following command speciïŹes “1.3.6.1.2.1.1.3.1” as the secondary OID to use for entry “SnmpProbe”:
console> probe (SnmpProbe)> secondary oid 1.3.6.1.2.1.1.3.1
Update complete
34
5. CLI Commands
secondary port
Use the command to set the port number of the second network device that the entry will probe. This secondary port
command applies only to NTP and SNMP probes.
Syntax
secondary port <port-number>
‱ – SpeciïŹes the port number of the second network device that the entry will use for probe tests (Range: port-number
1-65535).
Examples
The following command speciïŹes “161” as the secondary port for entry “SnmpProbe”:
console> probe (SnmpProbe)> secondary port 161
Update complete
show secondary
Use the command to display the secondary address, OID and port settings for the AutoProbe entry.show secondary
Syntax
show secondary [address | oid | port]
Examples
The following command displays the secondary address, OID and port settings for entry “SnmpProbe”:
console> probe (SnmpProbe)> show secondary
Secondary Address : 172.17.77.89
Secondary Oid : 1.3.6.1.2.1.1.3.0
Secondary Port : 161
autoprobe: security-mode
security-mode
Use the command to change the default Privacy setting of the SNMP (v3) GET probe entry. The default setting security-mode
is “No Authentication and No Privacy” ( ). The other available choices are: “Authentication and No Privacy” noauthnopriv
( ), “Authentication and Privacy” ( ). authnopriv authpriv
Syntax
security-mode {noauthnopriv | authnopriv | authpriv}
Examples
The following command sets the Security Mode to “Authentication and Privacy” for entry “Probe Get”:
console> autoprobe (Probe Get)> security-mode authpriv
Update complete
36
5. CLI Commands
autoprobe: username
username
Use the command to enter or modify the username for the SNMP (v3) GET AutoProbe entry.username
Syntax
username <username>
‱ – SpeciïŹes a username for the entry. spaces are not allowed in SNMPv3 usernames.username Note:
Examples
The following command sets “System123” as the username for entry “Probe Get”:
console> autoprobe (Probe Get)> username System123
Update complete
show username
Use the command to display the username entered for the SNMP GET AutoProbe entry.show username
Syntax
show username
Examples
The following command displays the username entered for entry “Probe Get”:
console> autoprobe (Probe Get)> show username
System123
autoprobe: version
version
Use the command to modify the SNMP version of the SNMP GET probe entry. Note that switching the SNMP version version
from v1/v2 to v3 – or vice-versa – will require entering parameters associated with the new version. The settings for the original
version will be retained, but not used. For example, switching from v2 to v3 will hide the setting and will require community
setting parameters for , , and .authentication privacy security-mode username
Syntax
version {v1 | v2 | v3}
Examples
The following command changes the SNMP version of entry “Probe Get” to v2:
console> autoprobe (Probe Get)> version v2
Update complete
37
5. CLI Commands
show version
Use the command to display the SNMP version for the SNMP GET probe entry.show version
Syntax
show version
Examples
The following command displays the version selected for entry “Probe Get”:
console> autoprobe (Probe Get)> show version
v3
backup
backup
Use the command to back up all conïŹguration settings and create a system-restore point. Use the command backup restore
to restore conïŹguration settings from the most recent backup.
Syntax
backup
Examples
The following command creates a system-restore point:
console > backup
Creating a backup...
clock
clock ntpserver
Use the command to specify the address of one or two Network Time Protocol (NTP) servers. This command clock ntpserver
is only available when NTP is set as the source (using the command).clock source
Syntax
clock ntpserver <primary-server> [<secondary-server>]
‱ – SpeciïŹes the IPv4 address, IPv6 address or hostname of the primary NTP server.primary-server
‱ – SpeciïŹes the IPv4 address, IPv6 address or hostname of the secondary NTP server.secondary-server
Example
The following command identiïŹes both a primary and a secondary NTP server as the clock source:
console> clock ntpserver 0.pool.ntp.org 1.pool.ntp.org
Update complete
38
5. CLI Commands
clock set
Use the command to conïŹgure the system date and time. This command is applicable only if is set clock set clock source
to RTC. Note that this command may terminate all sessions as the system undergoes synchronization. Use the option to force
execute the command without conïŹrmation. If the time format being used contains a space (for example, h:mm:ss tt), ensure
that the entire time period is bookended in quotes. Example: “10:11:22 PM”
Syntax
clock set <date> <time> [force]
‱ – SpeciïŹes the current date, in the format selected using the default date-format or default user date-format date
command.
‱
time – SpeciïŹes the current time, in the format selected using the default time-format or default user time-format command.
Example
The following command sets the time and date of the system as 1/8/2020, 3:58 PM; a conïŹrmation will appear when
entered:
console> clock set 1/8/2020 “3:58:00 PM”
Modifying system time settings may end this and other active user sessions. Type “yes”
to proceed:
clock source
Use the command to select one of two options as the clock source. The available choices are (Network clock source NTP
Time Protocol) and (Real Time Clock). If NTP is selected as the clock source, an NTP server address must be speciïŹed RTC
(using the command). Note that this command may terminate all sessions as the system undergoes clock ntpserver
synchronization. Use the option to execute the command without conïŹrmation.force
Syntax
clock source {ntp | rtc} [force]
Example
The following command sets NTP as the clock source, without a conïŹrmation prompt:
console> clock source ntp force
Update complete
show clock
Use the command to display the current clock settings.show clock
Syntax
show clock [ntpserver | source | timezone]
Example
The following command displays all clock settings:
console> show clock
Primary Server : 0.pool.ntp.org
Secondary Server : 1.pool.ntp.org
Source : ntp
Time Zone : America/Chicago
Current UTC Date and Time : 3/30/2020 12:45:10 PM
Current Local Date and Time : 3/30/2020 4:45:10 PM
41
5. CLI Commands
default timezone
Use the command to set the global settings for the local time zone, with respect to Universal Time default timezone
Coordinated (UTC). A list of available time zones can viewed using the command. Users can individually show timezones
override this setting by using the command.default user timezone
Syntax
default timezone <timezone>
‱ – The time zone in string format. timezone
Example
The following command sets the timezone to U.S. Central Standard Time:
console> default timezone America/Chicago
Update complete
default user date-format
Use the command to set a preferred date format, applied exclusively to the user logged into the default user date-format
system. Note that format selections are case-sensitive and must be entered using the same capitalization as documented.
Use the form of this command to remove the user preference, thereby reverting to the global default date format as set by no
default date-format.
Syntax
default user date-format {M/d/yyyy | M/d/yy | MM/dd/yy | MM/dd/yyyy | yy/MM/dd | yyyy-MM-dd | dd-MMM-yy}
no default user date-format
Examples
The following command sets the current user’s date format preference to “MM/dd/yyyy”:
console> default user date-format MM/dd/yyyy
Update complete
default user reset
Use the command to clear all user preferences for the user logged into the system. default user reset
Syntax
default user reset
Examples
Examples are not applicable for this command.
42
5. CLI Commands
default user temperature-format
Use the command to set a preferred temperature format, applied exclusively to the user default user temperature-format
logged into the system. Use the form of this command to remove the user preference, thereby reverting to the global no
default temperature format as set by . default temperature-format
Syntax
default user temperature-format {celsius | fahrenheit}
no default user temperature-format
Examples
The following command sets the current user’s temperature format preference to Fahrenheit:
console> default user temperature-format fahrenheit
Update complete
default user time-format
Use the command to set a preferred temperature format, applied exclusively to the user logged default user time-format
into the system. Note that format selections are case-sensitive and must be entered using the same capitalization as
documented. Use the form of this command to remove the user preference, thereby reverting to the global default time no
format as set by . default time-format
Syntax
default user time-format {h:mm:ss tt | hh:mm:ss tt | H:mm:ss | HH:mm:ss}
no default user time-format
‱ If using either the or time format, use quotes when entering the time (see Examples).h:mm:ss tt hh:mm:ss tt
Examples
The following command sets the current user’s time format preference to “hh:mm:ss tt”:
console> default user time-format “hh:mm:ss tt”
Update complete
default user timezone
Use the command to set a preferred timezone, applied exclusively to the user logged into the system. default user timezone
A list of available time zones can be viewed using the command. Use the form of this command to show timezones no
remove the user preference, thereby reverting to the global default time format as set by .default timezone
Syntax
default user timezone <timezone>
no default user timezone
‱ – Sets the time zone in string format. A list of available time zones can be found in the Appendix of this timezone
document.
Examples
Examples are not applicable for this command.
43
5. CLI Commands
show default
Use the command to display default conïŹguration settings.show default
Syntax
show default [date-format | temperature-format | time-format | timeout [idle | session] | timezone |
user [date-format | temperature-format | time-format | timezone]]
Examples
The following command displays all default conïŹguration settings:
console> show default
Display Date Format : MM/dd/yyyy
Display Time Format : hh:mm:ss tt
Default Temperature Format : fahrenheit
Default Timezone : America/Chicago
Global Session Timeout (Minutes) : 360
Global Idle Timeout (Minutes) : 30
The following command displays the user’s default conïŹguration settings:
console> show default user
Display Date Format : M/d/yyyy (System Default)
Display Time Format : HH:mm:ss
Default Temperature Format : celsius
Default Timezone : America/Chicago (System Default)
device
device
Use the command to enter the format in which all applicable commands can be entered. device device (<device-name>)
Specifying a is only necessary when more than one device is active, not including sensors. Use the form <device-name> no
of this command to delete an inactive device. To exit from the Active devices cannot be deleted. device (<device-name>)
command format, use either the or end exit commands.
Note: for devices that support External Battery Packs (EBPs), on entering the command format, device (<device-name>)
the system will automatically check for the availability of an update to the EBP conïŹguration ïŹle. If an update is available, a
message will appear stating so. Use the command to initiate the update process.battery-pack update
Syntax
device [<device-name>]
‱ – SpeciïŹes the device entry to be managed.device-name
no device <device-name>
‱ – SpeciïŹes the inactive device entry to be deleted.device-name
continued
45
5. CLI Commands
[Tab]
The keyboard [Tab] key serves several functions when used in conjunction with keywords. To view available keywords, enter
[Tab][Tab] [Tab] at the prompt. Enter to auto-ïŹll partially entered attributes.
Example
Pressing the [TAB] key twice at the prompt lists the keywords available for the device or sensor:
console> device (UPS123)> [TAB][TAB]
auto-restart end load no ramp sensor
battery exit load-group o reboot shed
buzzer help location on region show
date-installed input name output runtime threshold
show <keyword>
Use the show <keyword> command to display details about the device. Keywords for this command can be entered in a
non-speciïŹc order. For example, “show input voltage” and “show voltage input” will both display all input voltage data points
(e.g. input voltage, input voltage 1, input voltage 2).
Syntax
show [keyword-1 [keyword-2 [keyword-3 [keyword-4 [keyword-5 [keyword-6]]]]]]
‱ keyword – SpeciïŹes one or more words that comprise a data point’s name.
Examples
The following command displays the device’s Nominal Input Voltage:
console> device (Rack UPS)> show input voltage nominal
120
The following command displays all metrics labeled as “nominal”:
console> device (Rack PDU)> show nominal
NAME TYPE VALUE
------------------------ ------- --------
Nominal Input Voltage (V) Input 120
Nominal Output Voltage (V) Output 120
device: apply
apply ramp-shed
Use the command to make effective all changes made to ramp and shed parameters (i.e. enable and apply ramp-shed
delay). Upon entering the command, a conïŹrmation message will appear; enter “yes” to proceed. Use the option to force
apply the changes without conïŹrmation.
Syntax
apply ramp-shed [force]
Examples
The following command will apply all ramp and shed parameter changes made to device “UPS123”, without conïŹrmation:
console> device (UPS123)> apply ramp-shed force
Update complete
46
5. CLI Commands
device: asset-tag
asset-tag
Use the command to optionally enter an asset identiïŹer for the device. Use the form of this command to clear asset-tag no
the entry.
Syntax
asset-tag <tag>
no asset-tag
‱ – SpeciïŹes an identity for the device. If spaces are required, bookend the name in quotation marks (“).tag
Example
The following command assigns “IT123ZZ” as the asset tag for device “PDU-Rack1”:
console> device (PDU-Rack1)> asset-tag IT123ZZ
Update complete
show asset-tag
Use the command to display the identiïŹer entered for the device.show asset-tag
Syntax
show asset-tag
Examples
The following command displays the asset tag for device “PDU-Rack1”:
console> device (PDU-Rack1)> show asset-tag
IT123ZZ
device: auto-restart
auto-restart low-voltage
Use the command to set whether a low-voltage event will cause the device to automatically restart. auto-restart low-voltage
Syntax
auto-restart low-voltage enable
no auto-restart low-voltage enable
Examples
The following command conïŹgures device “UPS-123” not to auto-restart if a low-voltage event occurs:
console> device (UPS-123)> no auto-restart low-voltage enable
Update complete
47
5. CLI Commands
auto-restart overload
Use the command to set whether an overload event will cause the device to automatically restart.auto-restart overload
Syntax
auto-restart overload enable
no auto-restart overload enable
Examples
The following command conïŹgures device “UPS-123” to auto-restart if an overload event occurs:
console> device (UPS-123)> auto-restart overload enable
Update complete
auto-restart overtemp
Use the command to set whether an over-temperature event will cause the device to automatically auto-restart overtemp
restart.
Syntax
auto-restart overtemp enable
no auto-restart overtemp enable
Examples
The following command conïŹgures device “UPS-123” to auto-restart if an overtemp event occurs:
console> device (UPS-123)> auto-restart overtemp enable
Update complete
auto-restart shutdown
Use the command to set whether a shutdown event will cause the device to automatically restart.auto-restart shut-down
Syntax
auto-restart shutdown enable
no auto-restart shutdown enable
Examples
The following command conïŹgures device “UPS-123” to auto-restart if a shutdown event occurs:
console> device (UPS-123)> auto-restart shutdown enable
Update complete
48
5. CLI Commands
auto-restart wakeup
Use the auto-restart wakeup command to set whether a wakeup event will cause the device to automatically restart.
Syntax
auto-restart wakeup enable
no auto-restart wakeup enable
Examples
The following command conïŹgures device “UPS-123” to auto-restart if a wakeup event occurs:
console> device (UPS-123)> auto-restart wakeup enable
Update complete
show auto-restart
Use the command to display all or selected auto-restart settings.show auto-restart
Syntax
show auto-restart [low-voltage | overload | overtemp | shutdown | wakeup]
Examples
The following command displays all auto-restart settings for device “UPS-123”:
console> device (UPS-123)> show auto-restart
NAME VALUE
---------- ---------
On Delayed Wakeup disabled
On Low Voltage disabled
On Overload enabled
On Overtemp enabled
On Shutdown enabled
device: avr
avr transition count reset
Use the command to reset the recorded number of recorded AVR transitions. On executing this avr transition count reset
command, a prompt will appear to conïŹrm the action. Use the option to execute the command without conïŹrmation.force
Syntax
avr transition count reset [force]
Example
The following command resets the recorded AVR transition count for device “UPS123”, without conïŹrmation:
console> device (UPS123)> avr transition count reset force
Update complete
49
5. CLI Commands
show avr
Use the command to display the recorded count of AVR transitions.show avr
Syntax
show avr
Examples
The following command displays the recorded AVR transition count for device “UPS123”:
console> device (UPS123)> show avr
3
device: battery
battery age threshold
Use the command to conïŹgure age-related threshold parameters of the battery. This command is valid battery age threshold
only for devices that support battery age threshold.
Syntax
battery age threshold {high-warning| high-critical} <decimal-value>
‱ – Sets the time (in years) as the age threshold for the speciïŹed severity level. decimal-value
battery age threshold tolerance <tolerance>
‱ – Sets the time (in years) that must be exceeded for the threshold event to trigger againtolerance
Example
The following command sets the high-warning battery age threshold as 3.25 on device “UPS123”:
console> device (UPS123)> battery age threshold high-warning 3.25
Update complete
The following command sets the battery age threshold tolerance as 0.5 on device “UPS123”:
console> device (UPS123)> battery age threshold tolerance 0.5
Update complete
battery date installed
Use the command to enter a date on which the internal battery was installed.battery date installed
Syntax
battery date installed <date>
‱ - SpeciïŹes the date, in the format selected using the default date-format or default user date-format command.date
Example
The following command sets March 3, 2020 as the battery installation date for device “UPS123”:
console> device (UPS123)> battery date installed 3/3/2020
Update complete
50
5. CLI Commands
battery test period
Use the command to conïŹgure auto-test of the battery (if supported by the device). Note that the battery test period
available period choices will vary by UPS model.
Syntax
battery test period {disabled | monthly | quarterly | semi-annually}
Example
The following command conïŹgures auto-test of the battery every quarter on device “UPS123”:
console> device (UPS123)> battery test period quarterly
Update complete
battery test start
Use the command to perform an on-demand battery test (if supported by the device). On executing this battery test start
command, a prompt will appear to conïŹrm the action. Use the option to execute the command without conïŹrmation.force
Syntax
battery test start [force]
Example
The following command initiates a battery test on device “UPS123”:
console> device (UPS123)> battery test start
Are you sure? Type “yes” to proceed: yes
Execution complete
battery threshold capacity tolerance
Use the command to set the margin which must be exceeded in order to re-trigger a battery threshold capacity tolerance
threshold event.
Syntax
battery threshold capacity tolerance <integer-value>
‱ - SpeciïŹes the tolerance value, as a percentage. integer-value
Example
The following command sets the battery threshold capacity tolerance at 5% for device “UPS123”:
console> device (UPS123)> battery threshold capacity tolerance 5
Update complete
51
5. CLI Commands
battery transition count reset
Use the command to clear the stored value identifying the number of times the device battery transition count reset
transitioned from utility power to battery. Use the option to execute the command without conïŹrmation.force
Syntax
battery transition count reset [force]
Example
The following command clears the stored battery transition count on device “UPS123”, with no conïŹrmation:
console> device (UPS123)> battery transition count reset force
Execution complete
show battery
Use the command, with optional keywords, to display details about the battery. To view all keywords applicable to the show
battery, enter show battery [Tab][Tab].
Syntax
show battery [Tab][Tab]
Examples
The following command displays all battery-related keywords for device “UPS123”:show
console> device (UPS123)> show battery [Tab][Tab]
age fully rating transition
capacity high-critical replacement voltage
charge high-warning state
charged installed status
condition low temperature
count low-critical test
date low-warning threshold
discharged period tolerance
The following command displays all details about the battery associated with device “UPS123”:
console> device (UPS123)> show battery
NAME TYPE VALUE
----------------------- -------- -------------
Battery Temperature (C) Battery 35.0
Battery Temperature (F) Battery 95.0
Battery Age (Years) Battery 0.0
..Thresholds and Bounds
....High Warning 3.25
....High Critical 4.00
Battery Test Device Done and Passed
..Battery Test Date 3/31/2020
..Auto-Test Period 14 Days
..Initiate Battery Test
Battery Voltage (V) Battery 27.3
52
5. CLI Commands
device: buzzer
buzzer setting
Use the command to adjust how the device’s audible alert will behave when triggered. The available choices buzzer setting
are “audible buzzer” ( ) and “muted” ( ). This command applies only to devices that support audible alarm_normally stay_silent
alerts, and only if enabled via the command. buzzer status
Syntax
buzzer setting {alarm-normally | stay-silent}
Examples
The following command conïŹgures the buzzer on device “UPS-123” to be muted when triggered:
console> device (UPS-123)> buzzer setting stay-silent
Update complete
buzzer status
Use the command to enable or disable the ability to selectively adjust the device’s audible alert. This command buzzer status
applies only to devices that support audible alerts.
Syntax
buzzer status enable
no buzzer status enable
Examples
The following command conïŹgures the audible alarm on device “UPS-123” to be selectively adjusted:
console> device (UPS-123)> buzzer status enabled
Update complete
show buzzer
Use the command to display all buzzer settings.show buzzer
Syntax
show buzzer [setting | status]
Examples
The following command displays the buzzer settings for device “UPS-123”:
console> device (UPS-123)> show buzzer
NAME TYPE VALUE
-------- ------- --------------
Buzzer System Enabled
..Status Enabled
..Setting Alarm Normally
53
5. CLI Commands
device: bypass
bypass voltage
Use the command to set the lowest and highest acceptable input voltage for bypass operation. Expressed as bypass voltage
a percentage, the high limit is a positive integer and the low limit is a negative integer.
Syntax
bypass voltage {high-limit | low-limit} <integer-value>
‱ - Sets the value for the speciïŹed limit.integer-value
Examples
The following command sets the lower bypass voltage limit to -14 for device “UPS-123”:
console> device (UPS-123)> bypass voltage low-limit -14
Update complete
show bypass
Use the command to display all bypass values.show bypass
Syntax
show bypass [voltage | limit | line | count]
Examples
The following command displays all bypass values for device “UPS-123”:
console> device (UPS-123)> show bypass
NAME TYPE VALUE
---------------------- ------- ------
Bypass Limit Bypass
..Voltage Limit
....High Limit 10
....Low Limit -14
Hardware Conguration Device
..Bypass Line Count 0
54
5. CLI Commands
device: cold-start
cold-start enable
Use the command to activate the cold start function. Use the form of this command to disable cold-cold-start enable no
start.
Syntax
cold-start enable
no cold-start enable
Example
The following command activates cold start for device “UPS123”:
console> device (UPS123)> cold-start enable
Update complete
show cold-start
Use the command to display the status of the cold start function.show cold-start
Syntax
show cold-start
Examples
The following command displays the cold start status for device “UPS123”:
console> device (UPS123)> show cold-start
NAME TYPE VALUE
----------------- ------ --------
Hardware Features Device
..Cold Start Enabled
device: date-installed
date-installed
Use the command to modify the date that the device was installed. The default value is the current date. date-installed
Syntax
date-installed <date>
no date-installed
‱ – SpeciïŹes the date of the installation in the format selected using the or date default date-format default user date-
format command.
Example
The following command sets October 16, 2020 as the installation date for device “PDU-Rack1”:
console> device (PDU-Rack1)> date-installed 10/16/2020
Update complete
55
5. CLI Commands
show date-installed
Use the command to display the entered installation date.show date-installed
Syntax
show date-installed
Examples
The following command displays the installation date entered for device “PDU-Rack1”:
console> device (PDU-Rack1)> show date-installed
10/16/2020
device: db9
db9 input
Use the command to set the input action when pins 3 and 9 of the DB9 port are shorted. db9 input
Syntax
db9 input 3-9 {shutdown_(default) | output_off | reboot | output_on | power_toggle}
Example
The following command sets Output Off as the DB9 port input action for device “UPS123”:
console> device (UPS123)> db9 input 3-9 output_o
Update complete
db9 output
Use the command to set the condition signaled by the UPS when pins 1 and 5 or pins 8 and 5 of the DB9 port db9 output
are shorted.
Syntax
db9 output 1-5 {on_battery_(default) | on_bypass | output_on | low_battery}
db9 output 8-5 {on_battery | on_bypass | output_on | low_battery_(default)}
Example
The following command sets Output On as the condition signalled by device “UPS123” when pins 8 and 5 of the DB9 port are
shorted:
console> device (UPS123)> db9 output 8-5 output_on
Update complete

Produktspezifikationen

Marke: Tripp Lite
Kategorie: Nicht kategorisiert
Modell: S3M30KX-NIB

Brauchst du Hilfe?

Wenn Sie Hilfe mit Tripp Lite S3M30KX-NIB benötigen, stellen Sie unten eine Frage und andere Benutzer werden Ihnen antworten


Bedienungsanleitung Nicht kategorisiert Tripp Lite

Tripp Lite

Tripp Lite B127A-1A1-BDBH Bedienungsanleitung

12 Oktober 2024
Tripp Lite

Tripp Lite RBC92-2U Bedienungsanleitung

9 Oktober 2024
Tripp Lite

Tripp Lite SU6KRT3UX Bedienungsanleitung

8 Oktober 2024
Tripp Lite

Tripp Lite PS-406-HGULTRA Bedienungsanleitung

7 Oktober 2024
Tripp Lite

Tripp Lite T014-001 Bedienungsanleitung

7 Oktober 2024
Tripp Lite

Tripp Lite RBC7A Bedienungsanleitung

7 Oktober 2024
Tripp Lite

Tripp Lite PS410HGUK Bedienungsanleitung

6 Oktober 2024
Tripp Lite

Tripp Lite DCPU2 Bedienungsanleitung

6 Oktober 2024
Tripp Lite

Tripp Lite RBC11A Bedienungsanleitung

6 Oktober 2024
Tripp Lite

Tripp Lite U444-06N-VGA-RA Bedienungsanleitung

6 Oktober 2024

Bedienungsanleitung Nicht kategorisiert

Neueste Bedienungsanleitung fĂŒr -Kategorien-

BEKO

BEKO BBVM17400B Bedienungsanleitung

4 Dezember 2024
DeWalt

DeWalt DXV34PTA Bedienungsanleitung

4 Dezember 2024
DeWalt

DeWalt DCF414 Bedienungsanleitung

4 Dezember 2024
DeWalt

DeWalt DXIRFFP25 Bedienungsanleitung

4 Dezember 2024
DeWalt

DeWalt DXIR1A1A2P3 Bedienungsanleitung

4 Dezember 2024
DeWalt

DeWalt DCE450 Bedienungsanleitung

4 Dezember 2024
DeWalt

DeWalt DCMAS5713 Bedienungsanleitung

4 Dezember 2024
DeWalt

DeWalt DCMASBC1 Bedienungsanleitung

4 Dezember 2024
DeWalt

DeWalt DXKH180E Bedienungsanleitung

4 Dezember 2024
DeWalt

DeWalt DWE46150 Bedienungsanleitung

4 Dezember 2024