Table Of Contents

Maintenance and Administration of System Component Commands

Control Command Target States

Call Agent

Status Command

Control Command

Feature Server

Status Command

Control Command

Element Management System

Status Command

Control Command

Bulk Data Management System

Status Command

Control Command

Status System Command

Status Application Command

Control Application Command

System Configuration Command

Maintenance and Administration of System Component Commands

---

Revised: July 24, 2009, OL-3743-42

This chapter describes the status and control commands that are applicable only to the Call Agent (CA), Feature Server (FS), Element Management System (EMS), and the Bulk Data Management System (BDMS). There is also one System command. Status and control commands do not have their own tables.

Do not attempt to interpret responses from the status commands, or to use any control commands without first referring to the procedures and interpretations in the Cisco BTS 10200 Softswitch Operations Manual. Incorrect interpretation of the status commands, and incorrect usage of the control commands can cause a traffic or data interruption. For a complete list of sample replies and states, see the Cisco BTS 10200 Softswitch Operations Manual.

---

Note In this chapter, an asterisk preceding a token name means the token is mandatory. A token without an asterisk is optional.

---

Control Command Target States

Table 10-1 lists target states and their descriptions for the control commands.

.

Table 10-1 Control Command Target States and Descriptions 

Target State	Description
NORMAL (Obsoleted as of Release 4.5)	Normal allows changing the operational state from FORCED to NORMAL. If the previous configuration was FORCED_STANDBY_ACTIVE, a switchover will occur.
ACTIVE_STANDBY (Release 4.5)	Controls Side A to active and Side B to standby.
STANDBY_ACTIVE (Release 4.5)	Controls Side A to standby and Side B to active.
FORCED-ACTIVE- STANDBY (Obsoleted as of Release 4.5)	Side A is forced to active and Side B is standby.
FORCED-STANDBY- ACTIVE (Obsoleted as of Release 4.5)	Side A has been forced to standby and Side B is active.

Call Agent

This section describes the status and control commands for the Cisco BTS 10200 Softswitch Call Agent.

Status Command

The status command reports the status of a Call Agent.

Command Types

Status

Examples

status call-agent;

Reply Example:

Reply: Request was successful.

REPLY=CONFIGURATION COMMAND EXECUTED-> status call-agent

PRIMARY STATUS -> ACTIVE_NORMAL

SECONDARY STATUS -> STANDBY_NORMAL

---

Note In Release 4.5, the words FORCED and NORMAL are no longer returned in command responses. ACTIVE_NORMAL becomes ACTIVE, STANDBY_NORMAL becomes STANDBY, and so forth.

---

Control Command

The control command puts the Call Agent into a specific state.

Command Types

Control

Examples

control call-agent id=CA146; target-state=forced-standby-active;

control call-agent id=CA146; target-state=forced-active-standby;

control call-agent id=CA146; target-state=normal;

control call-agent id=CA146; target-state=standby-active; (Release 4.5)

control call-agent id=CA146; target-state=active-standby; (Release 4.5)

Reply Example:

Request was successful

REPLY=CONFIGURATION COMMAND EXECUTED->Reconfigured successfully.

---

Note In Release 4.5, the words FORCED and NORMAL are no longer returned in command responses. ACTIVE_NORMAL becomes ACTIVE, STANDBY_NORMAL becomes STANDBY, and so forth.

---

Feature Server

This section describes the status and control commands for the Cisco BTS 10200 Softswitch Feature Server.

Status Command

The status command reports the status of a Feature Server. Entering the command without an id returns all feature servers except third party (3PTY) feature servers. 3PTY feature servers are not valid for this command.

Command Types

Status

Examples

status feature-server id=FSAIN205.Cisco.com; 

Reply Example:

Request was successful.

REPLY=CONFIGURATION COMMAND EXECUTED-> status feature-server

PRIMARY STATUS -> ACTIVE-NORMAL

SECONDARY STATUS -> STANDBY-NORMAL

---

Note In Release 4.5, the words FORCED and NORMAL are no longer returned in command responses. ACTIVE_NORMAL becomes ACTIVE, STANDBY_NORMAL becomes STANDBY, and so forth.

---

Control Command

The control command puts a Feature Server into a specific state. This command is not valid for 3PTY feature servers.

Command Types

Control

Examples

control feature-server id=FSAIN205.Cisco.com; target-state=normal;

control feature-server id=FSAIN205.Cisco.com; target-state=active-standby; (Release 4.5)

Reply Example:

Request was successful

REPLY=CONFIGURATION COMMAND EXECUTED->control feature-server LOCAL STATUS 

Element Management System

This section describes the status and control commands for the Cisco BTS 10200 Softswitch Element Management System (EMS). These commands are specific to the EMS. For Billing commands, see the "Bulk Data Management System" section.

Status Command

The status command reports the status of an EMS.

Command Types

Status

Examples

status element-manager; id=EM01;

Reply Example:

Reply : Success:

        ELEMENT MANAGER STATUS IS... ->

        APPLICATION INSTANCE -> Element Manager [EM1]

        PRIMARY STATUS -> ACTIVE_NORMAL

        SECONDARY STATUS -> FAULTY

        EMS ORACLE STATUS IS ... -> Daemon is running!

        ORACLE STATUS IS... -> Daemon is running! Control Command

---

Note In Release 4.5, the words FORCED and NORMAL are no longer returned in command responses. ACTIVE_NORMAL becomes ACTIVE, STANDBY_NORMAL becomes STANDBY, and so forth.

---

Control Command

The control command puts an EMS into a specific state.

Command Types

Control

Examples

control element-manager id=EM01; target-state=normal;

control element-manager id=EM01; target-state=active-standby; (Release 4.5)

Reply Example:

Request was successful

REPLY=CONFIGURATION COMMAND EXECUTED->CONTROL EMS LOCAL STATUS 

Bulk Data Management System

This section describes the status and control commands for the Cisco BTS 10200 Softswitch Bulk Data Management System (BDMS).

Status Command

The status command reports the status of the BDMS.

Command Types

Status

Examples

status bdms; id=BDMS01;

Reply Example:

BILLING SERVER STATUS IS... -> 

APPLICATION INSTANCE -> Bulk Data Management Server [BDMS01]

PRIMARY STATUS -> ACTIVE

SECONDARY STATUS -> STANDBY

BILLING ORACLE STATUS IS... -> Daemon is running!

Reply : Success: 

CLI>

CLI>control bdms id=BDMS01; target-state=active-standby

APPLICATION INSTANCE -> Bulk Data Management Server [BDMS01]

REASON -> Application instance is already in request configuration

Reply : Success: 

Control Command

The control command puts the BDMS into a specific state.

Command Types

Control

Examples

control bdms id=BDMS1; target-state=normal;

control bdms id=BDMS1; target-state=active-standby; (Release 4.5)

Reply Example:

Reply : Success:

APPLICATION INSTANCE -> Bulk Data Management Server [BDMS01]

REASON -> CONFIGURATION COMMAND EXECUTED->CONTROL BDMS LOCAL STATUS System 

Status System Command

The status system command returns the status of all applicable components of the system, including the BDMS.

Command Types

Status

Examples

status system;

Reply Example:

Checking Call Agent status ... 

Checking Feature Server status ... 

Checking Billing Server status ... 

Checking Billing Oracle status ... 

Checking Element Manager status ... 

Checking ORACLE status ... 

CALL AGENT STATUS IS... -> 

APPLICATION INSTANCE -> Call Agent [CA146]

PRIMARY STATUS -> STANDBY_NORMAL

SECONDARY STATUS -> ACTIVE_NORMAL

FEATURE SERVER STATUS IS... -> 

APPLICATION INSTANCE -> Feature Server [FSPTC235]

PRIMARY STATUS -> STANDBY_NORMAL

SECONDARY STATUS -> ACTIVE_NORMAL

FEATURE SERVER STATUS IS... -> 

APPLICATION INSTANCE -> Feature Server [FSAIN205]

PRIMARY STATUS -> STANDBY_NORMAL

SECONDARY STATUS -> ACTIVE_NORMAL

BILLING SERVER STATUS IS... -> 

APPLICATION INSTANCE -> Bulk Data Management Server [BDMS01]

PRIMARY STATUS -> ACTIVE_NORMAL

SECONDARY STATUS -> STANDBY_NORMAL

BILLING ORACLE STATUS IS... -> Daemon is running!

ELEMENT MANAGER STATUS IS... -> 

APPLICATION INSTANCE -> Element Manager [EM01]

PRIMARY STATUS -> STANDBY_NORMAL

SECONDARY STATUS -> ACTIVE_NORMAL

EMS ORACLE STATUS IS ... -> Daemon is running!

Reply : Success: 

---

Note In Release 4.5, the words FORCED and NORMAL are no longer returned in command responses. ACTIVE_NORMAL becomes ACTIVE, STANDBY_NORMAL becomes STANDBY, and so forth.

---

Status Application Command

The status application command shows the state of any Cisco BTS 10200 Softswitch application (CA, FS, EMS, BDMS), including uptime, side indications and additional qualifying reason information.

Command Types

Status

Examples

status application id=*; (returns status of each component)

status application id=1; (returns status of every component containing a 1)

status application id=CA146; 

status application id=CA146; 

status application id=EM01; 

status application id=EM01;

Usage Guidelines

Wild card matching is available for this command. A value can be entered to report any component that has this value. For example, entering id=1 returns every component that has a 1 in its value.

Syntax Description

* ID	Type of application. VARCHAR(8): 1-8 ASCII characters. Permitted values are: CAnnn (or cannn)—CA EMnn (or emnn)—EMS BDMSnn (or bdms)—BDMS FSPTCnnn (or fsptcnnn)—FSPTC FSAINnnn (or fsainnnn)—FSAIN
NODE	UNIX system id. Input is not modified prior to validation. VARCHAR(64): 1-64 ASCII characters. Enter at least 1 character, but not more than 64 characters. To clear a value, enter NULL.

Control Application Command

The control application command stops or starts a platform instance using the CLI. This is the same as a root user entering the command: platform stop -i CA146.

Command Types

Control

Examples

control application id=CA146; node=prica01;action=start;

control application id=CA146; node=prica01;action=stop;

control application id=EM01; node=priems01;action=start;

control application id=EM01; node=priems01;action=stop;

Syntax Description

* ID	Type of application. VARCHAR(8): 1-8 ASCII characters. VARCHAR(64): 1-64 ASCII characters. (Release 4.5.1) Permitted values are: CAnnn (or cannn)—CA EMnn (or emnn)—EMS BDMSnn (or bdms)—BDMS FSnnn (or fsnnn)—FS
* ACTION	Activity to perform. Permitted values are: START—Start a CA, EMS, BDMS, or FS. This is the same as performing a platform start. STOP—Stop a CA, EMS, BDMS, or FS. This is the same as performing a platform stop. Caution Performing a platform stop takes down a component and can produce outages.
* BYPASS (Release 4.5)	Mandatory in Release 4.5.1. Bypass. Input is not modified prior to validation. CHAR(1): Y/N (Default = N).
* NODE	UNIX system id. Input is not modified prior to validation. VARCHAR(64): 1-64 ASCII characters. Enter at least 1 character, but not more than 64 characters. To clear a value, enter NULL.
* IRDP (Release 4.5)	Mandatory in Release 4.5.1. IRDP. Input is not modified prior to validation. CHAR(1): Y/N (Default = Y).
* PING (Release 4.5)	Mandatory in Release 4.5.1. Ping. Input is not modified prior to validation. CHAR(1): Y/N (Default = Y).

System Configuration Command

Use the System Configuration commands to manage the Network Time Protocol servers on the system.

Command Types

Show and change

Examples

show ems;

change ems ntp-server=ntp-server-1,ntp-server-2; (Obsolete in Release 4.5)

change ems interface=ce1;ip-alias=priems09.cisco.com

---

Note There are two forms of the change command:
change ems ntp-server=xxxx (Obsolete in Release 4.5)
change ems interface=xxx, ip-alias=xxx
The first form identifies the NTP server that the Element Management System (EMS) must synchronize to. The second form creates an IP address alias that tracks the active EMS.

---

Usage Guidelines

Primary Key Token(s): None.

Change Rules: None.

Syntax Description

INTERFACE	The physical network interface to be made an alias. VARCHAR(10): 1-10 characters.
IP-ALIAS	Interface alias. Assigned by the service provider. VARCHAR(64): 1-64 characters.
NTP-SERVER	Network time protocol master server name. Defines the Cisco BTS 10200 Softswitch server used for time synchronization. VARCHAR(64): 1-64 ASCII characters. Note In Release 4.1, both NTP servers must be specified. In Release 4.2, only one NTP server must be specified.