TeleBoss 830 2.11.370 STD User Manual
Page 134
Command and Control Information
Setting Keys
Setting Keys (SK) provide a flat file, human readable, means of setting and retrieving settings within the unit.
Setting Keys are commonly used to clone settings across multiple units or in automated processes. All of the
settings that can be set using the Web Interface or the SETUP menu in the Command Interface can also be
set using the Settings Key commands from the Command Prompt.
Setting Keys is abbreviated when used on the command line as
SK
. Following are commands when working
with the Setting Keys File from the command line of the unit.
There are settings that can only be configured using a settings key command.
SK GET
at the command prompt will list the Settings Keys on the TeleBoss. Use
SK GET A
for an ASCII list
on your terminal emulator or
X
for Xmodem.
When downloading keys, if all settings referred to by a single key are the same, the unit will give only one key,
but specify the keyword "all" as the index (e.g.,
event.data[all].enable=ON
means all data event alarms are
enabled).
The unit always adds "end" at the end of downloading keys.
SK GET CUSTOM
will list only the non-default settings.
SK GET A CUSTOM
for an ASCII output to the
terminal emulator.
SK GET [PARTIAL KEY]
to get a list of all keys of a partial setting type
SK GET
and part of the setting key
and the unit will output all settings that begin with that settings syntax. For example,
SK GET A
event.class
will output all event classes configured in the unit.
SK [KEY[=value]]
allows for reading or setting a single Setting Key. If the value portion of the command is
omitted, the TeleBoss will report back the value stored in that key. If the value is given, it will be stored in the
key. Example: Typing
sk event.class[1]
at the command prompt will report back "Info". To set it as something
else type
sk event.class[1]=TEST
and the unit will report back COMPLETE and that setting will now be set to
TEST.
SK GET CUSTOM SCRIPT
will list the non-default settings plus any scripts loaded on the unit.
SK SET [X|A]
puts the unit in bulk Settings Keys upload mode. Any of the settings retrieved by
SK GET
can
be manipulated and uploaded with new values. The unit will process settings in any order or number; not all
settings need to be uploaded each session. As with
SK GET
, both ASCII and Xmodem transfer methods may
be used to upload settings to the unit. These transfer methods are indicated by using the X and A attributes,
respectively. The TeleBoss monitors for invalid Setting Keys and will notify you after the upload if any invalid
data was received.
When using
SK SET
in ASCII mode, the data uploaded must end with a line consisting of the word
“end”
followed by a return.
