BW SAOverviewModules1 4 R120
BW SAOverviewModules1 4 R120
BW SAOverviewModules1 4 R120
May 2005
Module 1 Objectives
At the end of this module, you will be able to:
Explain BroadWorks VoIP network functionality Explain BroadWorks VoIP network features State function of each BroadWorks server State features of each BroadWorks server List ancillary components used with BroadWorks servers State hardware requirements for each BroadWorks server State software requirements for each BroadWorks server State administration roles
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
P S T N
SMTP
Border Element
Managed IP Network
Border Element Border Element
Firewall
Internet
MGCP IAD
Legacy PBX
SIP Phone
Video Phone
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
BroadWorks Servers
Application Server Line-side softswitch. Services delivery platform for end users. Web portal for self service management. Network Server Centralized routing of calls. Enterprise services to allow private dialing plans. Location register that maps users to servers. Media Server Multimedia resources used by the Application Server for voice mail. Interactive voice response (IVR) DTMF, prompt playback/recording. Conference Server Multimedia resource for dial-in conferencing and web collaboration to share PowerPoint, Excel, and Word documents. Element Management System Alarm proxy, measurement collection, provisioning entry point, software management, web and CLI cut-through, diagnostics. Web Server Secure web server, provisioning entry point, client call control entry point, offload processing of web pages from Application Servers, expandability. Call Detail Server Stores the call logs of users with the Enhanced Call Logs feature. Once they have exceeded the configuration limits per service provider, call logs are automatically cleared out of the SQL database daily.
P S T N
SMTP
Border Element
Managed IP Network
Border Element Border Element
Firewall
Internet
MGCP IAD
Legacy PBX
SIP Phone
Video Phone
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
SMTP Server Simple Mail Transfer Protocol (SMTP) server to transfer Internet e-mail messages, including short messages and voice messaging .WAV files. POP3/IMAP Server Post Office Protocol 3 (POP3) server for the voice messaging service. POP3/Internet Messaging Access Protocol (IMAP) server is a storage device for voice messages communicating over standard protocols. Any mail server meeting POP3/IMAP standards can be used. DNS Server DNS server to support A records and SRV records required for redundancy solution and public web portal access.
Hardware Overview
Application Server
Small Configuration
14 CPS 50K BHCA 10K Users
Network Server
Small Configuration
80 CPS 250K BHCA 75K Users
Media Server
Small Configuration
100 Ports
Medium Configuration
500 Ports
Medium Configuration
56 CPS 260K BHCA 50K Users
Medium Configuration
400 CPS 1560K BHCA 390K Users
Large Configuration
278 CPS 1000K BHCA 100K Users
Large Configuration
750 CPS 6000K BHCA 1500K Users
Conferencing Server
Small Configuration
300 Ports
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
Recommended Hardware
BroadWorks Server Types
Application Server Small Netra 120 (2 GB RAM) Network Server Netra 120 (2 GB RAM) Netra 240 (6 GB RAM) Netra 440 (8 GB RAM) Alliance Systems (2 GB RAM) Media Server Netra 120 (512 MB RAM) Netra 240 (1 GB RAM) Conference Server Web Server Netra 120 (2 GB RAM) Netra 240 (4 GB RAM) Element Manager System Netra 120 (2 GB RAM) Call Detail Server Netra 120 (2 GB RAM)
Medium
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
NOTE: The large server size, Netra 1280, will be tested in 2Q05.
Tomcat
(AS/NS/WS/EMS)
Java BroadWorks
(AS/NS/MS/WS/EMS/CDS)
TimesTen DB
(AS/NS)
MySQL
(EMS/CDS)
Solaris OS 9
(with recommended Patch Cluster)
Release 12 operates on Solaris OS 9. BroadWorks maintenance or emergency patches are applied on top of the active software release. Third-party software includes the following: TimesTen Database for the Application Server and Network Server. JAVA, Tomcat, and Apache for the web portal interface. MySQL for the EMS and CDS databases. Solaris utilities include the following: RSYNC is used to replicate files between servers. OPENSSL and OPENSSH are used for secure logins to the servers. TOP is a diagnostic program that shows the top fifteen processes that are running, as well as memory and CPU usage.
Capabilities
This is root access for the installation file. This role is used to install and upgrade BroadWorks This is the equivalent to bwadmin for releases prior to 12.0. This role can start, stop, and do all modifications using the CLI or other tools on a BroadWorks server This role can configure BroadWorks using the CLI or other tools, but is not allowed to start or stop BroadWorks This role can view the current configuration. If the user has a CLI account, the user can also do some modifications
BroadWorks Administrator
BroadWorks Operator
BroadWorks Viewer
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
Multiple user logins for system level administration Allow operators to choose the console login ID for a BroadWorks administrator. A new dummy user, named bworks, is created. It has no password and therefore you cannot log in as bworks. BroadWorks processes will run as this user. BroadWorks Administrator is the only role allowed to start and stop processes as bworks. The user bworks should only be allowed to create new files. Files created at runtime, logs and WAV files, are owned by bworks. Other files, typically all files installed by BroadWorks, are owned by bwadmin. By default bwadmin is also a user with no password. A skeleton directory is created with bwadmin environment variables and aliases. New users are based on the template files located in the skeleton directory. Additionally, BroadWorks Operators and BroadWorks Administrators are part of the bwadmin UNIX group. The UNIX umask is used to ensure that each role can perform its task with the minimum rights and permissions possible. The operator is prompted about administrator/operator/viewer user IDs during installation. It is possible to add as many users, of any type, as desired. By default, the proposed administrator user ID is bwadmin. It is also possible to add users later on with the use of a helper script.
Questions
10
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
10
May 2005
11
Module 2 Objectives
At the end of this module, you will be able to:
List protocols used by and between each BroadWorks server State basic call flows of SIP
12
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
12
13
14
RSYNC
File synchronization (system prompts, greetings)
15
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
15
SIP
OSS/NMS CDS
SIP SIP
DNS
ASR
SIP Radius
MS1
AS secondary AS primary
MS2
SIP
SMTP
SIP
POP3
CS2 CS1
SIP
MGCP
SIP Access
MGCP Access
PC - Browser
16
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
DNS Each device and server has a DNS lookup to get the address for the correct server or device to communicate to next. SIP/MGCP Access devices use SIP/MGCP to initiate a call. SIP Application Servers use SIP: - To get a new contact NGW1 from the Network Server - To set up a call with the new contact NGW1 - To set up and dial in to a conference call - For voice mail operations with the Media Server - To set up a call within a group on the Application Server itself Network Server uses SIP to return contacts to the network gateway and the Application Servers.
16
RTP
DNS AS secondary AS primary SMTP
RTP
MS2
RTP
MS1
RTP
CS2 POP3 CS1
RTP
SIP Access
MGCP Access
PC - Browser
17
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
RTP
Used to transfer audio between the access device and the gateway for the standard call. Media Server uses RTP for IVR prompts, as well as recording and playing back voice mail .WAV files and video .MOV files to video-enabled devices. Conference Server uses RTP to provide voice for conference calls between access devices and gateways.
17
TTREP
NS2 NS1
NGW1 NGW1
DNS
MS2 MS1
SyncAPI
SMTP
ASR
POP3
TTREP RSYNC
PC - Browser SIP Access
18
MGCP Access
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
Redundancy Protocols
TTREP Times Ten Replication is used to push changes made to the database on one server to the remote peer(s). RSYNC This is used to ensure that files and directories specified are at the same time stamp. ASR Application Server Redundancy tells the Network Server and remote Application Server that the local Application Server is hosting the end user. SyncAPI Application Server sends new group and user information to the Network Server to be associated to the provisioned Enterprise for call routing.
18
MS2
LocationAPI LocationAPI
WS AS secondary AS primary
MS1
OAM
HTTP/HTTPS
CS2
HTTP/HTTPS
CS1
CAP
PC - Browser
19
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
19
BroadWorks: Management
NGW1 NGW1 OSS NMS EMS NS2 NS1
SNMP
MS2 MS1
SNMP/SSH/HTTP(S)
AS secondary AS primary CS2 CDS WS CS1
20
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
Management Protocols
SNMP Traps and Gets between the BroadWorks servers and the EMS/OSS. HTTP(S)/SSH/CORBA Used by the OSS to bulk provision BroadWorks servers.
20
BroadWorks: Management
NGW1 NGW1 OSS NMS EMS NS2 NS1
HTTP(S)/SSH/Corba
SSH HTTP(S)/SSH/Corba
AS secondary AS primary MS2 MS1
CDS
WS
HTTP(S)
CS2 CS1
21
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
21
POP/IMAP
POP3 CS1
CS2
SMTP
SMTP SIP Access MGCP Access PC - Browser
22
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
22
SIP Overview
Session Initiation Protocol (SIP)
Internet Engineering Task Force (IETF) standard for multimedia conferencing over IP
SIP is an ASCII-based, application-layer control protocol (defined in RFC 3261) that can be used to establish, maintain, and terminate calls between two or more end points SIP provides the capabilities to:
Determine location of target end point Determine media capabilities of target end pointvia Session Description Protocol (SDP) Determine availability of target end point Establish a session between originating and target end points Handle transfer and termination of calls
23
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
23
SIP Overview
SIP (Methods) Requests
INVITEIndicates a user or service is being invited to participate in a call session ACKConfirms that the client has received a final response to an INVITE request BYETerminates a call and can be sent by either the caller or the callee CANCELCancels any pending searches but does not terminate a call that has already been accepted OPTIONSQueries the capabilities of servers PRACK Provisional acknowledgement REGISTERRegisters the address listed in the To header field with a SIP server
24
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
24
SIP Overview
Types of responses used in response to a Request
SIP 1xxInformational Responses (for example, 180 Ringing) SIP 2xxSuccessful Responses (for example, 200 OK) SIP 3xxRedirection Responses (for example, 302 Temporarily Moved) SIP 4xxClient Failure Responses (for example, 404 User Not Found) SIP 5xxServer Failure Responses SIP 6xxGlobal Failure Responses Registration Process Registration occurs when a SIP client must inform the Application Sever of its location During this process, client sends a REGISTER request to the Application Server and includes the address (or addresses) at which it can be reached Registrations can require Authentication (shared secret)
25
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
25
INVITE sip:[email protected];user=phone SIP/2.0 Originator Via: SIP/2.0/UDP(or TCP) 192.168.5.214:5060 From: "2403649314" <sip:[email protected]>;tag=0003e3630c9 To: <sip:[email protected];user=phone> Call-ID: [email protected] Date: Tue, 04 Jun 2002 19:52:42 GMT CSeq: 101 INVITE User-Agent: AccessDevice Unique Call-ID associates all Contact: sip:[email protected]:5060 messages related to the call Expires: 180 Content-Type: application/sdp Content-Length: 170 Accept: application/sdp v=0 o=SDP 26088 15595 IN IP4 192.168.5.214 s=SIP Call RTP listening port c=IN IP4 192.168.5.214 t=0 0 m=audio 23890 RTP/AVP 0 8 18 a=rtpmap:0 PCMU/8000
Codecs
26
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
26
27
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
Invitation Process
An invitation occurs when one SIP end point (user A) invites another SIP endpoint (user B) to join in a call. User A sends an INVITE message to the Application Server requesting that user B join or set up a call. Application Server processes the request and returns an appropriate response (for example, 100 Trying, 487 User Busy). If necessary, the Application Server initiates a terminating call-half to user B and mediates the two call-halves. If user A wants to end the call, it sends a BYE message.
27
Data Center
28
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
28
ALG: Functionality
SIP Endpoint
REGISTER Contact = Private Address REGISTER Contact = Public Address 200 OK
NAT
SIP ALG
200 OK
NOTIFY 200 OK
29
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
SIP Translation
Manipulates SIP and SIMPLE messages. Replaces an un-routable private IP address with a publicly addressable address. Supports VoIP and IM sessions.
RTP Translation
Manipulates RTP packets. Replaces a un-routable private IP address with a publicly addressable address. Relays audio and video streams.
29
(1) SipInviteEvent
(2) InvitationEvent
(3) InvitationReceivedEvent
(4) SipInviteEvent
(5) 18x Ringing Event (6) AlertingEvent (7) 18x Ringing Event (8) 200 OK Event (10) AnswerEvent (11) 200 OK Event (9) AckEvent (12) AckEvent
RTP Media
30
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
30
Questions
31
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
31
April 2005
32
Module 3 Objectives
At the end of this module, you will be able to:
List redundancy configurations the BroadWorks servers are deployed in State differences between the redundancy configurations deployed by BroadWorks
33
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
33
Data Center
Call Detail Server Network Gateway Network Server 1 Network Server 2 MS1 MS2 MS2 MS3 MS1, MS2, MS3
Network Gateways
Web Server
Primary Primary Secondary Conferencing AppServer Application Server Application Server Server
Customer Premises
IAD
34
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
34
Media Gateway Softswitch Network Server 2 Secondary Application Server Media Server 2
Media Server 1
Network Server 1
Web Server 1 Primary Application Call Detail Server 1 Server Conferencing Server 1 Public Public Access Access Network Network
Web Server 2
Customer Premises
35
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
35
BroadWorks Redundancy
BroadWorks redundancy characteristics
No single point of failure No loss of dial tone No loss of active calls when there is an Application Server deficiency Seamless failover for access and network devices CommPilot Web Portal support for failover Any server in an Application Server cluster can take over users or calls
36
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
36
IN IN IN IN
A A A A
1 2 1 1
0 0 0 0
IN IN IN IN
37
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
DNS
BroadWorks redundancy solution requires DNS. Single FQDN that represents the Application Server primary/secondary pair (both A and SRV records) and another FQDN representing the Network Server cluster (both A and SRV records). Application Server FQDN A/SRV records must be returned in fixed order. Network Server FQDN A/SRV records can be load balanced or fixed order. Some devices use A records (for example, 2421), some prefer SRV (for example, 79x0 SIP phone, 36xx/53xx network gateways), but in both cases you would set up the device to use the proper FQDN.
37
Basic Definitions
Term Cluster Definition
Multiple servers deployed in a data sharing model Typically one Network Server cluster for the entire network, based on N+1 model (1 cluster = ~1.5M end users) Many Application Server clusters, two servers per cluster (1 cluster = ~50k end users) A member of a cluster Nodes do not have to be collocated One node in an Application Server cluster is identified as the primary All end users have the same primary in the cluster Application Server node currently active for a given end user Capacity of a network element to revert control of endpoints or signaling to an alternate network element when a failure condition is detected Capacity to bring back an endpoint to its primary server
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
Node (Peer) Primary Application Server Active Application Server Rollover (Failover)
Rollback
38
38
Questions
39
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
39
April 2005
40
Module 4 Objectives
At the end of this module, you will be able to:
Understand BroadWorks UNIX directory structure Understand BroadWorks web and command line administrative interfaces Understand basic BroadWorks administrative commands
41
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
41
BroadWorks Directories
/ Root
/export/home/bwadmin
/usr/local/broadworks
/var/broadworks
42
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
usr/local/broadworks
BroadWorks working directory. On the Application Server and Network Server, each release has its own release-specific directory, for example, Rel_11.0_1.7/. Active release can be reached via bw_base link. Under release-specific directories: bin/ directory: Contains scripts used by install process and other useful scripts (for example, patchbwquery, broadworksctl, bwshowver). conf/ directory: Contains .properties and .xml files used by BroadWorks for configuration.
/export/home/bwadmin
license-backup/ directory: Created during install (backup of BroadWorks license). .profile file: Defines $PATH variable. .kshrc file: Add aliases that are available each time you log in. /var/broadworks Rel_x.0_1.xxx/ directory: Copy of install/upgrade CD contents (install and uninstall directories). Logs/ directory: Where BroadWorks logs are dumped (appserver/ on AS, routingserver/ on NS, mediaserver0/ on MS). billing/ directory: Call detail records and accounting XML files. userfiles/ directory: System prompts/greetings (personal voice mail greetings in VM/). userfiles/AuditLogs/ directory: Audit trail logs (record of all administrator activity: user creation/deletion, feature modifications). Installation.log file: Screen dump of all ./install script executions. Installation.warning file: Install/upgrade warning information. IpDeviceConfig/ directory: Contains the template files for the IP phones to be used to configure them. patches/ directory: Contains the maintenance and emergency patches for each release.
42
43
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
bwshowver
Provides information on the active release as well as patches that can be applied (run as bwadmin).
43
44
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
showrun
Provides information on running BroadWorks-related processes (run as bwadmin).
44
: :
Process pid 13081 context 0x100480ec0 connected (KEY 0x04003b8d) Process pid 13081 context 0x1004e40b0 connected (KEY 0x04003b8d) Process pid 13081 context 0x100510250 connected (KEY 0x04003b8d) Process pid 13081 context 0x10066e890 connected (KEY 0x04003b8d) Subdaemon pid 374 context 0x1001d0880 connected (KEY 0x04003b8d) Subdaemon pid 374 context 0x1001f69f0 connected (KEY 0x04003b8d) RAM residence policy: Always Replication policy : Always Replication agent is running. Oracle agent policy : Manual -----------------------------------------------------------------------End of report
45
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
ttStatus
Provides information that describes the current state of TimesTen database, for example, the number of connections to the database (run as bwadmin).
45
46
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
repctl status
Provides status information on TimesTen replication and RSYNC file replication (run as bwadmin). Information also available through CLI AS_CLI/System/Peering> status.
46
47
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
Peerctl ls
Provides information on TimesTen replication and RSYNC file replication. Information also available through CLI AS_CLI/System/Peering/Peers> get.
47
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
stopbw
Gracefully shuts down all BroadWorks-related processes (run as bwadmin).
startbw
Starts up all BroadWorks-related processes (run as bwadmin).
48
49
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
peercmd
Spans commands on all cluster peers at the same time.
49
50
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
50
51
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
Read To read commands from a file. Write To redirect CLI output to a file. Config To configure some aspects of CLI. History To show the history of a command. Pause To pause the CLI session remain idle for the amount of time specified. Repeat To execute a given CLI command a number of repetitions with a pause between each command.
51
52
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
52
Steps
Type the level name, abbreviation, or the corresponding number Type each of the level names making up the level path separated by a semicolon (;) Use an abbreviated form (as long as it is unique)
Examples
system s 0 To go to System/Device /Media> system;device;media s;d;m Quit q quit all q all ? help h help get ? get
To go directly to a level
To return to a previous level To return directly to top level To get help at any level
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
53
CLI Aliases
AS_CLI> h alias An alias is a command that contains one or more CLI commands separated by "\;". The alias command runs as if the commands it contains were run sequentially. Parameters typed after the alias command name are passed as parameters to the last command defined in the alias. Upon completion, the alias command returns the CLI session at the level it was when the alias command was typed, unless "stayInContext" is specified. This command lists currently defined CLI command aliases: alias to get an overview of all aliases defined alias <alias name> to get detailed information for an alias This command also supports the creation/modification of new/existing aliases: alias <alias name> "<command(s) to run>" This command also supports the deletion of existing aliases: alias <alias name> "" Example: alias cmds "quit all\;tree -r -f" cmds, typed from any level, lists all CLI levels and commands. Options: "stayInContext" set to TRUE specifies that the CLI session stays in the current context when aliases are invoked. FALSE allows the current context to change when aliases are invoked. The default is TRUE. "description" gives a short explanation of the alias. ====================================================================== alias [<alias>, String {1 to 80 characters}] [<result>, String {0 to 256 characters}] [<attribute>, Multiple Choice = {stayInContext, description}] <stayInContext>, Choice = {false, true} <description>, String {0 to 80 characters}]
54
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
To create an alias command: alias qasr q all\;cd Interface/ASR\;get stayInContext true description View ASR Interface attributes
54
CLI Aliases
NS_CLI> alias Alias Result ================================================================== cddiag q all;cd System/Util/Diag;help cdentpol q all;cd SubscriberMgmt/Enterprise/Policy;help cdmo q all;cd Maintenance/ManagedObjects;help cdpm q all;cd Monitoring/PM/NetworkServer;ls;help cdsched q all;cd Maintenance/Scheduler;get;help cdsystpol q all;cd Policy;help lo q all;login admin openalarm q all;cd Monitoring/Alarm;show on;open opencalllog q all;cd Monitoring/CallLog;open qa quit all qadmin q all;cd SubscriberMgmt/Administrator/User;get qasr q all;cd Interface/ASR;get qbw q all;cd Maintenance/ManagedObjects;get broadworks full qcalllog q all;cd Interface/CallLog;get qcarr q all;cd System/Carrier;get;cd PrefNE;get qct q all;cd System/CallP/CallTypes;get qcurrent q all;cd Monitoring/Report;current
55
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
The alias commands are stored as the bwcli_aliases.txt file in the /usr/local/broadworks/bw_base/conf.
55
CLI History
AS_CLI> h history The history command prints out (at the CLI window) recent commands that were typed in for the current CLI session. This is useful to view, re-enter, or edit, past commands. The default history size is 20. This command prints out the past history: history To set the history size: history <size> To execute a command from the history do: !<cmd_id> To re-execute the last command do: !! ====================================================================== history [<size>, Integer {10 to 1000}]
56
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
56
57
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
Log In
1. In the User ID text box, enter the login name assigned to you. 2. Press the Tab key or click in the Password box. 3. Type your password. 4. Click Bookmark this page and type the name in the Add Favorite dialog box to access this page from your Internet Explorer menu. 5. Press the Enter key or click Login.
Log Out
1. On any page in the system, click Logout. 2. Once you log out, to log in again you can log in with your existing User ID and password or log in with a different User ID and password.
57
Hands-On Training
58
2005 BroadSoft, Inc. Proprietary and Confidential; Do Not Copy, Duplicate, or Distribute
58
BroadWorks UNIX Commands BroadWorks runs on a standard Solaris UNIX platform. A number of BroadWorks-specific commands are available from the UNIX prompt (as part of the bwadmin environment settings). 1. Log in to the Application Server as bwadmin. 2. From the UNIX prompt, enter bwshowver.
Which version of the Application Server is active? ___________________________ Which BroadWorks patches are applied? __________________________________
59
BroadWorks UNIX Directory Structure BroadWorks runs on a standard Solaris UNIX platform. Installation of BroadWorks creates a BroadWorks-specific UNIX directory structure on each platform. 1. In which directory are new software images copied into as part of the installation process? _________________________________________________________________ 2. In which directory would you find the MoExtensions.pl script associated with the active software? _________________________________________________________________ BroadWorks Command Line Interface All platforms provide a BroadWorks command line interface (BWCLI) that is used to configure each platform. 1. Log in to the BroadWorks command line interface level as admin.
Which UNIX command did you use to enter the CLI? _______________________
2. The ? command provides context-sensitive help information depending on when it is used. What information does ? provide in the following cases (from AS_CLI level)?
?: _________________________________________________________________ ? login: ____________________________________________________________ login ?: ____________________________________________________________
5. The CLI supports standard get, set, add, and delete commands to manipulate or view parameters and to add or delete data entities.
In which level would you find the SIP T2 timer value? _________________________ Can the T2 timer be set to 5000 milliseconds? _______________________________ Which parameters are available to add a Network Server under AS_CLI/System/Device/NetServ? ___________________________________ Which parameters are mandatory and which are optional? _____________________
6. Exit from the BroadWorks CLI using the exit command. BroadWorks Web Server BroadWorks provides a web interface for the Application Server and Network Server that can be used for administration and user self-management. 1. Using Internet Explorer, log in to the Application Server web server as a system provider. (The default user ID is admin and the default password is admin). How many links are available from the system provider level? __________________ Which menu option would a system provider use to change the Web Portal Branding? ___________________________________________________________________
60
NS CLI Tree
NS_CLI [ login ] ...System [ ] .....Alias [ get add delete ] .....CallP [ ] .......CallTypes [ get add set delete ] .......CountryCodes [ get add set delete ] .........DialPlan [ get add set delete ] ...........Entry [ get add set delete ] .........NDC [ get add set delete ] ...........LCA [ get add set delete ] ...........Zones [ get add set delete ] .......DMI [ get add set delete ] .......PolicyPrecedence [ get set ] .......Translation [ get set SaveLCA ] .........LCA [ get add delete ] .........NNACL [ get add set delete ] .......Treatment [ get add set delete ] .....Carrier [ get add set delete ] .......PrefNE [ get add set delete ] .....ClientSession [ ] .......InactivityTimer [ get set ] .......LoginAuthLevel [ get set ] .....Device [ ] .......HostingNE [ get add set delete ] .........Address [ get add set delete ] .........Node [ get add set delete ] .......Monitor [ ] .........NetworkDevice [ get set ] .......ResourceNE [ get add set delete ] .........Address [ get add set delete ] .........MSSelect [ get add set delete ] .......RoutingNE [ get add set delete ] .........Address [ get add set delete ] .........Routing [ get add set delete viewDMI ] .......WebServerFarm [ get add set delete ] .........Address [ get add set delete ] .........Node [ get add set delete ] .....Licensing [ get set ] .......Alarm [ get set ] .....NetworkControlList [ ] .......ServiceControlProxy [ get add set delete ] .....Peering [ get set lock start status stop unlock ] .......Peers [ get add delete ] ..... .....Peering [ get set lock start status stop unlock ]
61
.....Util [ ] .......ASUpload [ upload ] .......Diag [ PingDevice ] .......Policy [ get load ] .......Verif [ vmss vtr ] ...Interface [ ] .....ASR [ get set ] .....CallLog [ get set ] .....MSS [ get set ] .....SIP [ get set ] .....SNMP [ ] .......AccessList [ get add delete ] .......Agent [ get set ] .......Reporting [ get set generateReport ] .........FTP [ get add set delete ] .......Trap [ get add delete ] .......V3User [ get add set delete ] .....ServiceControlProxy [ get set ] ...SubscriberMgmt [ ] .....Administrator [ ] .......HostingNEUser [ get add delete ] .......User [ get add set delete ] .....Enterprise [ get add set delete ] .......DnUrl [ get detail add set delete setOverflow ] .........AutoMigrate [ get set ] .......Policy [ ] .........EntMediaSrvSel [ get add set delete ] ...........SiteList [ get add set delete ] .........EntNGWRouting [ get add set delete ] ...........AuthHost [ get add delete ] ...........Properties [ get add set delete ] ...........RoutingList [ get add set delete ] .........EntSIMPLE [ get add set delete ] ...........Gateway [ get add set delete ] .........EntSubLocation [ get add set delete ] .........ExtDialing [ get add set delete ] .........FarEndHopOff [ get add set delete ] ...........AuthHost [ get add delete ] ...........RoutingList [ get add set delete ] .........voiceVPN [ get add set delete ] ...........DialPlan [ get add set delete ] ...........Properties [ get add set delete ] .......Site [ get add set delete ] .......UserGroup [ get add set delete ] .....MaxFailedLoginAttempts [ get set ] .....MinLoginIdLength [ get set ] .....Numbers [ get set ] .......UnassignedNumbers [ get add delete ] .....PasswordRules [ get set ]
62
...Policy [ ] .....CallScreening [ get add set delete ] .....CallTyping [ get add set delete ] .....EqualAccess [ get add set delete ] .....FarEndRtg [ get add set delete ] .....MediaSrvSel [ get add set delete ] .......RouteList [ get add set delete ] .....NearEndRtg [ get add set delete ] .....NumberPortability [ get add set delete ] .......PortedInNumbers [ get add set delete ] .......PortedOutNumbers [ get add set delete ] .....OrigRedirect [ get add set delete ] .....PreCallTyping [ get add set delete ] .......DialPlan [ get add set delete ] .....Profile [ get add set delete ] .....RCBasedRtg [ get add set delete ] .......LataRoutingList [ get add set delete ] .......ZoneRoutingList [ get add set delete ] .....SIMPLE [ get add set delete ] .......Gateway [ get add set delete ] .....SubLocation [ get add set delete ] .....SvcCtrRtg [ get add set delete ] .......GWController [ get add delete ] .......SCRL [ get add set delete ] .......TrunkGroup [ get add set delete ] .....TandemOverflow [ get add set delete ] .....UrlDialing [ get add set delete ] Monitoring [ ] .....Alarm [ get set clear ShowConfig close open show ] .....AuditTrail [ get set ] .....CallLog [ close open ] .....PM [ ] .......Mib-II [ get set cd ls pwd ] .......NetworkServer [ get set cd ls pwd ] .......SMC [ get set cd ls pwd ] .......Sun [ get set cd ls pwd ] .....Report [ get set current history recent ] .....Threshold [ get add set delete ] ...Maintenance [ ] .....ManagedObjects [ get set lock reset start stop unlock ] .....Scheduler [ get add delete ] .....Tools [ backupdb healthmon importdb restoredb tech-support ]
63
AS CLI Tree
.AS_CLI [ login ] ...System [ ] .....Alias [ get add delete ] .....CallP [ ] .......AccessRouting [ get set ] .......CallForwarding [ get set ] .......CallTypes [ get add delete ] .......CountryCodes [ get add set delete ] .......DigitCollection [ get set ] .......GroupCalling [ get set ] .......LongCallAcctg [ get set ] .......NetProgression [ get set ] .......OverloadControls [ get set ] .......Routing [ ] .........MediaServerSelection [ get set ] ...........MediaServerDevice [ get add set delete clear ] .........Route [ get add delete ] ...........Device [ get add set delete ] .........RouteParms [ get set ] .........RoutingXLA [ get add set delete ] .......SessionAudit [ get set ] .......Treatment [ get set ] .....Carrier [ get add set delete ] .....ClientSession [ ] .......InactivityTimer [ get set ] .......LoginAuthLevel [ get set ] .......ServerAddresses [ get set ] .....Device [ ] .......Codec [ get add delete ] .......InstantConf [ get detail add set delete resetUserPwd resyncCS ] .........Element [ get add set delete ] .......IpDeviceMgmt [ get set rebuildDefaultFile reset setConfigFile ] .........Fileserver [ get add set delete ] .......Monitor [ ] .........AccessDevice [ get add set delete ] .........NetworkDevice [ get set ] .......NetServ [ get add set delete clear ] .......SMDI [ get add set delete ] .........Routing [ get add set delete ] .....Domain [ get set ] .....EventNotification [ get set ] .......Subscription [ get detail delete ] .....Licensing [ get set ] .....NetworkAccessLists [ get set ] .......CAP [ get add set delete ] .......ExtAuth [ get add set delete ] .......SIP [ get add set delete ] .......SMDI [ get add set delete ]
64
..... .....Peering [ get set lock start status stop unlock ] .......Peers [ get add set delete ] Redundancy [ get set ] .......MigratedUsers [ get ] .....Registration [ get set ] .......Contacts [ get delete ] .....StartupParam [ get set ] .....Util [ ] .......ASDump [ dump ] .......CallTrace [ run ] .......Diag [ audit auditAll dump heap kill killAll list pingDevice release ] .......QueryGroup [ get ] .......QueryService [ get ] .......QueryUser [ get ] .......QueueStats [ get set ] ...Interface [ ] .....ASR [ get set ] .....Accounting [ ] .......BroadWorksCDRInterface [ get set ] .........File [ get set ] ...........FTP [ get set ] .........Radius [ get set ] .......Browser [ get browse ] .......EventInterface [ get set ] .....CAP [ get set ] .....CallLogs [ get set ] .....INServiceControl [ get set ] .....LDAPDirectory [ get set clear ] .....MGCP [ get set clear ] .....Mail [ get set ] .....NetServSync [ get set ] .....SIP [ get set clear ] .......ContentType [ get add set delete ] .....SMDI [ get set ] .....SNMP [ ] .......AccessList [ get add delete ] .......Agent [ get set ] .......Reporting [ get set generateReport ] .........FTP [ get add set delete ] .......Trap [ get add delete ] .......V3User [ get add set delete ] ...SubscriberMgmt [ ] .....Administrator [ get add set delete ] .....Domain [ get detail add delete ] .....Group [ get detail add set delete clear ] .......Administrator [ get add set delete ] .........Policy [ get set ] .......Department [ get add set delete clear ] .........Administrator [ get add set delete ]
65
.......Device [ get detail add set delete clear lineOrder ] .......DigitCollection [ get set ] .......Domain [ get detail add delete ] .......Extensions [ get set ] .......GroupCallerID [ get set ] .......GroupServices [ ] .........Assign [ get add delete ] .........Authorize [ get set ] .......InstantConfPorts [ get set ] .......LDAPDirectory [ get set clear ] .......Numbers [ get add delete ] .......PasswordRules [ get ] .......Policy [ get set ] .......UserServices [ ] .........Authorize [ get set ] .........ExistingUser [ add delete ] .........NewUser [ get add delete ] .......VPPasscodeRules [ get set ] .....Numbers [ get ] .......Utilization [ get ] .....PasswordRules [ get set ] .....Policy [ get set ] .....ServiceProvider [ get detail add set delete ] .......Administrator [ get add set delete ] .........Policy [ get set ] .......Carrier [ get add set delete ] .......Department [ get add set delete clear ] .......Device [ get detail add set delete clear ] .......DigitCollection [ get set ] .......Domain [ get detail add delete ] .......GroupServices [ get set ] .......InstantConfPorts [ get set ] .......LDAPDirectory [ get set clear ] .......Numbers [ get add delete ] .......PasswordRules [ get ] .......ServicePacks [ get detail add set delete addService ] .......UserServices [ get set ] .......VPPasscodeRules [ get set ] .....SupportedLanguages [ get add set delete ] .....SystemConfig [ get set ] .....User [ get detail add set delete clear ] .....Util [ ] .......ChangeUserId [ set ] .....VPPasscodeRules [ get set ] ...Service [ ] .....AutomaticCallback [ get set ] .....CallCenter [ get set ] .....CallNotify [ get set ] .....CallingNameRetrieval [ get set clear ] .....Conferencing [ get set ]
66
.....EmergencyZones [ get set ] .....VoiceMsg [ get set ] .....HuntGroup [ get set ] .....INServiceControl [ get set ] .....InventoryReport [ get set ] .....OutgoingCPCallTypes [ get add delete ] .....VoiceMailNotification [ get set ] .....WindowsMessenger [ get set ] ...Monitoring [ ] .....Alarm [ get set clear ShowConfig close open show ] .....AuditTrail [ get set ] .....PM [ ] .......ApplicationServer [ get set cd ls pwd ] .......Mib-II [ get set cd ls pwd ] .......OpenClientServer [ get set cd ls pwd ] .......SMC [ get set cd ls pwd ] .......Sun [ get set cd ls pwd ] .....ProtocolMonitor [ get add set delete dumpToCLI dumpToFile ] .....Report [ get set current history recent ] .....Threshold [ get add set delete ] ...WebServer [ ] .....HttpAlias [ get add set delete ] .....Protocol [ get set ] .....System [ get set ] .....WebBranding [ get set ] ...OpenClientServer [ get set ] .....AppServ [ get add set delete clear ] .....NetServ [ get add set delete ] ...Maintenance [ ] .....ManagedObjects [ get set lock reset start stop unlock ] .....Scheduler [ get add delete ] .....Tools [ backupdb healthmon importdb restoredb tech-support ]
67
MS CLI Tree
.MS_CLI [ ] ...System [ get set ] .....AccessControlList [ get set ] .......SIP [ get add delete ] .....Licensing [ get ] ...Interface [ ] .....RTP [ get add set delete ] .....SIP [ get add set delete ] .....SNMP [ ] .......AccessList [ get add delete ] .......Agent [ get set ] .......Reporting [ get set generateReport ] .........FTP [ get add set delete ] .......Trap [ get add delete ] .......V3User [ get add set delete ] ...Service [ ] .....Conferencing [ get set ] .......Codec [ get add delete ] .....IVR [ get set ] .......AudioCodec [ get add delete ] .......VideoCodec [ get add delete ] .....LiveAudio [ ] .......Codec [ get add delete ] ...Monitoring [ ] .....Alarm [ get set clear ShowConfig close open show ] .....PM [ ] .......MediaServer [ get set cd ls pwd ] .......Mib-II [ get set cd ls pwd ] .......SMC [ get set cd ls pwd ] .......Sun [ get set cd ls pwd ] .....Report [ get set current history recent ] .....Threshold [ get add set delete ] ...Maintenance [ ] .....ManagedObjects [ get set lock reset start stop unlock ] .....Scheduler [ get add delete ] .....Tools [ healthmon tech-support ]
68
WS CLI Tree
.WS_CLI [ ] ...System [ get set ] ...WebBranding [ get set ] ...HttpAlias [ get add set delete ] ...Protocol [ get set ] ...OpenClientServer [ get set ] .....AppServ [ get add set delete clear ] .....NetServ [ get add set delete ] ...Monitoring [ ] .....Alarm [ get set clear ShowConfig close open show ] .....PM [ ] .......ExternalWebServer [ get ] .......Mib-II [ get set cd ls pwd ] .......OpenClientServer [ get set cd ls pwd ] .......SMC [ get set cd ls pwd ] .......Sun [ get set cd ls pwd ] ...Interface [ ] .....SNMP [ ] .......AccessList [ get add delete ] .......Agent [ get set ] .......Trap [ get add delete ] .......V3User [ get add set delete ] ...Maintenance [ ] .....ManagedObjects [ get set lock reset start stop unlock ] .....Scheduler [ get add delete ] .....Tools [ healthmon tech-support ]
69
70