Epicenter External Access Protocol; External Access Protocol Overview; External Access Protocol Structure - Extreme Networks EPICenter Software Installation Manual

C

EPICenter External Access Protocol

This appendix describes:
• The EPICenter external access protocol structure and commands
• The client Tcl API, a higher-level API based on the External Access Protocol

External Access Protocol Overview

The EPICenter external access protocol enables you to access data from the EPICenter data for use
within other applications. It also lets you enable and disable EPICenter policies, and configure those
policies on Extreme devices.

External Access Protocol Structure

The external access protocol consists of three layers: transport, encoding, and command protocols. This
section briefly describes each layer.
Transport Layer
The EPICenter External Access is provided through a TCP connection. The external application must
first establish a persistent TCP connection with the EPICenter server. The EPICenter server listens on a
TCP port on the server machine for incoming connections. The EPICenter server picks a dynamic port
number that is not in use on the server machine during startup. This port number can be discovered by
the external application by sending an HTTP request to:
http://<EPICenter_host>:<EPICenter_web_port>/everest/getport
is the IP number or host name of the machine on which the EPICenter server is
EPICenter_host
running. is the port number for the EPICenter Web server. The result of this URL
EPICenter_web_port
is a number. This number is the port number on which the EPICenter server is listening for external
applications to establish the connection. If the external application receives an error while accessing the
above URL, then the EPICenter server is not running or the server is not listening for external
connections.
EPICenter Software Installation and User Guide 493