Main Type Of Commands - Cisco TelePresence ISDN Link Reference Manual

Cisco TelePresence ISDN Link
Contents Introduction

Main type of commands

The XACLI is divided into three main types of
commands, reflecting the information types
supported by the API Engine.
The main types are:
•
Configuration type commands
•
Status type commands
•
Command type commands
D14953.01 ISDN Link API Reference Guide IL1.0 June 2012.
© 2012 Cisco Systems, Inc. All rights reserved.
About the API About the API
Configuration type commands
Configuration type commands defines the
system settings. Configuration commands are
either supplied or read by the user.
System settings made by Configuration type
commands are persistant over a reboot.
Example: Configure ISDN settings, external
network settings, and enabling/disabling of
various features etc.
The Configuration commands are structured
in a hierarchy, making up a database of
system settings.
Supported Configuration type commands:
xConfiguration
Special commands
In addition to the above sets of commands,
XACLI supports the following set of special
commands:
xConfiguration xCommand
Command type commands
Command type commands instructs the
system to perform an action. Command
commands are supplied by the user.
Actions performed by a Command type
command are not persitant over a reboot.
Example: instructing the system to place a
call, assign floor to a specific site, disconnect
a call etc.
A xCommand command is usually followed by
a set of parameters to specify how the given
action is to be executed.
Supported Command type commands:
xCommand
Feedback type command
The Feedback commands are used to specify
what parts of the configuration and status
hierarchies to monitor. Feedback will only be
issued on the RS-232/SSH session for which
it is specified. If connecting to the system with
multiple sessions, each session can define
feedback individually.
More on this can be found in xfeedback.
xFeedback
11
API Reference Guide
xStatus Contact us
Status type commands
Status type commands returns information
about the system and system processes.
xStatus type commands are read by the user.
Example: Information generated by the
system about ongoing calls, network status,
conference status etc.
All status information is structured in a
hierarchy, making up a database constantly
being updated by the system to reflect system
and process changes.
Supported Status-type commands:
xStatus
Preferences type command
The Preference type command is used to
set various preferences for the RS-232/
SSH sessions. Each session can define
preferences individually. IMPORTANT! This
command has various settings to define the
formatting of the XACLI output. It is therefore
important to define settings to match the
parser used on the control system. XACLI is
designed to make parsing of data from the
system very simple.
More on this can be found in xpreferences.
xPreferences
www.cisco.com