Table Of Contents

Session Manager

Session Management Activity Commands

Session Manager

---

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

The Session Manager (SMG) user management tool tracks the session clients (users) that have logged in to the Cisco BTS 10200 Softswitch. The commands listed in this chapter display and control the behavior of users in the system. For example, when user wilmer7 logs in to the system, the SMG assigns a terminal ID to the user. A terminal ID is similar in concept to a UNIX terminal port. This terminal ID is then used in the commands below. It allows a service provider to force users off the system during a maintenance procedure such as a database backup.

The SMG supports a craft command interface by messages. These can be incorporated into a RequestManager implementation for use in the Cisco BTS 10200 Softswitch commands. This allows a craft to control the operations of the SMG.

---

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

---

Session Management Activity Commands

This section describes the session management activity commands.

Note The block session terminal command is not supported during a maintenance (MNT) session. All other block and unblock commands are only available during a MNT session. Mode is for the entire EMS and not just for a specific session.

Command Types

The supported commands are as follows:

•show—The interface supports a query listing all terminals in the system. The SMG returns a list of currently defined terminals. It allows the service provider to differentiate the list based on a user ID. If the terminal is not listed, all terminals are shown. The asterisk wildcard (*) is not supported.

show session terminal={1-32 characters}

show session terminal={4-5 characters} (Release 4.5.1)

show block-information (Release 4.5.1) 

•block—This command requires a single terminal ID. The terminal is then blocked and a notification is sent to the terminal to suspend all further operation. The state of the specified terminal is changed to blocked.

block session [terminal={1-32 characters}]

block session [terminal | user | type=#]; (Release 4.5.1)

block session mode = MAINTENANCE | UPGRADE (Release 4.5.1)

block session < type | user> =#; [ level=PROVISION | COMPLETE ] (Release 4.5.1)

---

Caution If the terminal type of a terminal is associated with either an FTP or SNMP application (such as type=ftp or type=snmp), the FTP or SNMP application is blocked as well.

---

•change—This command requires the idle-time token. See the syntax description for its properties.

change session idle-time=20;

•unblock—This command requires a single terminal ID. The terminal is then unblocked and notification is sent to the terminal for the user to resume normal operation. The state of the specified terminal is changed to unblocked.

unblock session [terminal={1-32 characters}]

unblock session [terminal | type | user] (Release 4.5.1)

unblock session (Release 4.5.1)

unblock session <type | user> =#; (Release 4.5.1)

•stop—This command requires a single terminal ID. The selected terminal is then notified to terminate and its associated terminal definition in the SMG is removed.

stop session [terminal={1-32 characters}]

stop session [terminal={4-52 characters}] (Release 4.5.1)

---

Note The stop, block, and unblock commands cannot be executed on the terminal from which the command was entered.

---

---

Note Command information in square brackets ( [ ] ) is mandatory. There is no mandatory information for the show command.

Command information in curly braces ( { } ) is optional.

---

Examples

show session

stop session terminal=USR5

block session terminal=USR5

unblock session terminal=USR5

change session idle-time=20;

Syntax Description

*IDLE-TIME	This token defines the number of minutes that a user can be idle on the CLI interface before being automatically logged off the Cisco BTS 10200 Softswitch. INTEGER: 10-30 (Default = 30).
MODE (Release 4.5.1)	Mandatory for the block and unblock commands as of Release 4.5.1. Specifies the operator mode. VARCHAR(12): 1-12 ASCII characters. Permitted values are: MAINTENANCE—Regular maintenance window UPGRADE—Upgrade
TERMINAL	Mandatory for the stop command. Terminal id. VARCHAR(5) 4-5 ASCII characters.
TYPE (Release 4.5.1)	Mandatory for the block and unblock commands as of Release 4.5.1. Blocks or unblocks sessions based on type definition. Must be used in conjunction with the user token. Valid only for the block or unblock command. VARCHAR(6): 1-6 ASCII characters. Permitted values are: ALL—all sessions with type CLI, CORBA, FTP, or SNMP are blocked CLI—all sessions with type CLI are blocked CORBA—all sessions with type CORBA are blocked FTP—all sessions with type FTP are blocked SNMP—all sessions with type SNMP are blocked Note MNT is never blocked.
USER (Release 4.5.1)	Mandatory for the block and unblock commands as of Release 4.5.1. Specifies whether one or all users are blocked or unblocked. Must be used in conjunction with the type token. Valid only for the block or unblock command. VARCHAR(16): 1-16 ASCII characters. Permitted values are: <name>—Block or unblock sessions by of a specific user name. suppose <%>—Block or unblock all users. For example, user=% blocks or unblocks all users.
LEVEL (Release 4.5.1)	Specifies the block level. Valid only for the block or unblock command. VARCHAR(10): 1-10 ASCII characters (Default = complete). Permitted values are: PROVISION—All provisioning commands are blocked (change, delete, add, clear, sync, audit, reset, stop, and start) COMPLETE—All commands are blocked.