Tripp Lite PDU3VSR6L2130 Owner's Manual for SNMPWEBCARD 9332CE - Page 93

Command Line Interface

Get Tripp Lite PDU3VSR6L2130 PDF manuals and user guides View all Tripp Lite PDU3VSR6L2130 manuals
Add to My Manuals
Save this manual to your list of manuals

Page 93 highlights

5. Command Line Interface The SNMPWEBCARD 12.06.006X firmware adds support for new features on the command line interface (CLI). Many of the functional controls available in the Web console and Telnet interface are now available on the command line interface. The CLI allows for the use of user-created scripts and easier integration with third party systems. The CLI can be accessed on the SNMPWEBCARD via the management serial port, via SSH on the default port 2112, and via Telnet on the default port 5214. For security purposes, some features are only enabled on the serial and SSH interfaces. (Refer to section 4.3.2 for more information on starting the CLI from the Telnet or SSH menu.) This section of the user manual will familiarize you with the way the CLI interprets your input and the meaning of the CLI output. 5.1 Syntax Conventions The PowerAlert CLI uses its own standard syntax to interpret your input. The syntax defines standard conventions which are used to describe any problems with the input. The next definitions are important for understanding the rest of this document and the CLI error messages. 1. Program - The 'program' refers to the software module that will interpret the user input and perform the work. 2. Program Name - The command keyword that is typed to invoke the program. 3. Directive - The entire phrase entered, including the program name and any arguments. The directive is broken down into several parts of grammar, like a sentence. 4. Mode - The mode tells the program what to do with your arguments. A program can usually perform several different operations on the same data. Program modes are: List, Add, Update, Delete, and Test. In some programs, the mode can be inferred without your specification; in other programs, entering the mode will be required. 5. Mode Modifier - If the mode alone can't describe your request, the program will have a mode modifier list. The mode modifier usually specifies 'what' to list and 'where' and 'what' to add, update, or delete. 6. Identifier - The update and delete modes support entering a numeric identifier to choose what data your new input will affect. The list mode often allows an optional identifier to display more information about a single set of data. 7. Option - The option precedes your input parameter and specifies which value you are updating. An option will always begin with a dash followed by a letter or double dash followed by a number or word. 8. Parameter - If an option requires a parameter, the parameter will follow the option or be appended to the option (for example when choosing SNMPv3: '--v3'). The directive syntax breaks down along the grammatical boundaries shown below. Directive |----------Preamble Predicate |-Program--|-Mode-|-Mode Modifier-|-Identifier-|----------Option List |-Option-|-Parameter-|-Option-|-----Parameter----| |-Subject--|-Verb-|-------Direct Object Indirect Object (List addrbook -u email 4 --name santa --email [email protected] All pieces of syntax are separated with single spaces. The interface does not support input containing spaces at this time, and the input cannot include a single quote character. 93

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
93
5. Command Line Interface
The SNMPWEBCARD 12.06.006X firmware adds support for new features on the command line interface (CLI).
Many of the functional controls
available in the Web console and Telnet interface are now available on the command line interface.
The CLI allows for the use of user-created
scripts and easier integration with third party systems.
The CLI can be accessed on the SNMPWEBCARD via the management serial port, via SSH on the default port 2112, and via Telnet on the default
port 5214.
For security purposes, some features are only enabled on the serial and SSH interfaces.
(Refer to section 4.3.2 for more information
on starting the CLI from the Telnet or SSH menu.)
This section of the user manual will familiarize you with the way the CLI interprets your input and the meaning of the CLI output.
5.1 Syntax Conventions
The PowerAlert CLI uses its own standard syntax to interpret your input. The syntax defines standard conventions which are used to describe any
problems with the input. The next definitions are important for understanding the rest of this document and the CLI error messages.
1.
Program - The ‘program’ refers to the software module that will interpret the user input and perform the work.
2.
Program Name - The command keyword that is typed to invoke the program.
3.
Directive - The entire phrase entered, including the program name and any arguments. The directive is broken down into several parts of
grammar, like a sentence.
4.
Mode - The mode tells the program what to do with your arguments. A program can usually perform several different operations on the same
data. Program modes are: List, Add, Update, Delete, and Test. In some programs, the mode can be inferred without your specification; in
other programs, entering the mode will be required.
5.
Mode Modifier - If the mode alone can’t describe your request, the program will have a mode modifier list. The mode modifier usually specifies
‘what’ to list and ‘where’ and ‘what’ to add, update, or delete.
6.
Identifier - The update and delete modes support entering a numeric identifier to choose what data your new input will affect. The list mode
often allows an optional identifier to display more information about a single set of data.
7.
Option - The option precedes your input parameter and specifies which value you are updating. An option will always begin with a dash
followed by a letter or double dash followed by a number or word.
8.
Parameter - If an option requires a parameter, the parameter will follow the option or be appended to the option (for example when choosing
SNMPv3: ‘--v3’).
The directive syntax breaks down along the grammatical boundaries shown below.
|----------------------------------------Directive----------------------------------------------|
|----------Preamble----------------------------|----------Predicate-----------------------------|
|-Program--|-Mode-|-Mode Modifier-|-Identifier-|----------Option List---------------------------|
|-Option-|-Parameter-|-Option-|-----Parameter----|
|-Subject--|-Verb-|-------Direct Object--------|--------------Indirect Object (List)------------|
addrbook
-u
email
4
--name
santa
--email
All pieces of syntax are separated with single spaces. The interface does not support input containing spaces at this time, and the input cannot
include a single quote character.