Skip to end of metadata
Go to start of metadata

In this section:

The primary interfaces used to access the SBC are the Embedded Management Application (EMA) GUI, Platform Manager GUI, Command Line Interface (CLI) and BMC (Baseboard Management Controller) GUI, Representational State Transfer Application Processing Interface (REST API ) and Simple Object Access Protocol Application Processing Interface (SOAP API).

EMA

Platform Manager

The Platform Manager (PM) provides current status of the platform, application software version information and system information. The PM is also used to start, stop and restart the application as well as reboot the host. The PM supports upgrading the operating system and application. Additional features include a web interface for generic troubleshooting activities, security and remote access management. Please see the Introduction to Platform Manager for details.

Go to Logging into Platform Manager.

Command Line Interface

Command Line Interface (CLI) is the traditional method to configure systems from any machine with network access using a secure shell (SSH) client terminal emulator). Please see the CLI Command Reference for details.

CLI Modes

The SBC CLI includes two modes:

  • The system-level mode, which you are in when you first log in to the CLI. This mode lets you view the current configuration and status of objects.
  • The configure mode lets you create/modify, show, and delete configurable SBC objects.

Space-Completion Functionality

The CLI includes space-completion behavior which automatically displays a list of possible arguments when the user types more than one space after a keyword or parameter (same action as pressing Tab). This is generally desired behavior when entering commands from an interactive session, and is the default setting (complete-on-space is set to "true").

The commands to turn on/off space-completion are:

  • set complete-on-space true
  • set complete-on-space false

Below is an example of entering "show" command plus two spaces when space-completion is set to "true". The result is a "Possible completions" list that automatically displays as shown:

admin@sbx131> show••
Possible completions:
cli - Display cli settings
configuration - Display current configuration
notification - Display notifications
status - Display current system status
table - Display current configuration and status as a table
users - Display currently logged on users
utils - System utilities

On the other hand, when copy-pasting multiple commands to the command line this feature is not desirable. Extra spaces may prevent the commands from running as expected due to the automatic space-completion feature. To avoid this, turn this feature off using the following command:

admin@sbx131> set complete-on-space false
[ok][2012-07-03 14:13:47]

Go to Logging Into CLI.

Baseboard Management Controller

The Baseboard Management Controller (BMC) supports the following functions:

  • View basic system information
  • Change mouse mode
  • Configure BMC and Platform Manager network settings
  • Add, edit or remove users
  • Configure NTP settings
  • View or change SSL certificate
  • Perform remote control settings
  • Update BMC firmware and reboot BMC
  • Switch to Platform Manager

Go to Logging Into BMC

Not applicable to SBC Software Edition.

SOAP API

SBC Core SOAP APIs provide access to Simple Object Access (SOAP) API which is protocol specification used to exchange structured information in the implementation of web services. It uses XML information set for its message format, and usually relies on other application layer protocols, such as Hypertext Transfer Protocol (HTTP) or Simple Mail Transfer Protocol (SMTP), for message negotiation and transmission. The advantage of using SOAP is that it is very versatile and use different transport protocols. The standard stacks use HTTP as a transport protocol.

The SBC SOAP API supports the following requests for each managed object:

  • CREATE – creates a managed object in the SBC.
  • UPDATE – updates a managed object in the SBC.
  • DELETE – deletes a managed object in the SBC.
  • SHOW– retrieves managed object details from SBC.
  • User defined operations – For example, manual switchover of the SBC.

The EMS application maps each SOAP request to the corresponding REST request towards the SBC. In network configurations where EMS is deployed, the EMS is also used to configure the SBC using SOAP API for SBC. This interface supports provisioning as well the operations exposed by the yang models. Please see SBC SOAP APIs for details.

Go to Accessing SOAP API.

REST API

REST APIs provide access to REpresentational State Transfer (REST) API which is a simple, stateless architecture style (not a protocol) that uses the HTTP/HTTPS method ( such as GET, PUT, POST, DELETE)  to retrieve the management information from the database. The main advantage is its simple interfaces and can be modified while the application is running.

REST has the following properties:

  • Stateless: No client context is stored on the server. A request from the client will contain all the necessary information required to process the request.
  • Client-Server model: In a client-server model, clients are associated with the user interface, and the servers manage data storage behind the interface. This allows a seperation between the client and server.

  • Cacheable: Improvement in scalability and performance when the client caches responses.
  • Language–independent: REST API uses open standards. Any language may be used to access the API ( C++, Java, etc. ) resources via URI paths.

 To use a REST API, your application makes HTTPs requests and parses the responses. Currently, the only supported response format is XML. The methods used by developers are standard HTTP methods such as GET, PUT, POST, PATCH and DELETE. Please see REST API User's Guide for details.

Go to Accessing REST API.