Asentria SiteBoss 530 User Manual
54
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.
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.
SK [KEY[=value]]
allows for reading or setting a single Setting Key. If the value portion of the command is omitted,
the S530 will report back the value stored in that key. If the value is given, it will be stored in the key.
SK GET [X|A [CUSTOM] [filter]]
initiates a download of unit settings. This listing can be retrieved either by Xmodem
or plain ASCII using the X and A attributes, respectively. If the transfer mode attribute is omitted, the unit will prompt
for the download method. The CUSTOM tag may be used to retrieve only the settings that are not set to factory
defaults. A filter may be applied to limit the keys output to just the branch specified. For example, to retrieve an ASCII
listing of all EventSensor settings, use the command:
SK GET A event.sensor
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
S530 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.
SK HERE
allows you to set or get individual keys interactively. Typing just the key name will cause the value to be
displayed. Typing the key name plus a new value will set that key. The unit will keep prompting for a new key or
key/value pair until you press <Esc> or <Enter>.
SK LOG
displays a list of any errors generated during an SK Set.
Setting Keys can also be retrieved and loaded via FTP.
FTP>
GET SKALL FILENAME.TXT
retrieves all of the Setting Keys for the unit, similar to the
SK GET A
command
described above.
FTP>
GET SKCUSTOM FILENAME.TXT
retrieves any settings that are not set to factory default, similar to the
SK
GET A CUSTOM
command described above.
FTP>
PUT FILENAME.TXT SKALL
and
PUT FILENAME.TXT SKCUSTOM
load the settings in FILENAME.TXT onto
the S530.
Upon successful completion of loading the settings FTP will respond with "
226 - Transfer complete
". If there is
a problem in the Setting Keys file then FTP will respond with "
226 - Transfer complete; errors in
setting key file! Type Get SKLOG to view
"
FTP>
GET SKLOG
retrieves the Setting Keys log as described above.
Summary of Contents for SiteBoss 530
Page 6: ......
