BroadWorks Application Server Command Line

Interface Administration Guide

Release 21.0
Version 2

9737 Washingtonian Boulevard, Suite 350

Gaithersburg, MD 20878
Tel +1 301.977.9440

WWW.BROADSOFT.COM
BroadWorks ® Guide

Copyright Notice
Copyright © 2015 BroadSoft, Inc.
All rights reserved.
Any technical documentation that is made available by BroadSoft, Inc. is proprietary and confidential and is
considered the copyrighted work of BroadSoft, Inc.
This publication is for distribution under BroadSoft non-disclosure agreement only. No part of this
publication may be duplicated without the express written permission of BroadSoft, Inc., 9737
Washingtonian Boulevard, Suite 350, Gaithersburg, MD 20878.
BroadSoft reserves the right to make changes without prior notice.

Trademarks
Any product names mentioned in this document may be trademarks or registered trademarks of BroadSoft
or their respective companies and are hereby acknowledged.
This document is printed in the United States of America.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 2
Document Revision History

Release Version Reason for Change Date Author

19.0 1 DITA version of the document. July 13, 2012 Charles Leduc

19.0 1 Updated document with minor editorial changes. July 30, 2012 Margot Hovey-Ritter

19.0 1 Generated content for Release 19.0. November, 2012 Charles Leduc

19.0 2 Added definitions of start-up parameters. November 26, 2012 Goska Auerbach

19.0 2 Added AS_CLI/Interface/IMS context. December 12, 2012 Charles Leduc

20.0 1 Inserted table headings for EV 177508 and modified March 12, 2013 Margot Hovey-Ritter
glossary items.

20.0 1 Updated DRH and validated Release 20.0 content. August 14, 2013 Margot Hovey-Ritter

20.0 1 Updated content with final Release 20.0 build and November 20, 2013 Margot Hovey-Ritter
published document.

21.0 1 Updated content with Release 21.0 content. November 20, 2014 Charles Leduc

21.0 1 Updated DRH and published document. December 15, 2014 Margot Hovey-Ritter

21.0 2 In response to PR-47033, the following section was October 14, 2015 Margot Hovey-Ritter
modified:
• ContentType on page 640

21.0 2 Updated DRH and published document. October 19, 2015 Margot Hovey-Ritter

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 3
Table of Contents

Document Revision History.............................................................................................................3

1 Summary of Changes................................................................................................................. 20
1.1 Changes from Release 20.0 to Release 21.0........................................................................................... 20
1.1.1 Added Contexts....................................................................................................................................20
1.1.2 Modified Contexts................................................................................................................................ 21
1.1.3 Removed Contexts...............................................................................................................................22
1.2 Changes from Release 19.0 to Release 20.0........................................................................................... 23
1.2.1 Added Contexts....................................................................................................................................23
1.2.2 Modified Contexts................................................................................................................................ 24
1.2.3 Removed Contexts...............................................................................................................................26
1.3 Changes from Release 18.0 to Release 19.0........................................................................................... 26
1.3.1 Added Contexts....................................................................................................................................26
1.3.2 Modified Contexts................................................................................................................................ 29
1.3.3 Removed Contexts...............................................................................................................................29
2 Purpose........................................................................................................................................ 30
3 Document Conventions.............................................................................................................. 31
3.1 Data You Enter.......................................................................................................................................... 31
3.2 Keys You Use............................................................................................................................................ 31
3.3 BroadWorks Server Software Version....................................................................................................... 31
3.4 BroadWorks Server Messages.................................................................................................................. 31
4 BroadWorks Server System Conventions................................................................................ 32
4.1 Start CLI..................................................................................................................................................... 32
4.2 Enter CLI Commands................................................................................................................................ 32
4.2.1 Enter 0 Digits or Characters................................................................................................................32
4.2.2 Enter Uppercase and Lowercase Data............................................................................................... 32
4.2.3 Enter SIP URL..................................................................................................................................... 32
4.2.4 Help...................................................................................................................................................... 32
4.3 Command Syntax.......................................................................................................................................33
4.3.1 Entering Commands............................................................................................................................ 33
4.3.2 Shortcuts.............................................................................................................................................. 33
4.4 Log In......................................................................................................................................................... 34
4.5 Menu System............................................................................................................................................. 34
4.5.1 Hierarchical Tree Structure.................................................................................................................. 35
4.5.2 Change Levels..................................................................................................................................... 35
4.6 Read Files.................................................................................................................................................. 35
4.7 Write Output to a File................................................................................................................................ 36
4.8 Configure CLI............................................................................................................................................. 37
4.9 CLI Commands History..............................................................................................................................38
4.10 CLI Command Alias................................................................................................................................. 39
4.11 Exit CLI.....................................................................................................................................................40
4.12 Procedural Steps......................................................................................................................................40
COMMAND LINE INTERFACE ADMINISTRATION....................................................................... 42
5 ASDiagnostic............................................................................................................................... 43
5.1 DNS............................................................................................................................................................ 43
5.1.1 clearAllCache....................................................................................................................................... 43
5.1.2 clearCache........................................................................................................................................... 43
5.1.3 lookup................................................................................................................................................... 43
5.1.4 reload................................................................................................................................................... 44
5.2 Diag............................................................................................................................................................ 44
5.2.1 audit......................................................................................................................................................44
5.2.2 auditAll..................................................................................................................................................44

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 4
 5.2.3 dump.................................................................................................................................................... 45
5.2.4 heap..................................................................................................................................................... 47
5.2.5 kill......................................................................................................................................................... 47
5.2.6 killAll..................................................................................................................................................... 47
5.2.7 list......................................................................................................................................................... 48
5.2.8 pingDevice............................................................................................................................................50
5.2.9 release..................................................................................................................................................51
5.2.10 vtr....................................................................................................................................................... 51
5.2.11 vtri.......................................................................................................................................................52
5.3 Diameter..................................................................................................................................................... 52
5.3.1 fetchRoutes.......................................................................................................................................... 52
5.3.2 Peers.................................................................................................................................................... 53
5.3.3 Realms................................................................................................................................................. 54
5.4 OverloadControls........................................................................................................................................54
5.4.1 CallpUtil................................................................................................................................................ 54
5.4.2 Neighbors............................................................................................................................................. 55
5.4.3 NonCallpUtil..........................................................................................................................................56
5.5 QueueStats.................................................................................................................................................57
5.5.1 get........................................................................................................................................................ 57
5.5.2 set.........................................................................................................................................................57
6 System.......................................................................................................................................... 58
6.1 ASClusterName.......................................................................................................................................... 58
6.1.1 get........................................................................................................................................................ 58
6.1.2 set.........................................................................................................................................................58
6.1.3 clear......................................................................................................................................................58
6.2 ActivatableFeature......................................................................................................................................59
6.2.1 get........................................................................................................................................................ 59
6.2.2 detail..................................................................................................................................................... 59
6.2.3 activate................................................................................................................................................. 59
6.2.4 deactivate............................................................................................................................................. 59
6.3 Alias............................................................................................................................................................ 60
6.3.1 get........................................................................................................................................................ 60
6.3.2 add....................................................................................................................................................... 60
6.3.3 delete....................................................................................................................................................60
6.4 ApplicationServerId.....................................................................................................................................60
6.4.1 get........................................................................................................................................................ 60
6.4.2 set.........................................................................................................................................................61
6.5 CallP........................................................................................................................................................... 61
6.5.1 AccessRouting......................................................................................................................................61
6.5.2 CallCorrelation......................................................................................................................................62
6.5.3 CallTypes..............................................................................................................................................63
6.5.4 CommunicationBarring......................................................................................................................... 64
6.5.5 CountryCodes.......................................................................................................................................66
6.5.6 DNS...................................................................................................................................................... 69
6.5.7 DTMFTransmission.............................................................................................................................. 70
6.5.8 ExpensiveCalls..................................................................................................................................... 71
6.5.9 ExternalEmergencyRouting..................................................................................................................74
6.5.10 NetProgression...................................................................................................................................75
6.5.11 Routing............................................................................................................................................... 76
6.5.12 ServiceCodes..................................................................................................................................... 88
6.5.13 SessionAudit.......................................................................................................................................89
6.5.14 Treatment........................................................................................................................................... 92
6.5.15 VirtualOnNetCallTypes..................................................................................................................... 112
6.6 Carrier.......................................................................................................................................................113
6.6.1 get...................................................................................................................................................... 113
6.6.2 add..................................................................................................................................................... 114

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 5
 6.6.3 set.......................................................................................................................................................114
6.6.4 delete..................................................................................................................................................115
6.7 ClientApplications..................................................................................................................................... 115
6.7.1 get...................................................................................................................................................... 115
6.7.2 set.......................................................................................................................................................115
6.7.3 genKey............................................................................................................................................... 116
6.7.4 import................................................................................................................................................. 116
6.8 ClientSession............................................................................................................................................117
6.8.1 InactivityTimer.................................................................................................................................... 117
6.8.2 ServerAddresses................................................................................................................................ 117
6.9 CommunicationUtility................................................................................................................................ 119
6.9.1 DefaultSettings................................................................................................................................... 119
6.10 ConfigAgent............................................................................................................................................ 143
6.10.1 Logging.............................................................................................................................................143
6.11 Device.....................................................................................................................................................146
6.11.1 EnhancedReportingServer............................................................................................................... 146
6.11.2 FileRepos......................................................................................................................................... 147
6.11.3 IpDeviceMgmt...................................................................................................................................151
6.11.4 MgcpCodec...................................................................................................................................... 198
6.11.5 Monitor..............................................................................................................................................199
6.11.6 NetworkServers................................................................................................................................ 201
6.11.7 SMDI................................................................................................................................................ 204
6.12 DeviceTagSet......................................................................................................................................... 207
6.12.1 get.................................................................................................................................................... 207
6.12.2 add................................................................................................................................................... 208
6.12.3 set.....................................................................................................................................................208
6.12.4 delete................................................................................................................................................208
6.12.5 Tags................................................................................................................................................. 208
6.13 DeviceType.............................................................................................................................................210
6.13.1 MGCP...............................................................................................................................................210
6.13.2 SIP....................................................................................................................................................211
6.14 Domain................................................................................................................................................... 232
6.14.1 get.................................................................................................................................................... 232
6.14.2 set.....................................................................................................................................................232
6.15 EventNotification.....................................................................................................................................233
6.15.1 get.................................................................................................................................................... 233
6.15.2 set.....................................................................................................................................................233
6.15.3 ChannelSets..................................................................................................................................... 235
6.15.4 Subscription......................................................................................................................................236
6.16 GeneralSettings...................................................................................................................................... 238
6.16.1 get.................................................................................................................................................... 238
6.16.2 set.....................................................................................................................................................238
6.17 Licensing.................................................................................................................................................239
6.17.1 get.................................................................................................................................................... 239
6.17.2 LicenseManager............................................................................................................................... 239
6.18 ManagementAccessList..........................................................................................................................245
6.18.1 get.................................................................................................................................................... 245
6.18.2 add................................................................................................................................................... 245
6.18.3 set.....................................................................................................................................................246
6.18.4 delete................................................................................................................................................246
6.18.5 clear..................................................................................................................................................246
6.19 MediaFileSystem.................................................................................................................................... 247
6.19.1 get.................................................................................................................................................... 247
6.19.2 set.....................................................................................................................................................247
6.19.3 clear..................................................................................................................................................248
6.20 MobileNetwork........................................................................................................................................ 248

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 6
 6.20.1 HomeNetwork...................................................................................................................................248
6.20.2 RoamingNetwork.............................................................................................................................. 249
6.21 NetworkAccessLists................................................................................................................................252
6.21.1 get.................................................................................................................................................... 252
6.21.2 set.....................................................................................................................................................252
6.21.3 CAP.................................................................................................................................................. 252
6.21.4 ExtAuth............................................................................................................................................. 254
6.21.5 OCI................................................................................................................................................... 255
6.21.6 SIP....................................................................................................................................................263
6.21.7 SMDI................................................................................................................................................ 265
6.22 OverloadControls....................................................................................................................................267
6.22.1 get.................................................................................................................................................... 268
6.22.2 set.....................................................................................................................................................268
6.22.3 CallP................................................................................................................................................. 270
6.22.4 ManagedNeighbors.......................................................................................................................... 271
6.22.5 NonCallP.......................................................................................................................................... 275
6.23 Peering................................................................................................................................................... 277
6.23.1 get.................................................................................................................................................... 277
6.23.2 set.....................................................................................................................................................277
6.23.3 lock................................................................................................................................................... 278
6.23.4 start.................................................................................................................................................. 278
6.23.5 status................................................................................................................................................ 279
6.23.6 stop...................................................................................................................................................279
6.23.7 unlock............................................................................................................................................... 279
6.23.8 Peers................................................................................................................................................ 279
6.24 ProfileTuning...........................................................................................................................................281
6.24.1 GeneralSettings................................................................................................................................281
6.25 Redundancy............................................................................................................................................281
6.25.1 get.................................................................................................................................................... 282
6.25.2 set.....................................................................................................................................................282
6.25.3 GeoProxy..........................................................................................................................................282
6.25.4 MigratedUsers.................................................................................................................................. 283
6.25.5 PeerSIPConnectionMonitoring......................................................................................................... 283
6.26 Registration.............................................................................................................................................284
6.26.1 get.................................................................................................................................................... 284
6.26.2 set.....................................................................................................................................................284
6.26.3 Contacts........................................................................................................................................... 285
6.27 Resources...............................................................................................................................................288
6.27.1 Memory.............................................................................................................................................288
6.28 RoutePoint.............................................................................................................................................. 289
6.28.1 ApplicationController........................................................................................................................ 289
6.28.2 ExternalSystem................................................................................................................................ 290
6.29 Security...................................................................................................................................................293
6.29.1 BlackList........................................................................................................................................... 293
6.29.2 WhiteList...........................................................................................................................................295
6.30 SessionDataReplication..........................................................................................................................297
6.30.1 get.................................................................................................................................................... 297
6.30.2 set.....................................................................................................................................................297
6.31 StartupParam..........................................................................................................................................298
6.31.1 get.................................................................................................................................................... 298
6.31.2 set.....................................................................................................................................................301
6.31.3 clear..................................................................................................................................................324
6.32 Util...........................................................................................................................................................325
6.32.1 ASDump........................................................................................................................................... 325
6.32.2 BTLU................................................................................................................................................ 326
6.32.3 CallTrace.......................................................................................................................................... 326

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 7
 6.32.4 EnhancedReporting..........................................................................................................................330
6.32.5 ListFiles............................................................................................................................................ 335
6.32.6 Messaging........................................................................................................................................ 336
6.32.7 QueryGroup......................................................................................................................................336
6.32.8 QueryUser........................................................................................................................................ 336
6.32.9 SubscriberExport.............................................................................................................................. 337
6.33 Zone........................................................................................................................................................337
6.33.1 get.................................................................................................................................................... 337
6.33.2 add................................................................................................................................................... 337
6.33.3 delete................................................................................................................................................337
6.33.4 usage................................................................................................................................................338
6.33.5 IPAddress......................................................................................................................................... 338
6.33.6 LocationBasedPhysicalLocations..................................................................................................... 339
6.33.7 ZoneCallingPhysicalLocation........................................................................................................... 340
7 Applications............................................................................................................................... 342
7.1 CommPilot................................................................................................................................................ 342
7.1.1 ClientApplicationLaunchUrls...............................................................................................................342
7.1.2 FileTransfer........................................................................................................................................ 343
7.1.3 GeneralSettings..................................................................................................................................344
7.1.4 Logging...............................................................................................................................................345
7.1.5 RelativeUrl.......................................................................................................................................... 349
7.1.6 VisualDeviceManagement..................................................................................................................351
7.1.7 WebBranding......................................................................................................................................352
7.2 DeviceManagementFiles.......................................................................................................................... 353
7.2.1 Logging...............................................................................................................................................353
7.3 ExecutionAndProvisioning........................................................................................................................ 356
7.3.1 Encryption...........................................................................................................................................356
7.3.2 PS.......................................................................................................................................................356
7.3.3 XS.......................................................................................................................................................370
7.4 JWSFiles...................................................................................................................................................384
7.4.1 Logging...............................................................................................................................................384
7.4.2 Users.................................................................................................................................................. 386
7.5 MediaFiles................................................................................................................................................ 387
7.5.1 GeneralSettings..................................................................................................................................387
7.5.2 Logging...............................................................................................................................................388
7.5.3 Users.................................................................................................................................................. 390
7.6 OCIFiles....................................................................................................................................................392
7.6.1 Logging...............................................................................................................................................392
7.7 OCIOverSoap........................................................................................................................................... 394
7.7.1 GeneralSettings..................................................................................................................................394
7.7.2 Logging...............................................................................................................................................395
7.7.3 OCSConnectivity................................................................................................................................ 398
7.8 OpenClientServer..................................................................................................................................... 398
7.8.1 CAPProxy........................................................................................................................................... 399
7.8.2 ExternalAuthentication........................................................................................................................399
7.8.3 GeneralSettings..................................................................................................................................401
7.8.4 JVMStatsCollector.............................................................................................................................. 402
7.8.5 Logging...............................................................................................................................................404
7.8.6 NSOCIProxy....................................................................................................................................... 407
7.8.7 NameService...................................................................................................................................... 408
7.8.8 OCIProxy............................................................................................................................................ 409
7.8.9 SSLConfiguration............................................................................................................................... 415
7.9 WebContainer...........................................................................................................................................423
7.9.1 Apache............................................................................................................................................... 423
7.9.2 Tomcat............................................................................................................................................... 424

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 8
 8 Monitoring.................................................................................................................................. 448
8.1 Alarm........................................................................................................................................................ 448
8.1.1 get...................................................................................................................................................... 448
8.1.2 set.......................................................................................................................................................452
8.1.3 clear....................................................................................................................................................453
8.1.4 close................................................................................................................................................... 453
8.1.5 open................................................................................................................................................... 453
8.1.6 show................................................................................................................................................... 454
8.1.7 showConfig.........................................................................................................................................454
8.1.8 AlarmsTable....................................................................................................................................... 454
8.1.9 Threshold............................................................................................................................................455
8.2 PM............................................................................................................................................................ 460
8.2.1 ConfigurationManagement................................................................................................................. 460
8.2.2 Execution............................................................................................................................................464
8.2.3 HostRessources................................................................................................................................. 468
8.2.4 LicenseManager................................................................................................................................. 472
8.2.5 Mib-II.................................................................................................................................................. 476
8.2.6 OpenClientServer............................................................................................................................... 480
8.2.7 Provisioning........................................................................................................................................ 484
8.2.8 Subscriber.......................................................................................................................................... 488
8.2.9 UCD-SNMP........................................................................................................................................ 492
8.2.10 WebContainer...................................................................................................................................496
8.3 ProtocolMonitor.........................................................................................................................................500
8.3.1 get...................................................................................................................................................... 500
8.3.2 add..................................................................................................................................................... 501
8.3.3 set.......................................................................................................................................................503
8.3.4 delete..................................................................................................................................................505
8.3.5 dumpToCLI.........................................................................................................................................506
8.3.6 dumpToFile.........................................................................................................................................506
8.4 Report....................................................................................................................................................... 507
8.4.1 get...................................................................................................................................................... 507
8.4.2 set.......................................................................................................................................................507
8.4.3 current................................................................................................................................................ 507
8.4.4 historyStats.........................................................................................................................................508
8.4.5 recent................................................................................................................................................. 508
8.5 Threshold..................................................................................................................................................508
8.5.1 get...................................................................................................................................................... 508
8.5.2 add..................................................................................................................................................... 509
8.5.3 set.......................................................................................................................................................510
8.5.4 delete..................................................................................................................................................512
9 Maintenance............................................................................................................................... 514
9.1 ContainerOptions......................................................................................................................................514
9.1.1 get...................................................................................................................................................... 514
9.1.2 add..................................................................................................................................................... 514
9.1.3 set.......................................................................................................................................................514
9.1.4 delete..................................................................................................................................................515
9.1.5 removeObsolete................................................................................................................................. 515
9.1.6 showOption.........................................................................................................................................515
9.1.7 showOptions.......................................................................................................................................516
9.2 Extraview.................................................................................................................................................. 516
9.2.1 upload.................................................................................................................................................517
9.3 ManagedObjects.......................................................................................................................................517
9.3.1 get...................................................................................................................................................... 517
9.3.2 detail................................................................................................................................................... 518
9.3.3 set.......................................................................................................................................................519
9.3.4 activate............................................................................................................................................... 521

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 9
 9.3.5 deactivate........................................................................................................................................... 521
9.3.6 deploy................................................................................................................................................. 522
9.3.7 lock..................................................................................................................................................... 522
9.3.8 start.................................................................................................................................................... 523
9.3.9 stop.....................................................................................................................................................523
9.3.10 undeploy........................................................................................................................................... 524
9.3.11 unlock............................................................................................................................................... 525
9.4 Patching....................................................................................................................................................525
9.4.1 detail................................................................................................................................................... 525
9.4.2 apply................................................................................................................................................... 526
9.4.3 checkPeer...........................................................................................................................................526
9.4.4 execute............................................................................................................................................... 526
9.4.5 getModifiedFile................................................................................................................................... 527
9.4.6 listBundle............................................................................................................................................ 527
9.4.7 listPatch.............................................................................................................................................. 527
9.4.8 listRelation.......................................................................................................................................... 528
9.4.9 patchHistory........................................................................................................................................529
9.4.10 refresh.............................................................................................................................................. 530
9.4.11 remove..............................................................................................................................................530
9.5 Scheduler..................................................................................................................................................530
9.5.1 get...................................................................................................................................................... 530
9.5.2 add..................................................................................................................................................... 531
9.5.3 delete..................................................................................................................................................532
9.5.4 FileCollector........................................................................................................................................533
9.6 Tools......................................................................................................................................................... 534
9.6.1 backupdb............................................................................................................................................ 534
9.6.2 healthmon...........................................................................................................................................535
9.6.3 importdb..............................................................................................................................................535
9.6.4 restoredb............................................................................................................................................ 535
9.6.5 tech-support........................................................................................................................................535
9.6.6 upgradeCheck.................................................................................................................................... 536
10 Interface.................................................................................................................................... 537
10.1 ASR........................................................................................................................................................ 537
10.1.1 get.................................................................................................................................................... 537
10.1.2 set.....................................................................................................................................................537
10.2 Accounting.............................................................................................................................................. 538
10.2.1 BroadWorksCDRInterface................................................................................................................ 538
10.2.2 Browser............................................................................................................................................ 557
10.2.3 FieldIdMapping................................................................................................................................. 565
10.3 CAP........................................................................................................................................................ 566
10.3.1 get.................................................................................................................................................... 566
10.3.2 set.....................................................................................................................................................566
10.4 CallLogs..................................................................................................................................................567
10.4.1 get.................................................................................................................................................... 567
10.4.2 set.....................................................................................................................................................567
10.4.3 clear..................................................................................................................................................569
10.5 CommonCommunicationTransport......................................................................................................... 569
10.5.1 get.................................................................................................................................................... 569
10.5.2 set.....................................................................................................................................................569
10.5.3 OCI................................................................................................................................................... 571
10.6 Cr............................................................................................................................................................ 574
10.6.1 get.................................................................................................................................................... 574
10.6.2 set.....................................................................................................................................................574
10.7 Diameter................................................................................................................................................. 575
10.7.1 get.................................................................................................................................................... 575
10.7.2 set.....................................................................................................................................................575

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 10
 10.7.3 clear..................................................................................................................................................578
10.7.4 Peers................................................................................................................................................ 578
10.7.5 Realms............................................................................................................................................. 580
10.8 FTP......................................................................................................................................................... 584
10.8.1 get.................................................................................................................................................... 584
10.8.2 set.....................................................................................................................................................584
10.9 Http......................................................................................................................................................... 585
10.9.1 ClientAuthentication..........................................................................................................................585
10.9.2 GeneralSettings................................................................................................................................593
10.9.3 HttpAlias........................................................................................................................................... 593
10.9.4 HttpBinding....................................................................................................................................... 595
10.9.5 HttpServer........................................................................................................................................ 597
10.10 INServiceControl...................................................................................................................................602
10.10.1 get.................................................................................................................................................. 602
10.10.2 set...................................................................................................................................................602
10.11 LDAP.................................................................................................................................................... 602
10.11.1 Client.............................................................................................................................................. 602
10.12 LDAPDirectory...................................................................................................................................... 605
10.12.1 get.................................................................................................................................................. 606
10.12.2 set...................................................................................................................................................606
10.12.3 clear................................................................................................................................................608
10.13 MGCP................................................................................................................................................... 608
10.13.1 get.................................................................................................................................................. 608
10.13.2 set...................................................................................................................................................608
10.13.3 clear................................................................................................................................................610
10.14 Mail....................................................................................................................................................... 610
10.14.1 get.................................................................................................................................................. 610
10.14.2 set...................................................................................................................................................610
10.14.3 clear................................................................................................................................................611
10.15 MediaFileSize....................................................................................................................................... 611
10.15.1 get.................................................................................................................................................. 612
10.15.2 set...................................................................................................................................................612
10.16 Messaging............................................................................................................................................ 614
10.16.1 get.................................................................................................................................................. 614
10.16.2 set...................................................................................................................................................614
10.16.3 clear................................................................................................................................................615
10.17 NetServSync.........................................................................................................................................615
10.17.1 get.................................................................................................................................................. 615
10.17.2 set...................................................................................................................................................615
10.18 OCI....................................................................................................................................................... 616
10.18.1 CallControl......................................................................................................................................616
10.18.2 Reporting........................................................................................................................................ 618
10.19 ProvisioningValidation.......................................................................................................................... 620
10.19.1 get.................................................................................................................................................. 620
10.19.2 set...................................................................................................................................................620
10.20 SIP........................................................................................................................................................ 621
10.20.1 get.................................................................................................................................................. 621
10.20.2 set...................................................................................................................................................621
10.20.3 clear................................................................................................................................................639
10.20.4 ContentType................................................................................................................................... 640
10.20.5 DiversionReasonMap..................................................................................................................... 641
10.20.6 ProxyPolicy.....................................................................................................................................642
10.21 SMDI.....................................................................................................................................................649
10.21.1 get.................................................................................................................................................. 649
10.21.2 set...................................................................................................................................................649
10.22 SMPP....................................................................................................................................................649

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 11
 10.22.1 get.................................................................................................................................................. 649
10.22.2 set...................................................................................................................................................650
10.22.3 clear................................................................................................................................................651
10.23 SNMP................................................................................................................................................... 651
10.23.1 AccessList...................................................................................................................................... 651
10.23.2 Agent.............................................................................................................................................. 652
10.23.3 Logging...........................................................................................................................................653
10.23.4 Reporting........................................................................................................................................ 656
10.23.5 SMAP............................................................................................................................................. 658
10.23.6 TrapTable....................................................................................................................................... 659
10.23.7 V3AccessControl............................................................................................................................ 662
10.23.8 V3Users..........................................................................................................................................664
10.24 Sh......................................................................................................................................................... 666
10.24.1 get.................................................................................................................................................. 666
10.24.2 set...................................................................................................................................................666
10.24.3 clear................................................................................................................................................667
10.24.4 NonTransparentData...................................................................................................................... 667
11 SubscriberMgmt.......................................................................................................................670
11.1 Administrator...........................................................................................................................................670
11.1.1 get.................................................................................................................................................... 670
11.1.2 add................................................................................................................................................... 670
11.1.3 set.....................................................................................................................................................671
11.1.4 delete................................................................................................................................................671
11.1.5 clear..................................................................................................................................................672
11.2 AnnouncementRepository...................................................................................................................... 672
11.2.1 get.................................................................................................................................................... 672
11.2.2 set.....................................................................................................................................................672
11.3 AppServerSet......................................................................................................................................... 673
11.3.1 Group............................................................................................................................................... 673
11.3.2 ServiceProvider................................................................................................................................ 674
11.4 AuthenticationLockout............................................................................................................................ 675
11.4.1 get.................................................................................................................................................... 675
11.4.2 set.....................................................................................................................................................675
11.4.3 dump................................................................................................................................................ 676
11.4.4 DeviceProfile.................................................................................................................................... 676
11.4.5 SIP....................................................................................................................................................678
11.5 AuthenticationPasswordRules................................................................................................................ 682
11.5.1 DeviceProfile.................................................................................................................................... 682
11.5.2 SIP....................................................................................................................................................685
11.6 ClientApplicationLaunchProfiles............................................................................................................. 689
11.6.1 get.................................................................................................................................................... 689
11.6.2 set.....................................................................................................................................................689
11.7 Device.....................................................................................................................................................690
11.7.1 get.................................................................................................................................................... 690
11.7.2 detail................................................................................................................................................. 691
11.7.3 add................................................................................................................................................... 691
11.7.4 set.....................................................................................................................................................692
11.7.5 delete................................................................................................................................................694
11.7.6 clear..................................................................................................................................................694
11.7.7 lineOrder...........................................................................................................................................694
11.7.8 rebuildDefaultFile..............................................................................................................................695
11.7.9 CustomTags..................................................................................................................................... 695
11.7.10 Files................................................................................................................................................ 697
11.7.11 User................................................................................................................................................ 698
11.8 DeviceInventory...................................................................................................................................... 701
11.8.1 get.................................................................................................................................................... 701

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 12
 11.9 Domain................................................................................................................................................... 702
11.9.1 get.................................................................................................................................................... 702
11.9.2 detail................................................................................................................................................. 703
11.9.3 add................................................................................................................................................... 703
11.9.4 delete................................................................................................................................................703
11.10 EnterpriseTrunkNumberRanges........................................................................................................... 703
11.10.1 get.................................................................................................................................................. 703
11.11 Extensions............................................................................................................................................ 704
11.11.1 get.................................................................................................................................................. 704
11.11.2 set...................................................................................................................................................704
11.12 FeatureAccessCodes........................................................................................................................... 704
11.12.1 get.................................................................................................................................................. 704
11.12.2 set...................................................................................................................................................705
11.12.3 clear................................................................................................................................................705
11.13 Group....................................................................................................................................................705
11.13.1 get.................................................................................................................................................. 706
11.13.2 detail............................................................................................................................................... 706
11.13.3 add................................................................................................................................................. 707
11.13.4 set...................................................................................................................................................708
11.13.5 delete..............................................................................................................................................709
11.13.6 clear................................................................................................................................................709
11.13.7 Administrator.................................................................................................................................. 710
11.13.8 ClientApplicationLaunchProfiles..................................................................................................... 714
11.13.9 Department.....................................................................................................................................716
11.13.10 Device...........................................................................................................................................721
11.13.11 DeviceFileReposUsers................................................................................................................. 734
11.13.12 Domain......................................................................................................................................... 736
11.13.13 EnterpriseTrunkNumberRanges................................................................................................... 737
11.13.14 Extensions.................................................................................................................................... 739
11.13.15 GroupPagingTargetsCapacity...................................................................................................... 740
11.13.16 GroupServices..............................................................................................................................740
11.13.17 LDAPDirectory..............................................................................................................................743
11.13.18 MeetMeConfPorts.........................................................................................................................746
11.13.19 Numbers....................................................................................................................................... 747
11.13.20 PasscodeRules.............................................................................................................................749
11.13.21 PasswordRules.............................................................................................................................752
11.13.22 Policy............................................................................................................................................ 752
11.13.23 TrunkingCallCapacity................................................................................................................... 768
11.13.24 UserServices................................................................................................................................ 769
11.14 MobileSubscriberDirectoryNumbers..................................................................................................... 774
11.14.1 get.................................................................................................................................................. 774
11.15 NumberActivation................................................................................................................................. 777
11.15.1 get.................................................................................................................................................. 777
11.15.2 set...................................................................................................................................................777
11.16 Numbers............................................................................................................................................... 777
11.16.1 get.................................................................................................................................................. 777
11.16.2 Utilization........................................................................................................................................ 778
11.17 PasscodeRules.....................................................................................................................................778
11.17.1 get.................................................................................................................................................. 778
11.17.2 set...................................................................................................................................................778
11.17.3 clear................................................................................................................................................780
11.18 PasswordRules.....................................................................................................................................781
11.18.1 get.................................................................................................................................................. 781
11.18.2 set...................................................................................................................................................781
11.18.3 clear................................................................................................................................................783
11.19 Policy.................................................................................................................................................... 784

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 13
 11.19.1 get.................................................................................................................................................. 784
11.19.2 set...................................................................................................................................................784
11.19.3 CallProcessing................................................................................................................................791
11.19.4 DialPlan.......................................................................................................................................... 798
11.19.5 Multimedia...................................................................................................................................... 802
11.20 ServicePackMigration........................................................................................................................... 807
11.20.1 get.................................................................................................................................................. 807
11.20.2 set...................................................................................................................................................808
11.21 ServiceProvider.................................................................................................................................... 808
11.21.1 get.................................................................................................................................................. 808
11.21.2 detail............................................................................................................................................... 809
11.21.3 add................................................................................................................................................. 809
11.21.4 set...................................................................................................................................................810
11.21.5 delete..............................................................................................................................................811
11.21.6 clear................................................................................................................................................812
11.21.7 Administrator.................................................................................................................................. 812
11.21.8 Announcements..............................................................................................................................818
11.21.9 AuthenticationPasswordRules........................................................................................................818
11.21.10 Carrier...........................................................................................................................................826
11.21.11 ClientApplicationLaunchProfiles................................................................................................... 828
11.21.12 Department...................................................................................................................................830
11.21.13 Device...........................................................................................................................................832
11.21.14 DeviceFileReposUsers................................................................................................................. 844
11.21.15 Domain......................................................................................................................................... 845
11.21.16 EnterpriseTrunkNumberRanges................................................................................................... 847
11.21.17 GroupPagingTargetsCapacity...................................................................................................... 849
11.21.18 GroupServices..............................................................................................................................849
11.21.19 LDAPDirectory..............................................................................................................................851
11.21.20 MeetMeConfPorts.........................................................................................................................854
11.21.21 Numbers....................................................................................................................................... 854
11.21.22 PasscodeRules.............................................................................................................................855
11.21.23 PasswordRules.............................................................................................................................858
11.21.24 Policy............................................................................................................................................ 858
11.21.25 ServicePacks................................................................................................................................872
11.21.26 SupportedLanguages................................................................................................................... 874
11.21.27 TrunkingCallCapacity................................................................................................................... 876
11.21.28 UserServices................................................................................................................................ 877
11.22 SupportedLanguages........................................................................................................................... 878
11.22.1 get.................................................................................................................................................. 878
11.22.2 add................................................................................................................................................. 878
11.22.3 set...................................................................................................................................................879
11.22.4 delete..............................................................................................................................................880
11.23 SystemConfig....................................................................................................................................... 880
11.23.1 CallProcessing................................................................................................................................880
11.23.2 Login...............................................................................................................................................883
11.23.3 Provisioning.................................................................................................................................... 884
11.24 SystemServices.................................................................................................................................... 884
11.24.1 Numbers......................................................................................................................................... 884
11.24.2 Policy.............................................................................................................................................. 885
11.25 User...................................................................................................................................................... 887
11.25.1 get.................................................................................................................................................. 887
11.25.2 detail............................................................................................................................................... 889
11.25.3 add................................................................................................................................................. 889
11.25.4 set...................................................................................................................................................893
11.25.5 delete..............................................................................................................................................899
11.25.6 clear................................................................................................................................................899

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 14
 11.25.7 ClientApplicationLaunchProfiles..................................................................................................... 899
11.26 Util.........................................................................................................................................................901
11.26.1 BroadWorksAnywhereNumberLookup........................................................................................... 901
11.26.2 ChangeUserId................................................................................................................................ 901
12 Service...................................................................................................................................... 903
12.1 AdviceOfCharge..................................................................................................................................... 903
12.1.1 get.................................................................................................................................................... 903
12.1.2 set.....................................................................................................................................................903
12.1.3 CostInformationSource.....................................................................................................................904
12.2 AnonymousCallRejection........................................................................................................................905
12.2.1 get.................................................................................................................................................... 905
12.2.2 set.....................................................................................................................................................905
12.3 AttendantConsole................................................................................................................................... 906
12.3.1 get.................................................................................................................................................... 906
12.3.2 set.....................................................................................................................................................906
12.4 AutoAttendant......................................................................................................................................... 906
12.4.1 get.................................................................................................................................................... 906
12.4.2 set.....................................................................................................................................................907
12.5 AutomaticCallback.................................................................................................................................. 907
12.5.1 get.................................................................................................................................................... 907
12.5.2 set.....................................................................................................................................................907
12.5.3 ReleaseCause.................................................................................................................................. 908
12.6 BroadWorksMobileManager................................................................................................................... 909
12.6.1 get.................................................................................................................................................... 909
12.6.2 set.....................................................................................................................................................909
12.6.3 clear..................................................................................................................................................910
12.7 BroadWorksMobility................................................................................................................................910
12.7.1 get.................................................................................................................................................... 910
12.7.2 set.....................................................................................................................................................910
12.7.3 IMRN................................................................................................................................................ 911
12.7.4 MobileNetwork..................................................................................................................................912
12.7.5 ServiceAccessCodeList....................................................................................................................917
12.8 BusyLampField....................................................................................................................................... 921
12.8.1 get.................................................................................................................................................... 921
12.8.2 set.....................................................................................................................................................921
12.9 COLP...................................................................................................................................................... 921
12.9.1 get.................................................................................................................................................... 922
12.9.2 set.....................................................................................................................................................922
12.10 CallCenter.............................................................................................................................................922
12.10.1 get.................................................................................................................................................. 922
12.10.2 set...................................................................................................................................................922
12.10.3 EnhancedReporting........................................................................................................................924
12.11 CallForwardingNotReachable............................................................................................................... 925
12.11.1 get.................................................................................................................................................. 925
12.11.2 set...................................................................................................................................................925
12.12 CallMeNow........................................................................................................................................... 926
12.12.1 get.................................................................................................................................................. 926
12.12.2 set...................................................................................................................................................926
12.13 CallNotify.............................................................................................................................................. 926
12.13.1 get.................................................................................................................................................. 926
12.13.2 set...................................................................................................................................................927
12.14 CallRecording....................................................................................................................................... 927
12.14.1 get.................................................................................................................................................. 927
12.14.2 set...................................................................................................................................................927
12.14.3 Platform.......................................................................................................................................... 928
12.15 CallReturn.............................................................................................................................................931

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 15
 12.15.1 get.................................................................................................................................................. 931
12.15.2 set...................................................................................................................................................931
12.15.3 clear................................................................................................................................................932
12.16 CallWaiting............................................................................................................................................932
12.16.1 get.................................................................................................................................................. 932
12.16.2 set...................................................................................................................................................932
12.17 CallingNameRetrieval........................................................................................................................... 933
12.17.1 get.................................................................................................................................................. 933
12.17.2 set...................................................................................................................................................933
12.17.3 clear................................................................................................................................................934
12.18 CallingPartyCategory............................................................................................................................935
12.18.1 get.................................................................................................................................................. 935
12.18.2 detail............................................................................................................................................... 935
12.18.3 add................................................................................................................................................. 935
12.18.4 set...................................................................................................................................................936
12.18.5 delete..............................................................................................................................................937
12.18.6 clear................................................................................................................................................937
12.19 Classmark.............................................................................................................................................938
12.19.1 get.................................................................................................................................................. 938
12.19.2 add................................................................................................................................................. 938
12.19.3 set...................................................................................................................................................938
12.19.4 delete..............................................................................................................................................939
12.19.5 clear................................................................................................................................................939
12.19.6 Utilization........................................................................................................................................ 939
12.20 Collaborate........................................................................................................................................... 941
12.20.1 get.................................................................................................................................................. 941
12.20.2 set...................................................................................................................................................941
12.20.3 clear................................................................................................................................................944
12.21 CommunicationBarring......................................................................................................................... 944
12.21.1 get.................................................................................................................................................. 944
12.21.2 set...................................................................................................................................................944
12.22 CommunicationBarringUserControl...................................................................................................... 944
12.22.1 get.................................................................................................................................................. 944
12.22.2 set...................................................................................................................................................945
12.23 CustomerOriginatedTrace.................................................................................................................... 945
12.23.1 get.................................................................................................................................................. 945
12.23.2 set...................................................................................................................................................945
12.24 EmergencyZones..................................................................................................................................946
12.24.1 get.................................................................................................................................................. 946
12.24.2 set...................................................................................................................................................946
12.25 EnhancedCallLogs................................................................................................................................946
12.25.1 get.................................................................................................................................................. 946
12.25.2 set...................................................................................................................................................946
12.25.3 clear................................................................................................................................................947
12.26 Executive.............................................................................................................................................. 947
12.26.1 get.................................................................................................................................................. 948
12.26.2 set...................................................................................................................................................948
12.27 GroupNightForwarding......................................................................................................................... 948
12.27.1 get.................................................................................................................................................. 948
12.27.2 set...................................................................................................................................................948
12.28 HuntGroup............................................................................................................................................ 949
12.28.1 get.................................................................................................................................................. 949
12.28.2 set...................................................................................................................................................949
12.29 INServiceControl...................................................................................................................................949
12.29.1 get.................................................................................................................................................. 950
12.29.2 set...................................................................................................................................................950

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 16
 12.30 InCallServiceActivation......................................................................................................................... 951
12.30.1 get.................................................................................................................................................. 951
12.30.2 set...................................................................................................................................................951
12.31 IntegratedIMP....................................................................................................................................... 952
12.31.1 get.................................................................................................................................................. 952
12.31.2 set...................................................................................................................................................952
12.31.3 clear................................................................................................................................................953
12.32 Intercept................................................................................................................................................953
12.32.1 SystemAllowedDNList.................................................................................................................... 953
12.32.2 User................................................................................................................................................ 954
12.33 InventoryReport.................................................................................................................................... 955
12.33.1 get.................................................................................................................................................. 955
12.33.2 set...................................................................................................................................................955
12.34 LegacyAutomaticCallback.................................................................................................................... 955
12.34.1 get.................................................................................................................................................. 956
12.34.2 set...................................................................................................................................................956
12.34.3 LineTypes....................................................................................................................................... 958
12.35 LocationBasedCallingRestrictions........................................................................................................ 959
12.35.1 get.................................................................................................................................................. 959
12.35.2 set...................................................................................................................................................959
12.36 MaliciousCallTrace............................................................................................................................... 960
12.36.1 get.................................................................................................................................................. 960
12.36.2 set...................................................................................................................................................960
12.37 MeetMeConferencing........................................................................................................................... 960
12.37.1 get.................................................................................................................................................. 960
12.37.2 set...................................................................................................................................................960
12.37.3 clear................................................................................................................................................962
12.38 MusicOnHold........................................................................................................................................ 963
12.38.1 get.................................................................................................................................................. 963
12.38.2 set...................................................................................................................................................963
12.39 NumberPortability................................................................................................................................. 963
12.39.1 get.................................................................................................................................................. 963
12.39.2 set...................................................................................................................................................963
12.39.3 Status............................................................................................................................................. 964
12.40 OutgoingCPCallTypes.......................................................................................................................... 968
12.40.1 get.................................................................................................................................................. 968
12.40.2 add................................................................................................................................................. 969
12.40.3 delete..............................................................................................................................................969
12.41 OutgoingCallingPlan............................................................................................................................. 970
12.41.1 get.................................................................................................................................................. 970
12.41.2 set...................................................................................................................................................970
12.42 PersonalAssistant................................................................................................................................. 970
12.42.1 get.................................................................................................................................................. 971
12.42.2 set...................................................................................................................................................971
12.43 PhysicalLocation...................................................................................................................................971
12.43.1 get.................................................................................................................................................. 971
12.43.2 set...................................................................................................................................................971
12.44 ReceptionistEnterprise..........................................................................................................................972
12.44.1 get.................................................................................................................................................. 972
12.44.2 set...................................................................................................................................................972
12.45 SelectiveServices................................................................................................................................. 972
12.45.1 get.................................................................................................................................................. 972
12.45.2 set...................................................................................................................................................973
12.46 SessionAdmissionControl.....................................................................................................................973
12.46.1 get.................................................................................................................................................. 973
12.46.2 set...................................................................................................................................................973

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 17
 12.47 ShortMessageService...........................................................................................................................974
12.47.1 get.................................................................................................................................................. 974
12.47.2 set...................................................................................................................................................974
12.48 SpeedDial100....................................................................................................................................... 975
12.48.1 get.................................................................................................................................................. 975
12.48.2 set...................................................................................................................................................975
12.49 ThirdPartyIMP.......................................................................................................................................976
12.49.1 get.................................................................................................................................................. 976
12.49.2 set...................................................................................................................................................976
12.49.3 clear................................................................................................................................................976
12.50 ThirdPartyVoiceMailSupport................................................................................................................. 976
12.50.1 get.................................................................................................................................................. 977
12.50.2 set...................................................................................................................................................977
12.50.3 Destinations....................................................................................................................................977
12.51 TrunkGroup...........................................................................................................................................979
12.51.1 get.................................................................................................................................................. 979
12.51.2 set...................................................................................................................................................979
12.51.3 OptionsMessageResponseStatusCode..........................................................................................982
12.52 TwoStageDialing...................................................................................................................................983
12.52.1 get.................................................................................................................................................. 983
12.52.2 add................................................................................................................................................. 984
12.52.3 set...................................................................................................................................................984
12.52.4 delete..............................................................................................................................................984
12.52.5 clear................................................................................................................................................985
12.53 VoiceMailNotification............................................................................................................................ 985
12.53.1 get.................................................................................................................................................. 985
12.53.2 set...................................................................................................................................................985
12.54 VoiceMessageSummaryUpdate........................................................................................................... 986
12.54.1 get.................................................................................................................................................. 986
12.54.2 set...................................................................................................................................................986
12.55 VoiceMsg.............................................................................................................................................. 987
12.55.1 get.................................................................................................................................................. 987
12.55.2 set...................................................................................................................................................987
12.55.3 clear................................................................................................................................................989

Acronyms and Abbreviations......................................................................................................991

Index............................................................................................................................................... 995

References................................................................................................................................... 1005

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 18
List of Tables

Table 1: Added CLI Contexts for Release 21.0............................................................................................... 20

Table 2: Modified CLI Contexts for Release 21.0............................................................................................ 21
Table 3: Removed CLI Contexts for Release 21.0.......................................................................................... 22
Table 4: Added CLI Contexts for Release 20.0............................................................................................... 23
Table 5: Modified CLI Contexts for Release 20.0............................................................................................ 24
Table 6: Removed CLI Contexts for Release 20.0.......................................................................................... 26
Table 7: Added CLI Contexts for Release 19.0............................................................................................... 26
Table 8: Modified CLI Contexts for Release 19.0............................................................................................ 29
Table 9: Removed CLI Contexts for Release 19.0.......................................................................................... 29
Table 10: Navigational Shortcuts......................................................................................................................33
Table 11: Editing Shortcuts...............................................................................................................................34

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 19
1 Summary of Changes

1.1 Changes from Release 20.0 to Release 21.0

This section provides the changes to the Application Server CLI between Release 21.0 and Release 20.0,
the previous major release of BroadWorks.

1.1.1 Added Contexts

Table 1: Added CLI Contexts for Release 21.0
Context

AS_CLI/Applications/ExecutionAndProvisioning/Encryption

AS_CLI/Applications/OpenClientServer/SSLConfiguration/ClientAuthentication

AS_CLI/Applications/OpenClientServer/SSLConfiguration/ClientAuthentication/Trusts

AS_CLI/Interface/Cr

AS_CLI/Interface/Http/ClientAuthentication

AS_CLI/Interface/Http/ClientAuthentication/Trusts

AS_CLI/Interface/Http/ClientAuthentication/WebApps

AS_CLI/Interface/Http/ClientAuthentication/WebApps/Resources

AS_CLI/Interface/LDAP

AS_CLI/Interface/LDAP/Client

AS_CLI/Interface/LDAP/Client/LocalUsers

AS_CLI/Interface/LDAP/Client/Servers

AS_CLI/Interface/Messaging

AS_CLI/Interface/SIP/DiversionReasonMap

AS_CLI/Monitoring/PM/LicenseManager

AS_CLI/Service/AdviceOfCharge/CostInformationSource

AS_CLI/Service/BroadWorksMobility/IMRN

AS_CLI/Service/BroadWorksMobility/MobileNetwork

AS_CLI/Service/BroadWorksMobility/MobileNetwork/IMRN

AS_CLI/Service/BroadWorksMobility/ServiceAccessCodeList

AS_CLI/Service/BroadWorksMobility/ServiceAccessCodeList/ServiceAccessCode

AS_CLI/Service/Collaborate

AS_CLI/Service/NumberPortability

AS_CLI/Service/NumberPortability/Status

AS_CLI/Service/NumberPortability/Status/DigitPatterns

AS_CLI/Service/PersonalAssistant

AS_CLI/Service/TrunkGroup/OptionsMessageResponseStatusCode

AS_CLI/SubscriberMgmt/EnterpriseTrunkNumberRanges

AS_CLI/SubscriberMgmt/Group/EnterpriseTrunkNumberRanges

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 20
 Context

AS_CLI/SubscriberMgmt/MobileSubscriberDirectoryNumbers

AS_CLI/SubscriberMgmt/ServicePackMigration

AS_CLI/SubscriberMgmt/ServiceProvider/EnterpriseTrunkNumberRanges

AS_CLI/SubscriberMgmt/SystemConfig/Provisioning

AS_CLI/SubscriberMgmt/Util/BroadWorksAnywhereNumberLookup

AS_CLI/System/CallP/Routing/VideoServerSelection

AS_CLI/System/CallP/Routing/VideoServerSelection/VideoServerDevice

AS_CLI/System/Device/IpDeviceMgmt/AutoRebuildConfig

AS_CLI/System/Licensing/LicenseManager

AS_CLI/System/Licensing/LicenseManager/Bcct

AS_CLI/System/Licensing/LicenseManager/Bcct/Ports

AS_CLI/System/Licensing/LicenseManager/GeneralSettings

AS_CLI/System/Licensing/LicenseManager/GracePeriods

AS_CLI/System/Licensing/LicenseManager/LicenseStore

AS_CLI/System/Licensing/LicenseManager/Logging

AS_CLI/System/Licensing/LicenseManager/Logging/InputChannels

AS_CLI/System/Licensing/LicenseManager/Logging/OutputChannels

AS_CLI/System/ManagementAccessList

AS_CLI/System/Util/EnhancedReporting/CallCenter/EventArchive

AS_CLI/System/Util/EnhancedReporting/CallLogs/EventArchive

AS_CLI/System/Util/Messaging

1.1.2 Modified Contexts

Table 2: Modified CLI Contexts for Release 21.0
Context

AS_CLI/Applications/CommPilot/GeneralSettings

AS_CLI/Applications/OpenClientServer/ExternalAuthentication/AccessControlList

AS_CLI/Applications/OpenClientServer/SSLConfiguration

AS_CLI/Interface/Accounting/BroadWorksCDRInterface

AS_CLI/Interface/Accounting/BroadWorksCDRInterface/Diameter

AS_CLI/Interface/Accounting/BroadWorksCDRInterface/Diameter/Offline

AS_CLI/Interface/Accounting/BroadWorksCDRInterface/Diameter/Online

AS_CLI/Interface/Http/HttpAlias

AS_CLI/Interface/Http/HttpServer

AS_CLI/Interface/SIP

AS_CLI/Interface/SMPP

AS_CLI/Interface/SNMP/Reporting

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 21
 Context

AS_CLI/Maintenance/ContainerOptions

AS_CLI/Monitoring/Alarm

AS_CLI/Service/AdviceOfCharge

AS_CLI/Service/BroadWorksMobility

AS_CLI/Service/CallCenter

AS_CLI/Service/EnhancedCallLogs

AS_CLI/Service/HuntGroup

AS_CLI/Service/IntegratedIMP

AS_CLI/Service/TrunkGroup

AS_CLI/Service/VoiceMsg

AS_CLI/SubscriberMgmt/Device

AS_CLI/SubscriberMgmt/FeatureAccessCodes

AS_CLI/SubscriberMgmt/Group/Device

AS_CLI/SubscriberMgmt/Group/PasswordRules

AS_CLI/SubscriberMgmt/NumberActivation

AS_CLI/SubscriberMgmt/ServiceProvider/Device

AS_CLI/SubscriberMgmt/ServiceProvider/PasswordRules

AS_CLI/System/CallP/CountryCodes

AS_CLI/System/Device/IpDeviceMgmt

AS_CLI/System/DeviceType/SIP

AS_CLI/System/GeneralSettings

AS_CLI/System/Licensing

AS_CLI/System/StartupParam

1.1.3 Removed Contexts

Table 3: Removed CLI Contexts for Release 21.0
Context

AS_CLI/Applications/ExecutionAndProvisioning/LawfulIntercept

AS_CLI/Interface/BroadCloud

AS_CLI/Interface/Ldap

AS_CLI/Interface/Ldap/Client

AS_CLI/Interface/Ldap/Client/Servers

AS_CLI/Service/BroadWorksMobility/IMRNList

AS_CLI/Service/BroadWorksMobility/ServiceAccessCode

AS_CLI/System/Util/BroadCloud

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 22
1.2 Changes from Release 19.0 to Release 20.0
This section provides the changes to the Application Server CLI between Release 20.0 and Release 19.0,
the previous major release of BroadWorks.

1.2.1 Added Contexts

Table 4: Added CLI Contexts for Release 20.0
Context

AS_CLI/Applications/CommPilot/FileTransfer

AS_CLI/Applications/CommPilot/FileTransfer/Link

AS_CLI/Applications/CommPilot/VisualDeviceManagement

AS_CLI/Applications/ExecutionAndProvisioning/LawfulIntercept

AS_CLI/Applications/ExecutionAndProvisioning/PS/SecurityLogging

AS_CLI/Applications/ExecutionAndProvisioning/PS/SecurityLogging/InputChannels

AS_CLI/Applications/ExecutionAndProvisioning/PS/SecurityLogging/OutputChannels

AS_CLI/Applications/ExecutionAndProvisioning/XS/SecurityLogging

AS_CLI/Applications/ExecutionAndProvisioning/XS/SecurityLogging/InputChannels

AS_CLI/Applications/ExecutionAndProvisioning/XS/SecurityLogging/OutputChannels

AS_CLI/Interface/Accounting/BroadWorksCDRInterface/Diameter/InhibitedAVPCodeList

AS_CLI/Interface/SNMP/Logging

AS_CLI/Interface/SNMP/Logging/InputChannels

AS_CLI/Interface/SNMP/Logging/OutputChannels

AS_CLI/Interface/SNMP/SMAP

AS_CLI/Interface/SNMP/SMAP/BCCT

AS_CLI/Interface/SNMP/TrapTable

AS_CLI/Interface/SNMP/V3AccessControl

AS_CLI/Interface/SNMP/V3AccessControl/Groups

AS_CLI/Interface/SNMP/V3AccessControl/Groups/AccessLevels

AS_CLI/Interface/SNMP/V3Users

AS_CLI/Service/CallRecording/Platform

AS_CLI/Service/Executive

AS_CLI/Service/SessionAdmissionControl

AS_CLI/SubscriberMgmt/AnnouncementRepository

AS_CLI/System/CallP/CallCorrelation

AS_CLI/System/CommunicationUtility/DefaultSettings/ExternalAuthentication/EmbeddedAgent

AS_CLI/System/CommunicationUtility/DefaultSettings/ExternalAuthentication/HealthCheck

AS_CLI/System/CommunicationUtility/DefaultSettings/ExternalAuthentication/Kerberos5

AS_CLI/System/CommunicationUtility/DefaultSettings/ExternalAuthentication/LDAP

AS_CLI/System/CommunicationUtility/DefaultSettings/ExternalAuthentication/LDAP/SASL

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 23
 Context

AS_CLI/System/CommunicationUtility/DefaultSettings/ExternalAuthentication/LDAP/SASL/Digest-MD5

AS_CLI/System/CommunicationUtility/DefaultSettings/ExternalAuthentication/LDAP/SASL/Kerberos5

AS_CLI/System/CommunicationUtility/DefaultSettings/ExternalAuthentication/LDAP/Simple

AS_CLI/System/CommunicationUtility/DefaultSettings/ExternalAuthentication/LDAP/UserToDNMapping

AS_CLI/System/CommunicationUtility/DefaultSettings/ExternalAuthentication/RADIUS

AS_CLI/System/Device/IpDeviceMgmt/DMEventQueues

AS_CLI/System/ProfileTuning

AS_CLI/System/ProfileTuning/GeneralSettings

AS_CLI/System/Redundancy/GeoProxy

AS_CLI/System/Redundancy/GeoProxy/UnreachableFromPrimary

AS_CLI/System/Redundancy/PeerSIPConnectionMonitoring

AS_CLI/System/Util/EnhancedReporting/CallCenter

AS_CLI/System/Util/EnhancedReporting/CallLogs

AS_CLI/System/Util/SubscriberExport

1.2.2 Modified Contexts

Table 5: Modified CLI Contexts for Release 20.0
Context

AS_CLI/Applications/CommPilot/ClientApplicationLaunchUrls

AS_CLI/Applications/CommPilot/GeneralSettings

AS_CLI/Applications/CommPilot/RelativeUrl/AliasesPrefix

AS_CLI/Applications/CommPilot/WebBranding

AS_CLI/Applications/ExecutionAndProvisioning/PS/Database/Databases

AS_CLI/Applications/ExecutionAndProvisioning/PS/Database/Databases/Sites

AS_CLI/Applications/ExecutionAndProvisioning/PS/Database/Schemas/Instances

AS_CLI/Applications/ExecutionAndProvisioning/XS/Database/Databases

AS_CLI/Applications/ExecutionAndProvisioning/XS/Database/Databases/Sites

AS_CLI/Applications/ExecutionAndProvisioning/XS/Database/Schemas/Instances

AS_CLI/Applications/JWSFiles/Users

AS_CLI/Applications/MediaFiles/Users

AS_CLI/Applications/OpenClientServer/GeneralSettings

AS_CLI/Applications/OpenClientServer/NameService

AS_CLI/Applications/WebContainer/Tomcat/NameService

AS_CLI/Interface/Accounting/BroadWorksCDRInterface/Diameter

AS_CLI/Interface/Http/GeneralSettings

AS_CLI/Interface/Ldap/Client

AS_CLI/Interface/MediaFileSize

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 24
 Context

AS_CLI/Interface/SIP

AS_CLI/Interface/SIP/ProxyPolicy/Rule

AS_CLI/Interface/SNMP/Agent

AS_CLI/Maintenance/ManagedObjects

AS_CLI/Maintenance/Patching

AS_CLI/Service/BroadWorksMobility

AS_CLI/Service/CallingNameRetrieval

AS_CLI/Service/CallRecording

AS_CLI/Service/TrunkGroup

AS_CLI/Service/VoiceMsg

AS_CLI/SubscriberMgmt/Device/Files

AS_CLI/SubscriberMgmt/Group/Administrator/Policy

AS_CLI/SubscriberMgmt/Group/Device/Files

AS_CLI/SubscriberMgmt/Group/PasswordRules

AS_CLI/SubscriberMgmt/Group/Policy

AS_CLI/SubscriberMgmt/Group/Policy/CallProcessing/CallingLineId

AS_CLI/SubscriberMgmt/Policy

AS_CLI/SubscriberMgmt/Policy/CallProcessing/CallingLineId

AS_CLI/SubscriberMgmt/ServiceProvider/Administrator/Policy

AS_CLI/SubscriberMgmt/ServiceProvider/Device/Files

AS_CLI/SubscriberMgmt/ServiceProvider/PasswordRules

AS_CLI/SubscriberMgmt/ServiceProvider/Policy/CallProcessing/CallingLineId

AS_CLI/SubscriberMgmt/User

AS_CLI/System/CallP/AccessRouting

AS_CLI/System/CallP/CountryCodes

AS_CLI/System/CommunicationUtility/DefaultSettings/ExternalAuthentication

AS_CLI/System/CommunicationUtility/DefaultSettings/ExternalAuthentication/WAS

AS_CLI/System/Device/IpDeviceMgmt

AS_CLI/System/Device/IpDeviceMgmt/Fileserver

AS_CLI/System/DeviceType/SIP

AS_CLI/System/DeviceType/SIP/Files

AS_CLI/System/EventNotification

AS_CLI/System/Util/EnhancedReporting

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 25
1.2.3 Removed Contexts
Table 6: Removed CLI Contexts for Release 20.0
Context

AS_CLI/Applications/DeviceManagementFiles/Users

AS_CLI/Applications/OCIFiles/Users

AS_CLI/Applications/WebContainer/Tomcat/Executors/AJP/ThreadPool/ProcessingTimeThreshold

AS_CLI/Interface/IMS

AS_CLI/Interface/SNMP/Trap

AS_CLI/Interface/SNMP/V3User

AS_CLI/System/CommunicationUtility/DefaultSettings/TrustedHosts

1.3 Changes from Release 18.0 to Release 19.0

This section provides the changes to the Application Server CLI between Release 19.0 and Release 18.0,
the previous major release of BroadWorks.

1.3.1 Added Contexts

Table 7: Added CLI Contexts for Release 19.0
Context

AS_CLI/Applications/OpenClientServer/JVMStatsCollector

AS_CLI/Applications/OpenClientServer/JVMStatsCollector/GeneralSettings

AS_CLI/Applications/OpenClientServer/JVMStatsCollector/HeapUsageThreshold

AS_CLI/Applications/OpenClientServer/JVMStatsCollector/NonHeapUsageThreshold

AS_CLI/Applications/OpenClientServer/NameService

AS_CLI/Applications/OpenClientServer/OCIProxy/ResponseCache

AS_CLI/Applications/OpenClientServer/OCIProxy/ResponseCache/RequestExclusionFilter

AS_CLI/Applications/OpenClientServer/OCIProxy/ResponseCache/RequestInclusionFilter

AS_CLI/Applications/WebContainer

AS_CLI/Applications/WebContainer/Apache

AS_CLI/Applications/WebContainer/Apache/GeneralSettings

AS_CLI/Applications/WebContainer/Apache/GeneralSettings/WorkersBusyThreshold

AS_CLI/Applications/WebContainer/Tomcat

AS_CLI/Applications/WebContainer/Tomcat/Executors

AS_CLI/Applications/WebContainer/Tomcat/Executors/AJP

AS_CLI/Applications/WebContainer/Tomcat/Executors/AJP/Queue

AS_CLI/Applications/WebContainer/Tomcat/Executors/AJP/Queue/LatencyThreshold

AS_CLI/Applications/WebContainer/Tomcat/Executors/AJP/Queue/SizeThreshold

AS_CLI/Applications/WebContainer/Tomcat/Executors/AJP/ThreadPool

AS_CLI/Applications/WebContainer/Tomcat/Executors/AJP/ThreadPool/ProcessingTimeThreshold

AS_CLI/Applications/WebContainer/Tomcat/Executors/AJP/ThreadPool/UsageThreshold

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 26
 Context

AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI

AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI/Queue

AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI/Queue/LatencyThreshold

AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI/Queue/SizeThreshold

AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI/ThreadPool

AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI/ThreadPool/ProcessingTimeThreshold

AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI/ThreadPool/UsageThreshold

AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio

AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio/Queue

AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio/Queue/LatencyThreshold

AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio/Queue/SizeThreshold

AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio/ThreadPool

AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio/ThreadPool/ProcessingTimeThreshold

AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio/ThreadPool/UsageThreshold

AS_CLI/Applications/WebContainer/Tomcat/GeneralSettings

AS_CLI/Applications/WebContainer/Tomcat/JVMStatsCollector

AS_CLI/Applications/WebContainer/Tomcat/JVMStatsCollector/GeneralSettings

AS_CLI/Applications/WebContainer/Tomcat/JVMStatsCollector/HeapUsageThreshold

AS_CLI/Applications/WebContainer/Tomcat/JVMStatsCollector/NonHeapUsageThreshold

AS_CLI/Applications/WebContainer/Tomcat/Logging

AS_CLI/Applications/WebContainer/Tomcat/Logging/InputChannels

AS_CLI/Applications/WebContainer/Tomcat/Logging/OutputChannels

AS_CLI/Applications/WebContainer/Tomcat/NameService

AS_CLI/Applications/WebContainer/Tomcat/OverloadProtection

AS_CLI/Applications/WebContainer/Tomcat/OverloadProtection/Server

AS_CLI/Applications/WebContainer/Tomcat/OverloadProtection/Webapps

AS_CLI/Applications/WebContainer/Tomcat/SessionManagement

AS_CLI/Applications/WebContainer/Tomcat/SessionManagement/Server

AS_CLI/Applications/WebContainer/Tomcat/SessionManagement/Webapps

AS_CLI/Interface/Http/GeneralSettings

AS_CLI/Interface/IMS

AS_CLI/Monitoring/Alarm/Threshold/Default

AS_CLI/Service/GroupNightForwarding

AS_CLI/Service/ThirdPartyVoiceMailSupport/Destinations

AS_CLI/SubscriberMgmt/AuthenticationLockout

AS_CLI/SubscriberMgmt/AuthenticationLockout/DeviceProfile

AS_CLI/SubscriberMgmt/AuthenticationLockout/SIP

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 27
 Context

AS_CLI/SubscriberMgmt/AuthenticationLockout/SIP/Endpoint

AS_CLI/SubscriberMgmt/AuthenticationLockout/SIP/TrunkGroup

AS_CLI/SubscriberMgmt/AuthenticationPasswordRules

AS_CLI/SubscriberMgmt/AuthenticationPasswordRules/DeviceProfile

AS_CLI/SubscriberMgmt/AuthenticationPasswordRules/SIP

AS_CLI/SubscriberMgmt/ServiceProvider/AuthenticationPasswordRules

AS_CLI/SubscriberMgmt/ServiceProvider/AuthenticationPasswordRules/DeviceProfile

AS_CLI/SubscriberMgmt/ServiceProvider/AuthenticationPasswordRules/SIP

AS_CLI/SubscriberMgmt/SystemServices

AS_CLI/SubscriberMgmt/SystemServices/Numbers

AS_CLI/SubscriberMgmt/SystemServices/Numbers/Usage

AS_CLI/SubscriberMgmt/SystemServices/Policy

AS_CLI/SubscriberMgmt/SystemServices/Policy/CallProcessing

AS_CLI/SubscriberMgmt/SystemServices/Policy/CallProcessing/CallLimits

AS_CLI/System/CommunicationUtility/DefaultSettings/Executors

AS_CLI/System/CommunicationUtility/DefaultSettings/Executors/OCIC

AS_CLI/System/CommunicationUtility/DefaultSettings/Executors/OCIC/Queue

AS_CLI/System/CommunicationUtility/DefaultSettings/Executors/OCIC/Queue/LatencyThreshold

AS_CLI/System/CommunicationUtility/DefaultSettings/Executors/OCIC/Queue/SizeThreshold

AS_CLI/System/CommunicationUtility/DefaultSettings/Executors/OCIC/ThreadPool

AS_CLI/System/CommunicationUtility/DefaultSettings/Executors/OCIC/ThreadPool/ProcessingTimeThreshold

AS_CLI/System/CommunicationUtility/DefaultSettings/Executors/OCIC/ThreadPool/UsageThreshold

AS_CLI/System/CommunicationUtility/DefaultSettings/Executors/OCIP

AS_CLI/System/CommunicationUtility/DefaultSettings/Executors/OCIP/Queue

AS_CLI/System/CommunicationUtility/DefaultSettings/Executors/OCIP/Queue/LatencyThreshold

AS_CLI/System/CommunicationUtility/DefaultSettings/Executors/OCIP/Queue/SizeThreshold

AS_CLI/System/CommunicationUtility/DefaultSettings/Executors/OCIP/ThreadPool

AS_CLI/System/CommunicationUtility/DefaultSettings/Executors/OCIP/ThreadPool/ProcessingTimeThreshold

AS_CLI/System/CommunicationUtility/DefaultSettings/Executors/OCIP/ThreadPool/UsageThreshold

AS_CLI/System/DeviceType/SIP/LineOrdering

AS_CLI/System/Security

AS_CLI/System/Security/BlackList

AS_CLI/System/Security/WhiteList

AS_CLI/System/Util/BTLU

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 28
1.3.2 Modified Contexts
Table 8: Modified CLI Contexts for Release 19.0
Context

AS_CLI/Applications/MediaFiles/GeneralSettings

AS_CLI/Interface/Accounting/BroadWorksCDRInterface/Diameter/Offline

AS_CLI/Interface/CAP

AS_CLI/Interface/MediaFileSize

AS_CLI/Interface/SIP

AS_CLI/Interface/SNMP/Agent

AS_CLI/Service/BroadWorksMobility

AS_CLI/Service/CallCenter

AS_CLI/Service/CallRecording

AS_CLI/Service/IntegratedIMP

AS_CLI/Service/MeetMeConferencing

AS_CLI/Service/SelectiveServices

AS_CLI/Service/ThirdPartyIMP

AS_CLI/Service/ThirdPartyVoiceMailSupport

AS_CLI/Service/TrunkGroup

AS_CLI/SubscriberMgmt/Group/PasscodeRules

AS_CLI/SubscriberMgmt/NumberActivation

AS_CLI/SubscriberMgmt/PasscodeRules

AS_CLI/SubscriberMgmt/ServiceProvider/PasscodeRules

AS_CLI/SubscriberMgmt/SystemConfig/CallProcessing

AS_CLI/System/CommunicationUtility/DefaultSettings

AS_CLI/System/Device/NetworkServers/Synch

AS_CLI/System/DeviceType/SIP

AS_CLI/System/DeviceType/SIP/Files

AS_CLI/System/Registration

AS_CLI/System/Util/CallTrace

1.3.3 Removed Contexts

Table 9: Removed CLI Contexts for Release 19.0
Context

AS_CLI/Applications/CommPilot/CCRSProxyUrls

AS_CLI/System/AppServerSet

AS_CLI/System/Device/ReportingServer

AS_CLI/System/Device/ReportingServer/Utilization

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 29
2 Purpose

This document is designed to assist system providers with management of all Application Server command
line interface (CLI) functions. Detailed instructions for each function of the Application Server can be found
both in the manual and in the online help, available using the help command from all levels of the CLI.
This document covers the administrative features of the Application Server, which are available from the
CLI. For administrative procedures for the CLI for other servers, see the following documents:
• For the Access Mediation Server, see the BroadWorks Access Mediation Server Command Line
Interface Administration Guide.
• For the Application Server, see the BroadWorks Application Server Command Line Interface
Administration Guide.
• For the Database Server, see the BroadWorks Database Server Command Line Interface
Administration Guide.
• For the Element Management System, see the BroadWorks Element Management Server Command
Line Interface Administration Guide.
• For the Execution Server, see the BroadWorks Execution Server Command Line Interface
Administration Guide.
• For Lawful Intercept, see the BroadWorks Lawful Intercept Command Line Interface Administration
Guide.
• For the Media Server, see the BroadWorks Media Server Command Line Interface Administration
Guide.
• For the Messaging Server, see the BroadWorks Messaging Server Command Line Interface
Administration Guide.
• For the Network Function Manager, see the BroadWorks Network Function Manager Command Line
Interface Administration Guide.
• For the Network Server, see the BroadWorks Network Server Command Line Interface Administration
Guide.
• For the Profile Server, see the BroadWorks Profile Server Command Line Interface Administration
Guide.
• For the Service Control Function, see the BroadWorks Service Control Function Command Line
Interface Administration Guide.
• For the Sharing Server, see the BroadWorks Sharing Server Command Line Interface Administration
Guide.
• For the Video Server, see the BroadWorks Video Server Command Line Interface Administration
Guide.
• For the WebRTC Server, see the BroadWorks WebRTC Server Command Line Interface Administration
Guide.
• For the Xtended Services Platform, see the BroadWorks Xtended Services Platform Command Line
Interface Administration Guide.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 30
3 Document Conventions

This section describes the conventions used in this document to distinguish between different types of
information you enter.

3.1 Data You Enter

Data you enter appears in a different type font and in bold.
For example, enter:
bwcli
Commands and fixed data appear as they are entered. Variable data appears in angle brackets.
For example:
<password>
Optional data that you enter to apply an option for a command is enclosed in square brackets.
For example:
[profile]

3.2 Keys You Use

The ENTER key is represented in commands by the ↵ symbol. Press the ENTER key after each
command where the ↵ symbol appears.

3.3 BroadWorks Server Software Version

Before starting the CLI, you can show the software version of the BroadWorks server.
At the UNIX prompt, enter:
bwshowver↵
The system displays the BroadWorks server software version, build date, and other software version
information.

3.4 BroadWorks Server Messages

Messages from the server in response to commands, including error messages, are shown on separate
lines.
To start the CLI, enter:
bwcli ↵
The system responds with the following.

==============================================================
BroadWorks Command Line Interface
Type HELP for more information
==============================================================

For the purpose of this document, long system messages may be abbreviated using ellipses (...).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 31
4 BroadWorks Server System Conventions

This section describes the configuration and provisioning commands using a CLI specific to this server.
Each CLI has context-sensitive commands and dynamic contexts that are added to the CLI when data is
obtained from the BroadWorks server. Commands are extendable and reusable. Changes made through
the CLI are immediately applied to the server. The CLI also has general-purpose session commands
usable from any context or level (that is, help, exit, quit, read, write, tree, and config).

4.1 Start CLI

To start the CLI, enter:
bwcli ↵

==============================================================
BroadWorks Command Line Interface
Type HELP for more information
==============================================================
AS_CLI>

Server commands are entered after the AS_CLI> prompt.

4.2 Enter CLI Commands

The CLI commands have short and long versions. Commands are given by entering:
• The corresponding command number. For example, at the top level to go to the System level, type 0.
• The full command name. For example, to quit a level, type quit.
• The first letters of the command that identify the command uniquely. For example, to quit a level,
type q. If another command at that level begins with q, you type as many letters of quit that identify it
uniquely from the other command (for example, qu or qui or even quit).
Session commands are available at any level in their long version (quit) or in their short version (q or qu).

4.2.1 Enter 0 Digits or Characters

Use empty quotation marks ("") to enter 0 digits or characters as values in fields taking 0 or more digits or
characters.

4.2.2 Enter Uppercase and Lowercase Data

Enter data in a case sensitive format. Uppercase and lowercase characters are important, especially when
searching for data using the get command.

4.2.3 Enter SIP URL

Some SIP URLs contain semi-colons (;). To enter a semi-colon in a command string, precede the semi-
colon with a slash. For example: sip:5046938826@10.10.233.60/;user=phone SIP/2.0.

4.2.4 Help
Enter ?, or help, or h to display help. The commands available at that level appear.
To obtain information on a command, enter help followed by the command. For example:
help get ↵
or
? get ↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 32
 or
hg↵

4.3 Command Syntax

The CLI uses a command syntax that visually represents the required and optional values. For example,
the following appears when you request help for the add new Admin User command:
help add ↵

This command is used to add a new Administrator in the system.

A system or provisioning administrator may be added
======================================================================
add
<userId>, String {2 to 80 characters}
<type>, Choice = {system, prov}
<readOnly>, Choice = {false, true}
[<attribute>, Multiple Choice = {lastName, firstName, language}]
<lastName>, String {1 to 30 characters}
<firstName>, String {1 to 30 characters}
<language>, String {1 to 40 characters}

The first line provides a description of the command. Subsequent lines provide the command syntax. In
this example, the add command requires the following values <userID>, <type> and <readOnly>. The
<attribute> value is optional (indicated by the square brackets [ ]), but if used, it has three possible values
indicated by the indent: <firstName>, <lastName> and <language>.

4.3.1 Entering Commands

The CLI can assist you completing commands. The CLI provides the command completion if you type "?".
The parameters available at that point display, as well as any currently defined values.
To obtain information on how to complete a command:
• Enter the command at any point followed by "?". For example:
add Carrier1 ? ↵

<CAC>, Number {4 to 4 digits}

Currently defined CAC = {1234, 5372, 6677}
add Carrier1

• Enter the subsequent parameter(s).

2000 yes yes yes ↵
If you do not know all the required parameters, you can continue entering one parameter at a time,
followed by a question mark, until you complete the command.

4.3.2 Shortcuts
You can navigate and edit in the CLI with the same shortcuts used in a bash command line.
Table 10: Navigational Shortcuts
Task Shortcut

To move the cursor to the left: Use the left arrow or Ctrl-b.

To move the cursor to the left: Use the right arrow or Ctrl-f.

To navigate backward in the command history: Use the up arrow or Ctrl-p.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 33
 Task Shortcut

To navigate forward in the command history: Use the down arrow or Ctrl-n.

To move the cursor to the beginning of a line: Use the Home key or Ctrl-a.

To move the cursor to the end of a line: Use the End key or Ctrl-e.

To move the cursor one word forward: Press Alt-f.

To move the cursor one word backward Press Alt-b.

Table 11: Editing Shortcuts

Task Shortcut

To complete a command: Press the Tab key. If the command is ambiguous, it will show
all possible options. The completion will be done for commands,
parameters, and aliases.

To clear the line before the position of the cursor: Press Ctrl-u.

To clear the line after the position of the cursor: Press Ctrl-k.

To delete from the cursor to the start of the first word on its left Press Ctrl-w.
side:

To erase the character before the cursor: Press the Backspace key.

To erase the character at the cursor's position: Press the Delete key.

4.4 Log In
To access the CLI:
Enter:
login <userid on BroadWorks> ↵
where:
Variable Field Type Valid Values Description

<userid on BroadWorks> String to characters and ! # $ The user ID for the

%&+-/=?_{|}.~@ administrator or end user.

At the Password prompt, enter the assigned password. For security purposes, the password does not
appear when you type it. For example:

login admin
Password:
Application Server Administrator logging in...

The administrator's name appears when logging in.

To use the commands, you must log in. There is no limit to the number of CLI sessions that can run at the
same time.

4.5 Menu System

This section describes how to navigate through the CLI menu system.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 34
4.5.1 Hierarchical Tree Structure
The CLI menu system is hierarchical, with menus and submenus. The tree command allows you to see
the menus system hierarchy, including available commands.
To see the complete tree structure for the CLI levels only, from the top level enter:
tree -r ↵
Entering this command at other levels shows the hierarchy from that level down.
The available commands at any level can also be viewed using the tree command. To see the complete
tree structure for the CLI including available commands, from the top level enter:
tree -r -f ↵
Entering this command at another level shows the hierarchy, including available commands (in square
brackets [ ]), from that level down.

4.5.2 Change Levels

To change to a lower level, type the level name, abbreviation, or the corresponding number. For example,
to change to the system level from the top level, enter:
system ↵
or
s↵
or
0↵
To go directly to a level, type each of the level names making up the level path separated by a semi-colon
(;). For example, to go directly to the System/Device/Media> level from the top level, enter:
system;device;media ↵
The abbreviated form of each level name can also be used. The abbreviated form must uniquely identify
it from other commands at that level. For example, to go directly to the System/Device/Media> level
from the top level using abbreviations, enter:
s;d;m ↵
To return to a previous level, type q or quit.
To return directly to the top level, type q all or quit all.

4.6 Read Files

The CLI commands can be executed from a file. The format of commands in a file are the same as when
they are used the CLI. The following is an example of a small command file:

system;device;hostingne
get

The absolute file path for the read file is used. If no file path is provided, the default directory is assumed
to be the directory from which the CLI was invoked.
To execute CLI commands from a file, at any level prompt, enter:
read <file name> [<pwProtOff>] [<stepByStep>] [<userEmulation>] ↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 35
 Variable Type Valid Values Description

<file name> String 1 to 300 characters The name of the file containing
the CLI commands. The
absolute path can be provided.

<pwProtOff> String pwProtOff Lets you turn off password

protection and enter
passwords in the read file and
have the CLI accept those
passwords.

<stepByStep> String stepByStep Lets you turn on the operator

step-by-step confirmation
mode.

<user Emulation> String userEmulation Lets you view the commands

that are executed instead of
only the results.

The commands in the file will execute. Results and any messages appear on the CLI.
Examples:

read /usr/local/broadworks/comfiles/file1.txt

or

read /usr/local/broadworks/comfiles/file1.txt pwProtOff

4.7 Write Output to a File

The output from CLI commands can be redirected to a file. The absolute file path for the write file is used.
If no file path is provided, the default directory is assumed to be the directory from which the CLI was
invoked. When writing output to a file, output is no longer directed to the screen.
Output can be started and stopped using this command.
You can start writing output to a file at any time.
At any level prompt, enter:
write <action> <file name> ↵
where:
Variable Type Valid Values Description

<action> Choice start Starts output to the specified

file.

<file name> String 1 to 300 characters The name of the file to

which output should be
redirected. The absolute path
can be provided.

Example:

write start /usr/local/broadworks/outfiles/output.txt

You can stop writing output to a file at any time.
At any level prompt, enter:
write stop

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 36
4.8 Configure CLI
The CLI can be configured in the following ways:
• The Yes/No prompt - when the Yes/No prompt is set to true, you will be prompted to respond Yes/
No during various commands. For example, you will be asked whether you want to display multiple
records. Setting the Yes/No prompt to "false", displays all records found without asking.
• The Continue prompt - when the Continue prompt is set to "true", you will be prompted whether to
continue during various commands. For example, you will be asked whether you want to continue
displaying the next screen of data. Setting the Continue prompt to "false", displays all data found
without pausing.
• Command Completion - when Command Completion is set to "true", you will be automatically prompted
for the next value when the command being entered is incomplete. When Command Completion is set
to "false", you will not be prompted for the next value.
• Script Echoing - when Script Echoing is set to "true", the names of any scripts called by a command will
be displayed when they are run. When Script Echoing is set to "false", you will not see the names of
scripts as they are being run.
• You can view the current settings for these CLI features at any time.
At any level prompt, enter:
config get ↵
Example:

config get
yesNoPromptEnabled = true
continuePromptEnabled = true
alwaysCommandCompletion = false
scriptEchoingEnabled = false
displayErrorDetail = false
alwaysDeleteConfirmation = false

To change the settings for these CLI features:

At any level prompt, enter:
config set <attribute> ↵
where:
Variable Type Valid Values Description

<attribute> MultipleChoice yesNoPromptEnabled,

continuePromptEnabled,
alwaysCommandCompletion,
scriptEchoingEnabled,
displayErrorDetail,
alwaysDeleteConfirmation

<yesNoPromptEnabled> Choice true, false When the Yes/No prompt is

set to "true", you are prompted
to respond Yes or No during
various commands. For
example, you are asked
whether you want to display
multiple records. Setting the
Yes/No prompt to "false",
displays all records found
without asking.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 37
 Variable Type Valid Values Description

<continuePromptEnabled> Choice true, false When the Continue prompt is

set to "true", you are prompted
to continue during various
commands. For example, you
are asked whether you want
to continue displaying the next
screen of data. Setting the
Continue prompt to "false",
displays all data found without
pausing.

<alwaysCommandCompletion> Choice true, false When Command Completion

is set to "true", you are
prompted for the next value
when the command being
entered is incomplete. When
Command Completion is set to
"false", you are not prompted
for the next value.

<scriptEchoingEnabled> Choice true, false When Script Echoing is set

to "true", the names of any
scripts called by a command
are displayed when they are
run. When Script Echoing is
set to "false", you do not see
the names of scripts as they
run.

<displayErrorDetail> Choice true, false When the Display Error

Details is set to "true", detailed
error message provided on
supported CLI command.
When the Display Error Details
is set to "false", detailed error
messages are disabled.

<alwaysDeleteConfirmation> Choice true, false When the Always Delete

Confirmation is set to "true",
confirmation not required
upon command completion.
When the Always Delete
Confirmation is set to "false",
confirmation required upon
command completion.

Example:

config set yesNoPromptEnabled false

4.9 CLI Commands History

The history command prints out (on 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.
To view the CLI command history, enter:
history ↵
To re-execute a CLI command from the history, enter:
!<cmdId> ↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 38
 Variable Type Valid Values Description

<CmdId> Integer 1 through 32767 A valid command ID read from

the CLI history.

To re-execute the previous command, enter:

!! ↵
To configure CLI command history, enter:
history <size> ↵
where:
Variable Type Valid Values Description

<Size> Integer 10 through 1000 The new history size.

4.10 CLI Command Alias

An alias is a command that contains one or more CLI commands separated by "\;". An alias command
runs as if the commands it contains were run sequentially. Parameters typed after the alias command,
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.
To view the list of aliases currently defined in a CLI session, enter:
alias ↵
To execute an alias, enter:
<aliasName> ↵
where:
Variable Type Valid Values Description

<aliasName> String 1 to 80 characters The name of an alias.

To see a detailed view of an alias currently defined in a CLI session, enter:

alias <aliasName> ↵
where:
Variable Type Valid Values Description

<aliasName> String 1 to 80 characters The name of an alias.

To add an alias to a CLI session, enter:

alias <aliasName> <result> [<attribute>] ↵
Aliases created at the CLI are not persisted. To have persisted CLI Alias, one can either capture CLI alias
in a CLI read file or modify the CLI alias bwcli_aliases.txt file under /usr/local/broadworks/bw_base/conf.
Note that this file is not persisted during a software upgrade.
where:
Variable Type Valid Values Description

<aliasName> String 1 to 80 characters The name of a new alias.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 39
 Variable Type Valid Values Description

<result> String 0 to 256 characters The string of commands to

be executed by the alias,
enclosed in quotes if it
contains any spaces.

<stayInContext> Choice true, false Upon completion, the CLI

session resumes at the
level it was when the alias
command was typed, unless
"stayInContext" is specified set
to "false".

<description> String 0 to 80 characters The description of the CLI

command alias.

Example:

alias getNetServ "q all\;System\;Device\;NetServ\;get"

stayInContext false

To delete an alias, enter:

alias <aliasName> "" ↵
where:
Variable Type Valid Values Description

<aliasName> String 1 to 80 characters The name of an alias.

4.11 Exit CLI

You can exit the CLI at any time.
At any CLI prompt, enter:
exit ↵

Please confirm (Yes, Y, No, N):

Then enter:
y↵

This session is now ending...

4.12 Procedural Steps

Usually the commands available for a BroadWorks server are performed according to the following
procedure:
• Start the CLI. To access the full range of CLI commands, you must first log in. When you have finished
using it, use the exit command.
• Configure basic elements of the server.
Basic configuration is provided when the server is installed. However, from time to time this basic
configuration may require changing. Basic information includes information such as addresses of
associated other BroadWorks network elements, system administration tasks, licensing, routing and
treatments, configuration of emergency numbers, and tracking of long duration call accounting events.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 40
 • Configure interfaces.
Basic configuration of interfaces used by the server is provided when the server is installed. However,
from time to time this basic configuration may require changing.
• Manage the applications.
In order to manage the applications, information management is necessary. It is the administrator's
responsibility to enter and maintain information such as groups, group members, and group
administrators.
• Maintain the server.
The day-to-day operations of the BroadWorks server are monitored through alarms, performance
measurements, and shutdown and restart procedures.
• Read and write command files.
The BroadWorks server CLI commands can be read from a file. Output from the CLI can be directed to
a file.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 41
COMMAND LINE INTERFACE
ADMINISTRATION

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 42
5 ASDiagnostic

This level is used to perform diagnostics tasks on the Application Server.

5.1 DNS
This level is used to view, reload, and clear entries from BroadWorks DNS client cache.

5.1.1 clearAllCache
This command is used to clear all entries from the BroadWorks DNS client cache.
1) Ensure you are at the /AS_CLI/ASDiagnostic/DNS> level.
2) Enter:
clearAllCache↵

5.1.2 clearCache
This command is used to clear an individual entry from the BroadWorks DNS client cache. If recordType is
not specified, "A" is assumed.
1) Ensure you are at the /AS_CLI/ASDiagnostic/DNS> level.
2) Enter:
clearCache <netAddress> [<recordType>]↵
where:
Variable Field Type Valid Values Description

<netAddress> String 1 to 80 characters The networks address identifying

the entry in the DNS cache to be
cleared.

<recordType> String 1 to 10 characters The type of record to be cleared.

The supported types include:
NAPTR (Naming Authority
Pointer), SRV (Service), A (IPv4
address), and PTR (pointer), with
A being the default.

5.1.3 lookup
This command is used to perform a domain name lookup using the BroadWorks DNS client. If recordType
is not specified, "A" is assumed. The Application Server either searches the local cache or queries the
DNS server.
1) Ensure you are at the /AS_CLI/ASDiagnostic/DNS> level.
2) Enter:
lookup <netAddress> [<recordType>]↵
where:
Variable Field Type Valid Values Description

<netAddress> String 1 to 80 characters The network address to be looked

up.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 43
 Variable Field Type Valid Values Description

<recordType> String 1 to 10 characters The type of record to be looked

up. The supported types include:
NAPTR (Naming Authority
Pointer), SRV (Service), A (IPv4
address), and PTR (pointer), with
A being the default.

5.1.4 reload
This command is used to dynamically reload static entries into the BroadWorks DNS client.
1) Ensure you are at the /AS_CLI/ASDiagnostic/DNS> level.
2) Enter:
reload↵

5.2 Diag
This level is used to manage sessions associated with DNs/users or devices.

5.2.1 audit
The audit command is used to audit a particular session.
1) Ensure you are at the /AS_CLI/ASDiagnostic/Diag> level.
2) Enter:
audit <sessionKey>↵
where:
Variable Field Type Valid Values Description

<sessionKey> String 1 to 1023 characters The session key.

5.2.2 auditAll
The auditAll command is used to audit all sessions associated with a given DN/user or device.
1) Ensure you are at the /AS_CLI/ASDiagnostic/Diag> level.
2) Enter:
auditAll <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> Choice userId, phone, deviceAddress, Audit command filtering criteria.

groupDeviceName, service
ProviderDeviceName, system
DeviceName

<userId> String 2 to 161 characters The userId command followed by

the authentication user ID name
of a subscriber to monitor.

<phone> String 0 to 17 characters The phone number command,

followed by the directory number
of the subscriber to monitor.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 44
 Variable Field Type Valid Values Description

<device String 1 to 80 characters The IP address, host name, or

Address> domain name.

Variable: groupDeviceName

groupDeviceName The name of the group device.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The ID of the group.

<deviceName> String 1 to 40 characters The name of the device.

Variable: serviceProviderDeviceName

serviceProviderDeviceName The name of the service provider

device.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device.

Variable: systemDeviceName

systemDeviceName The name of the system device.

<deviceName> String 1 to 40 characters The name of the device.

5.2.3 dump
The dump command is used to dump the details of a particular session, or all sessions for a given DN or
userID, or all sessions on a device by using the address or name of the device.
1) Ensure you are at the /AS_CLI/ASDiagnostic/Diag> level.
2) Enter:
dump <attribute> [<option>]↵
where:
Variable Field Type Valid Values Description

<attribute> Choice userId, phone, sessionKey, trunk Dump command filtering criteria.
Group, deviceAddress, group
DeviceName, serviceProvider
DeviceName, systemDevice
Name

<userId> String 2 to 161 characters The userId command followed by

the authentication user ID name
of a subscriber to monitor.

<phone> String 0 to 17 characters The phone number command,

followed by the directory number
of the subscriber to monitor.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 45
 Variable Field Type Valid Values Description

<sessionKey> String 1 to 1023 characters Unique session identifier. See the

following example for details.

Variable: trunkGroup

trunkGroup The trunk group command,

followed by the trunk group name.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The ID of the group.

<trunkGroup String 1 to 30 characters The unique name of a trunk

Name> group.

Variable: deviceAddress

deviceAddress Signifies the address of the

device.

<ipAddress> String 1 to 80 characters The IP address, host name, or

domain name.

<port> Integer 1025 through 65535 The port number (optional).

Variable: groupDeviceName

groupDeviceName The name of the group device.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The ID of the group.

<deviceName> String 1 to 40 characters The name of the device.

Variable: serviceProviderDeviceName

serviceProviderDeviceName The name of the service provider

device.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device.

Variable: systemDeviceName

systemDeviceName The name of the system device.

<deviceName> String 1 to 40 characters The name of the device.

<option> Choice servicesBrief, services, services Additional dump options.

Events

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 46
5.2.4 heap
The heap command is used to view data associated with the Java Heap.
1) Ensure you are at the /AS_CLI/ASDiagnostic/Diag> level.
2) Enter:
heap <mainOption>↵
where:
Variable Field Type Valid Values Description

<mainOption> Choice gc, show, dump Specifies how much information

is shown.

5.2.5 kill
The kill command is used to kill a particular session.
1) Ensure you are at the /AS_CLI/ASDiagnostic/Diag> level.
2) Enter:
kill <sessionKey>↵
where:
Variable Field Type Valid Values Description

<sessionKey> String 1 to 1023 characters The session to be killed.

5.2.6 killAll
The command is used to kill all sessions associated with a given DN/user or device. Consider using
release instead of the kill all command.
1) Ensure you are at the /AS_CLI/ASDiagnostic/Diag> level.
2) Enter:
killAll <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> Choice userId, phone, deviceAddress, Kill session command filtering

groupDeviceName, service criteria.
ProviderDeviceName, system
DeviceName

<userId> String 2 to 161 characters The user ID.

<phone> String 0 to 17 characters The phone number command,

followed by the directory number
of the subscriber to monitor.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 47
 Variable Field Type Valid Values Description

Variable: deviceAddress

deviceAddress Signifies the address of the

device.

<ipAddress> String 1 to 80 characters The IP address, host name, or

domain name.

<port> Integer 1025 through 65535 The port number (optional).

Variable: groupDeviceName

groupDeviceName The name of the group device.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The ID of the group.

<deviceName> String 1 to 40 characters The name of the device.

Variable: serviceProviderDeviceName

serviceProviderDeviceName The name of the service provider

device.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device.

Variable: systemDeviceName

systemDeviceName The name of the system device.

<deviceName> String 1 to 40 characters The name of the device.

5.2.7 list
The list command is used to view all the sessions associated with the given service provider,
group, DN, userId or device; or simply all the sessions of the server when used without arguments.
All sessions on an access device can also be listed by entering the "Tag" groupDeviceName
followed by the serviceProviderId, groupId, and access device name. Or by entering the "Tag"
serviceProviderDeviceName followed by the serviceProviderId and access device name. Or by entering
the "Tag" systemDeviceName followed by the access device name. Another way to show all the session of
an Access Device is by entering the deviceAddress of the Access Device.
1) Ensure you are at the /AS_CLI/ASDiagnostic/Diag> level.
2) Enter:
list [<attribute>] [<option>] [<option>]↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 48
 Variable Field Type Valid Values Description

<attribute> Choice userId, phone, groupId, svc List command filtering criteria.
ProviderId, deviceAddress, group
DeviceName, serviceProvider
DeviceName, systemDevice
Name

<userId> String 2 to 161 characters The user ID.

<phone> String 0 to 17 characters The phone number command,

followed by the directory number
of the subscriber to monitor.

<groupId> String 1 to 30 characters The ID of the group.

<option> Choice all Denotes all the sessions for the

service provider.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<option> Choice all Denotes all the sessions for the

service provider.

Variable: deviceAddress

deviceAddress Signifies the address of the

device.

<ipAddress> String 1 to 80 characters The IP address, host name, or

domain name.

<port> Integer 1025 through 65535 The port number (optional).

Variable: groupDeviceName

groupDeviceName The name of the group device.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The ID of the group.

<deviceName> String 1 to 40 characters The name of the device.

Variable: serviceProviderDeviceName

serviceProviderDeviceName The name of the service provider

device.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 49
 Variable Field Type Valid Values Description

Variable: systemDeviceName

systemDeviceName The name of the system device.

<deviceName> String 1 to 40 characters The name of the device.

5.2.8 pingDevice
The pingDevice command is used to perform an application layer ping using a user ID, phone, host, or
device name.
1) Ensure you are at the /AS_CLI/ASDiagnostic/Diag> level.
2) Enter:
pingDevice <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> Choice userId, phone, deviceAddress, The port number (optional).

groupDeviceName, service
ProviderDeviceName, system
DeviceName

<userId> String 2 to 161 characters The user ID.

<phone> String 0 to 17 characters The phone number command,

followed by the directory number
of the subscriber to monitor.

Variable: deviceAddress

deviceAddress Signifies the address of the

device.

<ipAddress> String 1 to 80 characters The IP address, host name, or

domain name.

<attribute> MultipleChoice port, transportType The port number (optional).

<port> Integer 1025 through 65535 Device listening port.

<transport Choice udp, tcp, unspecified The type of transport used.

Type>

Variable: groupDeviceName

groupDeviceName The name of the group device.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The ID of the group.

<deviceName> String 1 to 40 characters The name of the device.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 50
 Variable Field Type Valid Values Description

Variable: serviceProviderDeviceName

serviceProviderDeviceName The name of the service provider

device.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device.

Variable: systemDeviceName

systemDeviceName The name of the system device.

<deviceName> String 1 to 40 characters The name of the device.

5.2.9 release
The release command is used to release a particular call. Use this command instead of the kill or killAll
commands whenever possible. The call ID's format is "SessionKey:n" where n is a number.
1) Ensure you are at the /AS_CLI/ASDiagnostic/Diag> level.
2) Enter:
release <callId>↵
where:
Variable Field Type Valid Values Description

<callId> String 1 to 1023 characters The ID of the call to release.

5.2.10 vtr
The vtr command is used to perform a test call and see the routing results. Please be careful when
performing test calls, it may have an impact on existing real calls or cause user migration.
1) Ensure you are at the /AS_CLI/ASDiagnostic/Diag> level.
2) Enter:
vtr <origType> <destination> [<option>]↵
where:
Variable Field Type Valid Values Description

<origType> Choice linePort, bwphone, pstnphone, The type of origination used to

userId, url trigger the VTR request.

<linePort> String 1 to 80 characters The lineport of the originating

user.

<bwphone> String 1 to 17 characters The originating BroadWorks user

phone number.

<pstnphone> String 1 to 17 characters The originating PSTN user phone

number.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 51
 Variable Field Type Valid Values Description

<userId> String 2 to 161 characters The originating BroadWorks user

Id.

<url> String 2 to 161 characters The originating url.

<destination> String 1 to 161 characters The called user, number or URI.

<option> MultipleChoice contact, diversion Additional vtr options.

<contact> String 1 to 80 characters The contact URL to use for the

test call.

<diversion> String 1 to 80 characters The diversion URL to use for the

test call.

5.2.11 vtri
The vtri command is used to perform a test call and see the routing results. a SIP INVITE is used to trigger
the process. Please be careful when performing test calls, it may have an impact on existing real calls or
cause user migration.
1) Ensure you are at the /AS_CLI/ASDiagnostic/Diag> level.
2) Enter:
vtri↵

5.3 Diameter
This level exposes Diameter-related tools that allow
* Viewing complete Peer and Realm Routing Tables, including dynamic entries
* Deleting Peer and Realm Routing Tables dynamic entries
* Viewing extensive peer connection states
* Test routing

5.3.1 fetchRoutes
This command is used to troubleshoot the Diameter routing configuration according to the current Peer
Table/Realm Routing Table configuration and application. This command displays the potential next hop(s)
and final destination of an ACR (given a CCF), a CCR (given an OCS) or a Sh request. Only reachable
next hops are displayed. Warning: using this command might cause the stack to create dynamic Peer and/
or Realm Routing Table entries.
1) Ensure you are at the /AS_CLI/ASDiagnostic/Diameter> level.
2) Enter:
fetchRoutes <instance> <applicationId>↵
where:
Variable Field Type Valid Values Description

<instance> Choice xs, ps The process for which the routing

configuration is fetched.

<applicationId> Choice Rf, Ro, Sh The application for which the

routing configuration is fetched.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 52
 Variable Field Type Valid Values Description

Variable: Rf

Rf Fetch routes for the Rf

applicationId.

<ccf> String 1 to 1024 characters A CCF, as it would be received in

P-CFA header.

<realm> Domain/Host 1 to 80 characters Realm name.

Variable: Ro

Ro Fetch routes for the Ro

applicationId.

<ocs> String 1 to 1024 characters An OCS, as it would be received

in P-CFA header.

<realm> Domain/Host 1 to 80 characters Realm name.

Variable: Sh

Sh Fetch routes for the Sh

applicationId.

<realm> Domain/Host 1 to 80 characters Realm name.

5.3.2 Peers
This level is used to view and delete entries from the Peer Table.

5.3.2.1 get
This command is used to display live Peer Table information. Both static and dynamic entries are displayed
along with connection status.
1) Ensure you are at the /AS_CLI/ASDiagnostic/Diameter/Peers> level.
2) Enter:
get↵

5.3.2.2 delete
This command is used to delete a dynamic Peer Table entry.
1) Ensure you are at the /AS_CLI/ASDiagnostic/Diameter/Peers> level.
2) Enter:
delete <instance> <id>↵
where:
Variable Field Type Valid Values Description

<instance> Choice xs, ps, internalXs The process for which the
Peer Table live information is
displayed.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 53
 Variable Field Type Valid Values Description

<id> Long 1 through 9223372036854775807 The internal id of the peer, as

displayed in the "Id" column from
the "get" command.

5.3.3 Realms
This level is used to view and delete entries from the Realm Routing Table.

5.3.3.1 get
This command is used to display live Realm Routing information. Both static and dynamic entries are
displayed.
1) Ensure you are at the /AS_CLI/ASDiagnostic/Diameter/Realms> level.
2) Enter:
get↵

5.3.3.2 delete
This command is used to delete a dynamic Realm Routing Table entry along with all associated Routing
Peers. Static Realm Routing Table entries are deleted using the delete command under the AS_CLI/
Interface/Diameter/Realms context.
1) Ensure you are at the /AS_CLI/ASDiagnostic/Diameter/Realms> level.
2) Enter:
delete <instance> <id>↵
where:
Variable Field Type Valid Values Description

<instance> Choice xs, ps, internalXs The process for which the Realm
Routing Table entry will be
deleted.

<id> Long 1 through 9223372036854775807 The internal id of the realm, as

displayed in the "Id" column from
the "get" command.

5.3.3.3 RoutingPeers
This level is used to view Peers associated to a Realm Routing Table entry.
5.3.3.3.1 get
This command is used to display all Routing Peers associated to either a static or dynamic Realm Routing
Table entry. For dynamic Realm Routing Table entries, the priority and weight were obtained from a DNS
SRV lookup.
1) Ensure you are at the /AS_CLI/ASDiagnostic/Diameter/Realms/RoutingPeers> level.
2) Enter:
get↵

5.4 OverloadControls
This level is used to manage overload control-related attributes.

5.4.1 CallpUtil
This level is used to manage the call processing (CallP) overload related attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 54
5.4.1.1 get
This command is used to view the current overload zone value for CallP.
1) Ensure you are at the /AS_CLI/ASDiagnostic/OverloadControls/CallpUtil> level.
2) Enter:
get↵

5.4.1.2 set
This command is used to manually set the current overload zone for CallP.
1) Ensure you are at the /AS_CLI/ASDiagnostic/OverloadControls/CallpUtil> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice currentZone The name of an attribute to

modify.

<currentZone> Choice green, yellow, red The current overload zone for call
processing.

5.4.1.3 clear
This command is used to clear the callP queues.
1) Ensure you are at the /AS_CLI/ASDiagnostic/OverloadControls/CallpUtil> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice queues The name of the attribute(s) to

clear.

5.4.2 Neighbors
This level is used to view Neighbor entries.

5.4.2.1 get
This command is used to view a neighbor list sorted by traffic rate.
1) Ensure you are at the /AS_CLI/ASDiagnostic/OverloadControls/Neighbors> level.
2) Enter:
get [<count>]↵
where:
Variable Field Type Valid Values Description

<count> Integer 1 through 2000 The maximum number of

neighbors to display.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 55
5.4.2.2 detail
This command is used to get traffic, state and capability information for a given neighbor.
1) Ensure you are at the /AS_CLI/ASDiagnostic/OverloadControls/Neighbors> level.
2) Enter:
detail <ipAddress>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters The neighbor IP address.

5.4.3 NonCallpUtil
This level is used to manage the non-call processing overload related attributes.

5.4.3.1 get
This command is used to view the current overload zone value for NonCallP.
1) Ensure you are at the /AS_CLI/ASDiagnostic/OverloadControls/NonCallpUtil> level.
2) Enter:
get↵

5.4.3.2 set
This command is used to manually set the current overload zone for NonCallP.
1) Ensure you are at the /AS_CLI/ASDiagnostic/OverloadControls/NonCallpUtil> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice currentZone The name of an attribute to

modify.

<currentZone> Choice green, yellow, red The current overload zone for
non-call processing.

5.4.3.3 clear
This command is used to clear the NonCallP queues.
1) Ensure you are at the /AS_CLI/ASDiagnostic/OverloadControls/NonCallpUtil> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice queues The name of the attribute(s) to

clear.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 56
5.5 QueueStats
This level is used to view and modify Queues statistics. Queues statistical data show information about the
Application Server's internal system queues. Queue statistics are intended for gathering performance data
for testing and troubleshooting.

5.5.1 get
This command is used to get the internal queues statistics.
1) Ensure you are at the /AS_CLI/ASDiagnostic/QueueStats> level.
2) Enter:
get↵

5.5.2 set
This command is used to configure the internal queues statistics.
1) Ensure you are at the /AS_CLI/ASDiagnostic/QueueStats> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice sampleIntervalSeconds, counts The name of an attribute to

modify.

<sampleInterval Integer 60 through 6000 Sets sampling interval to

Seconds> specified period in seconds.
Information is output to the debug
log (if logging is enabled).

<counts> Choice reset, sampleOff When set to "reset", resets the

queue statistics data to zero.
When set to "sampleOff", turns off
sampling (if samplingInterval is
set).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 57
6 System

This level is used to configure and report on information related to routing and translations, devices
accessed by the Application Server, call processing, emergency numbers, long duration call accounting
events, digit collection, network progression, queue statistics, routing and treatments, session audits, and
device inventory.

6.1 ASClusterName
This level is used to view and modify the AS Cluster Name.

6.1.1 get
This command is used to view AS Cluster Name attributes.
1) Ensure you are at the /AS_CLI/System/ASClusterName> level.
2) Enter:
get↵

6.1.2 set
This command is used to modify AS Cluster Name-related attributes.
1) Ensure you are at the /AS_CLI/System/ASClusterName> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice name The name of an attribute to

modify.

<name> String 1 to 40 characters The name of the AS cluster

to keep the directory/file in file
repository unique in a multi-
cluster setting.

6.1.3 clear
This command is used to clear AS Cluster Name-related attributes.
1) Ensure you are at the /AS_CLI/System/ASClusterName> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice name The name of an attribute to clear.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 58
6.2 ActivatableFeature
NOTE: The ActivatableFeature functionality and the list of activatable features have been removed
from the system. This level is not used since the list of activatable features is empty. The level and its
commands have been kept for possible future use.

6.2.1 get
This command displays a list of all activatable features and their status.
1) Ensure you are at the /AS_CLI/System/ActivatableFeature> level.
2) Enter:
get↵

6.2.2 detail
This command displays the details of an activatable feature. Included are a list of interfaces changed, a
table (dependency) of EV IDs that the activatable feature is dependent on, and a table (dependent) of EV
IDs that are dependent on the activatable feature.
1) Ensure you are at the /AS_CLI/System/ActivatableFeature> level.
2) Enter:
detail <id>↵
where:
Variable Field Type Valid Values Description

<id> String 5 to 10 characters The activatable feature's ID.

6.2.3 activate
This command allows you to activate a specific feature.
1) Ensure you are at the /AS_CLI/System/ActivatableFeature> level.
2) Enter:
activate <id>↵
where:
Variable Field Type Valid Values Description

<id> String 5 to 10 characters The activatable feature's ID.

6.2.4 deactivate
This command allows you to deactivate a specific feature.
1) Ensure you are at the /AS_CLI/System/ActivatableFeature> level.
2) Enter:
deactivate <id>↵
where:
Variable Field Type Valid Values Description

<id> String 5 to 10 characters The activatable feature's ID.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 59
6.3 Alias
The BroadSoft Application Server identifies itself by multiple network addresses. The alias feature allows
a system administrator to configure these Internet IP addresses and aliases for the Application Server.
These addresses are used during call processing to determine if an incoming address matches one of the
server aliases. For example, a SIP REGISTER message or INVITE message contains IP addresses or
host names that must be looked up to determine if the address is one of the Application Server aliases.

6.3.1 get
This command is used to view a list of all the configured Application Server aliases in alphabetical order.
1) Ensure you are at the /AS_CLI/System/Alias> level.
2) Enter:
get↵

6.3.2 add
This command is used to add a new IP address or host name to the list of Application Server aliases.
1) Ensure you are at the /AS_CLI/System/Alias> level.
2) Enter:
add <ipAddress>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The alternative Internet address

of the Application Server.

6.3.3 delete
This command is used to delete a previously configured Application Server alias.
1) Ensure you are at the /AS_CLI/System/Alias> level.
2) Enter:
delete <ipAddress>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The alternative Internet address

of the Application Server.

6.4 ApplicationServerId
This level is used to view and modify the Application Server Id.

6.4.1 get
This command is used to view Application Server Id related attributes.
1) Ensure you are at the /AS_CLI/System/ApplicationServerId> level.
2) Enter:
get↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 60
6.4.2 set
This command is used to modify Application Server Id related attributes.
1) Ensure you are at the /AS_CLI/System/ApplicationServerId> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice id The name of an attribute to

modify.

<id> String 1 to 80 characters The id used to uniquely identify

this application server cluster. It
is recommended to use the host
NE name on the network server
for this cluster.

6.5 CallP
This level is used to view, add, modify, or delete information related to call processing.

6.5.1 AccessRouting
This level is used to view and modify call processing attributes of access devices.

6.5.1.1 get
This command is used to view the attributes related to call routing on the access-side.
1) Ensure you are at the /AS_CLI/System/CallP/AccessRouting> level.
2) Enter:
get↵

6.5.1.2 set
This command is used to modify the attributes related to call routing on the access-side.
1) Ensure you are at the /AS_CLI/System/CallP/AccessRouting> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice terminationAttemptTimeout The name of an attribute to

Seconds, terminationAttempt modify.
TimeoutActive, accessRoute
AdvanceTimeoutSeconds, cancel
AccessRouteAdvanceTimer
On100

<termination Integer 1 through 15 This parameter specifies the

AttemptTimeout time (in seconds) before the
Seconds> termination attempt to an access
device times out.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 61
 Variable Field Type Valid Values Description

<termination Choice true, false This parameter controls when

AttemptTimeout the termination attempt times
Active> out. When set to "false", the
termination attempt to an
unresponsive access device
times out according to the timer
of underlying protocol, Session
Initiation Protocol (SIP) / Media
Gateway Control Protocol
(MGCP). When set to "true",
the termination attempt to an
unresponsive access device
times out according to the value
indicated by the termination
attempt timeout seconds variable.

<accessRoute Integer 1 through 15 This parameter determines when

Advance the Access Routing service
Timeout advances to the next static
Seconds> contact in the static contact list.
This parameter is not used in the
IMS deployment.

<cancelAccess Choice true, false This parameter determines if

RouteAdvance the access route advance timer
TimerOn100> stops upon receiving a 100 Trying
response. When set to "false",
access route advance timer does
not stop upon receiving a 100
Trying response. When set to
"true", access route advance
timer stops upon receiving a 100
Trying response.

6.5.2 CallCorrelation
This level is used to view and modify Call Correlation Identifier attributes.

6.5.2.1 get
This command is used to view attributes of the Call Correlation Identifier.
1) Ensure you are at the /AS_CLI/System/CallP/CallCorrelation> level.
2) Enter:
get↵

6.5.2.2 set
This command is used to modify attributes for the Call Correlation Identifier.
1) Ensure you are at the /AS_CLI/System/CallP/CallCorrelation> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 62
 Variable Field Type Valid Values Description

<attribute> MultipleChoice callCorrelationIDFormat The name of an attribute to

modify.

<call Choice clusterUnique, networkUnique When set to clusterUnique,

CorrelationID the Call Correlation Identifier
Format> is guaranteed unique within
the AS cluster. When set
to networkUnique, the Call
Correlation Identifier is
guaranteed unique within the
network.

6.5.3 CallTypes
This level is used to configure various system call types, such as long distance. Most call types are
configured on the Network Server.

6.5.3.1 get
This command is used to view call types and their attributes.
1) Ensure you are at the /AS_CLI/System/CallP/CallTypes> level.
2) Enter:
get [<countryCode>]↵
where:
Variable Field Type Valid Values Description

<countryCode> Integer 1 through 999 The country code number; must

be a valid defined system country
code.

6.5.3.2 add
This command allows you to add a new call type digit mapping for the specified country code.
1) Ensure you are at the /AS_CLI/System/CallP/CallTypes> level.
2) Enter:
add <countryCode> <publicDigitMap> <callType>↵
where:
Variable Field Type Valid Values Description

<countryCode> Integer 1 through 999 The country code number; must

be a valid defined system country
code.

<publicDigit String 1 to 30 characters 1 to 30 digit pattern containing

Map> digits, 'x', '.', or "#' ('x' = single
digit wildcard, '.' = multiple digit
wildcard, '#' = # key). The '.' can
only be the last character in the
map.

<callType> String 1 to 40 characters The call type.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 63
6.5.3.3 delete
This command allows you to remove the mapping of the specified digitMap to a call type for the specified
country code.
1) Ensure you are at the /AS_CLI/System/CallP/CallTypes> level.
2) Enter:
delete <countryCode> <publicDigitMap>↵
where:
Variable Field Type Valid Values Description

<countryCode> Integer 1 through 999 The country code number must

be a valid defined system country
code.

<publicDigit String 1 to 30 characters 1 to 30 digit pattern containing

Map> digits, 'x', '.', or "#' ('x' = single
digit wildcard, '.' = multiple digit
wildcard, '#' = # key). The '.' can
only be the last character in the
map.

6.5.4 CommunicationBarring
The Communication Barring-Fixed service enables restriction, for specified users, of originated or
redirected calls that match certain criteria. The Communication Barring - Fixed service uses the concepts
of network class of service (NCOS) and a barring profile. An NCOS allows for mapping a subscriber to an
active barring profile. A barring profile specifies the barring criteria and actions.

6.5.4.1 AltCallIndicators
The Alternate Call Indicator criterion specifies a selection of alternate call indicators to which a barring
rule applies. The alternate call indicator is determined by the aci contact parameter obtained from the
Network Server query response. The alternate call indicators are user-defined and can be added by the
administrator.
6.5.4.1.1 get
This command is used to view Communication Barring AltCallIndicators-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/CommunicationBarring/
AltCallIndicators> level.
2) Enter:
get↵
6.5.4.1.2 add
This command is used to add a new Communication Barring AltCallIndicators entry.
1) Ensure you are at the /AS_CLI/System/CallP/CommunicationBarring/
AltCallIndicators> level.
2) Enter:
add <name> <networkServerAltCallIndicator>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters This is the name of the call type

to be added.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 64
 Variable Field Type Valid Values Description

<network String 1 to 64 characters This must be one of the defined

ServerAltCall alternate call indicators on the
Indicator> Network Server.

6.5.4.1.3 set
This command is used to modify a Communication Barring AltCallIndicators entry.
1) Ensure you are at the /AS_CLI/System/CallP/CommunicationBarring/
AltCallIndicators> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters This is the name of the call type

to be modified.

<attribute> MultipleChoice networkServerAltCallIndicator The name of an attribute to

modify.

<network String 1 to 64 characters The new Network Server

ServerAltCall alternate call indicator value.
Indicator> This must be one of the defined
alternate call indicators on the
Network Server.

6.5.4.1.4 delete
This command is used to delete an existing Communication Barring AltCallIndicators entry.
1) Ensure you are at the /AS_CLI/System/CallP/CommunicationBarring/
AltCallIndicators> level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters This is the name of the call type

to be deleted.

6.5.4.2 CallTypes
The network call type is determined by the ct contact parameter obtained from the Network Server query
response. Network call types can either be system-defined or user-defined.
6.5.4.2.1 get
This command is used to view Communication Barring Call Types-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/CommunicationBarring/CallTypes> level.
2) Enter:
get↵
6.5.4.2.2 add
This command is used to add a new Communication Barring Call Type.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 65
 1) Ensure you are at the /AS_CLI/System/CallP/CommunicationBarring/CallTypes> level.
2) Enter:
add <name> <networkServerCallType>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters This is the name of the call type

to be added.

<networkServer String 1 to 4 characters This must be one of the defined

CallType> call types on Network Server.

6.5.4.2.3 set
This command is used to modify a Communication Barring Call Type.
1) Ensure you are at the /AS_CLI/System/CallP/CommunicationBarring/CallTypes> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters This is the name of the call type

to be modified.

<attribute> MultipleChoice networkServerCallType The name of an attribute to

modify.

<networkServer String 1 to 4 characters The new Network Server call type

CallType> value. This needs to be one of the
defined call types on the Network
Server.

6.5.4.2.4 delete
This command is used to delete an existing Communication Barring Call Type.
1) Ensure you are at the /AS_CLI/System/CallP/CommunicationBarring/CallTypes> level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters This is the name of the call type

to be deleted.

6.5.5 CountryCodes
Country code commands allow you to view the country code file that contains the numerical list of all
country codes and to view and change the default system country code. There are between one and
three digits in a country code. Country codes follow E.164, an ITU-T recommendation that specifies the
international public telephone system numbering plan. The default system country code is affixed to
national telephone numbers as follows:If the country code is provisioned for a user or user service, the
country code used is the country code of the user's phone number. If the user does not have a phone
number, the country code of the user's Group Calling Line ID is used. If the user's group has no Group

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 66
 Calling Line ID provisioned, the system default country code is used. If the number is associated with a
group or a group service, the country code affixed is the country code of the group's Group Calling Line ID.
If the group has no Group Calling Line ID provisioned, the system default country code is used.

6.5.5.1 get
This command is used to view the default Country Code and the list of configured Country Codes.
1) Ensure you are at the /AS_CLI/System/CallP/CountryCodes> level.
2) Enter:
get [<default>]↵
where:
Variable Field Type Valid Values Description

<default> String default Use this option to get the default

country code.

6.5.5.2 add
This command is used to add a new country code.
1) Ensure you are at the /AS_CLI/System/CallP/CountryCodes> level.
2) Enter:
add <countryCode> <countryName> <ringPeriodMilliseconds>
<offHookWarningTimerSeconds> <numberCWTones> <timeBetweenCWTonesMilliseconds>
[<attribute>]↵
where:
Variable Field Type Valid Values Description

<countryCode> Integer 1 through 999 The country code number.

<country String 1 to 80 characters The name of the country.

Name>

<ringPeriod Integer 1 through 12000 Determines the length of each

Milliseconds> ring, in milliseconds, for calls
to this country code. Used to
determine the total length of ring
timeouts.

<offHook Integer 1 through 360 Determines the length of time,

WarningTimer in seconds, the system will wait
Seconds> before sending an off-hook
message to a local access device
when a remote access device
goes on-hook.

<numberCW Integer 1 through 20 The maximum number of call

Tones> waiting tones per call.

<time Integer 0 through 120000 The amount of quiet time

BetweenCW between call waiting tones.
Tones
Milliseconds>

<attribute> MultipleChoice enablePrefix, prefix, disable Additional attributes to include

NationalPrefixForOffNetCalls through the add command.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 67
 Variable Field Type Valid Values Description

<enablePrefix> Choice true, false When set to "false", do not use

the national prefix. When set to
"true", use the national prefix.

<prefix> Digit String 1 to 2 digits The national prefix for this country
code.

<disable Choice true, false This parameter controls if the

NationalPrefix national prefix is stripped off
ForOffNet of outbound off-network calls.
Calls> When set to "false", the national
prefix is not stripped-off. When
set to "true", the national prefix is
stripped-off.

6.5.5.3 set
This command is used to modify the system- level default Country Code and the Country Code
parameters.
1) Ensure you are at the /AS_CLI/System/CallP/CountryCodes> level.
2) Enter:
set <countryCode> <attribute>↵
where:
Variable Field Type Valid Values Description

<countryCode> Integer 1 through 999 The country code number.

<attribute> MultipleChoice default, enablePrefix, prefix, off The name of an attribute to

HookWarningTimerSeconds, ring modify.
PeriodMilliseconds, numberCW
Tones, timeBetweenCWTones
Milliseconds, disableNational
PrefixForOffNetCalls

<default> String true Sets the specified country code

as the default. Note that false is
not an accepted value; when you
set a country code as default, the
previous default is overwritten
as there can only be one default
country code.

<enablePrefix> Choice true, false When set to "false", do not use

the national prefix. When set to
"true", use the national prefix.

<prefix> Digit String 1 to 2 digits The national prefix for this country
code.

<offHook Integer 1 through 360 Determines the length of time,

WarningTimer in seconds, the system will wait
Seconds> before sending an off-hook
message to a local access device
when a remote access device
goes on-hook.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 68
 Variable Field Type Valid Values Description

<ringPeriod Integer 1 through 12000 Determines the length of each

Milliseconds> ring, in milliseconds, for calls
to this country code. Used to
determine the total length of ring
timeouts.

<numberCW Integer 1 through 20 The maximum number of call

Tones> waiting tones per call.

<time Integer 0 through 120000 The amount of quiet time

BetweenCW between call waiting tones.
Tones
Milliseconds>

<disable Choice true, false This parameter controls if the

NationalPrefix national prefix is stripped off
ForOffNet of outbound off-network calls.
Calls> When set to "false", the national
prefix is not stripped-off. When
set to "true", the national prefix is
stripped-off.

6.5.5.4 delete
You use this command to delete an existing country code.
1) Ensure you are at the /AS_CLI/System/CallP/CountryCodes> level.
2) Enter:
delete <countryCode>↵
where:
Variable Field Type Valid Values Description

<countryCode> Integer 1 through 999 The country code to delete.

6.5.5.5 clear
This command is used to clear the Country Code parameters.
1) Ensure you are at the /AS_CLI/System/CallP/CountryCodes> level.
2) Enter:
clear <countryCode> <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<countryCode> Integer 1 through 999 The country code number.

<clearAttribute> MultipleChoice prefix The name of the attribute(s) to

clear.

6.5.6 DNS
This level is used to view, add, modify, and delete DNS entries.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 69
6.5.6.1 get
This command is used to view the Domain Name Server (DNS)-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/DNS> level.
2) Enter:
get↵

6.5.6.2 set
This command is used to modify the call processing system attributes related to Domain Name Server
(DNS).
1) Ensure you are at the /AS_CLI/System/CallP/DNS> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enableNameLookupForURL The name of an attribute to

Dialing, enableNameLookup modify.
Timeout, nameLookupTimeout
Milliseconds

<enableName Choice true, false Determines whether the

LookupForURL Application server performs name
Dialing> lookups for the network URL
domain dialing.

<enable Choice true, false Determines whether the

NameLookup Application Server uses the name
Timeout> lookup timeout in the context of
the call processing thread.

<nameLookup Integer 1 through 2500 Determines the name lookup

Timeout timeout value.
Milliseconds>

6.5.7 DTMFTransmission
This level is used to determine how the DTMF is sent over an active media stream.

6.5.7.1 get
This command is used to view the Dual-Tone Multi-Frequency Transmission (DTMF)-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/DTMFTransmission> level.
2) Enter:
get↵

6.5.7.2 set
This command is used to modify the Dual-Tone Multi-Frequency Transmission (DTMF)-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/DTMFTransmission> level.
2) Enter:
set <transmissionMethod>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 70
 Variable Field Type Valid Values Description

<transmission Choice rtp, signaling The client DTMF transmission

Method> method.

Variable: signaling

signaling Shows attributes that apply when

transmissionMethod is set to
signaling.

<signaling Choice application/dtmf, application/dtmf- The content type for the signaling
ContentType> relay, audio/telephone-event transmission method.

6.5.8 ExpensiveCalls
The service provides an audio notification to users making a call that carries a particular Network Server
alternate call indicator (NS ACI), which corresponds to an expensive call. Upon originating a call, if the
Network ACI for that call corresponds to an ACI configured by this Expensive Call Notification service
to identify an expensive call, the user is provided with a warning announcement stating that the call is
expensive, and the user can release the call to avoid the charge before the call proceeds. If the network
ACI does not identify an expensive call by this Expensive Call Notification service, the call is routed as
usual. If the user does not release the call before the end of the announcement, the call is routed as usual.
The carrier can record a silence that follows the notification announcement, or repeat the announcement to
provide a grace period for the user to release the call-all in the same announcement file. The service, itself,
does not provide this grace period explicitly. This level is used to manage Expensive Call-related attributes.

6.5.8.1 get
This command is used to view expensive calls-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/ExpensiveCalls> level.
2) Enter:
get↵

6.5.8.2 set
This command is used to modify expensive calls-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/ExpensiveCalls> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enablePostAnnouncementDelay The name of an attribute to

Timer, postAnnouncementDelay modify.
Seconds

<enablePost Choice true, false Determines whether the Post

Announcement Announcement Delay Timer is
DelayTimer> enabled. The delay gives the user
more time to release the call.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 71
 Variable Field Type Valid Values Description

<post Integer 0 through 20 The value of the post-

Announcement announcement delay, after which
DelaySeconds> the call will proceed and the user
will be charged for it.

6.5.8.3 ExpensiveCallTypes
The Expensive Call Notification service is configured with a list, (which may be empty) of those Network
Server ACIs that identify expensive calls. It is a system-wide feature and it runs on every call, if the list is
not empty. Upon origination of a call, the Application Server verifies the ACI value returned by the Network
Server for that call against the Expensive Call Notification service list to determine whether the call is an
expensive call. (The Application Server uses the ACI value of the highest q-value Contact header entry
of the 302 response returned by the Network Server.) If the call is an expensive call, the Expensive Call
Notification warning announcement is played to the user before the call proceeds; otherwise, the call
proceeds as usual. This level is used to manage the list of Alternate Call Indicators for expensive calls.
6.5.8.3.1 get
This command is used to view expensive alternate call indicator defined.
1) Ensure you are at the /AS_CLI/System/CallP/ExpensiveCalls/ExpensiveCallTypes> level.
2) Enter:
get↵
6.5.8.3.2 add
This command is used to add a new expensive alternate call indicator.
1) Ensure you are at the /AS_CLI/System/CallP/ExpensiveCalls/ExpensiveCallTypes> level.
2) Enter:
add <alternateCallIndicator> [<treatmentAudioFile>]↵
where:
Variable Field Type Valid Values Description

<alternateCall String 1 to 64 characters Used by the Application Server

Indicator> to verify whether a call is an
expensive call. Has to match an
ACI on the Network Server.

<treatment String 1 to 256 characters Identifies the name of the

AudioFile> audio file that will be played as
announcement for an Expensive
Call Notification when the call
placed maps to this Alternate Call
Indicator. This file name must be
relative to the localized system
prompts directory, where current
system-defined audio treatments
are located (that is, files must
be copied to that directory). The
file must be in the proper format
(current supported format is .wav,
uLaw, 8kHz, 8 bit,

6.5.8.3.3 set
This command is used to modify expensive alternate call indicator defined.
1) Ensure you are at the /AS_CLI/System/CallP/ExpensiveCalls/ExpensiveCallTypes> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 72
 2) Enter:
set <alternateCallIndicator> <attribute>↵
where:
Variable Field Type Valid Values Description

<alternateCall String 1 to 64 characters Used by the Application Server

Indicator> to verify whether a call is an
expensive call. Has to match an
ACI on the Network Server.

<attribute> MultipleChoice treatmentAudioFile The name of an attribute to

modify.

<treatment String 1 to 256 characters Identifies the name of the

AudioFile> audio file that will be played as
announcement for an Expensive
Call Notification when the call
placed maps to this Alternate Call
Indicator. This file name must be
relative to the localized system
prompts directory, where current
system-defined audio treatments
are located (that is, files must
be copied to that directory). The
file must be in the proper format
(current supported format is .wav,
uLaw, 8kHz, 8 bit,

6.5.8.3.4 delete
This command is used to delete an existing expensive alternate call indicator from the system.
1) Ensure you are at the /AS_CLI/System/CallP/ExpensiveCalls/ExpensiveCallTypes> level.
2) Enter:
delete <alternateCallIndicator>↵
where:
Variable Field Type Valid Values Description

<alternateCall String 1 to 64 characters Used by the Application Server

Indicator> to verify whether a call is an
expensive call. It has to match an
ACI on the Network Server.

6.5.8.3.5 clear
This command is used to clear expensive alternate call indicator-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/ExpensiveCalls/ExpensiveCallTypes> level.
2) Enter:
clear <alternateCallIndicator> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 73
 Variable Field Type Valid Values Description

<alternateCall String 1 to 64 characters Used by the Application Server

Indicator> to verify whether a call is an
expensive call. It has to match an
ACI on the Network Server.

<attribute> MultipleChoice treatmentAudioFile The name of the attribute(s) to

clear.

6.5.9 ExternalEmergencyRouting
This level is used to view and modify external emergency routing-related attributes. Activation of the
External Emergency Routing service causes the Application Server to launch a query to the Emergency
Server (EN) to obtain a routable emergency number. This service, which is enabled at the system level,
has the address of the EN server configured as a fully qualified domain name (FQDN). The Application
Server accesses the EN server cluster via a DNS query and selects a specific EN server from the ordered
list of servers returned by the DNS. If there is no reply from the EN server, the Application Server falls
back to the default routing for the emergency call. A default emergency routing number is configured on a
system-wide basis. In the absence of a routing number obtained from the EN server, the emergency call is
routed to the default emergency number.

6.5.9.1 get
This command is used to view External Emergency Routing-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/ExternalEmergencyRouting> level.
2) Enter:
get↵

6.5.9.2 set
This command is used to modify External Emergency Routing-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/ExternalEmergencyRouting> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice serviceURI, defaultEmergency The name of an attribute to

Number, activeFlag, modify.
connectionTimeoutInSeconds,
supportsDNSSRV

<serviceURI> String 1 to 80 characters Specifies an IP address, host,

or domain for available SOAP
servers.

<default String 1 to 30 characters The default emergency number.

Emergency
Number>

<activeFlag> Choice true, false Specifies whether or not the

server is active.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 74
 Variable Field Type Valid Values Description

<connection Integer 1 through 10 Specifies the time in seconds

TimeoutIn before the emergency number
Seconds> server times out. If the server
times out, the next emergency
number server that has been
returned by DNS query is tried.

<supportsDNSSRV> Choice true, false When set to "true", the DNS SRV
query takes precedence over the
DNS A query in the default DNS/
SOAP query operation sequence.

6.5.9.3 clear
This command is used to clear (set to no value) External Emergency Routing-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/ExternalEmergencyRouting> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice serviceURI, defaultEmergency The name of the attribute(s) to

Number clear.

6.5.10 NetProgression
This level is used to configure the network progression service. NetProgression is an originating call timer
used for PRI interworking. If a progress message is not received before the netProgression times out,
the originating call sends a progress message. This ensures that the originating PRI gateway does not
tear down the call. The netProgression timer is used for interoperability with SIP PRI gateways that do
not allow configuration with the ISDN T310 timer. The T310 timer tears down a call that has been in the
call proceeding state longer than the T310 timer. The T310 timer is cleared when the call exits the call
proceeding state, typically when the call moves to the alerting, connect, or progress state. In general,
when the PRI gateway or soft switch supports configuration of the T310 timer, the T310 timer on the
gateway or soft switch should be adjusted to an appropriate value based on the network that the gateway
or soft switch is deployed in, rather than using the netProgression timer on BroadWorks. The purpose
of the netProgression timer is to cancel the T310 timer for gateways or soft switches that do not allow
configuration of the T310 timer.

6.5.10.1 get
This command is used to view Network Progression-related attributes. For example, attributes such as
whether network progression is active or the wait period before sending a message.
1) Ensure you are at the /AS_CLI/System/CallP/NetProgression> level.
2) Enter:
get↵

6.5.10.2 set
This command is used to modify Network Progression-related attributes. For example, attributes such as
whether network progression is active or the wait period before sending a message.
1) Ensure you are at the /AS_CLI/System/CallP/NetProgression> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 75
 set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice active, waitPeriod The name of an attribute to

modify.

<active> Choice true, false Controls if the network

progression is active or not.

<waitPeriod> Integer 1 through 15 The number of seconds before

the service will send a 180
(Ringing) back to the originating
PSTN gateway to pacify it to keep
it from terminating the connection.

6.5.11 Routing
This level is used to view and modify routes. Routes are small areas such as a building or a small
geographic area. A route is comprised of network devices (an IP address, host name, or domain) that
serve the area for calls outgoing to the public network.

6.5.11.1 MediaServerSelection
This level is used to view and modify Media Server Selection (MSS)-related attributes, such as whether
MSS is active, the local and remote ports, the maximum number of retransmissions allowed, and the
retransmission delay time.
6.5.11.1.1 get
This command is used to view Media Server Selection (MSS)-related attributes, such as whether
MSS is active, the local and remote ports, the maximum number of retransmissions allowed, and the
retransmission delay time.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/MediaServerSelection> level.
2) Enter:
get↵
6.5.11.1.2 set
This command is used to modify Media Server Selection (MSS)-related attributes, such as whether
MSS is active, the local and remote ports, the maximum number of retransmissions allowed, and the
retransmission delay time.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/MediaServerSelection> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice mediaServerTimerLength, mss The name of an attribute to

RouteTimerLength, useStatic modify.
MediaServerDevice

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 76
 Variable Field Type Valid Values Description

<mediaServer Integer 600 through 120000 The time (in milliseconds)

TimerLength> the Application Server waits
before declaring that the
Media Server has ceased
responding. When this timer
expires, the call is dropped and
a bwMediaServerNotResponding
alarm is raised. Default value is
15000 milliseconds.

<mssRoute Integer 500 through 120000 The time (in milliseconds) the
TimerLength> Application Server waits before
advancing to the next Network
Server during Media Server
selection, or before advancing
to the next Media Server when
processing an initial connection
message. This value is only used
if useStaticMediaServerDevice is
set to false. Default value is 800
milliseconds.

<useStatic Choice true, false Specifies if Media Server(s)

MediaServer statically configured on the
Device> Application Server are used
(useStaticMediaServerDevice
= true), or if a query is
made to the Network Server
(useStaticMediaServerDevice
= false). Static devices
are configured in AS_CLI/
System/CallP/Routing/
MediaServerSelection/Device.
Default value is false.

6.5.11.1.3 MediaServerDevice
This level is used to view and modify the Internet Protocol (IP) address, port, and description of active
Media Servers. The BroadWorks Media Server provides specialized media resources, interactive voice
response, and conferencing capabilities. The Application Server keeps a list of Media Servers associated
with that Application Server so it does not have to query the Network Server every time it needs a Media
Server. The relationship between Application Servers and Media Servers is many-to-many.
6.5.11.1.3.1 get
This command is used to view the Internet Protocol (IP) address, port, and description of active Media
Servers.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/MediaServerSelection/
MediaServerDevice> level.
2) Enter:
get↵
6.5.11.1.3.2 add
This command is used to add a new Media Server.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/MediaServerSelection/
MediaServerDevice> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 77
 add <ipAddress> <transportType> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The IP address, host name,

or domain name of the Media
Server.

<transport Choice udp, tcp, unspecified Specifies which transport type

Type> is used by this server. When
unspecified is selected, either
protocol is allowed.

<attribute> MultipleChoice port, description Additional attributes to include

through the add command.

<port> Integer 1025 through 65535 The port of the Media Server.

<description> String 1 to 80 characters The description of the Media

Server.

6.5.11.1.3.3 set
This command is used to modify a Media Server.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/MediaServerSelection/
MediaServerDevice> level.
2) Enter:
set <ipAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The IP address, host name,

or domain name of the Media
Server.

<attribute> MultipleChoice port, transportType, description The name of an attribute to

modify.

<port> Integer 1025 through 65535 The port of the Media Server.

<transport Choice udp, tcp, unspecified Specifies which transport type

Type> is used by this server. When
unspecified is selected, either
protocol is allowed.

<description> String 1 to 80 characters The description of the Media

Server.

6.5.11.1.3.4 delete
This command is used to delete a Media Server.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/MediaServerSelection/
MediaServerDevice> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 78
 delete <ipAddress>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The IP address, host name,

or domain name of the Media
Server.

6.5.11.1.3.5 clear
This command is used to clear (set to no value) Media Server attributes.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/MediaServerSelection/
MediaServerDevice> level.
2) Enter:
clear <ipAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The IP address, host name,

or domain name of the Media
Server.

<attribute> MultipleChoice port, description The name of the attribute(s) to

clear.

6.5.11.2 Route
This level is used to view, add, modify, and delete Route entries.
6.5.11.2.1 get
Existing routes are viewed using this command. This command shows the routes by which the Application
Server sends calls (typically to a Network Server).
1) Ensure you are at the /AS_CLI/System/CallP/Routing/Route> level.
2) Enter:
get↵
6.5.11.2.2 add
When adding a new route to the system, the route name is set. The route is where the Application Server
sends calls.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/Route> level.
2) Enter:
add <route>↵
where:
Variable Field Type Valid Values Description

<route> String 1 to 32 characters The name of the route where the

Application Server will route calls.

6.5.11.2.3 delete
Routes can be deleted from the system. The route name is used to identify the record.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/Route> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 79
 2) Enter:
delete <route>↵
where:
Variable Field Type Valid Values Description

<route> String 1 to 32 characters The name of the route where the

Application Server will route calls.

6.5.11.2.4 Device
Route device-related attributes, such as the route and the routing device names, and the corresponding
routing device IP address, port, and description, are viewed using this command. If you use this command
alone, all records will be displayed. If you use this command with a specified variable, all records that
match only those criteria will be displayed.
6.5.11.2.4.1 get
This command displays route device-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/Route/Device> level.
2) Enter:
get <route>↵
where:
Variable Field Type Valid Values Description

<route> String 1 to 32 characters The name of the route where the

Application Server will route calls.

6.5.11.2.4.2 add
When adding a new route device to the system, the route and the corresponding routing device IP address,
port, and description are set.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/Route/Device> level.
2) Enter:
add <route> <ipAddress> <transportType> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<route> String 1 to 32 characters The name of the route where the

Application Server will route calls.

<ipAddress> String 1 to 80 characters The IP address, host name, or

domain of the routing device.

<transport Choice udp, tcp, unspecified Specifies which transport type

Type> is used by this device. When
unspecified is selected, either
protocol is allowed.

<attribute> MultipleChoice port, description Additional attributes to include

through the add command.

<port> Integer 1025 through 65535 The device port number used for
routing calls.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 80
 Variable Field Type Valid Values Description

<description> String 1 to 80 characters The description of the routing

device such as an internal
reference, manufacturer name,
and so on.

6.5.11.2.4.3 set
The description of a routing device is changed using this command. To change other attributes of a device,
such as its address or port, delete the device and re-create it with the desired attributes.NOTE: The port
must always be given once it has been specified for a device.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/Route/Device> level.
2) Enter:
set <route> <ipAddress> [<port>] <attribute>↵
where:
Variable Field Type Valid Values Description

<route> String 1 to 32 characters The name of the route where the

Application Server will route calls.

<ipAddress> String 1 to 80 characters The corresponding IP address,

host name, or domain for the
routing device.

<port> Integer 1025 through 65535 The port of the routing device
used by this route. This attribute
becomes required once it has
been defined for the device.

<attribute> MultipleChoice transportType, description The name of an attribute to

modify.

<transport Choice udp, tcp, unspecified Specifies which transport type

Type> is used by this device. When
unspecified is selected, either
protocol is allowed.

<description> String 1 to 80 characters The description of the routing

device such as an internal
reference, manufacturer name,
and so on.

6.5.11.2.4.4 delete
Route devices can be deleted from the system. The unique route/address combination is used to identify
the record.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/Route/Device> level.
2) Enter:
delete <route> <ipAddress> [<port>]↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 81
 Variable Field Type Valid Values Description

<route> String 1 to 32 characters The name of the route where the

Application Server will route calls.

<ipAddress> String 1 to 80 characters The corresponding IP address,

host name, or domain for the
routing device.

<port> Integer 1025 through 65535 The port of the routing device
used by this route. Required if a
port is specified for the intended
device.

6.5.11.2.4.5 clear
This command is used to clear Route Device-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/Route/Device> level.
2) Enter:
clear <route> <ipAddress> [<port>] <attribute>↵
where:
Variable Field Type Valid Values Description

<route> String 1 to 32 characters The name of the route where the

Application Server will route calls.

<ipAddress> String 1 to 80 characters The corresponding IP address,

host name, or domain for the
routing device.

<port> Integer 1025 through 65535 The port of the routing device
used by this route. Required if a
port is specified for the intended
device.

<attribute> MultipleChoice description The name of the attribute(s) to

clear.

6.5.11.3 RouteParms
This level is used to view and modify network routing attributes. The Network Routing Service attributes
are routeTimerLength and routeRoundRobin. The routeTimerLength is the timer used to determine if the
Network Routing Service should route advance to the next device in the Route. The timer is configurable
from 1 to 25 seconds with a default of 1 second. The Network Routing Service considers a device
route successful upon receipt of a 1XX (including a 100 Trying) message from the device over the SIP
interface. The enableRoundRobin attribute is used by the Network Routing Service to determine the
routing algorithm to use upon route advancing to the next device in the Route. When enableRoundRobin
is false, the Network Routing Service performs sequential device route advancing and always starts with
the first device in the Route. Subsequent routes are tried sequentially, in order of their appearance in
the Route, until a successful device route is obtained. When enableRoundRobin is true, the Network
Routing Service remembers the last successful device route and starts the Route, using the device
immediately following the last successful device route in the Route. If the last successful device route
was the last device in the Route, the Network Routing Service then uses the first device in the Route to
attempt to route the call. Route Advancing proceeds sequentially, in order of their appearance in the Route,
until a successful device route is obtained. The hostname Usage parameter indicates how BroadWorks
should interpret the meaning hostnames with multiple IP addresses. The possible values are standard,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 82
 loadbalanced, or stateful. Standard indicates that the DNS query ordering reflects the preferred order.
Loadbalanced indicates that the results from the DNS query should be randomized. Stateful indicates that
the DNS query ordering is prioritized; however upon successfully reaching an IP address associated with a
hostname, it should be used until it fails or reaches statefulExpiration. Resetting the hostname Usage value
automatically clears the stateful hostname to IP address mappings.
6.5.11.3.1 get
This command is used to view routing parameter-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/RouteParms> level.
2) Enter:
get↵
6.5.11.3.2 set
This command is used to modify routing parameter-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/RouteParms> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice routeRoundRobin, routeTimer The name of an attribute to

Length, hostnameUsage, stateful modify.
Expiration, maxAddressesPer
Hostname, maxAddressesDuring
Setup

<routeRound Choice true, false When set to "true", turn on round

Robin> robin routing. When set to "false",
turn off round robin (default).

<routeTimer Integer 1 through 25 Used to determine when the

Length> Network Routing Service should
advance to the next device in the
Route. The default value is 1.

<hostname Choice standard, loadbalanced, stateful When set to standard, it indicates

Usage> that the DNS query ordering
reflects the preferred order. When
set to loadbalanced, it indicates
that the result from the DNS
query should be randomized.
When set to stateful, it indicates
that the DNS query ordering is
prioritized.

<stateful Integer 0 through 1440 Indicates the number of minutes

Expiration> that stateful hostnameUsage
should be maintained once
successful.

<max Integer 1 through 50 Indicates the maximum number of

AddressesPer addresses from a DNS query to
Hostname> be used.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 83
 Variable Field Type Valid Values Description

<max Integer 1 through 50 Indicates the maximum number

Addresses of addresses that the network
DuringSetup> routing service tries during a call
setup.

6.5.11.4 RoutingXLA
Routing translation-related attributes, such as the route and the associated NPA-NXX numbers, are viewed
using this command. This command displays the NPA-NXX numbering plan area and exchange, and the
corresponding route to be used. If you use this command alone, all records will be displayed. If you use
this command with a specified variable, all records that match only those criteria will be displayed.
6.5.11.4.1 get
This command is used to display routing translations-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/RoutingXLA> level.
2) Enter:
get [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice digits, route The name of an attribute to filter

on.

<digits> String 1 to 6 characters The NPA-NXX number.

<route> String 1 to 32 characters The route name. An asterisk (*) is

used as a wildcard.

6.5.11.4.2 add
To add new routing translations to the system, you set the -NXX numbers and the corresponding route.
The route names used here must have been previously defined.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/RoutingXLA> level.
2) Enter:
add <digits> <route>↵
where:
Variable Field Type Valid Values Description

<digits> String 1 to 6 characters The NPA-NXX number.

<route> Choice Network Server The route name.

6.5.11.4.3 set
Routing translations-related attributes, such NPA-NXX numbers and the corresponding route, are changed
using this command. The route names used here must have been previously defined.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/RoutingXLA> level.
2) Enter:
set <digits> <route>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 84
 Variable Field Type Valid Values Description

<digits> String 1 to 6 characters The NPA-NXX number.

<route> Choice Network Server The route name.

6.5.11.4.4 delete
Routing translations can be deleted from the system. The NPA-NXX number is used to identify the record.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/RoutingXLA> level.
2) Enter:
delete <digits>↵
where:
Variable Field Type Valid Values Description

<digits> String 1 to 6 characters The NPA-NXX number.

6.5.11.5 VideoServerSelection
This level is used to view and modify Video Server Selection-related attributes, such as whether Video
Server is active, the local and remote ports, the maximum number of retransmissions allowed, and the
retransmission delay time.
6.5.11.5.1 get
This command is used to view Video Server selection-related properties.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/VideoServerSelection> level.
2) Enter:
get↵
6.5.11.5.2 set
This command is used to set Video Server selection-related properties.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/VideoServerSelection> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice videoServerResponseTimer The name of an attribute to

Milliseconds, videoServer modify.
SelectionRouteTimerMilliseconds,
useStaticVideoServerDevice

<videoServer Integer 600 through 120000 This parameter specifies the

ResponseTimer time the Application Server waits
Milliseconds> before declaring that the Video
Server has ceased responding (in
milliseconds).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 85
 Variable Field Type Valid Values Description

<videoServer Integer 500 through 120000 This parameter specifies the

Selection time the Application Server waits
RouteTimer before advancing to the next
Milliseconds> Network Server to the next Video
Server when processing an
initial connection message (in
milliseconds).

<useStatic Choice true, false This parameter specifies if Video

VideoServer Server(s) are statically configured
Device> on the Application Server, or if
a query is made to the Network
Server.

6.5.11.5.3 VideoServerDevice
This level is used to view and modify the Internet Protocol (IP) address, port, and description of active
Video Servers.
6.5.11.5.3.1 get
This command is used to view parameters for active Video Servers.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/VideoServerSelection/
VideoServerDevice> level.
2) Enter:
get↵
6.5.11.5.3.2 add
This command is used to add a new Video Server.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/VideoServerSelection/
VideoServerDevice> level.
2) Enter:
add <ipAddress> <transportType> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters This parameter specifies the IP

address, host name or domain
name of the Video Server.

<transport Choice udp, tcp, unspecified This parameter specifies which

Type> transport type is used by this
server. When unspecified is
selected, either protocol is
allowed.

<attribute> MultipleChoice port, description Additional attributes to include

through the add command.

<port> Integer 1025 through 65535 This parameter specifies the port
of the Video Server. If not defined
it defaults to 5060.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 86
 Variable Field Type Valid Values Description

<description> String 1 to 80 characters This parameter specifies the

description of the Video Server.
This parameter is optional.

6.5.11.5.3.3 set
This command is used to modify the Video Server.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/VideoServerSelection/
VideoServerDevice> level.
2) Enter:
set <ipAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters This parameter specifies the IP

address, host name, or domain
name of the Video Server.

<attribute> MultipleChoice port, transportType, description The name of an attribute to

modify.

<port> Integer 1025 through 65535 This parameter specifies the port
of the Video Server.

<transport Choice udp, tcp, unspecified This parameter specifies which

Type> transport type is used by this
server. When unspecified is
selected, either protocol is
allowed.

<description> String 1 to 80 characters This parameter specifies the

description of the Video Server.

6.5.11.5.3.4 delete
This command is used to delete a Video Server.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/VideoServerSelection/
VideoServerDevice> level.
2) Enter:
delete <ipAddress>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters This parameter specifies the IP

address, host name, or domain
name of the Video Server.

6.5.11.5.3.5 clear
This command is used to clear (set to no value) Video Server-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/Routing/VideoServerSelection/
VideoServerDevice> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 87
 2) Enter:
clear <ipAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters This paramter specifies the IP

address, host name, or domain
name of the Video Server.

<attribute> MultipleChoice port, description The name of the attribute(s) to

clear.

6.5.12 ServiceCodes
This level is used to manage Service Code-related attributes.

6.5.12.1 get
This command is used to view Service Code-related attributes. At least one of the parameters defined
in the multiple choice attribute needs to be specified to search all service codes. The Service Code and
its description are used as search criteria. If the search produces over 1,000 entries, an error message
appears indicating you should refine your search criteria to narrow the search.
1) Ensure you are at the /AS_CLI/System/CallP/ServiceCodes> level.
2) Enter:
get <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice serviceCodeStarts, serviceCode The name of an attribute to filter

Contains, serviceCodeEquals, on.
descriptionStarts, description
Contains, descriptionEquals

<serviceCode String 0 to 30 characters A string with which the service

Starts> code starts.

<serviceCode String 0 to 30 characters A string contained in the service

Contains> code.

<serviceCode String 1 to 30 characters A string matching the service

Equals> code.

<description String 0 to 200 characters A string with which the description

Starts> starts.

<description String 0 to 200 characters A string contained in the

Contains> description.

<description String 1 to 200 characters A string matching the description.

Equals>

6.5.12.2 add
This command is used to add a new Service Code.
1) Ensure you are at the /AS_CLI/System/CallP/ServiceCodes> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 88
 2) Enter:
add <serviceCode> <description>↵
where:
Variable Field Type Valid Values Description

<serviceCode> String 1 to 30 characters The service code to be added.

<description> String 1 to 200 characters A description of the service code.

6.5.12.3 set
This command is used to modify Service Code-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/ServiceCodes> level.
2) Enter:
set <serviceCode> <attribute>↵
where:
Variable Field Type Valid Values Description

<serviceCode> String 1 to 30 characters The service code.

<attribute> MultipleChoice description The name of an attribute to

modify.

<description> String 1 to 200 characters A description of the service code.

6.5.12.4 delete
This command is used to delete an existing Service Code.
1) Ensure you are at the /AS_CLI/System/CallP/ServiceCodes> level.
2) Enter:
delete <serviceCode>↵
where:
Variable Field Type Valid Values Description

<serviceCode> String 1 to 30 characters The service code to be added.

6.5.13 SessionAudit
This level is used to view and modify session audit-related attributes, such as whether session audit is
active or not, the audit period, and the audit timeout period.

6.5.13.1 get
This command is used to view session audit-related attributes, such as whether session audit is active or
not, the audit period, and the audit timeout period.
1) Ensure you are at the /AS_CLI/System/CallP/SessionAudit> level.
2) Enter:
get↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 89
6.5.13.2 set
This command is used to modify session audit-related attributes, such as whether session audit is active or
not, the audit period, and the audit timeout period.
1) Ensure you are at the /AS_CLI/System/CallP/SessionAudit> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice auditActive, auditIntervalSeconds, The name of an attribute to

auditTimeoutSeconds, release modify.
CallOnAuditFailure, alwaysUse
SessionTimerWhenSupported,
preferredSessionTimerRefresher,
sipSessionExpiresMinimum
Seconds, enforceSIPSession
ExpiresMaximum, sipSession
ExpiresMaximumSeconds, sip
SessionExpiresTimerSeconds,
sipSessionTimerActive, sip
RefreshAllowedOnAudit, allow
UpdateForSIPRefresh, enable
EmergencyCallAlarmTimer,
emergencyCallAlarmMinutes,
enableEmergencyCallCleanup
Timer, emergencyCallCleanup
Minutes

<auditActive> Choice true, false Audits are enabled or disabled.

<auditInterval Integer 60 through 7200 The time a call must be up before

Seconds> the system checks to see if it still
exists (in seconds).

<auditTimeout Integer 60 through 600 The amount of time the access

Seconds> device has to respond to the
audit request from the Application
Server before a timeout occurs (in
seconds).

<releaseCallOn Choice true, false When set to "true", the calls are
AuditFailure> explicitly taken down with BYE
requests, when an audit times
out.

<always Choice true, false If set to true, the Application

UseSession Server always tries to negotiate
TimerWhen the Session Timer.
Supported>

<preferred Choice local, remote Specifies whether the local or

SessionTimer the remote note should refresh
Refresher> the session. The default value is
"local".

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 90
 Variable Field Type Valid Values Description

<sipSession Integer 30 through 3600 The minimum value of the SIP

Expires session expires timer, sent.
Minimum
Seconds>

<enforceSIP Choice true, false If set to "true", the Application

SessionExpires Server compares the received
Maximum> Min-SE against SIP Session
Expires Maximum Seconds. If
the received value is higher than
the ceiling, the Application Server
forces a refresh of the session
at half the configured ceiling
value (instead of half the received
Session-Expires value). This
forced refresh happens even if
the Application Server was not
supposed to be the refresher.
This prevents the abnormally high
refresh values.

<sipSession Integer 3600 through 86400 The ceiling value for the
Expires negotiated SIP Session Expires
Maximum timer. The default value is 7200.
Seconds>

<sipSession Integer 60 through 86400 The value of the SIP Session

ExpiresTimer Expires timer.
Seconds>

<sipSession Choice true, false Specifies whether the SIP

TimerActive> session timer is active.

<sipRefresh Choice true, false If set to "false" prevents session

AllowedOn audit from performing refreshes
Audit> if the SIP session timer was
negotiated with the device (or
intervening proxy).

<allowUpdate Choice true, false Specifies whether UPDATE

ForSIP messages should be allowed to
Refresh> SIP refresh.

<enable Choice true, false If set to true, the Application

EmergencyCall Server sends an SNMP
AlarmTimer> notification if the duration of an
emergency call exceeds the value
of emergencyCallAlarmMinutes.

<emergency Integer 1 through 1440 Specifies the allowed duration

CallAlarm of an emergency call before
Minutes> BroadWorks sends an SNMP
notification.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 91
 Variable Field Type Valid Values Description

<enable Choice true, false If set to true, the Application

EmergencyCall Server frees all internal
CleanupTimer> resources for an emergency
call if the duration of the
call exceeds the value of
emergencyCallCleanupMinutes.

<emergency Integer 1 through 1440 Specifies the allowed duration

CallCleanup of an emergency call before
Minutes> BroadWorks releases the internal
resources associated with the
call.

6.5.14 Treatment
This level is used to view and modify treatment-related attributes.
System treatments are the scheme by which errors are handled. When a specific event occurs, the
Application Server performs the corresponding treatment. For example, if a call fails, a file message can
be played. The list of .WAV files available are dynamically generated based on those available in the /var/
broadworks/userfiles directory.There are several error conditions with a corresponding directory for each
where .WAV files are located:\
Unknown user - a user dials an unassigned number within their group.
Unknown number - a user dials an unknown number.
Unknown route - a user attempts to make a call and the routing fails.
Network unavailable - a call is made when a gateway is not responding to the network service or when an
endpoint timeout has occurred.
Resource unavailable - a call is made but the media server and/or endpoint are/is not available.
Dial tone timeout - a call is attempted but incomplete or the receiver is left off-hook.
Call failure - a call is made and a network-related problem exists.For more information on system-
defined treatments, see the BroadWorks Announcement Guide.Treatments can also be configured by
the system administrator using SIP status code mapping and system treatments mapping. Support is
also provided for the Reason header, as defined in RFC 3326, which includes support of Q.850 cause
codes. This feature:Allows configuration of customer-defined treatments (as opposed to system-defined
treatments).Provides support for Q.850 cause values (extracted from the Reason header, as defined in
RFC 3326) in SIP responses.Allows system administrator to define Q.850 cause values for translation
errors on the Network Server.Allows Application Server handling of Network Server defined treatments via
the Network Server treatment being added as a new protocol to the Reason header.This feature allows
system administrators to configure the mapping of:SIP status codes to treatments (independently for the
network and access side)Q.850 cause values to treatments (if this Q.850 value is present, it supersedes
the SIP status code when computing the treatment to use)Services to the treatments to use, for services
that can block calls (Outgoing Calling Plan [OCP], Incoming Calling Plan [ICP], Anonymous Call Rejection
[ACR], Selective Call Rejection [SCR], Shared Call Appearance [SCA], Intercept, Account/Authorization
Code [AAC], and Push to Talk [PTT])Network Server defined treatments to treatments on the Application
ServerSystem-defined treatments (that is, internal release causes) to treatmentsTreatments to an action
(play a specific media file or simply send a SIP response) (independently for the network and access
side)Treatments to outgoing SIP status codes (independently for the network and access side)Treatments
to Q.850 cause values to be added in a Reason header in outgoing SIP responsesTreatments to whether
or not a Reason header should be sent in the response (independently for the network and access
side)Treatments to the termination cause to use when generating the call detail recordTreatments to
the Route Advancing policyTreatments to system-defined treatments (that is, internal release cause) to
allow predefined behavior processing for a particular customer-defined treatmentTreatments to a charge
indicator, to configure whether or not the call is marked as charged in the call detail recordThe presence
of a customer-defined treatment overrides the default system behavior with the customer-defined behavior
(media file to play, SIP status code to generate, terminationCause to generate, and so on). In the absence
of any customer-defined treatment, the system behaves as usual. Note that for a given treatment, the SIP

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 92
 status code, internal release cause, and terminationCause are optional. If these attributes are not defined
for a treatment, the existing behavior is applied based on the internal release cause. The Q.850 value,
Reason Header Transmission policy, Route Advance policy, charge indicator, and announcements for a
treatment must be explicitly configured. If these explicit configuration attributes are not configured, default
values are used, which means that there is no Reason header with Q.850 value sent for the treatment,
route advancing is not triggered, the call is not set to chargeable, and there is no announcement played
(the SIP status code is proxied instead).In addition to these configurable treatments, a system parameter
provides system administrators with the ability to decide whether charge treatments are handled by
answering the call (via a 200 OK message) or with early media (via an 18x message).

6.5.14.1 get
This command is used to view treatment-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment> level.
2) Enter:
get↵

6.5.14.2 set
This command is used to modify treatment-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice noChargeTreatments, access The name of an attribute to

NoChargeTreatmentHandling, modify.
networkNoChargeTreatment
Handling

<noCharge Choice none, allExceptUserScreened, all When set to "none", it indicates

Treatments> that network calls blocked by
ACR, SCR, SCA, PTT, or ICP
are marked as chargeable.
All other treatments remain
non-chargeable. When set to
"allExceptUserScreened", it
indicates that network calls
blocked by ACR, SCR, SCA, or
PTT are marked as chargeable.
All other treatments remain non-
chargeable. When set to "all",
it indicates that any treatment
applied by BroadWorks is marked
as non-chargeable in the Call
Detail Record, regardless of the
call type or service.

<access Choice answer, earlyMedia Specifies whether the non-

NoCharge chargeable treatments on the
Treatment access side are played using
Handling> earlyMedia (18x with SDP) or via
answer (200 OK).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 93
 Variable Field Type Valid Values Description

<network Choice answer, earlyMedia Specifies whether the non-

NoCharge chargeable treatments on the
Treatment network side are played using
Handling> earlyMedia (18x with SDP) or via
answer (200 OK).

6.5.14.3 ConfigurableTreatment
This level is used to view and manage Configurable Treatment entries.
6.5.14.3.1 get
This command is used to view ConfigurableTreatment-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment> level.
2) Enter:
get↵
6.5.14.3.2 detail
This command is used to view Configurable Treatment detail attributes.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment> level.
2) Enter:
detail <treatmentId>↵
where:
Variable Field Type Valid Values Description

<treatmentId> String 1 to 40 characters This is a short descriptive string

that identifies the treatment for
which details are to be viewed.

6.5.14.3.3 add
This command is used to add a new ConfigurableTreatment entry.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment> level.
2) Enter:
add <treatmentId> <chargeIndicator> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<treatmentId> String 1 to 40 characters This is a short descriptive string

that identifies the treatment that is
currently being defined. This field
is mandatory.

<charge Choice charge, noCharge This attribute provides the option

Indicator> to remove exception services
(that is, all unanswered calls are
marked as non-chargeable and
can use early media).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 94
 Variable Field Type Valid Values Description

<attribute> MultipleChoice description, accessSIPStatus Additional attributes to include

Code, accessSIPStatusMessage, through the add command.
networkSIPStatusCode,
networkSIPStatusMessage,
q850CauseValue, q850Text,
accessTreatmentAudioFile,
accessTreatmentVideoFile,
networkTreatmentAudioFile,
networkTreatmentVideoFile,
cdrTerminationCause, route
Advance, internalReleaseCause,
accessSendReasonHeader,
networkSendReasonHeader

<description> String 1 to 80 characters This optional field can be used

to provide more detail on this
treatment and its use.

<accessSIP Integer 400 through 699 This is the same as

StatusCode> networkSIPStatusCode but used
when sending a SIP response to
an access device.

<accessSIP String 1 to 50 characters This is the same as

Status networkSIPStatusMessage
Message> but used when sending a SIP
response to an access device.

<networkSIP Integer 400 through 699 This is the status code to use
StatusCode> when sending a SIP response
towards the network (that is,
when the request originated
from a non-BroadWorks user or
device). This value must be in the
4xx, 5xx, or 6xx range.

<networkSIP String 1 to 50 characters This is the message to be

Status appended to the SIP status line
Message> when sending the SIP response
to the network (this text replaces
the default SIP status message).
This is used for SIP status codes
that are unknown to BroadWorks.

<q850Cause Integer 1 through 256 This value can be defined as a

Value> code from 1 to 255. If configured,
it is sent inside the Reason
header. Note that this value must
follow current ISDN cause code
industry standards, since it is
not validated by BroadWorks.
If this value is defined, it is
also included in the CDR in the
q850Cause field. If this value
is omitted, no Q.850 value is
generated in the response and no
q850Cause is present in the CDR
(that is, the Q.850 value is never
automatically proxied).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 95
 Variable Field Type Valid Values Description

<q850Text> String 1 to 50 characters This field is used to append a text

parameter to the Reason header
to explain the Q.850 cause value.

<access String 1 to 256 characters This is the same as

Treatment networkTreatmentAudioFile but
AudioFile> used when releasing a call that
was initiated from an access
device.

<access String 1 to 256 characters This is the same as

Treatment networkTreatmentVideoFile but
VideoFile> used when releasing a call that
was initiated from an access
device.

<network String 1 to 256 characters This is the file name of the .wav
Treatment file to be played to the user
AudioFile> before releasing the call (when
the call was originated from
the network). This file name
must be relative to the localized
system prompts directory, where
current system-defined audio
treatments are located (that
is, files must be copied to that
directory). The file must be in the
proper format (current supported
format is .wav, uLaw, 8kHz, 8 bit,
Mono). This audio file is played
twice, separated by a 10 second
silence. Then the call is released
with the proper treatment (487
SIP response or BYE request
depending on call state). If this
field is omitted or if the field does
not point to a valid audio file
(inexistent file or bad format),
no audio file is played and the
call is released with the proper
SIP response (that is, the system
does not play the file that maps to
the internal release cause).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 96
 Variable Field Type Valid Values Description

<network String 1 to 256 characters This is the file name of the .mov
Treatment file to be played to the user
VideoFile> before releasing the call (when
the call was originated from
the network). This file name
must be relative to the localized
system prompts directory, where
current system-defined audio
treatments are located (that
is, files must be copied to that
directory). The file must be in the
proper format (current supported
formats are .mov, H.264, or
H.263 encoding). This video file
is used only if a video codec
was negotiated on call setup.
It is played twice, separated by
a 10 second silence. Then the
call is released with the proper
treatment (487 SIP response
or BYE request depending on
call state). If this field is omitted,
the audio file defined above is
played (even if a video codec
was negotiated). If the field does
not point to a valid video file
(inexistent file or bad format),
no media file is played and the
call is released with the proper
SIP response (that is, the system
does not play the file that maps to
the internal release cause). Note
that if the audio file is not defined,
the video file is not played either.

<cdr String 1 to 3 characters This is a three-digit string that

Termination indicates the reason why a call
Cause> completed. If this parameter is
set, it is reflected in the CDR.

<route Choice true, false The network routing service is

Advance> designed to go through a list of
contacts and try each destination
one by one. If the first destination
fails, it tries the second one; if
the second fails, it tries the third
one, and so on. This behavior is
called route advancing. Certain
types of faults received from one
of the destinations, stop route
advancing, and release the call.
The routeAdvance parameter
indicates whether or not the
network routing service should
do route advancing. If this flag is
set to "true", the route processing
continues. If this flag is set
to "false", the call is released
immediately.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 97
 Variable Field Type Valid Values Description

<internal Choice busy, forbidden, routingFailure, This parameter is provided to

Release globalFailure, requestFailure,
Cause> serverFailure, translationFailure,
temporarilyUnavailable, userNot
Found, requestTimeout, dialTone
Timeout, insufficientCredits
override the system default
behavior by choosing one of the
(other) existing system-defined
treatments. When this parameter
is set, the internal value for the
release cause is overridden and
the system behaves as if this
release cause had been mapped.
Note that this parameter should
be used carefully, as it could
impact some service behavior
(for example, remapping a BUSY
cause to something different does
not trigger voice mail in the same
way).

<access Choice true, false This is the same as

SendReason networkSendReasonHeader but
Header> used when releasing a call that
was initiated from an access
device. The default value of this
parameter is "false".

<network Choice true, false This boolean value specifies

SendReason whether or not a Reason header
Header> is added to SIP responses or call
terminating requests (CANCEL
and BYE) that are sent toward
the network. If this field is set
to "true", the Reason header
contains the Q.850 value (if
configured). For CANCEL and
BYE requests, if the Q.850 value
is not configured, the Reason
header contains the SIP status
code. The default value of this
parameter is "false".

6.5.14.3.4 set
This command is used to modify Configurable Treatment-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment> level.
2) Enter:
set <treatmentId> <attribute>↵
where:
Variable Field Type Valid Values Description

<treatmentId> String 1 to 40 characters This is a short descriptive string

that identifies the treatment that is
currently being defined. This field
is mandatory.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 98
 Variable Field Type Valid Values Description

<attribute> MultipleChoice chargeIndicator, description, The name of an attribute to

accessSIPStatusCode, modify.
accessSIPStatusMessage,
networkSIPStatusCode,
networkSIPStatusMessage,
q850CauseValue, q850Text,
accessTreatmentAudioFile,
accessTreatmentVideoFile,
networkTreatmentAudioFile,
networkTreatmentVideoFile,
cdrTerminationCause, route
Advance, internalReleaseCause,
accessSendReasonHeader,
networkSendReasonHeader

<charge Choice charge, noCharge This attribute provides the option

Indicator> to remove exception services
(that is, all unanswered calls are
marked as non-chargeable and
can use early media).

<description> String 1 to 80 characters This optional field can be used

to provide more detail on this
treatment and its use.

<accessSIP Integer 400 through 699 This is the same as

StatusCode> networkSIPStatusCode but used
when sending a SIP response to
an access device.

<accessSIP String 1 to 50 characters This is the same as

Status networkSIPStatusMessage
Message> but used when sending a SIP
response to an access device.

<networkSIP Integer 400 through 699 This is the status code to use
StatusCode> when sending a SIP response
towards the network (that is,
when the request originated
from a non-BroadWorks user or
device). This value must be in the
4xx, 5xx, or 6xx range.

<networkSIP String 1 to 50 characters This is the message to be

Status appended to the SIP status line
Message> when sending the SIP response
to the network (this text replaces
the default SIP status message).
This is used for SIP status codes
that are unknown to BroadWorks.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 99
 Variable Field Type Valid Values Description

<q850Cause Integer 1 through 256 If configured, it is sent inside

Value> the Reason header. Note that
this value must follow current
ISDN cause code industry
standards, since it is not validated
by BroadWorks. If this value
is defined, it is also included
in the CDR in the q850Cause
field. If this value is omitted, no
Q.850 value is generated in the
response and no q850Cause
is present in the CDR (that
is, the Q.850 value is never
automatically proxied).

<q850Text> String 1 to 50 characters This field is used to append a text

parameter to the Reason header
to explain the Q.850 cause value.

<access String 1 to 256 characters This is the same as

Treatment networkTreatmentAudioFile but
AudioFile> used when releasing a call that
was initiated from an access
device.

<access String 1 to 256 characters This is the same as

Treatment networkTreatmentVideoFile but
VideoFile> used when releasing a call that
was initiated from an access
device.

<network String 1 to 256 characters The name of the .wav file to

Treatment be played to the user before
AudioFile> releasing a network-originated
call. This file name must be
relative to the localized system
prompts directory, where current
system-defined audio treatments
are located (and the files must
be in that directory). The file
must be in a supported format
(currently: .wav, uLaw, 8kHz,
8 bit, or Mono). It is played
twice, with a 10-second silence
in between. Then the call
is released with the proper
treatment. If this field is omitted
or if the field does not point to a
valid audio file, no audio file is
played and the call is released
with the SIP response (without
playing the file that maps to the
internal release cause).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 100
 Variable Field Type Valid Values Description

<network String 1 to 256 characters The name of the .mov file to

Treatment be played to the user before
VideoFile> releasing a network-originated
call. The file name must be
relative to the localized system
prompts directory, where current
system-defined audio treatments
are located (and the file must
be copied to that directory).
The file must be in the proper
format (currently: .mov, H.264,
or H.263). It is used only if a
video codec was negotiated on
call setup. It is played twice,
separated by a 10 second
silence. Then the call is released
with the proper treatment. If this
field is omitted, the audio file
defined above is played (even if
a video codec was negotiated). If
the field does not point to a valid
video file (inexistent file or bad
format), no media file is played
and the call is released with the
proper SIP response (that is,
the system does not play the file
that maps to the internal release
cause). Note that if the audio file
is not defined, the video file is not
played either.

<cdr String 1 to 3 characters This is a three-digit string that

Termination indicates the reason why a call
Cause> completed. If this parameter is
set, it is reflected in the CDR.

<route Choice true, false The network routing service is

Advance> designed to go through a list of
contacts and try each destination
one by one. If the first destination
fails, it tries the second one; if
the second fails, it tries the third
one, and so on. This behavior is
called route advancing. Certain
types of faults received from one
of the destinations, stop route
advancing, and release the call.
The routeAdvance parameter
indicates whether or not the
network routing service should
do route advancing. If this flag is
set to "true", the route processing
continues. If this flag is set
to "false", the call is released
immediately.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 101
 Variable Field Type Valid Values Description

<internal Choice busy, forbidden, routingFailure, This parameter is provided to

Release globalFailure, requestFailure,
Cause> serverFailure, translationFailure,
temporarilyUnavailable, userNot
Found, requestTimeout, dialTone
Timeout, insufficientCredits
override the system default
behavior by choosing one of the
(other) existing system-defined
treatments. When this parameter
is set, the internal value for the
release cause is overridden and
the system behaves as if this
release cause had been mapped.
Note that this parameter should
be used carefully, as it could
impact some service behavior
(for example, remapping a BUSY
cause to something different does
not trigger voice mail in the same
way).

<access Choice true, false This is the same as

SendReason networkSendReasonHeader but
Header> used when releasing a call that
was initiated from an access
device. The default value of this
parameter is "false".

<network Choice true, false This boolean value specifies

SendReason whether or not a Reason header
Header> is added to SIP responses or call
terminating requests (CANCEL
and BYE) that are sent toward
the network. If this field is set
to "true", the Reason header
contains the Q.850 value (if
configured). For CANCEL and
BYE requests, if the Q.850 value
is not configured, the Reason
header contains the SIP status
code. The default value of this
parameter is "false".

6.5.14.3.5 delete
This command is used to delete an existing Configurable Treatment from the system.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment> level.
2) Enter:
delete <treatmentId>↵
where:
Variable Field Type Valid Values Description

<treatmentId> String 1 to 40 characters The treatmentId ID for the

treatment to be deleted.

6.5.14.3.6 clear
This command is used to clear Configurable Treatment-related attributes.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 102
 clear <treatmentId> <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<treatmentId> String 1 to 40 characters The treatment ID for the

treatment for which an attribute
value is to be cleared.

<clearAttribute> MultipleChoice description, accessSIPStatus The name of the attribute(s) to

Code, accessSIPStatusMessage, clear.
networkSIPStatusCode,
networkSIPStatusMessage,
q850CauseValue, q850Text,
accessTreatmentAudioFile,
accessTreatmentVideoFile,
networkTreatmentAudioFile,
networkTreatmentVideoFile,
cdrTerminationCause, internal
ReleaseCause

6.5.14.3.7 AccessSIPStatusMap
This level is used to view, modify, add and delete Access SIP Status Maps.
6.5.14.3.7.1 get
This command is used to view all existing Access SIP Status Maps.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
AccessSIPStatusMap> level.
2) Enter:
get↵
6.5.14.3.7.2 add
This command is used to add a new Access SIP Status Map.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
AccessSIPStatusMap> level.
2) Enter:
add <sipStatusCode> <treatmentId>↵
where:
Variable Field Type Valid Values Description

<sipStatus Integer 400 through 699 The SIP status code.

Code>

<treatmentId> String 1 to 40 characters The treatment ID.

6.5.14.3.7.3 set
This command is used to modify Access SIP Status Map attributes.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
AccessSIPStatusMap> level.
2) Enter:
set <sipStatusCode> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 103
 Variable Field Type Valid Values Description

<sipStatus Integer 400 through 699 The SIP status code.

Code>

<attribute> MultipleChoice treatmentId The name of an attribute to

modify.

<treatmentId> String 1 to 40 characters The treatment ID.

6.5.14.3.7.4 delete
This command is used to delete an existing Access SIP Status Map entry.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
AccessSIPStatusMap> level.
2) Enter:
delete <sipStatusCode>↵
where:
Variable Field Type Valid Values Description

<sipStatus Integer 400 through 699 The SIP status code.

Code>

6.5.14.3.8 CallBlockingServiceMap
This level is used to view, modify, add and delete Call Blocking Service Maps.
6.5.14.3.8.1 get
This command is used to view all existing Call Blocking Service Maps.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
CallBlockingServiceMap> level.
2) Enter:
get↵
6.5.14.3.8.2 add
This command is used to add a new Call Blocking Service Map.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
CallBlockingServiceMap> level.
2) Enter:
add <callBlockingService> <treatmentId>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 104
 Variable Field Type Valid Values Description

<callBlocking Choice OCP, EOCP, ICP, ACR, SCR, SC
Service> A, AAC, Intercept, PTT, Comm
Barring, SAC, IncomingComm
Barring, HierCommBarring, Incom
HierCommBarring, BWMobility
DenyOrig, BWMobilityDenyTerm,
ETRouteExhaust, CallPark,
NumberPortability
Services that reject calls generate
call release scenarios and create
situations where treatments
must be used. This mapping
allows system providers to define
which treatment is used for which
service. The following services
are supported:Outgoing Calling
Plan (OCP), Enhanced Outgoing
Calling Plan (EOCP), Incoming
Calling Plan (ICP), Anonymous
Call Rejection (ACR), Selective
Call Rejection (SCR), Shared
Call Appearance (SCA), Account/
Authorization Code (AAC),
Intercept (user or group), Push
To Talk (PTT), Communication
Barring (CommBarring), Session
Admission Control (SAC),
Incoming Communication
Barring (IncomingCommBarring),
Hierarchical Communication
Barring(HierCommBarring),
Incoming Hierarchical
Communication
Barring(IncomHierCommBarring),
BroadWorks Mobility
Deny Originations
(BWMobilityDenyOrig),
BroadWorks Mobility
Deny Terminations
(BWMobilityDenyTerm),
Enterprise Trunk Route Exhaust
(ETRouteExhaust), Call Park
(CallPark), Number Portability
(NumberPortability).

<treatmentId> String 1 to 40 characters The treatment ID.

6.5.14.3.8.3 set
This command is used to modify an existing Call Blocking Service Map.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
CallBlockingServiceMap> level.
2) Enter:
set <callBlockingService> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 105
 Variable Field Type Valid Values Description

<callBlocking Choice OCP, EOCP, ICP, ACR, SCR, SC
Service> A, AAC, Intercept, PTT, Comm
Barring, SAC, IncomingComm
Barring, HierCommBarring, Incom
HierCommBarring, BWMobility
DenyOrig, BWMobilityDenyTerm,
ETRouteExhaust, CallPark,
NumberPortability
Services that reject calls generate
call release scenarios and create
situations where treatments
must be used. This mapping
allows system providers to define
which treatment is used for which
service. The following services
are supported: Outgoing Calling
Plan (OCP), Enhanced Outgoing
Calling Plan (EOCP), Incoming
Calling Plan (ICP), Anonymous
Call Rejection (ACR), Selective
Call Rejection (SCR), Shared
Call Appearance (SCA), Account/
Authorization Code (AAC),
Intercept (user or group), Push
To Talk (PTT), Communication
Barring (CommBarring), Session
Admission Control (SAC),
Incoming Communication
Barring (IncomingCommBarring),
Hierarchical Communication
Barring(HierCommBarring),
Incoming Hierarchical
Communication
Barring(IncomHierCommBarring),
Enterprise Trunk Route Exhaust
(ETRouteExhaust), Call Park
(CallPark), Number Portability
(NumberPortability).

<attribute> MultipleChoice treatmentId The name of an attribute to

modify.

<treatmentId> String 1 to 40 characters The treatment ID.

6.5.14.3.8.4 delete
This command is used to delete an existing Call Blocking Service Map.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
CallBlockingServiceMap> level.
2) Enter:
delete <callBlockingService>↵
where:
Variable Field Type Valid Values Description

<callBlocking Choice OCP, EOCP, ICP, ACR, SCR, SC The call blocking service map to
Service> A, AAC, Intercept, PTT, Comm be deleted.
Barring, SAC, IncomingComm
Barring, HierCommBarring, Incom
HierCommBarring, BWMobility
DenyOrig, BWMobilityDenyTerm,
ETRouteExhaust, CallPark,
NumberPortability

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 106
6.5.14.3.9 InternalReleaseCauseMap
This level is used to view, modify, add and delete Internal Release Cause Maps.
6.5.14.3.9.1 get
This command is used to view all existing Internal Release Cause Maps.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
InternalReleaseCauseMap> level.
2) Enter:
get↵
6.5.14.3.9.2 add
This command is used to add a new Internal Release Cause Map.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
InternalReleaseCauseMap> level.
2) Enter:
add <internalReleaseCause> <treatmentId>↵
where:
Variable Field Type Valid Values Description

<internal Choice busy, forbidden, routingFailure, This parameter is provided to

Release globalFailure, requestFailure,
Cause> serverFailure, translationFailure,
temporarilyUnavailable, userNot
Found, requestTimeout, dialTone
Timeout, insufficientCredits
override the system default
behavior by choosing one of the
(other) existing system-defined
treatments. When this parameter
is set, the internal value for the
release cause is overridden and
the system behaves as if this
release cause had been mapped.
Note that this parameter should
be used carefully, as it could
impact some service behavior
(for example, remapping a BUSY
cause to something different does
not trigger voice mail in the same
way).

<treatmentId> String 1 to 40 characters The treatment ID.

6.5.14.3.9.3 set
This command is used to modify an Internal Release Cause Map.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
InternalReleaseCauseMap> level.
2) Enter:
set <internalReleaseCause> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 107
 Variable Field Type Valid Values Description

<internal Choice busy, forbidden, routingFailure, This parameter is provided to

Release globalFailure, requestFailure,
Cause> serverFailure, translationFailure,
temporarilyUnavailable, userNot
Found, requestTimeout, dialTone
Timeout, insufficientCredits
override the system default
behavior by choosing one of the
(other) existing system-defined
treatments. When this parameter
is set, the internal value for the
release cause is overridden and
the system behaves as if this
release cause had been mapped.
Note that this parameter should
be used carefully, as it could
impact some service behavior
(for example, remapping a BUSY
cause to something different does
not trigger voice mail in the same
way).

<attribute> MultipleChoice treatmentId The name of an attribute to

modify.

<treatmentId> String 1 to 40 characters The treatment ID.

6.5.14.3.9.4 delete
This command is used to delete an existing Internal Release Cause Map.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
InternalReleaseCauseMap> level.
2) Enter:
delete <internalReleaseCause>↵
where:
Variable Field Type Valid Values Description

<internal Choice busy, forbidden, routingFailure, The internal release cause map
Release globalFailure, requestFailure, to be deleted.
Cause> serverFailure, translationFailure,
temporarilyUnavailable, userNot
Found, requestTimeout, dialTone
Timeout, insufficientCredits

6.5.14.3.10 NSTreatmentMap
This level is used to map Network Server defined treatments to treatments on the Application Server. It is
used to view, add, modify, and delete NS Treatment Map entries.
6.5.14.3.10.1 get
This command is used to view all existing NS Treatment Maps.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
NSTreatmentMap> level.
2) Enter:
get↵
6.5.14.3.10.2 add
This command is used to add a new NS Treatment Map.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
NSTreatmentMap> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 108
 2) Enter:
add <nsTreatment> <treatmentId>↵
where:
Variable Field Type Valid Values Description

<nsTreatment> String 1 to 8 characters The ID of Network Server

treatment to be mapped.

<treatmentId> String 1 to 40 characters The ID to be assigned to this

treatment on the Application
Server.

6.5.14.3.10.3 set
This command is used to modify an NS Treatment Map.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
NSTreatmentMap> level.
2) Enter:
set <nsTreatment> <attribute>↵
where:
Variable Field Type Valid Values Description

<nsTreatment> String 1 to 8 characters The Network Server treatment ID.

<attribute> MultipleChoice treatmentId The name of an attribute to

modify.

<treatmentId> String 1 to 40 characters The ID to be assigned to this

treatment on the Application
Server.

6.5.14.3.10.4 delete
This command is used to delete an existing NS Treatment Map.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
NSTreatmentMap> level.
2) Enter:
delete <nsTreatment>↵
where:
Variable Field Type Valid Values Description

<nsTreatment> String 1 to 8 characters The Network Server treatment ID.

6.5.14.3.11 NetworkSIPStatusMap
This level is used to configure SIP status codes to treatments for the network side independently from the
access side. It is used to view, add, modify, and delete NetworkSIPStatusMap entries.
6.5.14.3.11.1 get
This command is used to view all existing Network SIP Status Maps.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
NetworkSIPStatusMap> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 109
 get↵
6.5.14.3.11.2 add
This command is used to add a new Network SIP Status Map.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
NetworkSIPStatusMap> level.
2) Enter:
add <sipStatusCode> <treatmentId>↵
where:
Variable Field Type Valid Values Description

<sipStatus Integer 400 through 699 The SIP status code to be

Code> mapped.

<treatmentId> String 1 to 40 characters The treatment identification on

the Application Server.

6.5.14.3.11.3 set
This command is used to modify a Network SIP Status Map.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
NetworkSIPStatusMap> level.
2) Enter:
set <sipStatusCode> <attribute>↵
where:
Variable Field Type Valid Values Description

<sipStatus Integer 400 through 699 The SIP status code.

Code>

<attribute> MultipleChoice treatmentId The name of an attribute to

modify.

<treatmentId> String 1 to 40 characters The treatment ID on the

Application Server.

6.5.14.3.11.4 delete
This command is used to delete an existing Network SIP Status Map.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
NetworkSIPStatusMap> level.
2) Enter:
delete <sipStatusCode>↵
where:
Variable Field Type Valid Values Description

<sipStatus Integer 400 through 699 The SIP status code.

Code>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 110
6.5.14.3.12 Q850CauseMap
This level is used to configure the mapping of Q.850 cause values to treatments (If such a Q.850 value is
present, it supersedes the SIP status code when computing the treatment to use.) It is used to view, add,
modify, and delete Q850CauseMap entries.
6.5.14.3.12.1 get
This command is used to view all existing Q850 Cause Maps.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
Q850CauseMap> level.
2) Enter:
get↵
6.5.14.3.12.2 add
This command is used to add a new Q850 Cause Map.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
Q850CauseMap> level.
2) Enter:
add <q850CauseValue> <treatmentId>↵
where:
Variable Field Type Valid Values Description

<q850Cause Integer 1 through 256 The Q850 cause value to be

Value> mapped.

<treatmentId> String 1 to 40 characters The treatment ID on the

Application Server.

6.5.14.3.12.3 set
This command is used to modify a Q850 Cause Map.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
Q850CauseMap> level.
2) Enter:
set <q850CauseValue> <attribute>↵
where:
Variable Field Type Valid Values Description

<q850Cause Integer 1 through 256 The Q850 cause value to be

Value> mapped.

<attribute> MultipleChoice treatmentId The name of an attribute to

modify.

<treatmentId> String 1 to 40 characters The treatment ID on the

Application Server.

6.5.14.3.12.4 delete
This command is used to delete an existing Q850 Cause Map.
1) Ensure you are at the /AS_CLI/System/CallP/Treatment/ConfigurableTreatment/
Q850CauseMap> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 111
 delete <q850CauseValue>↵
where:
Variable Field Type Valid Values Description

<q850Cause Integer 1 through 256 The Q850 cause mapping to be

Value> deleted.

6.5.15 VirtualOnNetCallTypes
This level is used to manage the Call Types for the VirtualOnNet service.

6.5.15.1 get
This command is used to view VirutalOnNet Call Types-related entries.
1) Ensure you are at the /AS_CLI/System/CallP/VirtualOnNetCallTypes> level.
2) Enter:
get↵

6.5.15.2 add
This command is used to add new VirutalOnNet Call Types entries.
1) Ensure you are at the /AS_CLI/System/CallP/VirtualOnNetCallTypes> level.
2) Enter:
add <name> <cdrValue>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters The virtual on net call type's

name.

<cdrValue> String 1 to 6 characters The virtual on net call type's CDR

value, used for billing purposes.

6.5.15.3 set
This command is used to modify VirutalOnNet Call Types-related entries.
1) Ensure you are at the /AS_CLI/System/CallP/VirtualOnNetCallTypes> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters The virtual on net call type's

name.

<attribute> MultipleChoice cdrValue The name of an attribute to

modify.

<cdrValue> String 1 to 6 characters The virtual on net call type's CDR

value, used for billing purposes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 112
6.5.15.4 delete
This command is used to remove VirutalOnNet Call Types-related entries.
1) Ensure you are at the /AS_CLI/System/CallP/VirtualOnNetCallTypes> level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters The virtual on net call type's

name.

6.6 Carrier
This level is used to view, add, delete, or modify Preferred Inter-exchange Carriers (PICs) in the
Application Server.

6.6.1 get
This command is used to view carrier-related attributes.
1) Ensure you are at the /AS_CLI/System/Carrier> level.
2) Enter:
get [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice carrier, countryCode, cic, isIntra The name of an attribute to filter
Lata, isInterLata, isInternational on.

<carrier> String 1 to 80 characters The name of the carrier.

<countryCode> Digit String 1 to 3 digits The number representing the

country where the carrier is
located.

<cic> Digit String 2 to 6 digits Represents the Carrier

Identification Code (CIC), which is
unique for each country code.

<isIntraLata> Choice true, false Specifies if the carrier can be

used to transport intra-LATA
calls.

<isInterLata> Choice true, false Specifies if the carrier can be

used to transport inter-LATA
calls.

<is Choice true, false Specifies if the carrier can be

International> used to transport international
calls.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 113
6.6.2 add
This command is used to add a new carrier to the system.
1) Ensure you are at the /AS_CLI/System/Carrier> level.
2) Enter:
add <carrier> <countryCode> <cic> <isIntraLata> <isInterLata> <isInternational>↵
where:
Variable Field Type Valid Values Description

<carrier> String 1 to 80 characters The name of the carrier.

<countryCode> Digit String 1 to 3 digits The number representing the

country where the carrier is
located.

<cic> Digit String 2 to 6 digits Represents the Carrier

Identification Code (CIC), which is
unique for each country code.

<isIntraLata> Choice true, false Specifies if the carrier can be

used to transport intra-LATA
calls.

<isInterLata> Choice true, false Specifies if the carrier can be

used to transport inter-LATA
calls.

<is Choice true, false Specifies if the carrier can be

International> used to transport international
calls.

6.6.3 set
This command is used to modify carrier-related attributes.
1) Ensure you are at the /AS_CLI/System/Carrier> level.
2) Enter:
set <carrier> <attribute>↵
where:
Variable Field Type Valid Values Description

<carrier> String 1 to 80 characters The name of the carrier.

<attribute> MultipleChoice countryCode, cic, isIntraLata, is The name of an attribute to

InterLata, isInternational modify.

<countryCode> Digit String 1 to 3 digits The number representing the

country where the carrier is
located.

<cic> Digit String 2 to 6 digits Represents the Carrier

Identification Code (CIC), which is
unique for each country code.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 114
 Variable Field Type Valid Values Description

<isIntraLata> Choice true, false Specifies if the carrier can be

used to transport intra-LATA
calls.

<isInterLata> Choice true, false Specifies if the carrier can be

used to transport inter-LATA
calls.

<is Choice true, false Specifies if the carrier can be

International> used to transport international
calls.

6.6.4 delete
This command is used to delete an existing carrier from the system.
1) Ensure you are at the /AS_CLI/System/Carrier> level.
2) Enter:
delete <carrier>↵
where:
Variable Field Type Valid Values Description

<carrier> String 1 to 80 characters The name of the carrier.

6.7 ClientApplications
This level is used to view and modify Client Applications attributes on the Application Server. The
commands at this level are used to manage the Java Web Start file signing certificate. Note that file signing
applies only to the Receptionist and Call Center applications.

6.7.1 get
This command is used to view the file-signing attributes.
1) Ensure you are at the /AS_CLI/System/ClientApplications> level.
2) Enter:
get↵

6.7.2 set
This command is used to modify the file-signing attributes.
1) Ensure you are at the /AS_CLI/System/ClientApplications> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice fileSignature The name of an attribute to

modify.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 115
 Variable Field Type Valid Values Description

<fileSignature> Choice BroadSoft, Custom Identifies the file signature is

either a BroadSoft one or is a
custom one.

6.7.3 genKey
This command is used to generate a certificate signing request (CSR). The generated request is written to
the /var/broadworks/tmp/req.csr directory.
1) Ensure you are at the /AS_CLI/System/ClientApplications> level.
2) Enter:
genKey <commonName> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<common String 1 to 255 characters The common name.

Name>

<attribute> MultipleChoice country, stateOrProvince, city, The name of an optional attribute.

organisationName, organisation
Unit

<country> String 2 to 2 characters The country code.

<stateOr String 1 to 50 characters The state or province.

Province>

<city> String 1 to 50 characters The name of the city.

<organisation String 1 to 50 characters The name of the organization.

Name>

<organisation String 1 to 50 characters The name of organization unit.

Unit>

6.7.4 import
This command is used to load and update certificates. The certificate file is taken from the specified path,
which is used to sign the application files when fileSignature is set to "custom".
1) Ensure you are at the /AS_CLI/System/ClientApplications> level.
2) Enter:
import <certificateFile> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<certificateFile> String 1 to 255 characters The file name and path for the
certificate file.

<attribute> MultipleChoice chainFile The name of an optional attribute.

<chainFile> String 1 to 255 characters The file name for the certificate
chain file.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 116
6.8 ClientSession
This level is used to modify parameters related to the active web and command line interface sessions for
administrators and users.

6.8.1 InactivityTimer
This level is used to view and modify the inactivity timers for active web and command line interface
sessions. After a designated period of inactivity, for example, users are automatically logged out of active
sessions.

6.8.1.1 get
This command displays the length of time CLI and web sessions are permitted to remain open without
activity.
1) Ensure you are at the /AS_CLI/System/ClientSession/InactivityTimer> level.
2) Enter:
get↵

6.8.1.2 set
This command allows modification of the inactivity timers for web and CLI sessions.
1) Ensure you are at the /AS_CLI/System/ClientSession/InactivityTimer> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice active, timeoutInMinutes The name of an attribute to

modify.

<active> Choice true, false Indicates that the timer is set or

not. The default value is true.

<timeoutIn Integer 10 through 360 The length of time, in minutes,

Minutes> that an inactive web or CLI
session can be open without
activity. When limit is reached,
the user is automatically logged
out. The default value is 10
minutes.

6.8.2 ServerAddresses
This level is used to view and modify ServerAddresses-related attributes. This level is used to manage
the Fully Qualified Domain Names (FQDNs) for an Application Server cluster. These attributes are used
to configure the public and private FQDNs for the primary and secondary Application Servers in a cluster
when there is no Network Server. If a Network Server is used, then these parameters should not be
configured. The default value is blank for these parameters (that is, they are not set).

6.8.2.1 get
This command allows you to view ServerAddresses-related attributes.
1) Ensure you are at the /AS_CLI/System/ClientSession/ServerAddresses> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 117
 get↵

6.8.2.2 set
This command allows you to modify ServerAddresses-related attributes.
1) Ensure you are at the /AS_CLI/System/ClientSession/ServerAddresses> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice publicClusterFQDN, primary The name of an attribute to

PublicFQDN, secondary modify.
PublicFQDN, primaryPrivateFQD
N, secondaryPrivateFQDN

<public String 1 to 80 characters The IP address, host name,

ClusterFQDN> or domain name for the public
cluster FQDN.

<primary String 1 to 80 characters The IP address, host name,

PublicFQDN> or domain name for the public
FQDN for the primary Application
Server.

<secondary String 1 to 80 characters The IP address, host name,

PublicFQDN> or domain name for the public
FQDN for the secondary
Application Server.

<primary String 1 to 80 characters The IP address, host name, or

PrivateFQDN> domain name for the private
FQDN for the primary Application
Server.

<secondary String 1 to 80 characters The IP address, host name, or

PrivateFQDN> domain name for the private
FQDN for the secondary
Application Server.

6.8.2.3 clear
This command allows you to clear Server Addresses-related attributes.
1) Ensure you are at the /AS_CLI/System/ClientSession/ServerAddresses> level.
2) Enter:
clear <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<clearAttribute> MultipleChoice publicClusterFQDN, primary The name of the attribute(s) to

PublicFQDN, secondary clear.
PublicFQDN, primaryPrivateFQD
N, secondaryPrivateFQDN

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 118
6.9 CommunicationUtility
This level is used to view and modify the communication utility attributes.

6.9.1 DefaultSettings
This level is used to view and modify communication utility default settings.

6.9.1.1 get
This command is used to modify BroadWorks communication utility attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings> level.
2) Enter:
get↵

6.9.1.2 set
This command is used to modify BroadWorks communication utility attributes. The mode attribute (AS or
NS) refers to the integration scheme used to integrate with the Application Server clusters. In Network
Server (NS) mode, Network Server lookups are used to dynamically resolve the Application Server
clusters. The Application Server (AS) mode allows direct integration with a single Application Server
cluster. The transaction limit rates are computed as follows: *Global - globalTransactionLimit divided by the
transactionLimitPeriodSecs *per User - userTransactionLimit divided by the transactionLimitPeriodSecs
Note that all Application Server clusters must use the same OCI port when using the Network Server (NS)
mode. ++++noFor your changes to take effect, you must restart the system.++++nc
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice mode, provisionOnSecondary, Attribute to modify.

reconnectionTimerSecs,
responseTimeoutSecs, user
TransactionLimit, transactionLimit
PeriodSecs, useSecureBCCT

<mode> Choice AS, NS Select the mode, which is either

AS for an Application Server or
NS for a Network Server. The
attributes applicable to each
mode is shown below.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 119
 Variable Field Type Valid Values Description

Variable: AS

AS The CommunicationUtility
operating in AS mode.

<asPrimary String 1 to 80 characters The primary Application Server's

Address> IP address, host, or domain.

<attribute> MultipleChoice asSecondaryAddress, asOCIPort, Attribute to modify.

asOCISecurePort, asOCICPort,
asOCICSecurePort

<asSecondary String 1 to 80 characters The secondary Application

Address> Server's IP address, host, or
domain.

<asOCIPort> Integer 1024 through 65535 Aplication Server OCI-P (to the
Provisioning Server process)
plain tcp/ip listening port.

<asOCISecure Integer 1024 through 65535 Aplication Server OCI-P (to the
Port> Provisioning Server process)
plain secure tcp/ip listening port.

<asOCICPort> Integer 1024 through 65535 Aplication Server OCI-C (to the
eXecution Server process) plain
tcp/ip listening port.

<asOCIC Integer 1024 through 65535 Aplication Server OCI-C (to the
SecurePort> eXecution Server process) plain
secure tcp/ip listening port.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 120
 Variable Field Type Valid Values Description

Variable: NS

NS The CommunicationUtility
operating in NS mode.

<nsSeed String 1 to 80 characters The Network Server's IP address,

Cluster host, or domain.
Address>

<attribute> MultipleChoice asOCIPort, asOCISecurePort, Attribute to modify.

asOCICPort, asOCICSecurePort,
locationApiTimeoutSecs, enable
SrvLookup

<asOCIPort> Integer 1024 through 65535 Aplication Server OCI-P (to the
Provisioning Server process)
plain tcp/ip listening port.

<asOCISecure Integer 1024 through 65535 Aplication Server OCI-P (to the
Port> Provisioning Server process)
plain secure tcp/ip listening port.

<asOCICPort> Integer 1024 through 65535 Aplication Server OCI-C (to the
eXecution Server process) plain
tcp/ip listening port.

<asOCIC Integer 1024 through 65535 Aplication Server OCI-C (to the
SecurePort> eXecution Server process) plain
secure tcp/ip listening port.

<locationApi Integer 1 through 10 Sets the Location API response

TimeoutSecs> time-out (in seconds).

<enableSrv Choice true, false Enables or disable SRV lookup

Lookup> for NS location API requests.

<provisionOn Choice true, false Allows or disallows provisioning

Secondary> on the secondary Application
Server.

<reconnection Integer 1 through 300 Sets the reconnection timer (in

TimerSecs> seconds).

<response Integer 1 through 60 Sets the response timeout (in

TimeoutSecs> seconds).

<user Integer 1 through 65535 Sets the user transaction limit.

Transaction
Limit>

<transaction Integer 1 through 300 Sets the transaction limit period

LimitPeriod (in seconds).
Secs>

<use Choice true, false Sets if secure BCCT is used.

SecureBCCT>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 121
6.9.1.3 Executors
This level is used to view and modify the communication utility executors.
6.9.1.3.1 OCIC
This level is used to view and modify the Open Client Interface-Call Control (OCI-C) executor.
6.9.1.3.1.1 Queue
This level is used to view and modify the queue settings.
6.9.1.3.1.1.1 get
This command is used to view the queue settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIC/Queue> level.
2) Enter:
get↵
6.9.1.3.1.1.2 set
The command is used to modify the queue settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIC/Queue> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice capacity The name of an attribute to

modify.

<capacity> Integer 0 through 2147483647 This parameter specifies the

maximum queue capacity. Tasks
are queued while waiting for
an available thread. When the
value is left unspecified (cleared),
queuing is unlimited: tasks are
queued as long as there is
enough memory available.

6.9.1.3.1.1.3 clear
This command is used to clear (set to no value) the queue settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIC/Queue> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice capacity The name of the attribute(s) to

clear.

6.9.1.3.1.1.4 LatencyThreshold
This level is used to view and modify latency threshold settings.
6.9.1.3.1.1.4.1 get
This command is used to view the latency threshold settings.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 122
 1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIC/Queue/LatencyThreshold> level.
2) Enter:
get↵
6.9.1.3.1.1.4.2 set
The command is used to modify the latency threshold settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIC/Queue/LatencyThreshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 1 through 2147483647 This parameter specifies a value

(in milliseconds) for enabling a
threshold crossing.

<resetValue> Integer 1 through 2147483647 This parameter specifies a value

(in milliseconds) for clearing a
threshold crossing.

6.9.1.3.1.1.5 SizeThreshold
This level is used to view and modify the size threshold settings.
6.9.1.3.1.1.5.1 get
This command is used to view the size threshold settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIC/Queue/SizeThreshold> level.
2) Enter:
get↵
6.9.1.3.1.1.5.2 set
The command is used to modify the size threshold settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIC/Queue/SizeThreshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 123
 Variable Field Type Valid Values Description

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 0 through 100 This parameter specifies a value

for enabling a threshold crossing.

<resetValue> Integer 0 through 100 This parameter specifies a value

for clearing a threshold crossing.

6.9.1.3.1.2 ThreadPool
This level is used to view and modify the thread pool settings.
6.9.1.3.1.2.1 get
This command is used to view the thread pool settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIC/ThreadPool> level.
2) Enter:
get↵
6.9.1.3.1.2.2 set
The command is used to modify the thread pool settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIC/ThreadPool> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice min, max, keepAliveTime The name of an attribute to

modify.

<min> Integer 1 through 10000 This parameter specifies the

minimum number of threads
to keep in steady state. Lower
thread counts are possible during
initialization.

<max> Integer 1 through 10000 This parameter specifies the

maximum number of threads this
pool contains.

<keepAlive Integer 1 through 3600 This parameter specifies the

Time> amount of idle time before an
excess thread is terminated (in
seconds).

6.9.1.3.1.2.3 ProcessingTimeThreshold
This level is used to view and modify processing time threshold settings.
6.9.1.3.1.2.3.1 get
This command is used to view the processing time threshold settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIC/ThreadPool/ProcessingTimeThreshold> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 124
 2) Enter:
get↵
6.9.1.3.1.2.3.2 set
The command is used to modify processing time threshold settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIC/ThreadPool/ProcessingTimeThreshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 1 through 2147483647 This parameter specifies a value

(in milliseconds) for enabling a
threshold crossing.

<resetValue> Integer 1 through 2147483647 This parameter specifies a value

(in milliseconds) for clearing a
threshold crossing.

6.9.1.3.1.2.4 UsageThreshold
This level is used to view and modify usage threshold settings.
6.9.1.3.1.2.4.1 get
This command is used to view the usage threshold settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIC/ThreadPool/UsageThreshold> level.
2) Enter:
get↵
6.9.1.3.1.2.4.2 set
The command is used to modify the usage threshold settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIC/ThreadPool/UsageThreshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 125
 Variable Field Type Valid Values Description

<armValue> Integer 0 through 100 This parameter specifies a value

for enabling a threshold crossing.

<resetValue> Integer 0 through 100 This parameter specifies a value

for clearing a threshold crossing.

6.9.1.3.2 OCIP
This level is used to view and modify the Open Client Interface-Provisioning (OCI-P) executor.
6.9.1.3.2.1 Queue
This level is used to view and modify the Open Client Interface-Provisioning (OCI-P) queue settings.
6.9.1.3.2.1.1 get
This command is used to view the Open Client Interface-Provisioning (OCI-P) queue settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIP/Queue> level.
2) Enter:
get↵
6.9.1.3.2.1.2 set
The command is used to modify the Open Client Interface-Provisioning (OCI-P) queue settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIP/Queue> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice capacity The name of an attribute to

modify.

<capacity> Integer 0 through 2147483647 This parameter specifies the

maximum queue capacity. Tasks
are queued while waiting for
an available thread. When the
value is left unspecified (cleared),
queuing is unlimited: tasks are
queued as long as there is
enough memory available.

6.9.1.3.2.1.3 clear
This command is used to clear (set to no value) the Open Client Interface-Provisioning (OCI-P) queue
settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIP/Queue> level.
2) Enter:
clear <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 126
 Variable Field Type Valid Values Description

<attribute> MultipleChoice capacity The name of the attribute(s) to

clear.

6.9.1.3.2.1.4 LatencyThreshold
This level is used to view and modify latency threshold settings.
6.9.1.3.2.1.4.1 get
This command is used to view the latency threshold settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIP/Queue/LatencyThreshold> level.
2) Enter:
get↵
6.9.1.3.2.1.4.2 set
The command is used to modify the latency threshold settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIP/Queue/LatencyThreshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 1 through 2147483647 This parameter specifies a value

(in milliseconds) for enabling a
threshold crossing.

<resetValue> Integer 1 through 2147483647 This parameter specifies a value

(in milliseconds) for clearing a
threshold crossing.

6.9.1.3.2.1.5 SizeThreshold
This level is used to view and modify the size threshold settings.
6.9.1.3.2.1.5.1 get
This command is used to view the size threshold settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIP/Queue/SizeThreshold> level.
2) Enter:
get↵
6.9.1.3.2.1.5.2 set
The command is used to modify the size threshold settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIP/Queue/SizeThreshold> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 127
 set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 0 through 100 This parameter specifies a value

for enabling a threshold crossing.

<resetValue> Integer 0 through 100 This parameter specifies a value

for clearing a threshold crossing.

6.9.1.3.2.2 ThreadPool
This level is used to view and modify the thread pool settings.
6.9.1.3.2.2.1 get
This command is used to view ThreadPool settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIP/ThreadPool> level.
2) Enter:
get↵
6.9.1.3.2.2.2 set
The command is used to modify ThreadPool settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIP/ThreadPool> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice min, max, keepAliveTime The name of an attribute to

modify.

<min> Integer 1 through 10000 This parameter specifies the

minimum number of threads
to keep in steady state. Lower
thread counts are possible during
initialization.

<max> Integer 1 through 10000 This parameter specifies the

maximum number of threads this
pool contains.

<keepAlive Integer 1 through 3600 This parameter specifies the

Time> amount of idle time before an
excess thread is terminated (in
seconds).

6.9.1.3.2.2.3 ProcessingTimeThreshold

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 128
 This level is used to view and modify the processing time threshold settings.
6.9.1.3.2.2.3.1 get
This command is used to view the processing time threshold settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIP/ThreadPool/ProcessingTimeThreshold> level.
2) Enter:
get↵
6.9.1.3.2.2.3.2 set
The command is used to modify the processing time threshold settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIP/ThreadPool/ProcessingTimeThreshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 1 through 2147483647 This parameter specifies a value

(in milliseconds) for enabling a
threshold crossing.

<resetValue> Integer 1 through 2147483647 This parameter specifies a value

(in milliseconds) for clearing a
threshold crossing.

6.9.1.3.2.2.4 UsageThreshold
This level is used to view and modify the usage threshold settings.
6.9.1.3.2.2.4.1 get
This command is used to view the usage threshold settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIP/ThreadPool/UsageThreshold> level.
2) Enter:
get↵
6.9.1.3.2.2.4.2 set
The command is used to modify the usage threshold settings.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
Executors/OCIP/ThreadPool/UsageThreshold> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 129
 Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 0 through 100 This parameter specifies a value

for enabling a threshold crossing.

<resetValue> Integer 0 through 100 This parameter specifies a value

for clearing a threshold crossing.

6.9.1.4 ExternalAuthentication
This level is used to view and modify the external authentication settings.
6.9.1.4.1 get
This command is used to view the external authentication-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication> level.
2) Enter:
get↵
6.9.1.4.2 set
This command is used to modify the external authentication-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice authenticationType, timeout The name of an attribute to

modify.

<authentication Choice was, radius, ldap, kerberos5 This parameter identifies

Type> the type to perform external
authentication. The mechanism is
disabled when nil, or left blank.

<timeout> Integer 5 through 120 This parameter specifies the

time-out (in seconds) for external
authentication.

6.9.1.4.3 clear
This command is used to clear the external authentication-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication> level.
2) Enter:
clear <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 130
 Variable Field Type Valid Values Description

<attribute> MultipleChoice authenticationType The name of an attribute to

modify.

6.9.1.4.4 EmbeddedAgent
This level is used to view and modify the embedded agent settings.
6.9.1.4.4.1 get
This command is used to view the embedded agent-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/EmbeddedAgent> level.
2) Enter:
get↵
6.9.1.4.4.2 set
This command is used to modify the embedded agent-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/EmbeddedAgent> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enable The name of an attribute to

modify.

<enable> Choice true, false This parameter controls

authentication without credentials.

6.9.1.4.5 HealthCheck
This level is used to view and modify the Health Check settings.
6.9.1.4.5.1 get
This command is used to view the Health Check-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/HealthCheck> level.
2) Enter:
get↵
6.9.1.4.5.2 set
This command is used to modify the Health Check-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/HealthCheck> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 131
 Variable Field Type Valid Values Description

<attribute> MultipleChoice healthCheckInterval, username The name of an attribute to

modify.

<healthCheck Integer 1 through 3600 This parameters specifies

Interval> the health chech interval (in
seconds). The mechanism is
disabled when nil, or left blank.

<username> String 1 to 256 characters This parameter specifies the

username used by the health
check mechanism. However,
when the selected authentication
server does specify client
authentication data (for exemple,
with Lightweight Directory Access
Protocol (LDAP) simple), this
parameter is ignored.

6.9.1.4.5.3 clear
This command is used to clear the Health Check-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/HealthCheck> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice healthCheckInterval The name of an attribute to

modify.

6.9.1.4.6 Kerberos5
This level is used to view and modify the Kerberos5 settings.
6.9.1.4.6.1 get
This command is used to view the Kerberos5-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/Kerberos5> level.
2) Enter:
get↵
6.9.1.4.6.2 set
This command is used to modify the Kerberos5-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/Kerberos5> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 132
 Variable Field Type Valid Values Description

<attribute> MultipleChoice configurablePrincipal, default The name of an attribute to

Realm, defaultDomain, modify.
kerberos5KDC, serverPort, ticket
Timeout

<configurable String 1 to 256 characters This parameter specifies the

Principal> configurable principal. It is
defined as a string in which {0}
is substituted with the username.
A nil value implies {0}. The
username is defined as follows:
- In the case of kerberos version
5 as a BroadWorks ext.auth,
{0}:=BWPrincipal. (The K5
principal is the BroadWorks
principal.)
- In the case of Lightweight
Directory Access Protocol
(LDAP)/kerberos version 5 in
direct mode (although not really
needed), {0}:=BWPrincipal. (The
K5 principal is the BroadWorks
principal.)
- In the case of LDAP/kerberos
version 5 in indirect mode, {0}
is the username obtained from
the LDAP search, that is, the
same as {0} used in the LDAP
userPattern.

<defaultRealm> String 1 to 256 characters This parameter specifies the

default kerberos realm.

<default String 1 to 256 characters This parameter specifies the

Domain> default kerberos domain.

<kerberos5KDC> String 1 to 80 characters This parameter specifies the

location of the Kerberos Key
Distribution Center (KDC)
location.

<serverPort> Integer 0 through 65535 This parameter specifies the

Kerberos Key Distribution Center
(KDC) listening port.

<ticket Integer 5 through 120 This parameter specifies the

Timeout> time-out (in seconds) when
communicating with the Kerberos
Key Distribution Center (KDC).

6.9.1.4.6.3 clear
This command is used to clear the Kerberos5-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/Kerberos5> level.
2) Enter:
clear <attribute>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 133
 where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice configurablePrincipal, default The name of an attribute to

Realm, defaultDomain, modify.
kerberos5KDC

6.9.1.4.7 LDAP
This level is used to view and modify the Lightweight Directory Access Protocol (LDAP) settings.
6.9.1.4.7.1 get
This command is used to view the Lightweight Directory Access Protocol (LDAP)-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/LDAP> level.
2) Enter:
get↵
6.9.1.4.7.2 set
This command is used to modify the Lightweight Directory Access Protocol (LDAP)-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/LDAP> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice url, version, security The name of an attribute to

Authentication modify.

<url> String 1 to 255 characters This parameter specifies the

Uniform Resource Locator (URL)
of the external Lightweight
Directory Access Protocol (LDAP)
server. For connecting to the
default unsecure ldap port (389)
at broadsoft.com, you can set
the URL to ldap://broadsoft.com.
For connecting to the default
secure port (636), you can set
the URL to ldaps://broadsoft.com.
Otherwise, you must specify
the port (for example, ldap://
broadsoft.com:4321).

<version> Choice 2, 3 This parameter specifies the

Lightweight Directory Access
Protocol (LDAP) version to be
used when connecting to the
LDAP server.

<security Choice anonymous, simple, SASL This parameter specifies the

Authentication> Lightweight Directory Access
Protocol (LDAP) security
authentication.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 134
6.9.1.4.7.3 clear
This command is used to clear the Lightweight Directory Access Protocol (LDAP)-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/LDAP> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice url The name of an attribute to

modify.

6.9.1.4.7.4 SASL
This level is used to view and modify the Simple Authentication and Security Layer (SASL) settings.
6.9.1.4.7.4.1 get
This command is used to view the Simple Authentication and Security Layer (SASL)-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/LDAP/SASL> level.
2) Enter:
get↵
6.9.1.4.7.4.2 set
This command is used to modify the Simple Authentication and Security Layer (SASL)-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/LDAP/SASL> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice mechanismName, principal, The name of an attribute to

credentials modify.

<mechanism Choice KERBEROS5, DIGEST-MD5 This parameter specifies

Name> the name of the Simple
Authentication and Security Layer
(SASL) mechanism to use when
connecting to the Lightweight
Directory Access Protocol (LDAP)
server.

<principal> String 1 to 256 characters This parameter specifies the

principal to connect to the
Lightweight Directory Access
Protocol (LDAP) server when
a Simple Authentication
and Security Layer (SASL)
mechanism is used.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 135
 Variable Field Type Valid Values Description

<credentials> Password 1 to 128 characters This parameter specifies

(prompted) the credentials to connect
to the Lightweight Directory
Access Protocol (LDAP) server
when a Simple Authentication
and Security Layer (SASL)
mechanism is used.

6.9.1.4.7.4.3 clear
This command is used to clear the Simple Authentication and Security Layer (SASL)-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/LDAP/SASL> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice principal, credentials The name of an attribute to

modify.

6.9.1.4.7.4.4 Digest-MD5
This level is used to view and modify the Digest-MD5 settings.
6.9.1.4.7.4.4.1 get
This command is used to view the Digest-MD5-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/LDAP/SASL/Digest-MD5> level.
2) Enter:
get↵
6.9.1.4.7.4.4.2 set
This command is used to modify the Digest-MD5-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/LDAP/SASL/Digest-MD5> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice realm The name of an attribute to

modify.

<realm> String 1 to 256 characters This parameter specifies the

DIGEST-MD5 realm.

6.9.1.4.7.4.4.3 clear
This command is used to clear the Digest-MD5-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/LDAP/SASL/Digest-MD5> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 136
 2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice realm The name of an attribute to

modify.

6.9.1.4.7.4.5 Kerberos5
This level is used to view and modify the Kerberos5 settings.
6.9.1.4.7.4.5.1 get
This command is used to view the Kerberos5-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/LDAP/SASL/Kerberos5> level.
2) Enter:
get↵
6.9.1.4.7.4.5.2 set
This command is used to modify the Kerberos5-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/LDAP/SASL/Kerberos5> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice configurablePrincipal, default The name of an attribute to

Realm, defaultDomain, modify.
kerberos5KDC, serverPort, ticket
Timeout

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 137
 Variable Field Type Valid Values Description

<configurable String 1 to 256 characters This parameter specifies the

Principal> configurable principal. It is
defined as a string in which {0}
is substituted with the username.
A nil value implies {0}. The
username is defined as follows:
- In the case of kerberos version
5 as a BroadWorks ext.auth,
{0}:=BWPrincipal. (The K5
principal is the BroadWorks
principal.)
- In the case of Lightweight
Directory Access Protocol
(LDAP)/kerberos version 5 in
direct mode (although not really
needed), {0}:=BWPrincipal. (The
K5 principal is the BroadWorks
principal.)
- In the case of LDAP/kerberos
version 5 in indirect mode, {0}
is the username obtained from
the LDAP search, that is, the
same as {0} used in the LDAP
userPattern.

<defaultRealm> String 1 to 256 characters This parameter specifies the

default kerberos realm.

<default String 1 to 256 characters This parameter specifies the

Domain> default kerberos domain.

<kerberos5KDC> String 1 to 80 characters This parameter specifies the

location of the Kerberos Key
Distribution Center (KDC)
location.

<serverPort> Integer 0 through 65535 This parameter specifies the

Kerberos Key Distribution Center
(KDC) listening port.

<ticket Integer 5 through 120 This parameter specifies the

Timeout> time-out (in seconds) when
communicating with the Kerberos
Key Distribution Center (KDC).

6.9.1.4.7.4.5.3 clear
This command is used to clear the Kerberos5-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/LDAP/SASL/Kerberos5> level.
2) Enter:
clear <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 138
 Variable Field Type Valid Values Description

<attribute> MultipleChoice configurablePrincipal, default The name of an attribute to

Realm, defaultDomain, modify.
kerberos5KDC

6.9.1.4.7.5 Simple
This level is used to view and modify the Simple settings.
6.9.1.4.7.5.1 get
This command is used to view the Simple-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/LDAP/Simple> level.
2) Enter:
get↵
6.9.1.4.7.5.2 set
This command is used to modify the Simple-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/LDAP/Simple> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice principal, credentials The name of an attribute to

modify.

<principal> String 1 to 256 characters This parameter specifies the

principal to connect to the
Lightweight Directory Access
Protocol (LDAP) server. This
is typically a username with
administrative privileges.

<credentials> Password 1 to 128 characters This parameter specifies the

(prompted) credentials to connect to the
Lightweight Directory Access
Protocol (LDAP) server. This is
typically the password associated
with the principal.

6.9.1.4.7.5.3 clear
This command is used to clear the Simple-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/LDAP/Simple> level.
2) Enter:
clear <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 139
 Variable Field Type Valid Values Description

<attribute> MultipleChoice principal, credentials The name of an attribute to

modify.

6.9.1.4.7.6 UserToDNMapping
This level is used to view and modify the user to DN Mapping settings.
6.9.1.4.7.6.1 get
This command is used to view the user to DN Mapping-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/LDAP/UserToDNMapping> level.
2) Enter:
get↵
6.9.1.4.7.6.2 set
This command is used to modify the user to DN Mapping-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/LDAP/UserToDNMapping> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice userPattern, userBase, user The name of an attribute to

Search, userSubtree modify.

<userPattern> String 1 to 256 characters For non-SASL security

authentication, this parameter
specifies how entries are laid
out in the Lightweight Directory
Access Protocol (LDAP)
directory. To be used for direct
correlation with {0} marking
where the username substitution
is. The keyword '{0}' identifies
where the username substitution
occurs. For SASL security
authentication, this parameter
specifies which Distinguish
Name (DN) attribute to use for
authentication. The keyword
'{0}' identifies the username
location and must be preceded
by the equal sign '=' and the
attribute name. For example, after
setting the userPattern to 'cn={0}',
the system fetches the value
associated with the cn attribute
and sends it for authentication.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 140
 Variable Field Type Valid Values Description

<userBase> String 1 to 256 characters This parameter specifies the

entry that is the base of the
subtree containing users. If it is
not specified, the search base is
restricted to the top-level.

<userSearch> String 1 to 256 characters This parameter specifies how

to search the Lightweight
Directory Access Protocol (LDAP)
directory. The pattern specifies
the LDAP search filter to use after
the substitution of the username.

<userSubtree> Choice true, false This parameter if the search

scope is for the top level only
(false) or for the entire subtree
(true).

6.9.1.4.7.6.3 clear
This command is used to clear the user to DN Mapping-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/LDAP/UserToDNMapping> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice userPattern, userBase, user The name of an attribute to

Search modify.

6.9.1.4.8 RADIUS
This level is used to view and modify the Remote Authentication Dial In User Service (RADIUS) settings.
6.9.1.4.8.1 get
This command is used to view the Remote Authentication Dial In User Service (RADIUS)-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/RADIUS> level.
2) Enter:
get↵
6.9.1.4.8.2 set
This command is used to modify the Remote Authentication Dial In User Service (RADIUS)-related
attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/RADIUS> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 141
 Variable Field Type Valid Values Description

<attribute> MultipleChoice authenticationScheme, The name of an attribute to

hostname, port, sharedSecret modify.

<authentication Choice pap, chap, mschapv2 This parameter specifies the

Scheme> Remote Authentication Dial
In User Service (RADIUS)
authentication scheme.

<hostname> String 1 to 80 characters This parameter specifies the

primary Internet Protocol (IP)
address, host, or domain name of
the Remote Authentication Dial In
User Service (RADIUS) server.

<port> Integer 1024 through 65535 This parameter specifies the

Remote Authentication Dial In
User Service (RADIUS) server
port number.

<shared Password 1 to 128 characters This parameter specifies

Secret> (prompted) the shared secret required
by Challenge-Handshake
Authentication Protocol (CHAP).

6.9.1.4.8.3 clear
This command is used to clear the Remote Authentication Dial In User Service (RADIUS)-related
attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/RADIUS> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice hostname, sharedSecret The name of an attribute to

modify.

6.9.1.4.9 WAS
This level is used to view and modify the Web Authentication Server (WAS) settings.
6.9.1.4.9.1 get
This command is used to view the Web Authentication Server (WAS)-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/WAS> level.
2) Enter:
get↵
6.9.1.4.9.2 set
This command is used to modify the Web Authentication Server (WAS)-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/WAS> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 142
 2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice url, supportsBasicCredentials The name of an attribute to

modify.

<url> String 8 to 255 characters This parameter specifies the

Uniform Resource Locator
(URL) of the external Web
Authentication Server (WAS).

<supportsBasic Choice true, false This parameter indicates whether

Credentials> the external Web Authentication
Server (WAS) supports the use of
basicCredentials.

6.9.1.4.9.3 clear
This command is used to clear the Web Authentication Server (WAS)-related attributes.
1) Ensure you are at the /AS_CLI/System/CommunicationUtility/DefaultSettings/
ExternalAuthentication/WAS> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice url The name of an attribute to

modify.

6.10 ConfigAgent
This level is used to view and modify the BroadWorks Configuration Agent information for the BroadWorks
server.

6.10.1 Logging
This level is used to view and modify logging for the Configuration Agent.

6.10.1.1 get
This command is used to view logging-related attributes.
1) Ensure you are at the /AS_CLI/System/ConfigAgent/Logging> level.
2) Enter:
get↵

6.10.1.2 set
This command is used to modify logging-related attributes.
1) Ensure you are at the /AS_CLI/System/ConfigAgent/Logging> level.
2) Enter:
set <attribute>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 143
 where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, severity, priority, max The name of an attribute to

QueueSize, showThreadName modify.

<enabled> Choice true, false This parameter turns the logging

on and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn default logging severity level.

<priority> Integer 1 through 5 This parameter specifies the

priority of the logging thread. The
value "1" indicates the lowest
priority and "5" indicates the
highest.

<maxQueue Integer 0 through 2147483647 This parameter specifies the

Size> maximum size of the logging
queue.

<showThread Choice true, false This parameter enables thread

Name> name logging.

6.10.1.3 InputChannels
This level is used to view, modify, or clear input channels entries.
6.10.1.3.1 get
This command is used to view input channels-related attributes.
1) Ensure you are at the /AS_CLI/System/ConfigAgent/Logging/InputChannels> level.
2) Enter:
get↵
6.10.1.3.2 set
This command is used to modify input channels-related attributes.
1) Ensure you are at the /AS_CLI/System/ConfigAgent/Logging/InputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Generic, BroadsoftCommon This parameter specifies the

CommunicationTransport, name of the logging input
BroadsoftCommon channel.
CommunicationTransportKeep
Alive, Config, SMAP

<attribute> MultipleChoice enabled, severity The name of an attribute to

modify.

<enabled> Choice true, false This parameter turns the logging

to the logging input channel on
and off.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 144
 Variable Field Type Valid Values Description

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn severity level of the logging input
channel.

6.10.1.3.3 clear
This command is used to clear input channels-related attributes.
1) Ensure you are at the /AS_CLI/System/ConfigAgent/Logging/InputChannels> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Generic, BroadsoftCommon This parameter specifies the

CommunicationTransport, name of the logging input
BroadsoftCommon channel.
CommunicationTransportKeep
Alive, Config, SMAP

<attribute> MultipleChoice severity The name of an attribute to clear.

6.10.1.4 OutputChannels
This level is used to view, modify, or clear output channels.
6.10.1.4.1 get
This command is used to view output channels-related attributes.
1) Ensure you are at the /AS_CLI/System/ConfigAgent/Logging/OutputChannels> level.
2) Enter:
get↵
6.10.1.4.2 set
This command is used to modify output channels-related attributes.
1) Ensure you are at the /AS_CLI/System/ConfigAgent/Logging/OutputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Stdout, File This parameter specifies the

name of the logging output
channel.

<attribute> MultipleChoice enabled, directory, filePrefix, file The name of an attribute to

SizeInMB, numberOfFiles modify.

<enabled> Choice true, false This parameter turns the logging

to the logging output channel on
and off.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 145
 Variable Field Type Valid Values Description

<directory> String 1 to 256 characters This parameter specifies the

directory where the log files are
located.

<filePrefix> String 1 to 256 characters This parameter specifies the

prefix of the log files.

<fileSizeInMB> Integer 1 through 2000 This parameter specifies the

maximum size of a log file.

<numberOf Integer 1 through 65535 This parameter specifies the

Files> maximum number of log files that
exist before the old log files are
deleted.

6.11 Device
This level is used to view, modify, add, and delete devices, device monitors, and other attributes related to
devices associated with the Application Server. Devices can be access devices, network devices, Media
Servers, or Network Servers.

6.11.1 EnhancedReportingServer
This level is used to view and modify Call Center Enhanced Reporting Server-related attributes.

6.11.1.1 get
This command is used to view Call Center Enhanced Reporting Server-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/EnhancedReportingServer> level.
2) Enter:
get↵

6.11.1.2 set
This command is used to modify Call Center Enhanced Reporting Server-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/EnhancedReportingServer> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice templateRepositoryApplicationUR The name of an attribute to

L, reportApplicationURL, archive modify.
Reports

<template String 1 to 256 characters The name of the file repository

Repository location to keep the templates.
ApplicationURL>

<report String 1 to 256 characters The URL of the Reporting Web

ApplicationURL> Application.

<archive Choice true, false A flag indicating whether the

Reports> reports need to be archived.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 146
6.11.1.3 clear
This command is used to clear Call Center Enhanced Reporting Server-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/EnhancedReportingServer> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice templateRepositoryApplicationUR The name of an attribute to clear.

L, reportApplicationURL

6.11.2 FileRepos
This level is used to view, add, modify, and delete FileRepos entries in the system.

6.11.2.1 get
This command is used to view File Repository-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/FileRepos> level.
2) Enter:
get↵

6.11.2.2 detail
This command is used to view File Repository detail attributes.
1) Ensure you are at the /AS_CLI/System/Device/FileRepos> level.
2) Enter:
detail <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters The name of the file repository.

6.11.2.3 add
This command is used to add a new File Repository.
1) Ensure you are at the /AS_CLI/System/Device/FileRepos> level.
2) Enter:
add <name> <protocol> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters The name of the file repository.

<protocol> Choice ftp, webdav Specifies whether ftp or webdav

should be used to access the
repository.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 147
 Variable Field Type Valid Values Description

Variable: ftp

ftp Specifies that ftp should be used

to access the repository.

<FQDN> String 1 to 80 characters The domain name to be used to

access the repository.

<ftpPassive> Choice true, false Specifies whether the ftp is

passive or not.

<ftpRemote Choice true, false When set to "true", a minimal

Verification> security check is enforced. The
destination IP address of data
connections cannot be different
from the IP address of the original
control connection. When set
to "false", the security check is
disabled and data connections
can occur on any remote IP
address.

Variable: webdav

webdav Specifies that webdav should be

used to access the repository.

<FQDN> String 1 to 80 characters The domain name to be used to

access the repository.

<secure> Choice true, false Specifies whether the webdav is

secure or not.

<extended Choice true, false This parameter specifies whether

FileCapture the file repository supports
Support> extended file capture.

<attribute> MultipleChoice rootDirectory, port Additional attributes to include

through the add command.

<rootDirectory> String 1 to 256 characters Specifies the path that a webdav

or ftp client should use to retrieve
or put a file in the file repository.

<port> Integer 1 through 65535 The port used to access the

Provisioning Server.

6.11.2.4 set
This command is used to modify File Repository-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/FileRepos> level.
2) Enter:
set <name> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 148
 Variable Field Type Valid Values Description

<name> String 1 to 40 characters The name of the file repository.

<attribute> MultipleChoice protocol, FQDN, ftpPassive, The name of an attribute to

secure, rootDirectory, port, ftp modify.
RemoteVerification

<protocol> Choice ftp, webdav Specifies whether ftp or webdav

should be used to access the
repository.

<FQDN> String 1 to 80 characters The domain name to be used to

access the repository.

<ftpPassive> Choice true, false Specifies whether ftp is passive

or not.

<secure> Choice true, false Specifies whether the protocol is

secure or not.

<rootDirectory> String 1 to 256 characters Specifies the path that a webdav

or ftp client should use to retrieve
or put a file in the file repository.

<port> Integer 1 through 65535 The port used to access the

Provisioning Server.

<ftpRemote Choice true, false When set to "true", a minimal

Verification> security check is enforced. The
destination IP address of data
connections cannot be different
from the IP address of the original
control connection. When set
to "false", the security check is
disabled and data connections
can occur on any remote IP
address.

6.11.2.5 delete
This command is used to delete an existing File Repository from the system.
1) Ensure you are at the /AS_CLI/System/Device/FileRepos> level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters The name of the file repository.

6.11.2.6 clear
This command is used to view File Repository detail attributes.
1) Ensure you are at the /AS_CLI/System/Device/FileRepos> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 149
 clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters The name of the file repository.

<attribute> MultipleChoice rootDirectory, port The name of the attribute(s) to

clear.

6.11.2.7 Users
This level is used to view, add, modify, and delete File Repository Users entries.
6.11.2.7.1 get
This command is used to view File Repository User-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/FileRepos/Users> level.
2) Enter:
get <fileReposName>↵
where:
Variable Field Type Valid Values Description

<fileRepos String 1 to 40 characters The name of the file repository.

Name>

6.11.2.7.2 add
This command is used to add a new File Repository User.
1) Ensure you are at the /AS_CLI/System/Device/FileRepos/Users> level.
2) Enter:
add <fileReposName> <userName> <accessPriv>↵
where:
Variable Field Type Valid Values Description

<fileRepos String 1 to 40 characters The name of the file repository.

Name>

<userName> String 1 to 30 characters The name of the user to be

added.

<accessPriv> MultipleChoice put, delete, get The user access privileges.

6.11.2.7.3 set
This command is used to modify File Repository User-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/FileRepos/Users> level.
2) Enter:
set <fileReposName> <userName> <attribute>↵
where:
Variable Field Type Valid Values Description

<fileRepos String 1 to 40 characters The name of the file repository.

Name>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 150
 Variable Field Type Valid Values Description

<userName> String 1 to 30 characters The name of the user.

<attribute> MultipleChoice accessPriv, password The name of an attribute to

modify.

<accessPriv> MultipleChoice put, delete, get The user access privileges.

6.11.2.7.4 delete
This command is used to delete an existing File Repository User from the system.
1) Ensure you are at the /AS_CLI/System/Device/FileRepos/Users> level.
2) Enter:
delete <fileReposName> <userName>↵
where:
Variable Field Type Valid Values Description

<fileRepos String 1 to 40 characters The name of the file repository.

Name>

<userName> String 1 to 30 characters The name of the user to be

deleted.

6.11.3 IpDeviceMgmt
BroadWorks provides the capability to configure IP phones from a remote location. IpDeviceMgmt allows
an administrator to provision an IP phone at the system, group, or device level. Device-level provisioning
is done via the SubscriberMgmt/Group/Device command level. Phones that support a remote reset can be
reset at the system, group, or device level. This allows full control of the remote phone by the system or
group administrator.

6.11.3.1 get
This command is used to view IpDeviceMgmt-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt> level.
2) Enter:
get↵

6.11.3.2 set
This command is used to modify the IpDeviceMgmt-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 151
 Variable Field Type Valid Values Description

<attribute> MultipleChoice enableIPDeviceMgmt, ftp The name of an attribute to

ConnectTimeoutSeconds, ftpFile modify.
TransferTimeoutSeconds, pause
BetweenFileRebuildMilliseconds,
deviceAccessAppServerCluster
Name, minTimeBetweenReset
Milliseconds, alwaysPushFilesOn
Rebuild, maxFileOperationRetry
Attempts, enableAutoRebuild
Config, eventQueueSize, allow
DeviceCredentialsRetrieval

<enableIP Choice true, false This parameter controls IP Device

DeviceMgmt> Management for the entire
system.

<ftpConnect Integer 1 through 600 This parameter specifies the

Timeout length of time before the system
Seconds> disconnects from the File
Transfer Protocol (FTP) server
while attempting to perform a file
transfer (in seconds).

<ftpFileTransfer Integer 1 through 600 This parameter specifies the

Timeout length of time before the system
Seconds> disconnects from the File
Transfer Protocol (FTP) server
during a file transfer (in seconds).

<pause Integer 0 through 10000 This parameter specifies

Between the length of time that the
FileRebuild Provisioning Server waits before
Milliseconds> processing the next file. This
controls the system load.

<deviceAccess String 1 to 80 characters This parameter specifies the IP

AppServer address of the Application Server
ClusterName> cluster that devices use to access
setup and configuration files.

<minTime Integer 0 through 86400000 This parameter specifies the

BetweenReset length of time to wait before
Milliseconds> processing the next reset event or
the rate of resets sent to devices.

<always Choice true, false This parameter determines

PushFilesOn whether a file is always pushed to
Rebuild> the file repository when rebuilt. If
the value is set to "true", the file is
pushed to the file repository even
if its content has not changed
since the last push.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 152
 Variable Field Type Valid Values Description

<maxFile Integer 0 through 20 This parameter specifies the

OperationRetry number of times a file/folder
Attempts> operation (read, write, create
folder, or delete) is retried by the
Application Server following the
reception of a file error from the
file repository.

<enableAuto Choice true, false This parameter determines

RebuildConfig> whether or not the automatic
rebuild configuration list is used.
If the value is set to "true", the
list is used to reduce the number
of device management events
generated while provisioniong the
system.

<eventQueue Integer 0 through 100000000 This parameter specifies the size

Size> of the device management event
queue. The value determines
the total number of individual
file events that can be queued
at one time. Excess events are
discarded.

<allowDevice Choice true, false This parameter determines

Credentials whether device management
Retrieval> credentials are returned to
authenticated client applications.

6.11.3.3 clear
This command is used to clear IpDeviceMgmt-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice deviceAccessAppServerCluster The name of the attribute(s) to

Name clear.

6.11.3.4 rebuildDefaultFile
This command is used to rebuild each device file using the subscribers profile parameter.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt> level.
2) Enter:
rebuildDefaultFile <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 153
 Variable Field Type Valid Values Description

<attribute> Choice system, group, all Attribute that scopes the

command.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 154
 Variable Field Type Valid Values Description

Variable: system

system The rebuild command is issued at

the system level.

<deviceType> Choice Aastra 480i, Aastra 480i CT, The device type.
Aastra 53i, Aastra 55i, Aastra
57i, Aastra 57iCT, Aastra
9112i, Aastra 9133i, Business
Communicator - PC, Cisco 7905,
Cisco 7912, Cisco 7940, Cisco
7960, Cisco ATA-186, Cisco Sccp
7905(G), Cisco Sccp 7906(G),
Cisco Sccp 7911(G), Cisco Sccp
7912(G), Cisco Sccp 7940(G),
Cisco Sccp 7941G(E), Cisco
Sccp 7942G, Cisco Sccp 7945
G, Cisco Sccp 7960(G), Cisco
Sccp 7960(G) 7914 1, Cisco Sccp
7960(G) 7914 2, Cisco Sccp 7961
G(E), Cisco Sccp 7961G(E) 7914
1, Cisco Sccp 7961G(E) 7914 2,
Cisco Sccp 7962G, Cisco Sccp
7962G 7914 1, Cisco Sccp 7962
G 7914 2, Cisco Sccp 7962G
7915 1, Cisco Sccp 7962G 7915
2, Cisco Sccp 7962G 7916 1,
Cisco Sccp 7962G 7916 2, Cisco
Sccp 7965G, Cisco Sccp 7965G
7914 1, Cisco Sccp 7965G 7914
2, Cisco Sccp 7965G 7915 1,
Cisco Sccp 7965G 7915 2, Cisco
Sccp 7965G 7916 1, Cisco Sccp
7965G 7916 2, Cisco Sccp 7970
G(E), Cisco Sccp 7970G(E) 7914
1, Cisco Sccp 7970G(E) 7914 2,
Cisco Sccp 7971G, Cisco Sccp
7971G 7914 1, Cisco Sccp 7971
G 7914 2, Cisco Sccp 7975,
Cisco Sccp 7975 7914 1, Cisco
Sccp 7975 7914 2, Cisco Sccp
7975 7915 1, Cisco Sccp 7975
7915 2, Cisco Sccp 7975 7916 1,
Cisco Sccp 7975 7916 2, Dasan
Networks H415SE, Grandstream
BT-200, Grandstream GX
P-2000, Grandstream GX
P-2020, Grandstream GX
V-3000, Grandstream GX
W-4004, Grandstream GX
W-4008, Grandstream HT-502,
InnoMedia 3308, InnoMedia
3328-1, InnoMedia 3328-2,
InnoMedia 3328-4, InnoMedia
3328-8, InnoMedia 6328-2, LG-
Nortel LIP-6812, LG-Nortel LI
P-6830, Linksys PAP2, Linksys
PAP2T, Linksys RTP300_WRT
P54G, Linksys SPA-1000 1001,
Linksys SPA-2000 2002 2100,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 155
 Variable Field Type Valid Values Description
Linksys SPA-2102, Linksys SP
A-3000 3100, Linksys SPA-3102,
Linksys SPA-841, Linksys SP
A-901_921_922, Linksys SP
A-941_942, Linksys SPA-962,
Mitel 5055, Mitel 5212, Mitel
5215, Mitel 5220, Mitel 5224,
Mitel 5235, Mitel Navigator,
Moimstone IP250C, Polycom
Soundpoint IP 300, Polycom
Soundpoint IP 320 330, Polycom
Soundpoint IP 4000, Polycom
Soundpoint IP 430, Polycom
Soundpoint IP 500, Polycom
Soundpoint IP 550, Polycom
Soundpoint IP 600, Polycom
Soundpoint IP 601, Polycom
Soundpoint IP 650, Quantier
IPR-720E, SNOM 320, SNO
M 360, Siemens Optipoint
410 Advanced, Siemens
Optipoint 410 Economy,
Siemens Optipoint 410 Economy
Plus, Siemens Optipoint 410
Entry, Siemens Optipoint 410
Standard, Siemens Optipoint 420
Advanced, Siemens Optipoint
420 Economy, Siemens Optipoint
420 Economy Plus, Siemens
Optipoint 420 Standard, Siemens
optiPoint 400, SwissVoice IP 10
S, Thomson ST2030-SG, UT
Starcom iAN-02EX, UniData WI
P-5000, Uniden UIP200, ZyXEL
P2002, ZyXEL P2302R

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 156
 Variable Field Type Valid Values Description

Variable: group

group The rebuild command is issued at

the group level.

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

<groupId> String 1 to 30 characters Valid group within the service

provider.

<deviceType> Choice Aastra 480i, Aastra 480i CT, The device type.
Aastra 53i, Aastra 55i, Aastra
57i, Aastra 57iCT, Aastra
9112i, Aastra 9133i, Business
Communicator - PC, Cisco 7905,
Cisco 7912, Cisco 7940, Cisco
7960, Cisco ATA-186, Cisco Sccp
7905(G), Cisco Sccp 7906(G),
Cisco Sccp 7911(G), Cisco Sccp
7912(G), Cisco Sccp 7940(G),
Cisco Sccp 7941G(E), Cisco
Sccp 7942G, Cisco Sccp 7945
G, Cisco Sccp 7960(G), Cisco
Sccp 7960(G) 7914 1, Cisco Sccp
7960(G) 7914 2, Cisco Sccp 7961
G(E), Cisco Sccp 7961G(E) 7914
1, Cisco Sccp 7961G(E) 7914 2,
Cisco Sccp 7962G, Cisco Sccp
7962G 7914 1, Cisco Sccp 7962
G 7914 2, Cisco Sccp 7962G
7915 1, Cisco Sccp 7962G 7915
2, Cisco Sccp 7962G 7916 1,
Cisco Sccp 7962G 7916 2, Cisco
Sccp 7965G, Cisco Sccp 7965G
7914 1, Cisco Sccp 7965G 7914
2, Cisco Sccp 7965G 7915 1,
Cisco Sccp 7965G 7915 2, Cisco
Sccp 7965G 7916 1, Cisco Sccp
7965G 7916 2, Cisco Sccp 7970
G(E), Cisco Sccp 7970G(E) 7914
1, Cisco Sccp 7970G(E) 7914 2,
Cisco Sccp 7971G, Cisco Sccp
7971G 7914 1, Cisco Sccp 7971
G 7914 2, Cisco Sccp 7975,
Cisco Sccp 7975 7914 1, Cisco
Sccp 7975 7914 2, Cisco Sccp
7975 7915 1, Cisco Sccp 7975
7915 2, Cisco Sccp 7975 7916 1,
Cisco Sccp 7975 7916 2, Dasan
Networks H415SE, Grandstream
BT-200, Grandstream GX
P-2000, Grandstream GX
P-2020, Grandstream GX
V-3000, Grandstream GX
W-4004, Grandstream GX
W-4008, Grandstream HT-502,
InnoMedia 3308, InnoMedia
3328-1, InnoMedia 3328-2,
InnoMedia 3328-4, InnoMedia

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 157
 Variable Field Type Valid Values Description
3328-8, InnoMedia 6328-2, LG-
Nortel LIP-6812, LG-Nortel LI
P-6830, Linksys PAP2, Linksys
PAP2T, Linksys RTP300_WRT
P54G, Linksys SPA-1000 1001,
Linksys SPA-2000 2002 2100,
Linksys SPA-2102, Linksys SP
A-3000 3100, Linksys SPA-3102,
Linksys SPA-841, Linksys SP
A-901_921_922, Linksys SP
A-941_942, Linksys SPA-962,
Mitel 5055, Mitel 5212, Mitel
5215, Mitel 5220, Mitel 5224,
Mitel 5235, Mitel Navigator,
Moimstone IP250C, Polycom
Soundpoint IP 300, Polycom
Soundpoint IP 320 330, Polycom
Soundpoint IP 4000, Polycom
Soundpoint IP 430, Polycom
Soundpoint IP 500, Polycom
Soundpoint IP 550, Polycom
Soundpoint IP 600, Polycom
Soundpoint IP 601, Polycom
Soundpoint IP 650, Quantier
IPR-720E, SNOM 320, SNO
M 360, Siemens Optipoint
410 Advanced, Siemens
Optipoint 410 Economy,
Siemens Optipoint 410 Economy
Plus, Siemens Optipoint 410
Entry, Siemens Optipoint 410
Standard, Siemens Optipoint 420
Advanced, Siemens Optipoint
420 Economy, Siemens Optipoint
420 Economy Plus, Siemens
Optipoint 420 Standard, Siemens
optiPoint 400, SwissVoice IP 10
S, Thomson ST2030-SG, UT
Starcom iAN-02EX, UniData WI
P-5000, Uniden UIP200, ZyXEL
P2002, ZyXEL P2302R

<force> Choice force When specified, the templates

are uploaded to the repository
even if the content hasn't
changed since the last rebuilt was
performed.

6.11.3.5 reset
This command is used to reset or reload configuration files for IP phones at the system, group, or
subscriber's level. When a phone's configuration file is rebuilt, the phone must be reset for the new file to
be read and loaded by the phone.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt> level.
2) Enter:
reset <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 158
 Variable Field Type Valid Values Description

<attribute> Choice deviceType, device, all Attribute that scopes the

command.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 159
 Variable Field Type Valid Values Description

Variable: deviceType

deviceType The device type.

<attribute> Choice system, group Attribute that scopes the

command.

Variable: system

system The rebuild command is issued at

the system level.

<deviceType> Choice Aastra 480i, Aastra 480i CT, The device type.
Aastra 53i, Aastra 55i, Aastra
57i, Aastra 57iCT, Aastra 9112i,
Aastra 9133i, Cisco 7905, Cisco
7912, Cisco 7940, Cisco 7960,
Cisco ATA-186, Cisco Sccp
7905(G), Cisco Sccp 7906(G),
Cisco Sccp 7911(G), Cisco Sccp
7912(G), Cisco Sccp 7940(G),
Cisco Sccp 7941G(E), Cisco
Sccp 7942G, Cisco Sccp 7945
G, Cisco Sccp 7960(G), Cisco
Sccp 7960(G) 7914 1, Cisco Sccp
7960(G) 7914 2, Cisco Sccp 7961
G(E), Cisco Sccp 7961G(E) 7914
1, Cisco Sccp 7961G(E) 7914 2,
Cisco Sccp 7962G, Cisco Sccp
7962G 7914 1, Cisco Sccp 7962
G 7914 2, Cisco Sccp 7962G
7915 1, Cisco Sccp 7962G 7915
2, Cisco Sccp 7962G 7916 1,
Cisco Sccp 7962G 7916 2, Cisco
Sccp 7965G, Cisco Sccp 7965G
7914 1, Cisco Sccp 7965G 7914
2, Cisco Sccp 7965G 7915 1,
Cisco Sccp 7965G 7915 2, Cisco
Sccp 7965G 7916 1, Cisco Sccp
7965G 7916 2, Cisco Sccp 7970
G(E), Cisco Sccp 7970G(E) 7914
1, Cisco Sccp 7970G(E) 7914 2,
Cisco Sccp 7971G, Cisco Sccp
7971G 7914 1, Cisco Sccp 7971
G 7914 2, Cisco Sccp 7975,
Cisco Sccp 7975 7914 1, Cisco
Sccp 7975 7914 2, Cisco Sccp
7975 7915 1, Cisco Sccp 7975
7915 2, Cisco Sccp 7975 7916 1,
Cisco Sccp 7975 7916 2, Dasan
Networks H415SE, Grandstream
BT-200, Grandstream GX
P-2000, Grandstream GX
P-2020, Grandstream GX
V-3000, Grandstream GX
W-4004, Grandstream GX
W-4008, Grandstream HT-502,
InnoMedia 3308, InnoMedia
3328-1, InnoMedia 3328-2,
InnoMedia 3328-4, InnoMedia

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 160
 Variable Field Type Valid Values Description
3328-8, InnoMedia 6328-2, LG-
Nortel LIP-6812, LG-Nortel LI
P-6830, Linksys PAP2, Linksys
PAP2T, Linksys RTP300_WRT
P54G, Linksys SPA-1000 1001,
Linksys SPA-2000 2002 2100,
Linksys SPA-2102, Linksys
SPA-3000 3100, Linksys SP
A-3102, Linksys SPA-841,
Linksys SPA-901_921_922,
Linksys SPA-941_942, Linksys
SPA-962, Moimstone IP250C,
Polycom Soundpoint IP 300,
Polycom Soundpoint IP 320 330,
Polycom Soundpoint IP 4000,
Polycom Soundpoint IP 430,
Polycom Soundpoint IP 500,
Polycom Soundpoint IP 550,
Polycom Soundpoint IP 600,
Polycom Soundpoint IP 601,
Polycom Soundpoint IP 650,
Quantier IPR-720E, SNOM 320,
SNOM 360, Siemens Optipoint
410 Advanced, Siemens
Optipoint 410 Economy,
Siemens Optipoint 410 Economy
Plus, Siemens Optipoint 410
Entry, Siemens Optipoint 410
Standard, Siemens Optipoint 420
Advanced, Siemens Optipoint
420 Economy, Siemens Optipoint
420 Economy Plus, Siemens
Optipoint 420 Standard, Siemens
optiPoint 400, SwissVoice IP 10
S, Thomson ST2030-SG, UT
Starcom iAN-02EX, UniData WI
P-5000, Uniden UIP200, ZyXEL
P2002, ZyXEL P2302R

Variable: group

group The rebuild command is issued at

the group level.

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

<groupId> String 1 to 30 characters Valid group within the service

provider.

<deviceType> Choice Aastra 480i, Aastra 480i CT, The device type.
Aastra 53i, Aastra 55i, Aastra
57i, Aastra 57iCT, Aastra 9112i,
Aastra 9133i, Cisco 7905, Cisco
7912, Cisco 7940, Cisco 7960,
Cisco ATA-186, Cisco Sccp
7905(G), Cisco Sccp 7906(G),
Cisco Sccp 7911(G), Cisco Sccp
7912(G), Cisco Sccp 7940(G),
Cisco Sccp 7941G(E), Cisco

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 161
 Variable Field Type Valid Values Description
Sccp 7942G, Cisco Sccp 7945
G, Cisco Sccp 7960(G), Cisco
Sccp 7960(G) 7914 1, Cisco Sccp
7960(G) 7914 2, Cisco Sccp 7961
G(E), Cisco Sccp 7961G(E) 7914
1, Cisco Sccp 7961G(E) 7914 2,
Cisco Sccp 7962G, Cisco Sccp
7962G 7914 1, Cisco Sccp 7962
G 7914 2, Cisco Sccp 7962G
7915 1, Cisco Sccp 7962G 7915
2, Cisco Sccp 7962G 7916 1,
Cisco Sccp 7962G 7916 2, Cisco
Sccp 7965G, Cisco Sccp 7965G
7914 1, Cisco Sccp 7965G 7914
2, Cisco Sccp 7965G 7915 1,
Cisco Sccp 7965G 7915 2, Cisco
Sccp 7965G 7916 1, Cisco Sccp
7965G 7916 2, Cisco Sccp 7970
G(E), Cisco Sccp 7970G(E) 7914
1, Cisco Sccp 7970G(E) 7914 2,
Cisco Sccp 7971G, Cisco Sccp
7971G 7914 1, Cisco Sccp 7971
G 7914 2, Cisco Sccp 7975,
Cisco Sccp 7975 7914 1, Cisco
Sccp 7975 7914 2, Cisco Sccp
7975 7915 1, Cisco Sccp 7975
7915 2, Cisco Sccp 7975 7916 1,
Cisco Sccp 7975 7916 2, Dasan
Networks H415SE, Grandstream
BT-200, Grandstream GX
P-2000, Grandstream GX
P-2020, Grandstream GX
V-3000, Grandstream GX
W-4004, Grandstream GX
W-4008, Grandstream HT-502,
InnoMedia 3308, InnoMedia
3328-1, InnoMedia 3328-2,
InnoMedia 3328-4, InnoMedia
3328-8, InnoMedia 6328-2, LG-
Nortel LIP-6812, LG-Nortel LI
P-6830, Linksys PAP2, Linksys
PAP2T, Linksys RTP300_WRT
P54G, Linksys SPA-1000 1001,
Linksys SPA-2000 2002 2100,
Linksys SPA-2102, Linksys
SPA-3000 3100, Linksys SP
A-3102, Linksys SPA-841,
Linksys SPA-901_921_922,
Linksys SPA-941_942, Linksys
SPA-962, Moimstone IP250C,
Polycom Soundpoint IP 300,
Polycom Soundpoint IP 320 330,
Polycom Soundpoint IP 4000,
Polycom Soundpoint IP 430,
Polycom Soundpoint IP 500,
Polycom Soundpoint IP 550,
Polycom Soundpoint IP 600,
Polycom Soundpoint IP 601,
Polycom Soundpoint IP 650,
Quantier IPR-720E, SNOM 320,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 162
 Variable Field Type Valid Values Description
SNOM 360, Siemens Optipoint
410 Advanced, Siemens
Optipoint 410 Economy,
Siemens Optipoint 410 Economy
Plus, Siemens Optipoint 410
Entry, Siemens Optipoint 410
Standard, Siemens Optipoint 420
Advanced, Siemens Optipoint
420 Economy, Siemens Optipoint
420 Economy Plus, Siemens
Optipoint 420 Standard, Siemens
optiPoint 400, SwissVoice IP 10
S, Thomson ST2030-SG, UT
Starcom iAN-02EX, UniData WI
P-5000, Uniden UIP200, ZyXEL
P2002, ZyXEL P2302R

Variable: device

device This resets a specific device.

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

<groupId> String 1 to 30 characters Valid group within the service

provider.

<deviceName> String 1 to 40 characters The device name.

6.11.3.6 setConfigFile
This command is used to set a new system or group level default configuration file.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt> level.
2) Enter:
setConfigFile <fileName> <attribute>↵
where:
Variable Field Type Valid Values Description

<fileName> String 1 to 512 characters The name of the file to be set.

<attribute> Choice system, group Attribute that scopes the

command.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 163
 Variable Field Type Valid Values Description

Variable: system

system The rebuild command is issued at

the system level.

<deviceType> Choice Aastra 480i, Aastra 480i CT, The device type.
Aastra 53i, Aastra 55i, Aastra
57i, Aastra 57iCT, Aastra
9112i, Aastra 9133i, Business
Communicator - PC, Cisco 7905,
Cisco 7912, Cisco 7940, Cisco
7960, Cisco ATA-186, Cisco Sccp
7905(G), Cisco Sccp 7906(G),
Cisco Sccp 7911(G), Cisco Sccp
7912(G), Cisco Sccp 7940(G),
Cisco Sccp 7941G(E), Cisco
Sccp 7942G, Cisco Sccp 7945
G, Cisco Sccp 7960(G), Cisco
Sccp 7960(G) 7914 1, Cisco Sccp
7960(G) 7914 2, Cisco Sccp 7961
G(E), Cisco Sccp 7961G(E) 7914
1, Cisco Sccp 7961G(E) 7914 2,
Cisco Sccp 7962G, Cisco Sccp
7962G 7914 1, Cisco Sccp 7962
G 7914 2, Cisco Sccp 7962G
7915 1, Cisco Sccp 7962G 7915
2, Cisco Sccp 7962G 7916 1,
Cisco Sccp 7962G 7916 2, Cisco
Sccp 7965G, Cisco Sccp 7965G
7914 1, Cisco Sccp 7965G 7914
2, Cisco Sccp 7965G 7915 1,
Cisco Sccp 7965G 7915 2, Cisco
Sccp 7965G 7916 1, Cisco Sccp
7965G 7916 2, Cisco Sccp 7970
G(E), Cisco Sccp 7970G(E) 7914
1, Cisco Sccp 7970G(E) 7914 2,
Cisco Sccp 7971G, Cisco Sccp
7971G 7914 1, Cisco Sccp 7971
G 7914 2, Cisco Sccp 7975,
Cisco Sccp 7975 7914 1, Cisco
Sccp 7975 7914 2, Cisco Sccp
7975 7915 1, Cisco Sccp 7975
7915 2, Cisco Sccp 7975 7916 1,
Cisco Sccp 7975 7916 2, Dasan
Networks H415SE, Grandstream
BT-200, Grandstream GX
P-2000, Grandstream GX
P-2020, Grandstream GX
V-3000, Grandstream GX
W-4004, Grandstream GX
W-4008, Grandstream HT-502,
InnoMedia 3308, InnoMedia
3328-1, InnoMedia 3328-2,
InnoMedia 3328-4, InnoMedia
3328-8, InnoMedia 6328-2, LG-
Nortel LIP-6812, LG-Nortel LI
P-6830, Linksys PAP2, Linksys
PAP2T, Linksys RTP300_WRT
P54G, Linksys SPA-1000 1001,
Linksys SPA-2000 2002 2100,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 164
 Variable Field Type Valid Values Description
Linksys SPA-2102, Linksys SP
A-3000 3100, Linksys SPA-3102,
Linksys SPA-841, Linksys SP
A-901_921_922, Linksys SP
A-941_942, Linksys SPA-962,
Mitel 5055, Mitel 5212, Mitel
5215, Mitel 5220, Mitel 5224,
Mitel 5235, Mitel Navigator,
Moimstone IP250C, Polycom
Soundpoint IP 300, Polycom
Soundpoint IP 320 330, Polycom
Soundpoint IP 4000, Polycom
Soundpoint IP 430, Polycom
Soundpoint IP 500, Polycom
Soundpoint IP 550, Polycom
Soundpoint IP 600, Polycom
Soundpoint IP 601, Polycom
Soundpoint IP 650, Quantier
IPR-720E, SNOM 320, SNO
M 360, Siemens Optipoint
410 Advanced, Siemens
Optipoint 410 Economy,
Siemens Optipoint 410 Economy
Plus, Siemens Optipoint 410
Entry, Siemens Optipoint 410
Standard, Siemens Optipoint 420
Advanced, Siemens Optipoint
420 Economy, Siemens Optipoint
420 Economy Plus, Siemens
Optipoint 420 Standard, Siemens
optiPoint 400, SwissVoice IP 10
S, Thomson ST2030-SG, UT
Starcom iAN-02EX, UniData WI
P-5000, Uniden UIP200, ZyXEL
P2002, ZyXEL P2302R

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 165
 Variable Field Type Valid Values Description

Variable: group

group The rebuild command is issued at

the group level.

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

<groupId> String 1 to 30 characters Valid group within the service

provider.

<deviceType> Choice Aastra 480i, Aastra 480i CT, The device type.
Aastra 53i, Aastra 55i, Aastra
57i, Aastra 57iCT, Aastra
9112i, Aastra 9133i, Business
Communicator - PC, Cisco 7905,
Cisco 7912, Cisco 7940, Cisco
7960, Cisco ATA-186, Cisco Sccp
7905(G), Cisco Sccp 7906(G),
Cisco Sccp 7911(G), Cisco Sccp
7912(G), Cisco Sccp 7940(G),
Cisco Sccp 7941G(E), Cisco
Sccp 7942G, Cisco Sccp 7945
G, Cisco Sccp 7960(G), Cisco
Sccp 7960(G) 7914 1, Cisco Sccp
7960(G) 7914 2, Cisco Sccp 7961
G(E), Cisco Sccp 7961G(E) 7914
1, Cisco Sccp 7961G(E) 7914 2,
Cisco Sccp 7962G, Cisco Sccp
7962G 7914 1, Cisco Sccp 7962
G 7914 2, Cisco Sccp 7962G
7915 1, Cisco Sccp 7962G 7915
2, Cisco Sccp 7962G 7916 1,
Cisco Sccp 7962G 7916 2, Cisco
Sccp 7965G, Cisco Sccp 7965G
7914 1, Cisco Sccp 7965G 7914
2, Cisco Sccp 7965G 7915 1,
Cisco Sccp 7965G 7915 2, Cisco
Sccp 7965G 7916 1, Cisco Sccp
7965G 7916 2, Cisco Sccp 7970
G(E), Cisco Sccp 7970G(E) 7914
1, Cisco Sccp 7970G(E) 7914 2,
Cisco Sccp 7971G, Cisco Sccp
7971G 7914 1, Cisco Sccp 7971
G 7914 2, Cisco Sccp 7975,
Cisco Sccp 7975 7914 1, Cisco
Sccp 7975 7914 2, Cisco Sccp
7975 7915 1, Cisco Sccp 7975
7915 2, Cisco Sccp 7975 7916 1,
Cisco Sccp 7975 7916 2, Dasan
Networks H415SE, Grandstream
BT-200, Grandstream GX
P-2000, Grandstream GX
P-2020, Grandstream GX
V-3000, Grandstream GX
W-4004, Grandstream GX
W-4008, Grandstream HT-502,
InnoMedia 3308, InnoMedia
3328-1, InnoMedia 3328-2,
InnoMedia 3328-4, InnoMedia

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 166
 Variable Field Type Valid Values Description
3328-8, InnoMedia 6328-2, LG-
Nortel LIP-6812, LG-Nortel LI
P-6830, Linksys PAP2, Linksys
PAP2T, Linksys RTP300_WRT
P54G, Linksys SPA-1000 1001,
Linksys SPA-2000 2002 2100,
Linksys SPA-2102, Linksys SP
A-3000 3100, Linksys SPA-3102,
Linksys SPA-841, Linksys SP
A-901_921_922, Linksys SP
A-941_942, Linksys SPA-962,
Mitel 5055, Mitel 5212, Mitel
5215, Mitel 5220, Mitel 5224,
Mitel 5235, Mitel Navigator,
Moimstone IP250C, Polycom
Soundpoint IP 300, Polycom
Soundpoint IP 320 330, Polycom
Soundpoint IP 4000, Polycom
Soundpoint IP 430, Polycom
Soundpoint IP 500, Polycom
Soundpoint IP 550, Polycom
Soundpoint IP 600, Polycom
Soundpoint IP 601, Polycom
Soundpoint IP 650, Quantier
IPR-720E, SNOM 320, SNO
M 360, Siemens Optipoint
410 Advanced, Siemens
Optipoint 410 Economy,
Siemens Optipoint 410 Economy
Plus, Siemens Optipoint 410
Entry, Siemens Optipoint 410
Standard, Siemens Optipoint 420
Advanced, Siemens Optipoint
420 Economy, Siemens Optipoint
420 Economy Plus, Siemens
Optipoint 420 Standard, Siemens
optiPoint 400, SwissVoice IP 10
S, Thomson ST2030-SG, UT
Starcom iAN-02EX, UniData WI
P-5000, Uniden UIP200, ZyXEL
P2002, ZyXEL P2302R

6.11.3.7 AutoRebuildConfig
This level is used to get and modify auto rebuild config entries.
6.11.3.7.1 get
This command is used to view the AutoRebuildConfig-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt/AutoRebuildConfig> level.
2) Enter:
get [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice ociRequestPrefix, autoRebuild The criteria used to filter the get
Enabled command. The entries listed
match all of the specified criteria.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 167
 Variable Field Type Valid Values Description

<ociRequest String 1 to 256 characters This parameter displays entries

Prefix> that match the Open Client
Interface (OCI) request prefix with
the specified string. All requests
starting with the specified string
are displayed.

<autoRebuild Choice true, false This parameter displays entries

Enabled> that match the auto rebuild
enabled flag with the specified
value.

6.11.3.7.2 set
This command is used to modify the AutoRebuildConfig-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt/AutoRebuildConfig> level.
2) Enter:
set <ociRequestPrefixes> <attribute>↵
where:
Variable Field Type Valid Values Description

<ociRequest Choice all, ociRequestPrefix This parameter specifies the

Prefixes> scope of the command. When
the value is set to "all", the
modification is applied to all Open
Client Interface (OCI) request
prefixes. When the value is
set to "ociRequestPrefix", the
modification is applied to a single
OCI request prefix.

<ociRequest String 1 to 256 characters This parameter specifies the

Prefix> name of the Open Client Interface
(OCI) request prefix to modify.
The OCI request prefix is the OCI
request without the version suffix.
Ex: the OCI request prefix for
"UserModifyRequest17sp4" is
"UserModifyRequest".

<attribute> MultipleChoice autoRebuildEnabled The name of an attribute to

modify.

<autoRebuild Choice true, false This parameter determines

Enabled> whether the request prefix
generates device management
events. If the value is set to "true",
events are generated.

6.11.3.8 CustomTags
This level is used to view, add, modify, and delete CustomTags entries.
6.11.3.8.1 get
This command is used to view Custom Tag-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt/CustomTags> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 168
 2) Enter:
get <svcProviderId> <groupId> <deviceType>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 169
 Variable Field Type Valid Values Description

<deviceType> Choice Aastra 480i, Aastra 480i CT, The device type.
Aastra 53i, Aastra 55i, Aastra
57i, Aastra 57iCT, Aastra
9112i, Aastra 9133i, Business
Communicator - PC, Cisco 7905,
Cisco 7912, Cisco 7940, Cisco
7960, Cisco ATA-186, Cisco Sccp
7905(G), Cisco Sccp 7906(G),
Cisco Sccp 7911(G), Cisco Sccp
7912(G), Cisco Sccp 7940(G),
Cisco Sccp 7941G(E), Cisco
Sccp 7942G, Cisco Sccp 7945
G, Cisco Sccp 7960(G), Cisco
Sccp 7960(G) 7914 1, Cisco Sccp
7960(G) 7914 2, Cisco Sccp 7961
G(E), Cisco Sccp 7961G(E) 7914
1, Cisco Sccp 7961G(E) 7914 2,
Cisco Sccp 7962G, Cisco Sccp
7962G 7914 1, Cisco Sccp 7962
G 7914 2, Cisco Sccp 7962G
7915 1, Cisco Sccp 7962G 7915
2, Cisco Sccp 7962G 7916 1,
Cisco Sccp 7962G 7916 2, Cisco
Sccp 7965G, Cisco Sccp 7965G
7914 1, Cisco Sccp 7965G 7914
2, Cisco Sccp 7965G 7915 1,
Cisco Sccp 7965G 7915 2, Cisco
Sccp 7965G 7916 1, Cisco Sccp
7965G 7916 2, Cisco Sccp 7970
G(E), Cisco Sccp 7970G(E) 7914
1, Cisco Sccp 7970G(E) 7914 2,
Cisco Sccp 7971G, Cisco Sccp
7971G 7914 1, Cisco Sccp 7971
G 7914 2, Cisco Sccp 7975,
Cisco Sccp 7975 7914 1, Cisco
Sccp 7975 7914 2, Cisco Sccp
7975 7915 1, Cisco Sccp 7975
7915 2, Cisco Sccp 7975 7916 1,
Cisco Sccp 7975 7916 2, Dasan
Networks H415SE, Grandstream
BT-200, Grandstream GX
P-2000, Grandstream GX
P-2020, Grandstream GX
V-3000, Grandstream GX
W-4004, Grandstream GX
W-4008, Grandstream HT-502,
InnoMedia 3308, InnoMedia
3328-1, InnoMedia 3328-2,
InnoMedia 3328-4, InnoMedia
3328-8, InnoMedia 6328-2, LG-
Nortel LIP-6812, LG-Nortel LI
P-6830, Linksys PAP2, Linksys
PAP2T, Linksys RTP300_WRT
P54G, Linksys SPA-1000 1001,
Linksys SPA-2000 2002 2100,
Linksys SPA-2102, Linksys SP
A-3000 3100, Linksys SPA-3102,
Linksys SPA-841, Linksys SP
A-901_921_922, Linksys SP
A-941_942, Linksys SPA-962,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 170
 Variable Field Type Valid Values Description
Mitel 5055, Mitel 5212, Mitel
5215, Mitel 5220, Mitel 5224,
Mitel 5235, Mitel Navigator,
Moimstone IP250C, Polycom
Soundpoint IP 300, Polycom
Soundpoint IP 320 330, Polycom
Soundpoint IP 4000, Polycom
Soundpoint IP 430, Polycom
Soundpoint IP 500, Polycom
Soundpoint IP 550, Polycom
Soundpoint IP 600, Polycom
Soundpoint IP 601, Polycom
Soundpoint IP 650, Quantier
IPR-720E, SNOM 320, SNO
M 360, Siemens Optipoint
410 Advanced, Siemens
Optipoint 410 Economy,
Siemens Optipoint 410 Economy
Plus, Siemens Optipoint 410
Entry, Siemens Optipoint 410
Standard, Siemens Optipoint 420
Advanced, Siemens Optipoint
420 Economy, Siemens Optipoint
420 Economy Plus, Siemens
Optipoint 420 Standard, Siemens
optiPoint 400, SwissVoice IP 10
S, Thomson ST2030-SG, UT
Starcom iAN-02EX, UniData WI
P-5000, Uniden UIP200, ZyXEL
P2002, ZyXEL P2302R

6.11.3.8.2 add
This command is used to add a new Custom Tag.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt/CustomTags> level.
2) Enter:
add <svcProviderId> <groupId> <deviceType> <tagName> [<tagValue>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 171
 Variable Field Type Valid Values Description

<deviceType> Choice Aastra 480i, Aastra 480i CT, The device type.
Aastra 53i, Aastra 55i, Aastra
57i, Aastra 57iCT, Aastra
9112i, Aastra 9133i, Business
Communicator - PC, Cisco 7905,
Cisco 7912, Cisco 7940, Cisco
7960, Cisco ATA-186, Cisco Sccp
7905(G), Cisco Sccp 7906(G),
Cisco Sccp 7911(G), Cisco Sccp
7912(G), Cisco Sccp 7940(G),
Cisco Sccp 7941G(E), Cisco
Sccp 7942G, Cisco Sccp 7945
G, Cisco Sccp 7960(G), Cisco
Sccp 7960(G) 7914 1, Cisco Sccp
7960(G) 7914 2, Cisco Sccp 7961
G(E), Cisco Sccp 7961G(E) 7914
1, Cisco Sccp 7961G(E) 7914 2,
Cisco Sccp 7962G, Cisco Sccp
7962G 7914 1, Cisco Sccp 7962
G 7914 2, Cisco Sccp 7962G
7915 1, Cisco Sccp 7962G 7915
2, Cisco Sccp 7962G 7916 1,
Cisco Sccp 7962G 7916 2, Cisco
Sccp 7965G, Cisco Sccp 7965G
7914 1, Cisco Sccp 7965G 7914
2, Cisco Sccp 7965G 7915 1,
Cisco Sccp 7965G 7915 2, Cisco
Sccp 7965G 7916 1, Cisco Sccp
7965G 7916 2, Cisco Sccp 7970
G(E), Cisco Sccp 7970G(E) 7914
1, Cisco Sccp 7970G(E) 7914 2,
Cisco Sccp 7971G, Cisco Sccp
7971G 7914 1, Cisco Sccp 7971
G 7914 2, Cisco Sccp 7975,
Cisco Sccp 7975 7914 1, Cisco
Sccp 7975 7914 2, Cisco Sccp
7975 7915 1, Cisco Sccp 7975
7915 2, Cisco Sccp 7975 7916 1,
Cisco Sccp 7975 7916 2, Dasan
Networks H415SE, Grandstream
BT-200, Grandstream GX
P-2000, Grandstream GX
P-2020, Grandstream GX
V-3000, Grandstream GX
W-4004, Grandstream GX
W-4008, Grandstream HT-502,
InnoMedia 3308, InnoMedia
3328-1, InnoMedia 3328-2,
InnoMedia 3328-4, InnoMedia
3328-8, InnoMedia 6328-2, LG-
Nortel LIP-6812, LG-Nortel LI
P-6830, Linksys PAP2, Linksys
PAP2T, Linksys RTP300_WRT
P54G, Linksys SPA-1000 1001,
Linksys SPA-2000 2002 2100,
Linksys SPA-2102, Linksys SP
A-3000 3100, Linksys SPA-3102,
Linksys SPA-841, Linksys SP
A-901_921_922, Linksys SP
A-941_942, Linksys SPA-962,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 172
 Variable Field Type Valid Values Description
Mitel 5055, Mitel 5212, Mitel
5215, Mitel 5220, Mitel 5224,
Mitel 5235, Mitel Navigator,
Moimstone IP250C, Polycom
Soundpoint IP 300, Polycom
Soundpoint IP 320 330, Polycom
Soundpoint IP 4000, Polycom
Soundpoint IP 430, Polycom
Soundpoint IP 500, Polycom
Soundpoint IP 550, Polycom
Soundpoint IP 600, Polycom
Soundpoint IP 601, Polycom
Soundpoint IP 650, Quantier
IPR-720E, SNOM 320, SNO
M 360, Siemens Optipoint
410 Advanced, Siemens
Optipoint 410 Economy,
Siemens Optipoint 410 Economy
Plus, Siemens Optipoint 410
Entry, Siemens Optipoint 410
Standard, Siemens Optipoint 420
Advanced, Siemens Optipoint
420 Economy, Siemens Optipoint
420 Economy Plus, Siemens
Optipoint 420 Standard, Siemens
optiPoint 400, SwissVoice IP 10
S, Thomson ST2030-SG, UT
Starcom iAN-02EX, UniData WI
P-5000, Uniden UIP200, ZyXEL
P2002, ZyXEL P2302R

<tagName> String 1 to 64 characters The name of the tag.

<tagValue> String 1 to 256 characters The tag value.

6.11.3.8.3 set
This command is used to modify CustomTags-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt/CustomTags> level.
2) Enter:
set <svcProviderId> <groupId> <deviceType> <tagName> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 173
 Variable Field Type Valid Values Description

<deviceType> Choice Aastra 480i, Aastra 480i CT, The device type.
Aastra 53i, Aastra 55i, Aastra
57i, Aastra 57iCT, Aastra
9112i, Aastra 9133i, Business
Communicator - PC, Cisco 7905,
Cisco 7912, Cisco 7940, Cisco
7960, Cisco ATA-186, Cisco Sccp
7905(G), Cisco Sccp 7906(G),
Cisco Sccp 7911(G), Cisco Sccp
7912(G), Cisco Sccp 7940(G),
Cisco Sccp 7941G(E), Cisco
Sccp 7942G, Cisco Sccp 7945
G, Cisco Sccp 7960(G), Cisco
Sccp 7960(G) 7914 1, Cisco Sccp
7960(G) 7914 2, Cisco Sccp 7961
G(E), Cisco Sccp 7961G(E) 7914
1, Cisco Sccp 7961G(E) 7914 2,
Cisco Sccp 7962G, Cisco Sccp
7962G 7914 1, Cisco Sccp 7962
G 7914 2, Cisco Sccp 7962G
7915 1, Cisco Sccp 7962G 7915
2, Cisco Sccp 7962G 7916 1,
Cisco Sccp 7962G 7916 2, Cisco
Sccp 7965G, Cisco Sccp 7965G
7914 1, Cisco Sccp 7965G 7914
2, Cisco Sccp 7965G 7915 1,
Cisco Sccp 7965G 7915 2, Cisco
Sccp 7965G 7916 1, Cisco Sccp
7965G 7916 2, Cisco Sccp 7970
G(E), Cisco Sccp 7970G(E) 7914
1, Cisco Sccp 7970G(E) 7914 2,
Cisco Sccp 7971G, Cisco Sccp
7971G 7914 1, Cisco Sccp 7971
G 7914 2, Cisco Sccp 7975,
Cisco Sccp 7975 7914 1, Cisco
Sccp 7975 7914 2, Cisco Sccp
7975 7915 1, Cisco Sccp 7975
7915 2, Cisco Sccp 7975 7916 1,
Cisco Sccp 7975 7916 2, Dasan
Networks H415SE, Grandstream
BT-200, Grandstream GX
P-2000, Grandstream GX
P-2020, Grandstream GX
V-3000, Grandstream GX
W-4004, Grandstream GX
W-4008, Grandstream HT-502,
InnoMedia 3308, InnoMedia
3328-1, InnoMedia 3328-2,
InnoMedia 3328-4, InnoMedia
3328-8, InnoMedia 6328-2, LG-
Nortel LIP-6812, LG-Nortel LI
P-6830, Linksys PAP2, Linksys
PAP2T, Linksys RTP300_WRT
P54G, Linksys SPA-1000 1001,
Linksys SPA-2000 2002 2100,
Linksys SPA-2102, Linksys SP
A-3000 3100, Linksys SPA-3102,
Linksys SPA-841, Linksys SP
A-901_921_922, Linksys SP
A-941_942, Linksys SPA-962,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 174
 Variable Field Type Valid Values Description
Mitel 5055, Mitel 5212, Mitel
5215, Mitel 5220, Mitel 5224,
Mitel 5235, Mitel Navigator,
Moimstone IP250C, Polycom
Soundpoint IP 300, Polycom
Soundpoint IP 320 330, Polycom
Soundpoint IP 4000, Polycom
Soundpoint IP 430, Polycom
Soundpoint IP 500, Polycom
Soundpoint IP 550, Polycom
Soundpoint IP 600, Polycom
Soundpoint IP 601, Polycom
Soundpoint IP 650, Quantier
IPR-720E, SNOM 320, SNO
M 360, Siemens Optipoint
410 Advanced, Siemens
Optipoint 410 Economy,
Siemens Optipoint 410 Economy
Plus, Siemens Optipoint 410
Entry, Siemens Optipoint 410
Standard, Siemens Optipoint 420
Advanced, Siemens Optipoint
420 Economy, Siemens Optipoint
420 Economy Plus, Siemens
Optipoint 420 Standard, Siemens
optiPoint 400, SwissVoice IP 10
S, Thomson ST2030-SG, UT
Starcom iAN-02EX, UniData WI
P-5000, Uniden UIP200, ZyXEL
P2002, ZyXEL P2302R

<tagName> String 1 to 64 characters The tag name.

<attribute> MultipleChoice tagValue The name of an attribute to

modify.

<tagValue> String 1 to 256 characters The tag value.

6.11.3.8.4 delete
This command is used to delete an existing Custom Tag from the system.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt/CustomTags> level.
2) Enter:
delete <svcProviderId> <groupId> <deviceType> <tagName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters Device name to retrieve.

Id>

<groupId> String 1 to 30 characters The group ID.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 175
 Variable Field Type Valid Values Description

<deviceType> Choice Aastra 480i, Aastra 480i CT, The device type.
Aastra 53i, Aastra 55i, Aastra
57i, Aastra 57iCT, Aastra
9112i, Aastra 9133i, Business
Communicator - PC, Cisco 7905,
Cisco 7912, Cisco 7940, Cisco
7960, Cisco ATA-186, Cisco Sccp
7905(G), Cisco Sccp 7906(G),
Cisco Sccp 7911(G), Cisco Sccp
7912(G), Cisco Sccp 7940(G),
Cisco Sccp 7941G(E), Cisco
Sccp 7942G, Cisco Sccp 7945
G, Cisco Sccp 7960(G), Cisco
Sccp 7960(G) 7914 1, Cisco Sccp
7960(G) 7914 2, Cisco Sccp 7961
G(E), Cisco Sccp 7961G(E) 7914
1, Cisco Sccp 7961G(E) 7914 2,
Cisco Sccp 7962G, Cisco Sccp
7962G 7914 1, Cisco Sccp 7962
G 7914 2, Cisco Sccp 7962G
7915 1, Cisco Sccp 7962G 7915
2, Cisco Sccp 7962G 7916 1,
Cisco Sccp 7962G 7916 2, Cisco
Sccp 7965G, Cisco Sccp 7965G
7914 1, Cisco Sccp 7965G 7914
2, Cisco Sccp 7965G 7915 1,
Cisco Sccp 7965G 7915 2, Cisco
Sccp 7965G 7916 1, Cisco Sccp
7965G 7916 2, Cisco Sccp 7970
G(E), Cisco Sccp 7970G(E) 7914
1, Cisco Sccp 7970G(E) 7914 2,
Cisco Sccp 7971G, Cisco Sccp
7971G 7914 1, Cisco Sccp 7971
G 7914 2, Cisco Sccp 7975,
Cisco Sccp 7975 7914 1, Cisco
Sccp 7975 7914 2, Cisco Sccp
7975 7915 1, Cisco Sccp 7975
7915 2, Cisco Sccp 7975 7916 1,
Cisco Sccp 7975 7916 2, Dasan
Networks H415SE, Grandstream
BT-200, Grandstream GX
P-2000, Grandstream GX
P-2020, Grandstream GX
V-3000, Grandstream GX
W-4004, Grandstream GX
W-4008, Grandstream HT-502,
InnoMedia 3308, InnoMedia
3328-1, InnoMedia 3328-2,
InnoMedia 3328-4, InnoMedia
3328-8, InnoMedia 6328-2, LG-
Nortel LIP-6812, LG-Nortel LI
P-6830, Linksys PAP2, Linksys
PAP2T, Linksys RTP300_WRT
P54G, Linksys SPA-1000 1001,
Linksys SPA-2000 2002 2100,
Linksys SPA-2102, Linksys SP
A-3000 3100, Linksys SPA-3102,
Linksys SPA-841, Linksys SP
A-901_921_922, Linksys SP
A-941_942, Linksys SPA-962,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 176
 Variable Field Type Valid Values Description
Mitel 5055, Mitel 5212, Mitel
5215, Mitel 5220, Mitel 5224,
Mitel 5235, Mitel Navigator,
Moimstone IP250C, Polycom
Soundpoint IP 300, Polycom
Soundpoint IP 320 330, Polycom
Soundpoint IP 4000, Polycom
Soundpoint IP 430, Polycom
Soundpoint IP 500, Polycom
Soundpoint IP 550, Polycom
Soundpoint IP 600, Polycom
Soundpoint IP 601, Polycom
Soundpoint IP 650, Quantier
IPR-720E, SNOM 320, SNO
M 360, Siemens Optipoint
410 Advanced, Siemens
Optipoint 410 Economy,
Siemens Optipoint 410 Economy
Plus, Siemens Optipoint 410
Entry, Siemens Optipoint 410
Standard, Siemens Optipoint 420
Advanced, Siemens Optipoint
420 Economy, Siemens Optipoint
420 Economy Plus, Siemens
Optipoint 420 Standard, Siemens
optiPoint 400, SwissVoice IP 10
S, Thomson ST2030-SG, UT
Starcom iAN-02EX, UniData WI
P-5000, Uniden UIP200, ZyXEL
P2002, ZyXEL P2302R

<tagName> String 1 to 64 characters The tag name.

6.11.3.8.5 clear
This command is used to clear an existing Custom Tag from the system.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt/CustomTags> level.
2) Enter:
clear <svcProviderId> <groupId> <deviceType> <tagName> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters Device name to retrieve.

Id>

<groupId> String 1 to 30 characters The group ID.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 177
 Variable Field Type Valid Values Description

<deviceType> Choice Aastra 480i, Aastra 480i CT, The device type.
Aastra 53i, Aastra 55i, Aastra
57i, Aastra 57iCT, Aastra
9112i, Aastra 9133i, Business
Communicator - PC, Cisco 7905,
Cisco 7912, Cisco 7940, Cisco
7960, Cisco ATA-186, Cisco Sccp
7905(G), Cisco Sccp 7906(G),
Cisco Sccp 7911(G), Cisco Sccp
7912(G), Cisco Sccp 7940(G),
Cisco Sccp 7941G(E), Cisco
Sccp 7942G, Cisco Sccp 7945
G, Cisco Sccp 7960(G), Cisco
Sccp 7960(G) 7914 1, Cisco Sccp
7960(G) 7914 2, Cisco Sccp 7961
G(E), Cisco Sccp 7961G(E) 7914
1, Cisco Sccp 7961G(E) 7914 2,
Cisco Sccp 7962G, Cisco Sccp
7962G 7914 1, Cisco Sccp 7962
G 7914 2, Cisco Sccp 7962G
7915 1, Cisco Sccp 7962G 7915
2, Cisco Sccp 7962G 7916 1,
Cisco Sccp 7962G 7916 2, Cisco
Sccp 7965G, Cisco Sccp 7965G
7914 1, Cisco Sccp 7965G 7914
2, Cisco Sccp 7965G 7915 1,
Cisco Sccp 7965G 7915 2, Cisco
Sccp 7965G 7916 1, Cisco Sccp
7965G 7916 2, Cisco Sccp 7970
G(E), Cisco Sccp 7970G(E) 7914
1, Cisco Sccp 7970G(E) 7914 2,
Cisco Sccp 7971G, Cisco Sccp
7971G 7914 1, Cisco Sccp 7971
G 7914 2, Cisco Sccp 7975,
Cisco Sccp 7975 7914 1, Cisco
Sccp 7975 7914 2, Cisco Sccp
7975 7915 1, Cisco Sccp 7975
7915 2, Cisco Sccp 7975 7916 1,
Cisco Sccp 7975 7916 2, Dasan
Networks H415SE, Grandstream
BT-200, Grandstream GX
P-2000, Grandstream GX
P-2020, Grandstream GX
V-3000, Grandstream GX
W-4004, Grandstream GX
W-4008, Grandstream HT-502,
InnoMedia 3308, InnoMedia
3328-1, InnoMedia 3328-2,
InnoMedia 3328-4, InnoMedia
3328-8, InnoMedia 6328-2, LG-
Nortel LIP-6812, LG-Nortel LI
P-6830, Linksys PAP2, Linksys
PAP2T, Linksys RTP300_WRT
P54G, Linksys SPA-1000 1001,
Linksys SPA-2000 2002 2100,
Linksys SPA-2102, Linksys SP
A-3000 3100, Linksys SPA-3102,
Linksys SPA-841, Linksys SP
A-901_921_922, Linksys SP
A-941_942, Linksys SPA-962,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 178
 Variable Field Type Valid Values Description
Mitel 5055, Mitel 5212, Mitel
5215, Mitel 5220, Mitel 5224,
Mitel 5235, Mitel Navigator,
Moimstone IP250C, Polycom
Soundpoint IP 300, Polycom
Soundpoint IP 320 330, Polycom
Soundpoint IP 4000, Polycom
Soundpoint IP 430, Polycom
Soundpoint IP 500, Polycom
Soundpoint IP 550, Polycom
Soundpoint IP 600, Polycom
Soundpoint IP 601, Polycom
Soundpoint IP 650, Quantier
IPR-720E, SNOM 320, SNO
M 360, Siemens Optipoint
410 Advanced, Siemens
Optipoint 410 Economy,
Siemens Optipoint 410 Economy
Plus, Siemens Optipoint 410
Entry, Siemens Optipoint 410
Standard, Siemens Optipoint 420
Advanced, Siemens Optipoint
420 Economy, Siemens Optipoint
420 Economy Plus, Siemens
Optipoint 420 Standard, Siemens
optiPoint 400, SwissVoice IP 10
S, Thomson ST2030-SG, UT
Starcom iAN-02EX, UniData WI
P-5000, Uniden UIP200, ZyXEL
P2002, ZyXEL P2302R

<tagName> String 1 to 64 characters The tag name.

<attribute> MultipleChoice tagValue The name of the attribute(s) to

clear.

6.11.3.9 DMEventQueues
This level is used to view and clear events in the Device Management queues.
6.11.3.9.1 get
This command is used to view the events in a Device Management queue.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt/DMEventQueues> level.
2) Enter:
get <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice queueType, status, action,
level, type, additionalInfoStarts,
additionalInfoContains, additional
InfoEquals, loginIdStarts, loginId
Contains, loginIdEquals
Criteria used to filter the get
command. The events listed
match all of the specified criteria.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 179
 Variable Field Type Valid Values Description

<queueType> Choice inProgressPending, completed This parameter determines the

Device Management queue to
get events from. If a value is
not specified, the "inProgress/
Pending" queue is used.

<status> Choice pending, queued, inProgress, This parameter determines the

processOnOtherHost, stale,
completed, canceled
filter on the status of the event
in the Device Management
queue. The value "pending"
means the event is not queued
for processing yet. The value
"queued" means the event is
ready to be processed. The
value "inProgress" means
that one of the event's child is
currently being processed. The
value "stale" means that the
event is not queued internally
but should be. The value
"processOnOtherHost" means
that the event is processed
by another server. The value
"completed" means that the
event's processing is complete
and all of its children have been
processed. The value "canceled"
means that the event processing
was interrupted by the admin.

<action> Choice delete, download, rebuild, reset, This parameter displays events
upload by the action performed by the
event.

<level> Choice device, deviceType, deviceType This parameter displays events

Group, group, user by the level of the event.

<type> Choice automatic, manual This parameter displays events

by the type of event. The value
"manual" means that the event
was triggered by a user directly.
The value "automatic" means
that the event was generated
automatically, following an event
in the system like a provisioning
event on a service that impacts a
Device Management tag.

<additionalInfo String 0 to 256 characters This parameter displays eventsby

Starts> the additional information related
to the event. The beginning of
additional information must match
the string supplied. For example,
additional information includes
the impacted device, group, or
device type.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 180
 Variable Field Type Valid Values Description

<additionalInfo String 0 to 256 characters This parameter displays events

Contains> by the additional information
related to the event. The
additional information must
contain the string supplied. For
example, additional information
includes the impacted device,
group, or device type.

<additionalInfo String 0 to 256 characters This parameter displays events

Equals> by the additional information
related to the event. The
additional information must match
the string supplied exactly. For
example, additional information
includes the impacted device,
group, or device type.

<loginIdStarts> String 0 to 161 characters This parameter displays

the eventsby the ID of the
administrator or user who
triggered the event. The
beginning of the login ID must
match the string supplied.

<loginId String 0 to 161 characters This parameter displays eventsby

Contains> the ID of the administrator or user
who triggered the event. The
login ID must contain the string
supplied.

<loginId String 0 to 161 characters This parameter displays eventsby

Equals> the ID of the admin or user who
triggered the event. The login ID
must match the string supplied
exactly.

6.11.3.9.2 cancel
This command is used to cancel events from the pending/in progress Device Management queue.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt/DMEventQueues> level.
2) Enter:
cancel <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> Choice all, multiple, one The scope of the command. All
events, multiple events or one
event can be canceled.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 181
 Variable Field Type Valid Values Description

Variable: multiple

multiple Cancel multiple events based on

the criteria supplied. At least one
criterion must be specified.

<criteria> MultipleChoice status, action, level, type The criteria specifying which
events to cancel. To be canceled,
an event must meet all specified
criteria.

<status> Choice pending, queued, inProgress, This parameter cancels events by

stale the status of the event.

<action> Choice delete, download, rebuild, reset, This parameter cancels events
upload by the action performed by the
event.

<level> Choice device, deviceType, deviceType This parameter cancels events by

Group, group, user the level of the event.

<type> Choice automatic, manual This parameter cancels events

by the type of event. The value
"manual" means that the event
was triggered by a user directly.
The value "automatic" means
that the event was generated
automatically, following an event
in the system like a provisioning
event on a service that impacts a
Device Management tag.

Variable: one

one Cancel a single event.

<eventId> Integer 1 through 2147483647 The event identifier, used to

uniquely identify a specific event.

6.11.3.9.3 summary
This command is used show the number of events currently being processed in the system per action (ex:
Rebuild) and processing state (ex: Pending).
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt/DMEventQueues> level.
2) Enter:
summary↵

6.11.3.10 Files
This level is used to view, add, modify, and delete IpDeviceMgmt Files entries.
6.11.3.10.1 get
This command is used to view Device Files-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt/Files> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 182
 get <svcProviderId> <groupId> <deviceType>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider.

Id>

<groupId> String 1 to 30 characters The ID of the group.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 183
 Variable Field Type Valid Values Description

<deviceType> Choice Aastra 480i, Aastra 480i CT, The device type.
Aastra 53i, Aastra 55i, Aastra
57i, Aastra 57iCT, Aastra
9112i, Aastra 9133i, Business
Communicator - PC, Cisco 7905,
Cisco 7912, Cisco 7940, Cisco
7960, Cisco ATA-186, Cisco Sccp
7905(G), Cisco Sccp 7906(G),
Cisco Sccp 7911(G), Cisco Sccp
7912(G), Cisco Sccp 7940(G),
Cisco Sccp 7941G(E), Cisco
Sccp 7942G, Cisco Sccp 7945
G, Cisco Sccp 7960(G), Cisco
Sccp 7960(G) 7914 1, Cisco Sccp
7960(G) 7914 2, Cisco Sccp 7961
G(E), Cisco Sccp 7961G(E) 7914
1, Cisco Sccp 7961G(E) 7914 2,
Cisco Sccp 7962G, Cisco Sccp
7962G 7914 1, Cisco Sccp 7962
G 7914 2, Cisco Sccp 7962G
7915 1, Cisco Sccp 7962G 7915
2, Cisco Sccp 7962G 7916 1,
Cisco Sccp 7962G 7916 2, Cisco
Sccp 7965G, Cisco Sccp 7965G
7914 1, Cisco Sccp 7965G 7914
2, Cisco Sccp 7965G 7915 1,
Cisco Sccp 7965G 7915 2, Cisco
Sccp 7965G 7916 1, Cisco Sccp
7965G 7916 2, Cisco Sccp 7970
G(E), Cisco Sccp 7970G(E) 7914
1, Cisco Sccp 7970G(E) 7914 2,
Cisco Sccp 7971G, Cisco Sccp
7971G 7914 1, Cisco Sccp 7971
G 7914 2, Cisco Sccp 7975,
Cisco Sccp 7975 7914 1, Cisco
Sccp 7975 7914 2, Cisco Sccp
7975 7915 1, Cisco Sccp 7975
7915 2, Cisco Sccp 7975 7916 1,
Cisco Sccp 7975 7916 2, Dasan
Networks H415SE, Grandstream
BT-200, Grandstream GX
P-2000, Grandstream GX
P-2020, Grandstream GX
V-3000, Grandstream GX
W-4004, Grandstream GX
W-4008, Grandstream HT-502,
InnoMedia 3308, InnoMedia
3328-1, InnoMedia 3328-2,
InnoMedia 3328-4, InnoMedia
3328-8, InnoMedia 6328-2, LG-
Nortel LIP-6812, LG-Nortel LI
P-6830, Linksys PAP2, Linksys
PAP2T, Linksys RTP300_WRT
P54G, Linksys SPA-1000 1001,
Linksys SPA-2000 2002 2100,
Linksys SPA-2102, Linksys SP
A-3000 3100, Linksys SPA-3102,
Linksys SPA-841, Linksys SP
A-901_921_922, Linksys SP
A-941_942, Linksys SPA-962,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 184
 Variable Field Type Valid Values Description
Mitel 5055, Mitel 5212, Mitel
5215, Mitel 5220, Mitel 5224,
Mitel 5235, Mitel Navigator,
Moimstone IP250C, Polycom
Soundpoint IP 300, Polycom
Soundpoint IP 320 330, Polycom
Soundpoint IP 4000, Polycom
Soundpoint IP 430, Polycom
Soundpoint IP 500, Polycom
Soundpoint IP 550, Polycom
Soundpoint IP 600, Polycom
Soundpoint IP 601, Polycom
Soundpoint IP 650, Quantier
IPR-720E, SNOM 320, SNO
M 360, Siemens Optipoint
410 Advanced, Siemens
Optipoint 410 Economy,
Siemens Optipoint 410 Economy
Plus, Siemens Optipoint 410
Entry, Siemens Optipoint 410
Standard, Siemens Optipoint 420
Advanced, Siemens Optipoint
420 Economy, Siemens Optipoint
420 Economy Plus, Siemens
Optipoint 420 Standard, Siemens
optiPoint 400, SwissVoice IP 10
S, Thomson ST2030-SG, UT
Starcom iAN-02EX, UniData WI
P-5000, Uniden UIP200, ZyXEL
P2002, ZyXEL P2302R

6.11.3.10.2 detail
This command is used to view Device Profile File detail attributes.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt/Files> level.
2) Enter:
detail <svcProviderId> <groupId> <deviceType> <fileFormat>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The ID of the group.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 185
 Variable Field Type Valid Values Description

<deviceType> Choice Aastra 480i, Aastra 480i CT, The device type.
Aastra 53i, Aastra 55i, Aastra
57i, Aastra 57iCT, Aastra
9112i, Aastra 9133i, Business
Communicator - PC, Cisco 7905,
Cisco 7912, Cisco 7940, Cisco
7960, Cisco ATA-186, Cisco Sccp
7905(G), Cisco Sccp 7906(G),
Cisco Sccp 7911(G), Cisco Sccp
7912(G), Cisco Sccp 7940(G),
Cisco Sccp 7941G(E), Cisco
Sccp 7942G, Cisco Sccp 7945
G, Cisco Sccp 7960(G), Cisco
Sccp 7960(G) 7914 1, Cisco Sccp
7960(G) 7914 2, Cisco Sccp 7961
G(E), Cisco Sccp 7961G(E) 7914
1, Cisco Sccp 7961G(E) 7914 2,
Cisco Sccp 7962G, Cisco Sccp
7962G 7914 1, Cisco Sccp 7962
G 7914 2, Cisco Sccp 7962G
7915 1, Cisco Sccp 7962G 7915
2, Cisco Sccp 7962G 7916 1,
Cisco Sccp 7962G 7916 2, Cisco
Sccp 7965G, Cisco Sccp 7965G
7914 1, Cisco Sccp 7965G 7914
2, Cisco Sccp 7965G 7915 1,
Cisco Sccp 7965G 7915 2, Cisco
Sccp 7965G 7916 1, Cisco Sccp
7965G 7916 2, Cisco Sccp 7970
G(E), Cisco Sccp 7970G(E) 7914
1, Cisco Sccp 7970G(E) 7914 2,
Cisco Sccp 7971G, Cisco Sccp
7971G 7914 1, Cisco Sccp 7971
G 7914 2, Cisco Sccp 7975,
Cisco Sccp 7975 7914 1, Cisco
Sccp 7975 7914 2, Cisco Sccp
7975 7915 1, Cisco Sccp 7975
7915 2, Cisco Sccp 7975 7916 1,
Cisco Sccp 7975 7916 2, Dasan
Networks H415SE, Grandstream
BT-200, Grandstream GX
P-2000, Grandstream GX
P-2020, Grandstream GX
V-3000, Grandstream GX
W-4004, Grandstream GX
W-4008, Grandstream HT-502,
InnoMedia 3308, InnoMedia
3328-1, InnoMedia 3328-2,
InnoMedia 3328-4, InnoMedia
3328-8, InnoMedia 6328-2, LG-
Nortel LIP-6812, LG-Nortel LI
P-6830, Linksys PAP2, Linksys
PAP2T, Linksys RTP300_WRT
P54G, Linksys SPA-1000 1001,
Linksys SPA-2000 2002 2100,
Linksys SPA-2102, Linksys SP
A-3000 3100, Linksys SPA-3102,
Linksys SPA-841, Linksys SP
A-901_921_922, Linksys SP
A-941_942, Linksys SPA-962,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 186
 Variable Field Type Valid Values Description
Mitel 5055, Mitel 5212, Mitel
5215, Mitel 5220, Mitel 5224,
Mitel 5235, Mitel Navigator,
Moimstone IP250C, Polycom
Soundpoint IP 300, Polycom
Soundpoint IP 320 330, Polycom
Soundpoint IP 4000, Polycom
Soundpoint IP 430, Polycom
Soundpoint IP 500, Polycom
Soundpoint IP 550, Polycom
Soundpoint IP 600, Polycom
Soundpoint IP 601, Polycom
Soundpoint IP 650, Quantier
IPR-720E, SNOM 320, SNO
M 360, Siemens Optipoint
410 Advanced, Siemens
Optipoint 410 Economy,
Siemens Optipoint 410 Economy
Plus, Siemens Optipoint 410
Entry, Siemens Optipoint 410
Standard, Siemens Optipoint 420
Advanced, Siemens Optipoint
420 Economy, Siemens Optipoint
420 Economy Plus, Siemens
Optipoint 420 Standard, Siemens
optiPoint 400, SwissVoice IP 10
S, Thomson ST2030-SG, UT
Starcom iAN-02EX, UniData WI
P-5000, Uniden UIP200, ZyXEL
P2002, ZyXEL P2302R

<fileFormat> String 1 to 128 characters The file format.

6.11.3.10.3 set
This command is used to modify Group Device Profile Type File-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt/Files> level.
2) Enter:
set <svcProviderId> <groupId> <deviceType> <fileFormat> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 187
 Variable Field Type Valid Values Description

<deviceType> Choice Aastra 480i, Aastra 480i CT, The device type.
Aastra 53i, Aastra 55i, Aastra
57i, Aastra 57iCT, Aastra
9112i, Aastra 9133i, Business
Communicator - PC, Cisco 7905,
Cisco 7912, Cisco 7940, Cisco
7960, Cisco ATA-186, Cisco Sccp
7905(G), Cisco Sccp 7906(G),
Cisco Sccp 7911(G), Cisco Sccp
7912(G), Cisco Sccp 7940(G),
Cisco Sccp 7941G(E), Cisco
Sccp 7942G, Cisco Sccp 7945
G, Cisco Sccp 7960(G), Cisco
Sccp 7960(G) 7914 1, Cisco Sccp
7960(G) 7914 2, Cisco Sccp 7961
G(E), Cisco Sccp 7961G(E) 7914
1, Cisco Sccp 7961G(E) 7914 2,
Cisco Sccp 7962G, Cisco Sccp
7962G 7914 1, Cisco Sccp 7962
G 7914 2, Cisco Sccp 7962G
7915 1, Cisco Sccp 7962G 7915
2, Cisco Sccp 7962G 7916 1,
Cisco Sccp 7962G 7916 2, Cisco
Sccp 7965G, Cisco Sccp 7965G
7914 1, Cisco Sccp 7965G 7914
2, Cisco Sccp 7965G 7915 1,
Cisco Sccp 7965G 7915 2, Cisco
Sccp 7965G 7916 1, Cisco Sccp
7965G 7916 2, Cisco Sccp 7970
G(E), Cisco Sccp 7970G(E) 7914
1, Cisco Sccp 7970G(E) 7914 2,
Cisco Sccp 7971G, Cisco Sccp
7971G 7914 1, Cisco Sccp 7971
G 7914 2, Cisco Sccp 7975,
Cisco Sccp 7975 7914 1, Cisco
Sccp 7975 7914 2, Cisco Sccp
7975 7915 1, Cisco Sccp 7975
7915 2, Cisco Sccp 7975 7916 1,
Cisco Sccp 7975 7916 2, Dasan
Networks H415SE, Grandstream
BT-200, Grandstream GX
P-2000, Grandstream GX
P-2020, Grandstream GX
V-3000, Grandstream GX
W-4004, Grandstream GX
W-4008, Grandstream HT-502,
InnoMedia 3308, InnoMedia
3328-1, InnoMedia 3328-2,
InnoMedia 3328-4, InnoMedia
3328-8, InnoMedia 6328-2, LG-
Nortel LIP-6812, LG-Nortel LI
P-6830, Linksys PAP2, Linksys
PAP2T, Linksys RTP300_WRT
P54G, Linksys SPA-1000 1001,
Linksys SPA-2000 2002 2100,
Linksys SPA-2102, Linksys SP
A-3000 3100, Linksys SPA-3102,
Linksys SPA-841, Linksys SP
A-901_921_922, Linksys SP
A-941_942, Linksys SPA-962,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 188
 Variable Field Type Valid Values Description
Mitel 5055, Mitel 5212, Mitel
5215, Mitel 5220, Mitel 5224,
Mitel 5235, Mitel Navigator,
Moimstone IP250C, Polycom
Soundpoint IP 300, Polycom
Soundpoint IP 320 330, Polycom
Soundpoint IP 4000, Polycom
Soundpoint IP 430, Polycom
Soundpoint IP 500, Polycom
Soundpoint IP 550, Polycom
Soundpoint IP 600, Polycom
Soundpoint IP 601, Polycom
Soundpoint IP 650, Quantier
IPR-720E, SNOM 320, SNO
M 360, Siemens Optipoint
410 Advanced, Siemens
Optipoint 410 Economy,
Siemens Optipoint 410 Economy
Plus, Siemens Optipoint 410
Entry, Siemens Optipoint 410
Standard, Siemens Optipoint 420
Advanced, Siemens Optipoint
420 Economy, Siemens Optipoint
420 Economy Plus, Siemens
Optipoint 420 Standard, Siemens
optiPoint 400, SwissVoice IP 10
S, Thomson ST2030-SG, UT
Starcom iAN-02EX, UniData WI
P-5000, Uniden UIP200, ZyXEL
P2002, ZyXEL P2302R

<fileFormat> String 1 to 128 characters The type of the device profile file.

<attribute> MultipleChoice fileSource, configurationFileName The name of an attribute to

modify.

<fileSource> Choice manual, default, custom Identifies the file source.

<configuration String 1 to 256 characters The configuration file name.

FileName>

6.11.3.11 Fileserver
File Server is the next level down in the IpDeviceMgmt level. The File Server level sets up the FTP client
so BroadWorks can transmit the device configuration files to the location for the device to download.
This level does not install an FTP client or server; rather it provisions the client side for configuration file
management (storing and deleting files).
6.11.3.11.1 get
This command is used to view Fileserver-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt/Fileserver> level.
2) Enter:
get↵
6.11.3.11.2 add
This command is used to add a new Fileserver.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt/Fileserver> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 189
 add <deviceType> <fileReposName> [<attribute>]↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 190
 Variable Field Type Valid Values Description

<deviceType> Choice Aastra 480i, Aastra 480i CT, The device type.
Aastra 53i, Aastra 55i, Aastra
57i, Aastra 57iCT, Aastra
9112i, Aastra 9133i, Business
Communicator - PC, Cisco 7905,
Cisco 7912, Cisco 7940, Cisco
7960, Cisco ATA-186, Cisco Sccp
7905(G), Cisco Sccp 7906(G),
Cisco Sccp 7911(G), Cisco Sccp
7912(G), Cisco Sccp 7940(G),
Cisco Sccp 7941G(E), Cisco
Sccp 7942G, Cisco Sccp 7945
G, Cisco Sccp 7960(G), Cisco
Sccp 7960(G) 7914 1, Cisco Sccp
7960(G) 7914 2, Cisco Sccp 7961
G(E), Cisco Sccp 7961G(E) 7914
1, Cisco Sccp 7961G(E) 7914 2,
Cisco Sccp 7962G, Cisco Sccp
7962G 7914 1, Cisco Sccp 7962
G 7914 2, Cisco Sccp 7962G
7915 1, Cisco Sccp 7962G 7915
2, Cisco Sccp 7962G 7916 1,
Cisco Sccp 7962G 7916 2, Cisco
Sccp 7965G, Cisco Sccp 7965G
7914 1, Cisco Sccp 7965G 7914
2, Cisco Sccp 7965G 7915 1,
Cisco Sccp 7965G 7915 2, Cisco
Sccp 7965G 7916 1, Cisco Sccp
7965G 7916 2, Cisco Sccp 7970
G(E), Cisco Sccp 7970G(E) 7914
1, Cisco Sccp 7970G(E) 7914 2,
Cisco Sccp 7971G, Cisco Sccp
7971G 7914 1, Cisco Sccp 7971
G 7914 2, Cisco Sccp 7975,
Cisco Sccp 7975 7914 1, Cisco
Sccp 7975 7914 2, Cisco Sccp
7975 7915 1, Cisco Sccp 7975
7915 2, Cisco Sccp 7975 7916 1,
Cisco Sccp 7975 7916 2, Dasan
Networks H415SE, Grandstream
BT-200, Grandstream GX
P-2000, Grandstream GX
P-2020, Grandstream GX
V-3000, Grandstream GX
W-4004, Grandstream GX
W-4008, Grandstream HT-502,
InnoMedia 3308, InnoMedia
3328-1, InnoMedia 3328-2,
InnoMedia 3328-4, InnoMedia
3328-8, InnoMedia 6328-2, LG-
Nortel LIP-6812, LG-Nortel LI
P-6830, Linksys PAP2, Linksys
PAP2T, Linksys RTP300_WRT
P54G, Linksys SPA-1000 1001,
Linksys SPA-2000 2002 2100,
Linksys SPA-2102, Linksys SP
A-3000 3100, Linksys SPA-3102,
Linksys SPA-841, Linksys SP
A-901_921_922, Linksys SP
A-941_942, Linksys SPA-962,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 191
 Variable Field Type Valid Values Description
Mitel 5055, Mitel 5212, Mitel
5215, Mitel 5220, Mitel 5224,
Mitel 5235, Mitel Navigator,
Moimstone IP250C, Polycom
Soundpoint IP 300, Polycom
Soundpoint IP 320 330, Polycom
Soundpoint IP 4000, Polycom
Soundpoint IP 430, Polycom
Soundpoint IP 500, Polycom
Soundpoint IP 550, Polycom
Soundpoint IP 600, Polycom
Soundpoint IP 601, Polycom
Soundpoint IP 650, Quantier
IPR-720E, SNOM 320, SNO
M 360, Siemens Optipoint
410 Advanced, Siemens
Optipoint 410 Economy,
Siemens Optipoint 410 Economy
Plus, Siemens Optipoint 410
Entry, Siemens Optipoint 410
Standard, Siemens Optipoint 420
Advanced, Siemens Optipoint
420 Economy, Siemens Optipoint
420 Economy Plus, Siemens
Optipoint 420 Standard, Siemens
optiPoint 400, SwissVoice IP 10
S, Thomson ST2030-SG, UT
Starcom iAN-02EX, UniData WI
P-5000, Uniden UIP200, ZyXEL
P2002, ZyXEL P2302R

<fileRepos String 1 to 40 characters The name of the file repository.

Name>

<attribute> MultipleChoice directory, extendedCaptureFile Additional attributes to include

ReposName through the add command.

<extended String 1 to 40 characters This parameter specifies the

CaptureFile name of the extended capture file
ReposName> repository.

<directory> String 0 to 256 characters The directory where the

repository is located.

6.11.3.11.3 set
This command is used to modify Fileserver-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt/Fileserver> level.
2) Enter:
set <deviceType> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 192
 Variable Field Type Valid Values Description

<deviceType> Choice Aastra 480i, Aastra 480i CT, The device type.
Aastra 53i, Aastra 55i, Aastra
57i, Aastra 57iCT, Aastra
9112i, Aastra 9133i, Business
Communicator - PC, Cisco 7905,
Cisco 7912, Cisco 7940, Cisco
7960, Cisco ATA-186, Cisco Sccp
7905(G), Cisco Sccp 7906(G),
Cisco Sccp 7911(G), Cisco Sccp
7912(G), Cisco Sccp 7940(G),
Cisco Sccp 7941G(E), Cisco
Sccp 7942G, Cisco Sccp 7945
G, Cisco Sccp 7960(G), Cisco
Sccp 7960(G) 7914 1, Cisco Sccp
7960(G) 7914 2, Cisco Sccp 7961
G(E), Cisco Sccp 7961G(E) 7914
1, Cisco Sccp 7961G(E) 7914 2,
Cisco Sccp 7962G, Cisco Sccp
7962G 7914 1, Cisco Sccp 7962
G 7914 2, Cisco Sccp 7962G
7915 1, Cisco Sccp 7962G 7915
2, Cisco Sccp 7962G 7916 1,
Cisco Sccp 7962G 7916 2, Cisco
Sccp 7965G, Cisco Sccp 7965G
7914 1, Cisco Sccp 7965G 7914
2, Cisco Sccp 7965G 7915 1,
Cisco Sccp 7965G 7915 2, Cisco
Sccp 7965G 7916 1, Cisco Sccp
7965G 7916 2, Cisco Sccp 7970
G(E), Cisco Sccp 7970G(E) 7914
1, Cisco Sccp 7970G(E) 7914 2,
Cisco Sccp 7971G, Cisco Sccp
7971G 7914 1, Cisco Sccp 7971
G 7914 2, Cisco Sccp 7975,
Cisco Sccp 7975 7914 1, Cisco
Sccp 7975 7914 2, Cisco Sccp
7975 7915 1, Cisco Sccp 7975
7915 2, Cisco Sccp 7975 7916 1,
Cisco Sccp 7975 7916 2, Dasan
Networks H415SE, Grandstream
BT-200, Grandstream GX
P-2000, Grandstream GX
P-2020, Grandstream GX
V-3000, Grandstream GX
W-4004, Grandstream GX
W-4008, Grandstream HT-502,
InnoMedia 3308, InnoMedia
3328-1, InnoMedia 3328-2,
InnoMedia 3328-4, InnoMedia
3328-8, InnoMedia 6328-2, LG-
Nortel LIP-6812, LG-Nortel LI
P-6830, Linksys PAP2, Linksys
PAP2T, Linksys RTP300_WRT
P54G, Linksys SPA-1000 1001,
Linksys SPA-2000 2002 2100,
Linksys SPA-2102, Linksys SP
A-3000 3100, Linksys SPA-3102,
Linksys SPA-841, Linksys SP
A-901_921_922, Linksys SP
A-941_942, Linksys SPA-962,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 193
 Variable Field Type Valid Values Description
Mitel 5055, Mitel 5212, Mitel
5215, Mitel 5220, Mitel 5224,
Mitel 5235, Mitel Navigator,
Moimstone IP250C, Polycom
Soundpoint IP 300, Polycom
Soundpoint IP 320 330, Polycom
Soundpoint IP 4000, Polycom
Soundpoint IP 430, Polycom
Soundpoint IP 500, Polycom
Soundpoint IP 550, Polycom
Soundpoint IP 600, Polycom
Soundpoint IP 601, Polycom
Soundpoint IP 650, Quantier
IPR-720E, SNOM 320, SNO
M 360, Siemens Optipoint
410 Advanced, Siemens
Optipoint 410 Economy,
Siemens Optipoint 410 Economy
Plus, Siemens Optipoint 410
Entry, Siemens Optipoint 410
Standard, Siemens Optipoint 420
Advanced, Siemens Optipoint
420 Economy, Siemens Optipoint
420 Economy Plus, Siemens
Optipoint 420 Standard, Siemens
optiPoint 400, SwissVoice IP 10
S, Thomson ST2030-SG, UT
Starcom iAN-02EX, UniData WI
P-5000, Uniden UIP200, ZyXEL
P2002, ZyXEL P2302R

<attribute> MultipleChoice fileReposName, directory, The name of an attribute to

extendedCaptureFileReposName modify.

<fileRepos String 1 to 40 characters The name of the file repository.

Name>

<extended String 1 to 40 characters This parameter specifies the

CaptureFile name of the extended capture file
ReposName> repository.

<directory> String 0 to 256 characters The directory where the

repository is located.

6.11.3.11.4 delete
This command is used to delete an existing Fileserver from the system.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt/Fileserver> level.
2) Enter:
delete <deviceType>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 194
 Variable Field Type Valid Values Description

<deviceType> Choice Aastra 480i, Aastra 480i CT, The device type.
Aastra 53i, Aastra 55i, Aastra
57i, Aastra 57iCT, Aastra
9112i, Aastra 9133i, Business
Communicator - PC, Cisco 7905,
Cisco 7912, Cisco 7940, Cisco
7960, Cisco ATA-186, Cisco Sccp
7905(G), Cisco Sccp 7906(G),
Cisco Sccp 7911(G), Cisco Sccp
7912(G), Cisco Sccp 7940(G),
Cisco Sccp 7941G(E), Cisco
Sccp 7942G, Cisco Sccp 7945
G, Cisco Sccp 7960(G), Cisco
Sccp 7960(G) 7914 1, Cisco Sccp
7960(G) 7914 2, Cisco Sccp 7961
G(E), Cisco Sccp 7961G(E) 7914
1, Cisco Sccp 7961G(E) 7914 2,
Cisco Sccp 7962G, Cisco Sccp
7962G 7914 1, Cisco Sccp 7962
G 7914 2, Cisco Sccp 7962G
7915 1, Cisco Sccp 7962G 7915
2, Cisco Sccp 7962G 7916 1,
Cisco Sccp 7962G 7916 2, Cisco
Sccp 7965G, Cisco Sccp 7965G
7914 1, Cisco Sccp 7965G 7914
2, Cisco Sccp 7965G 7915 1,
Cisco Sccp 7965G 7915 2, Cisco
Sccp 7965G 7916 1, Cisco Sccp
7965G 7916 2, Cisco Sccp 7970
G(E), Cisco Sccp 7970G(E) 7914
1, Cisco Sccp 7970G(E) 7914 2,
Cisco Sccp 7971G, Cisco Sccp
7971G 7914 1, Cisco Sccp 7971
G 7914 2, Cisco Sccp 7975,
Cisco Sccp 7975 7914 1, Cisco
Sccp 7975 7914 2, Cisco Sccp
7975 7915 1, Cisco Sccp 7975
7915 2, Cisco Sccp 7975 7916 1,
Cisco Sccp 7975 7916 2, Dasan
Networks H415SE, Grandstream
BT-200, Grandstream GX
P-2000, Grandstream GX
P-2020, Grandstream GX
V-3000, Grandstream GX
W-4004, Grandstream GX
W-4008, Grandstream HT-502,
InnoMedia 3308, InnoMedia
3328-1, InnoMedia 3328-2,
InnoMedia 3328-4, InnoMedia
3328-8, InnoMedia 6328-2, LG-
Nortel LIP-6812, LG-Nortel LI
P-6830, Linksys PAP2, Linksys
PAP2T, Linksys RTP300_WRT
P54G, Linksys SPA-1000 1001,
Linksys SPA-2000 2002 2100,
Linksys SPA-2102, Linksys SP
A-3000 3100, Linksys SPA-3102,
Linksys SPA-841, Linksys SP
A-901_921_922, Linksys SP
A-941_942, Linksys SPA-962,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 195
 Variable Field Type Valid Values Description
Mitel 5055, Mitel 5212, Mitel
5215, Mitel 5220, Mitel 5224,
Mitel 5235, Mitel Navigator,
Moimstone IP250C, Polycom
Soundpoint IP 300, Polycom
Soundpoint IP 320 330, Polycom
Soundpoint IP 4000, Polycom
Soundpoint IP 430, Polycom
Soundpoint IP 500, Polycom
Soundpoint IP 550, Polycom
Soundpoint IP 600, Polycom
Soundpoint IP 601, Polycom
Soundpoint IP 650, Quantier
IPR-720E, SNOM 320, SNO
M 360, Siemens Optipoint
410 Advanced, Siemens
Optipoint 410 Economy,
Siemens Optipoint 410 Economy
Plus, Siemens Optipoint 410
Entry, Siemens Optipoint 410
Standard, Siemens Optipoint 420
Advanced, Siemens Optipoint
420 Economy, Siemens Optipoint
420 Economy Plus, Siemens
Optipoint 420 Standard, Siemens
optiPoint 400, SwissVoice IP 10
S, Thomson ST2030-SG, UT
Starcom iAN-02EX, UniData WI
P-5000, Uniden UIP200, ZyXEL
P2002, ZyXEL P2302R

6.11.3.11.5 clear
This command is used to clear the fileserver-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/IpDeviceMgmt/Fileserver> level.
2) Enter:
clear <deviceType> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 196
 Variable Field Type Valid Values Description

<deviceType> Choice Aastra 480i, Aastra 480i CT, This parameter specifies the
Aastra 53i, Aastra 55i, Aastra device type.
57i, Aastra 57iCT, Aastra
9112i, Aastra 9133i, Business
Communicator - PC, Cisco 7905,
Cisco 7912, Cisco 7940, Cisco
7960, Cisco ATA-186, Cisco Sccp
7905(G), Cisco Sccp 7906(G),
Cisco Sccp 7911(G), Cisco Sccp
7912(G), Cisco Sccp 7940(G),
Cisco Sccp 7941G(E), Cisco
Sccp 7942G, Cisco Sccp 7945
G, Cisco Sccp 7960(G), Cisco
Sccp 7960(G) 7914 1, Cisco Sccp
7960(G) 7914 2, Cisco Sccp 7961
G(E), Cisco Sccp 7961G(E) 7914
1, Cisco Sccp 7961G(E) 7914 2,
Cisco Sccp 7962G, Cisco Sccp
7962G 7914 1, Cisco Sccp 7962
G 7914 2, Cisco Sccp 7962G
7915 1, Cisco Sccp 7962G 7915
2, Cisco Sccp 7962G 7916 1,
Cisco Sccp 7962G 7916 2, Cisco
Sccp 7965G, Cisco Sccp 7965G
7914 1, Cisco Sccp 7965G 7914
2, Cisco Sccp 7965G 7915 1,
Cisco Sccp 7965G 7915 2, Cisco
Sccp 7965G 7916 1, Cisco Sccp
7965G 7916 2, Cisco Sccp 7970
G(E), Cisco Sccp 7970G(E) 7914
1, Cisco Sccp 7970G(E) 7914 2,
Cisco Sccp 7971G, Cisco Sccp
7971G 7914 1, Cisco Sccp 7971
G 7914 2, Cisco Sccp 7975,
Cisco Sccp 7975 7914 1, Cisco
Sccp 7975 7914 2, Cisco Sccp
7975 7915 1, Cisco Sccp 7975
7915 2, Cisco Sccp 7975 7916 1,
Cisco Sccp 7975 7916 2, Dasan
Networks H415SE, Grandstream
BT-200, Grandstream GX
P-2000, Grandstream GX
P-2020, Grandstream GX
V-3000, Grandstream GX
W-4004, Grandstream GX
W-4008, Grandstream HT-502,
InnoMedia 3308, InnoMedia
3328-1, InnoMedia 3328-2,
InnoMedia 3328-4, InnoMedia
3328-8, InnoMedia 6328-2, LG-
Nortel LIP-6812, LG-Nortel LI
P-6830, Linksys PAP2, Linksys
PAP2T, Linksys RTP300_WRT
P54G, Linksys SPA-1000 1001,
Linksys SPA-2000 2002 2100,
Linksys SPA-2102, Linksys SP
A-3000 3100, Linksys SPA-3102,
Linksys SPA-841, Linksys SP
A-901_921_922, Linksys SP
A-941_942, Linksys SPA-962,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 197
 Variable Field Type Valid Values Description
Mitel 5055, Mitel 5212, Mitel
5215, Mitel 5220, Mitel 5224,
Mitel 5235, Mitel Navigator,
Moimstone IP250C, Polycom
Soundpoint IP 300, Polycom
Soundpoint IP 320 330, Polycom
Soundpoint IP 4000, Polycom
Soundpoint IP 430, Polycom
Soundpoint IP 500, Polycom
Soundpoint IP 550, Polycom
Soundpoint IP 600, Polycom
Soundpoint IP 601, Polycom
Soundpoint IP 650, Quantier
IPR-720E, SNOM 320, SNO
M 360, Siemens Optipoint
410 Advanced, Siemens
Optipoint 410 Economy,
Siemens Optipoint 410 Economy
Plus, Siemens Optipoint 410
Entry, Siemens Optipoint 410
Standard, Siemens Optipoint 420
Advanced, Siemens Optipoint
420 Economy, Siemens Optipoint
420 Economy Plus, Siemens
Optipoint 420 Standard, Siemens
optiPoint 400, SwissVoice IP 10
S, Thomson ST2030-SG, UT
Starcom iAN-02EX, UniData WI
P-5000, Uniden UIP200, ZyXEL
P2002, ZyXEL P2302R

<attribute> MultipleChoice extendedCaptureFileReposName The name of an attribute to

modify.

6.11.4 MgcpCodec
This level allows display, addition, and deletion of code-related parameters and attributes.

6.11.4.1 get
This command displays the active codecs of the Application Server.
1) Ensure you are at the /AS_CLI/System/Device/MgcpCodec> level.
2) Enter:
get↵

6.11.4.2 add
This command is used to add a codec for use.
1) Ensure you are at the /AS_CLI/System/Device/MgcpCodec> level.
2) Enter:
add <codec>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 198
 Variable Field Type Valid Values Description

<codec> Choice clear, PCMA, PCMU, G722, A codec.

G723-53, G723-63, G723A-53,
G723A-63, G726-16, G726-24,
G726-32, G726-40, G728,
G729-8, G729B-8, GSMEFR,
GSMFR, AMR-WB

6.11.4.3 delete
This command is used to delete a codec from the system. Note that G711ulaw (G.711 u-Law 64000 bps)
cannot be deleted.
1) Ensure you are at the /AS_CLI/System/Device/MgcpCodec> level.
2) Enter:
delete <codec>↵
where:
Variable Field Type Valid Values Description

<codec> String 0 to 255 characters Name of the codec to be deleted.

6.11.5 Monitor
There are two contexts in the Monitor level: AccessDevice and NetworkDevice.

6.11.5.1 AccessDevice
The access device monitoring feature enhances the existing device inventory feature by keeping the
connection status of access devices and by making BroadWorks the central point from which it is possible
to configure all access devices.The purpose of this feature is to make network management easier by
providing a central point from which it is possible to configure and obtain the status of access devices.
6.11.5.1.1 get
This command is used to view monitored device type and polling intervals.
1) Ensure you are at the /AS_CLI/System/Device/Monitor/AccessDevice> level.
2) Enter:
get↵
6.11.5.1.2 add
This command is used to add a device type to the CPE monitoring engine.
1) Ensure you are at the /AS_CLI/System/Device/Monitor/AccessDevice> level.
2) Enter:
add <deviceType>↵
where:
Variable Field Type Valid Values Description

<deviceType> String 1 to 80 characters Enter the device type or enter "all'

to monitor all valid device types.

6.11.5.1.3 set
This command is used to modify the polling interval of monitored device types.
1) Ensure you are at the /AS_CLI/System/Device/Monitor/AccessDevice> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 199
 2) Enter:
set <pollingIntervalInMin>↵
where:
Variable Field Type Valid Values Description

<pollingInterval Integer 0 through 1440 The interval at which the device

InMin> should be monitored (in minutes).

6.11.5.1.4 delete
This command is used to remove a device type from the CPE monitoring engine.
1) Ensure you are at the /AS_CLI/System/Device/Monitor/AccessDevice> level.
2) Enter:
delete <deviceType>↵
where:
Variable Field Type Valid Values Description

<deviceType> String 1 to 80 characters Enter the device type or enter "all'

to monitor all valid device types.

6.11.5.2 NetworkDevice
At startup, the Application Server assumes that all Network Servers and Media Servers are operational.
At an interval specified by the set command, all Network Servers and Media Servers whose polling states
are enabled, are pinged. A successful "ping" results in the server being marked as operational. A failed
"ping" results in the server being marked as non-operational. The failed server is placed on the failed ping
schedule and is kept on that schedule until it is successfully pinged.
6.11.5.2.1 get
This command retrieves configuration data related to network device monitoring. Currently, the only
parameter is the polling interval.
1) Ensure you are at the /AS_CLI/System/Device/Monitor/NetworkDevice> level.
2) Enter:
get↵
6.11.5.2.2 set
This command modifies the SIP "pinging" intervals of monitored network devices. The intervals are
specified in minutes.
1) Ensure you are at the /AS_CLI/System/Device/Monitor/NetworkDevice> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice pollingIntervalInMin, failedPolling The name of an attribute to

IntervalInMin modify.

<pollingInterval Integer 0 through 1440 Pinging interval (in minutes). The

InMin> default is 5 minutes; a value of 0
indicates that pinging is disabled.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 200
 Variable Field Type Valid Values Description

<failedPolling Integer 1 through 720 Sets the polling interval for non-
IntervalInMin> operational servers. The default
value is 1 minute. A failed "ping"
results in the server being marked
as non-operational and placed
on the failed ping schedule. The
failed server will be kept on this
schedule until it is successfully
pinged.

6.11.6 NetworkServers
This level is used to view and configure addressable Network Servers. The Network Server provides
policy-based call routing and translations. The Application Server keeps a list of all the addressable
Network Servers available to the Application Server. The Network Server context is split into two separate
contexts to allow a different port to be set for each function: routing and synching. A routing Network
Server translates to a "lookup" type with reference to the OCI and a synching Network Server translates to
an "update" type with reference to the OCI. If a Network Server is to perform both functions, it now must to
be added in both the Routing and Synch CLI contexts.

6.11.6.1 Routing
This level is used to view and modify routing Network Server-related attributes.
6.11.6.1.1 get
This command is used to view routing Network Server-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/NetworkServers/Routing> level.
2) Enter:
get↵
6.11.6.1.2 add
This command is used to add a new routing Network Server.
1) Ensure you are at the /AS_CLI/System/Device/NetworkServers/Routing> level.
2) Enter:
add <ipAddress> <transportType> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The corresponding IP address,

host name, or domain for the
routing Network Server.

<transport Choice udp, tcp, unspecified Specifies which transport type

Type> is used by this server. When
"unspecified" is selected, either
protocol is allowed.

<attribute> MultipleChoice port, poll, description Additional attributes to include

through the add command.

<port> Integer 1025 through 65535 Specifies the port for the routing
Network Server.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 201
 Variable Field Type Valid Values Description

<poll> Choice true, false Enables server polling (or

pinging).

<description> String 1 to 80 characters The routing Network Server's

description.

6.11.6.1.3 set
This command is used to modify Routing Network Server-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/NetworkServers/Routing> level.
2) Enter:
set <ipAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The corresponding IP address,

host name, or domain for the
routing Network Server.

<attribute> MultipleChoice port, transportType, poll, The name of an attribute to

description modify.

<port> Integer 1025 through 65535 Specifies the port for the routing
Network Server.

<transport Choice udp, tcp, unspecified Specifies which transport type

Type> is used by this server. When
"unspecified" is selected, either
protocol is allowed.

<poll> Choice true, false Enables server polling (or

pinging).

<description> String 1 to 80 characters The routing Network Server's

description.

6.11.6.1.4 delete
This command is used to delete a routing Network Server entry.
1) Ensure you are at the /AS_CLI/System/Device/NetworkServers/Routing> level.
2) Enter:
delete <ipAddress>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The corresponding IP address,

host name, or domain for the
routing Network Server.

6.11.6.1.5 clear
This command is used to clear (set to no value) routing Network Server-related attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 202
 1) Ensure you are at the /AS_CLI/System/Device/NetworkServers/Routing> level.
2) Enter:
clear <ipAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The IP address, host name, or

domain for the routing Network
Server.

<attribute> MultipleChoice port, description The name of the attribute(s) to

clear.

6.11.6.2 Synch
The Network Server context has been split into two separate contexts so as to allow a different port to be
set for each function: routing and synching. A routing Network Server translates to a "lookup" type with
reference to the OCI and a synching Network Server translates to an "update" type with reference to the
OCI. If a Network Server is to perform both functions, it now must to be added in both the Routing and
Synch CLI contexts.
6.11.6.2.1 get
This command is used to view synching Network Server-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/NetworkServers/Synch> level.
2) Enter:
get↵
6.11.6.2.2 add
This command is used to add a new synching Network Server to the system.
1) Ensure you are at the /AS_CLI/System/Device/NetworkServers/Synch> level.
2) Enter:
add <ipAddress> <port> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The corresponding IP address,

host name, or domain for the
synching Network Server.

<port> Integer 1025 through 65535 Specifies the port for the synching
Network Server.

<attribute> MultipleChoice description Additional attributes to include

through the add command.

<description> String 1 to 80 characters The synching Network Server's

description.

6.11.6.2.3 set
This command is used to modify synching Network Server-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/NetworkServers/Synch> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 203
 set <ipAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The corresponding IP address,

host name, or domain for the
synching Network Server.

<attribute> MultipleChoice port, description, preferred The name of an attribute to

modify.

<port> Integer 1025 through 65535 Specifies the port for the synching
Network Server.

<description> String 1 to 80 characters The synching Network Server's

description.

<preferred> String true Specifies if the synching server is

preferred.

6.11.6.2.4 delete
This command is used to delete an existing synching Network Server from the system.
1) Ensure you are at the /AS_CLI/System/Device/NetworkServers/Synch> level.
2) Enter:
delete <ipAddress>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The corresponding IP address,

host name, or domain for the
synching Network Server.

6.11.6.2.5 clear
This command is used to clear synchronization Network Server-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/NetworkServers/Synch> level.
2) Enter:
clear <ipAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The corresponding IP address,

host name, or domain for the
synching Network Server.

<attribute> MultipleChoice description The name of the attribute(s) to

clear.

6.11.7 SMDI
This level is used to view, add, modify, and delete SMDI entries in the system.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 204
6.11.7.1 get
This command is used to view SMDI Terminal Server-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/SMDI> level.
2) Enter:
get [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice deviceName, ipAddress, port, The name of an attribute to filter

description on.

<deviceName> String 1 to 40 characters The name of the device.

<ipAddress> String 2 to 80 characters The IP address, host, or domain

name of the device.

<port> Integer 1 through 65535 The port number of the device.

<description> String 1 to 80 characters The description of the device.

6.11.7.2 add
This command is used to add a new SMDI Terminal Server.
1) Ensure you are at the /AS_CLI/System/Device/SMDI> level.
2) Enter:
add <deviceName> <ipAddress> <port> [<description>]↵
where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device.

<ipAddress> String 2 to 80 characters The IP address, host, or domain

name of the device.

<port> Integer 1 through 65535 The port number of the device.

<description> String 0 to 80 characters The description of the device.

6.11.7.3 set
This command is used to modify SMDI Terminal Server -related attributes.
1) Ensure you are at the /AS_CLI/System/Device/SMDI> level.
2) Enter:
set <deviceName> <attribute>↵
where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 205
 Variable Field Type Valid Values Description

<attribute> MultipleChoice ipAddress, port, description The name of an attribute to

modify.

<ipAddress> String 2 to 80 characters The IP address, host, or domain

name of the device.

<port> Integer 1 through 65535 The port number of the device.

<description> String 1 to 80 characters The description of the device.

6.11.7.4 delete
This command is used to delete an existing SMDI Terminal Server.
1) Ensure you are at the /AS_CLI/System/Device/SMDI> level.
2) Enter:
delete <deviceName>↵
where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device.

6.11.7.5 clear
This command is used to clear SMDI Terminal Server-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/SMDI> level.
2) Enter:
clear <deviceName> <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device.

<clearAttribute> MultipleChoice Description The name of the attribute(s) to

clear.

6.11.7.6 Routing
This level is used to display, add, modify, and delete SMDI Terminal Server route-related attributes.
6.11.7.6.1 get
This command is used to display SMDI Terminal Server route-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/SMDI/Routing> level.
2) Enter:
get [<destination>]↵
where:
Variable Field Type Valid Values Description

<destination> Digit String 3 to 10 digits The routing destination.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 206
6.11.7.6.2 add
This command is used to add a new SMDI Terminal Server Route. Use this command to add a new routing
destination and to associate SMDI terminal servers to that route.
1) Ensure you are at the /AS_CLI/System/Device/SMDI/Routing> level.
2) Enter:
add <destination> <deviceList>↵
where:
Variable Field Type Valid Values Description

<destination> Digit String 3 to 10 digits The routing destination.

<deviceList> MultipleChoice The terminal server(s) for this

destination.

6.11.7.6.3 set
This command is used to modify SMDI Terminal Server route-related attributes.
1) Ensure you are at the /AS_CLI/System/Device/SMDI/Routing> level.
2) Enter:
set <destination> <deviceList>↵
where:
Variable Field Type Valid Values Description

<destination> Digit String 3 to 10 digits The routing destination.

<deviceList> MultipleChoice The terminal server(s) for this

destination.

6.11.7.6.4 delete
This command is used to delete an existing SMDI Terminal Server route.
1) Ensure you are at the /AS_CLI/System/Device/SMDI/Routing> level.
2) Enter:
delete <destination>↵
where:
Variable Field Type Valid Values Description

<destination> Digit String 3 to 10 digits The routing destination to delete.

6.12 DeviceTagSet
This level is used to manage Device Tag Set-related attributes.

6.12.1 get
This command is used to view Device Tag Set-related attributes.
1) Ensure you are at the /AS_CLI/System/DeviceTagSet> level.
2) Enter:
get↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 207
6.12.2 add
This command is used to add an existing Tag Set from the system.
1) Ensure you are at the /AS_CLI/System/DeviceTagSet> level.
2) Enter:
add <tagSetName>↵
where:
Variable Field Type Valid Values Description

<tagSetName> String 1 to 30 characters The name of the tag set.

6.12.3 set
This command is used to modify Tag Set-related attributes.
1) Ensure you are at the /AS_CLI/System/DeviceTagSet> level.
2) Enter:
set <tagSetName> <attribute>↵
where:
Variable Field Type Valid Values Description

<tagSetName> String 1 to 30 characters The name of the tag set.

<attribute> MultipleChoice newTagSetName The name of an attribute to

modify.

<newTagSet String 1 to 30 characters The new name of the tag set.

Name>

6.12.4 delete
This command is used to delete an existing Tag Set from the system.
1) Ensure you are at the /AS_CLI/System/DeviceTagSet> level.
2) Enter:
delete <tagSetName>↵
where:
Variable Field Type Valid Values Description

<tagSetName> String 1 to 30 characters The name of the tag set.

6.12.5 Tags
This level allows for the adding, modifying, or removal of Tags used by a group.

6.12.5.1 get
This command is used to view Tag-related attributes.
1) Ensure you are at the /AS_CLI/System/DeviceTagSet/Tags> level.
2) Enter:
get <tagSet>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 208
 Variable Field Type Valid Values Description

<tagSet> Choice systemTagSet, tagSetName Specifies that the system tag set
should be used.

<tagSetName> String 1 to 30 characters The name of the tag set.

6.12.5.2 add
This command is used to add a new Tag.
1) Ensure you are at the /AS_CLI/System/DeviceTagSet/Tags> level.
2) Enter:
add <tagSet> <tagName> [<tagValue>]↵
where:
Variable Field Type Valid Values Description

<tagSet> Choice systemTagSet, tagSetName The system tag set.

<tagSetName> String 1 to 30 characters The name of the tag set.

<tagName> String 1 to 64 characters The tag name.

<tagValue> String 1 to 256 characters The tag value.

6.12.5.3 set
This command is used to modify Tag-related attributes.
1) Ensure you are at the /AS_CLI/System/DeviceTagSet/Tags> level.
2) Enter:
set <tagSet> <tagName> <attribute>↵
where:
Variable Field Type Valid Values Description

<tagSet> Choice systemTagSet, tagSetName The system tag set.

<tagSetName> String 1 to 30 characters The name of the tag set.

<tagName> String 1 to 64 characters The tag name.

<attribute> MultipleChoice tagValue The name of an attribute to

modify.

<tagValue> String 1 to 256 characters The tag value.

6.12.5.4 delete
This command is used to delete an existing Tag from the system.
1) Ensure you are at the /AS_CLI/System/DeviceTagSet/Tags> level.
2) Enter:
delete <tagSet> <tagName>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 209
 Variable Field Type Valid Values Description

<tagSet> Choice systemTagSet, tagSetName Indicates the system tag set.

<tagSetName> String 1 to 30 characters The name of the tag set.

<tagName> String 1 to 64 characters The tag name.

6.12.5.5 clear
This command is used to clear Tag-related attributes.
1) Ensure you are at the /AS_CLI/System/DeviceTagSet/Tags> level.
2) Enter:
clear <tagSet> <tagName> <attribute>↵
where:
Variable Field Type Valid Values Description

<tagSet> Choice systemTagSet, tagSetName Indicates the system tag set.

<tagSetName> String 1 to 30 characters The name of the tag set.

<tagName> String 1 to 64 characters The tag name.

<attribute> MultipleChoice tagValue The name of the attribute(s) to

clear.

6.13 DeviceType
This level is used to manage device type attributes.

6.13.1 MGCP
This level is used to view, add, modify, and delete MGCP entries.

6.13.1.1 get
This command allows a user to view the list of defined MGCP device types.
1) Ensure you are at the /AS_CLI/System/DeviceType/MGCP> level.
2) Enter:
get↵

6.13.1.2 set
This command allows a user to modify the attributes of a MGCP device type and/or render the device type
obsolete.
1) Ensure you are at the /AS_CLI/System/DeviceType/MGCP> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters The name of this device type.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 210
 Variable Field Type Valid Values Description

<attribute> MultipleChoice obsolete The name of an attribute to

modify.

<obsolete> Choice true, false Specifies if this device type is

obsolete or not.

6.13.2 SIP
This level is used to view, add, modify, and delete SIP entries.

6.13.2.1 get
This command allows a user to view the SIP identity/device profiles.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP> level.
2) Enter:
get↵

6.13.2.2 detail
This command is used to view SIP Device Type attributes.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP> level.
2) Enter:
detail <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters The name of the SIP device type.

6.13.2.3 add
This command is used to add a SIP identity/device profile type.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP> level.
2) Enter:
add <name> <profile> <numberOfPorts> <isConferenceDevice> <isMobilityManagerDevice>
<isMusicOnHoldDevice> <registrationCapable> <authenticateRefer> <authentication>
<autoConfigSoftClient> <isVideoCapable> <holdNormalization> <holdAnnouncementMethod>
<isTrusted> <e164Capable> <routeAdvance> <forwardingOverride> <pbxIntegration>
<requiresBroadWorksDigitCollection> <requiresBroadWorksCallWaitingTone>
<addPCalledPartyId> <wirelessIntegration> <staticRegistrationCapable>
<requiresMWISubscription> <useHistoryInfoHeaderOnAccessSide>
<ringbackToneEarlyMediaSupport> <aocCapable> <supportCallCenterMIMEType>
<supportEmergencyDisconnectControl> <supportIdentityInUPDATEandReINVITE>
<resetEvent> <trunkMode> <unscreenedPresentationIdentityPolicy> <enableMonitoring>
<staticLineOrdering> <bypassMediaTreatment> <supportCauseParameter>
<deviceConfigurationOption> <supportRFC3398> <supportVisualDeviceManagement>
<supportClientSessionInfo> <supportCallInfoConferenceSubscriptionURI>
<supportRemotePartyInfo> [<webBasedConfigURLExtension>]↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 211
 Variable Field Type Valid Values Description

<name> String 1 to 40 characters The name of the identity/device

profile.

<profile> Choice nonIntelligentDeviceAddressing, Indicates the signaling address

nonIntelligentProxyAddressing, type for this profile.
intelligentDeviceAddressing,
intelligentProxyAddressing

<numberOf Choice unlimited, limited When set to unlimited, this

Ports> identity/device profile can have an
unlimited amount of ports. When
set to limited, this identity/device
profile uses a specific number of
ports.

Variable: limited

limited Options specific to the number of

ports on limited mode.

<quantity> Integer 1 through 999999 When limited is "true", specifies

the number of ports.

<isConference Choice true, false Specifies if this identity/device

Device> profile is a conferencing device or
not.

<isMobility Choice true, false Specifies if this identity/device is

Manager a mobility manager device.
Device>

<isMusicOn Choice true, false Specifies if this identity/device

HoldDevice> profile is a Music On Hold device
or not.

<registration Choice true, false Specifies if this identity/device

Capable> profile is capable of registration or
not.

<authenticate Choice true, false When set to "true", triggers

Refer> authentication of SIP REFER
requests.

<authentication> Choice enabled, disabled, enabledWith When this attribute is set to

WebCredentials enabled, the authentication will be
performed using the credentials
contained in the authentication
service and assigned to the
user. When set to disabled, the
device is not authenticated, even
if the authentication service is
assigned to the user. When set to
enabledWithWebCredentials, the
subscriber's OCI login credentials
are used for SIP authentication.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 212
 Variable Field Type Valid Values Description

<autoConfig Choice true, false When set to "true", specifies that

SoftClient> this device has auto-configuration
capability.

<isVideo Choice true, false Specifies if this identity/device

Capable> profile is video capable or not.

<hold Choice useUnspecifiedAddress, use Specifies how the Application

Normalization> Inactive, useRfc3264 Server will perform SDP
normalization on the access
side when attempting to hold the
device media.

<hold Choice useInactive, useBandwidth Specifies the scheme that will be

Announcement Attributes used to modify the answer SDP
Method> when an announcement (MOH) is
being played to the held party.

<isTrusted> Choice true, false Specifies if this identity/device

profile operates on a trusted
network or not.

<e164 Choice true, false Specifies if this identity/device

Capable> profile supports E.164 formatted
strings or not.

<route Choice true, false The network routing service

Advance> is designed to go through a
list of contacts and try each
destination one by one. If the
first destination fails, it tries the
second one; if the second fails,
it tries the third one, and so on.
This behavior is called route
advancing. The routeAdvance
parameter indicates whether or
not the network routing service
should do route advancing. If
this flag is set to "true", the route
processing continues if the first
destination fails. If this flag is
set to "false" the call is released
immediately if the first destination
fails.

<forwarding Choice true, false Specifies whether forwarding

Override> override is enabled.

<pbx Choice true, false Specifies if this identity/device

Integration> profile supports private branch
exchange (PBX) integration or
not.

<requiresBroad Choice true, false Determines whether BroadWorks

WorksDigit is to perform the digit collection.
Collection>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 213
 Variable Field Type Valid Values Description

<requiresBroad Choice true, false Specifies whether the device

WorksCall required the BroadWorks call
WaitingTone> waiting tone.

<addPCalled Choice true, false Enables adding P-Called-Party-

PartyId> ID header on terminating calls to
outgoing requests.

<wireless Choice true, false Specifies whether wireless

Integration> integration is enabled.

<static Choice true, false Specifies if this identity/

Registration device profile supports static
Capable> registrations or not.

<requiresMWI Choice true, false Determines whether a

Subscription> subscription to the message-
summary package is required for
sending MWI to a device.

<useHistory Choice true, false When set to "false", the use

InfoHeaderOn History Info Header On Access
AccessSide> Side device policy is off, and
the system inserts a Diversion
header in all INVITE messages
on the access side (current and
default system behavior). When
set to "true", the use History Info
Header On Access Side device
policy is on, and the system
inserts a History-Info header in all
INVITE messages on the access
side.

<ringbackTone Choice rtp-session, rtp-earlySession, Specifies which type of early

EarlyMedia localRingback-noEarlyMedia media session, if any, this
Support> identity/device profile supports.

<aocCapable> Choice true, false Setting this parameter to true

identifies the device as capable of
receiving and processing Advice
of Charge messages.

<supportCall Choice true, false The SIP system default for

CenterMIME whether an agent's device
Type> supports the Call Center MIME
type.

<support Choice true, false Indicates that the device is

Emergency capable of sending a re-INVITE
Disconnect on disconnect for emergency
Control> calls.

<support Choice true, false Specifies if this Identity/Device

Identity Type supports identity information
InUPDATEand in UPDATE/Re-INVITE message.
ReINVITE>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 214
 Variable Field Type Valid Values Description

<resetEvent> Choice reSync, checkSync, none Specifies the type of reset event.

<trunkMode> Choice pilot, proxy, user Replaces the existing

'useBusinessTrunkingContact'
option with configurable values
'pilot', 'proxy' & 'user'.

<unscreened Choice profilePresentationIdentity, Specifies the presentation identity

Presentation unscreenedPresentationIdentity, of the originator.
IdentityPolicy> unscreenedPresentationIdentity
WithProfileDomain

<enable Choice true, false When set to "true", the customer

Monitoring> premises equipment (CPE)
configuration file is used.
Monitoring is enabled when set to
true.

<staticLine Choice true, false Specifies the static line ordering

Ordering> option: false, true. When set
to "false", static line ordering
is disabled and dynamic port
reordering is enabled. When set
to "true", static line ordering is
enabled and this prevents line
port reordering to occur.

<bypassMedia Choice true, false Indicates whether media

Treatment> treatments are bypassed for the
device type.

<supportCause Choice true, false This parameter determines if the

Parameter> cause parameter is supported.
Valid values are "false" and
"true". When the value is set to
"false", the mapping between
History-Info header and Diversion
header acts in accordance to
the existing configuration. When
the value is set to "true", the
cause URI parameter in History-
Info as specified in RFC 4458
is supported which enables the
mapping between History-Info
header and Diversion header in
accordance to RFC 6044.

<device Choice notSupported, device Specifies the device configuration

Configuration Management, legacy option: notSupported,
Option> deviceManagement, legacy.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 215
 Variable Field Type Valid Values Description

Variable: deviceManagement

deviceManagement Device configuration option value

is deviceManagement.

<deviceAccess Choice http, https, ftp, tftp Specifies the device access
Protocol> protocol.

<tagMode> Choice none, system, sysAndCustom The tag mode.

<allowDevice Choice true, false When set to "true", allows a

ProfileCustom custom tag set for a device type.
TagSet>

<allowGroup Choice true, false When set to "true", allows a

CustomTag custom tag set for a group.
Set>

<sendEmail Choice true, false Specifies whether an e-mail

NotifUponReset notification should be sent upon
Failure> reset failure.

<useHttpDigest Choice true, false Specifies whether HTTP digest

Authentication> should be used to authenticate
devices.

<macBasedFile Choice true, false Specifies whether MAC should be

Authentication> used to authenticate device files.

<userName Choice true, false Specifies whether user name

PasswordFile and password should be used to
Authentication> authenticate device files.

<macInNon Choice true, false Specifies whether MAC address

RequestURI> is provided in non-request URI.

<options> MultipleChoice tagSet, deviceAccessFQDN, Other attributes.

deviceAccessPortNumber,
deviceAccessContextName,
deviceAccessURI, default
DeviceLanguage, defaultDevice
Encoding, userName, macFormat
InNonRequestURI

<tagSet> String 1 to 30 characters A valid tag set name.

<device String 1 to 80 characters The device access FQDN.

AccessFQDN>

<deviceAccess Integer 1 through 65535 The device access port number.

PortNumber>

<deviceAccess String 1 to 80 characters The device access context name.

ContextName>

<device String 1 to 256 characters The URI that the device uses to
AccessURI> retrieve a file.

<defaultDevice String 1 to 40 characters The default language of the

Language> device.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 216
 Variable Field Type Valid Values Description

<defaultDevice String 1 to 40 characters The default device encoding, for

Encoding> example "UTF-8".

<userName> String 1 to 30 characters The user name.

<macFormat String 1 to 256 characters MAC format in non-request URI.

InNon
RequestURI>

Variable: legacy

legacy Device configuration option value

is legacy.

<legacyConfig Choice 2FileConfig, 3FileConfig Specifies the CPE configuration

Type> type.

<systemFile String 1 to 265 characters The name of the configuration

Name> file.

<deviceFile String 1 to 265 characters The configuration file format.

Format>

<supportRF Choice true, false When this parameter is set to

C3398> false, the Application Server
allows remote to local ringback
transitions. When this parameter
is set to true, the Application
Server does not allow remote to
local ringback transitions unless it
determines that the remote side is
another BroadWorks server. The
default value is false.

<support Choice true, false This parameter controls

VisualDevice support for the Visual Device
Management> Management. Valid values are:
"false" and "true". When set to
"false", support for Visual Device
Management is disabled. When
set to "true", support for Visual
Device Management is enabled.

<supportClient Choice true, false This parameter determines

SessionInfo> whether the device type supports
the ability to communicate client
session information.

<supportCall Choice true, false This parameter determines

InfoConference whether the device type supports
SubscriptionURI> the ability to use the Call-Info
conference subscription URI to
subscribe to the conference event
package.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 217
 Variable Field Type Valid Values Description

<support Choice true, false This parameter determines

RemoteParty whether the device type supports
Info> the ability to process the X-
BroadWorks-Remote-Party-Info
header (when available) which
could be used to perform contact
lookup.

<webBased String 1 to 80 characters The URL extension for web-

ConfigURL based configuration.
Extension>

6.13.2.4 set
This command is used to modify the attributes of a SIP identity/device profile type or render the profile
obsolete.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP> level.
2) Enter:
set <name> <options>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters The name of the identity/device

profile.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 218
 Variable Field Type Valid Values Description

<options> MultipleChoice obsolete, registrationCapable, The name of an attribute to

authenticateRefer, authentication, modify.
autoConfigSoftClient, isVideo
Capable, holdNormalization,
holdAnnouncementMethod,
isTrusted, e164Capable,
routeAdvance, forwarding
Override, pbxIntegration,
requiresBroadWorksDigit
Collection, requiresBroadWorks
CallWaitingTone, addPCalled
PartyId, wirelessIntegration,
staticRegistrationCapable,
requiresMWISubscription, use
HistoryInfoHeaderOnAccess
Side, ringbackToneEarlyMedia
Support, aocCapable, support
CallCenterMIMEType, support
EmergencyDisconnectControl,
supportIdentityInUPDATEand
ReINVITE, enableMonitoring,
bypassMediaTreatment, reset
Event, webBasedConfigURL
Extension, deviceAccessProtocol,
tagMode, tagSet, allowDevice
ProfileCustomTagSet, allow
GroupCustomTagSet, send
EmailNotifUponResetFailure,
deviceAccessFQDN, device
AccessPortNumber, device
AccessContextName, default
DeviceLanguage, defaultDevice
Encoding, userName, useHttp
DigestAuthentication, macBased
FileAuthentication, userName
PasswordFileAuthentication, mac
InNonRequestURI, macFormat
InNonRequestURI, trunkMode,
unscreenedPresentationIdentity
Policy, supportRFC3398, support
ClientSessionInfo, supportCall
InfoConferenceSubscriptionURI,
supportRemotePartyInfo, support
VisualDeviceManagement,
supportCauseParameter

<obsolete> Choice true, false Specifies if this device profile is

obsolete or not.

<registration Choice true, false Specifies if this identity/device

Capable> profile is capable of registrations
or not.

<authenticate Choice true, false When set to "true", triggers

Refer> authentication of SIP REFER
requests.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 219
 Variable Field Type Valid Values Description

<authentication> Choice enabled, disabled, enabledWith When this attribute is set to

WebCredentials "enabled", authentication is
performed using the credentials
contained in the Authentication
service and assigned to the
user. When set to "disabled", the
device is not authenticated, even
if the Authentication service is
assigned to the user. When set to
enabledWithWebCredentials, the
subscriber's OCI login credentials
are used for SIP authentication.

<autoConfig Choice true, false When set to "true", specifies that

SoftClient> this device has auto-configuration
capability.

<isVideo Choice true, false Specifies if this identity/device

Capable> profile is video capable or not.

<hold Choice useUnspecifiedAddress, use Specifies how the Application

Normalization> Inactive, useRfc3264 Server will perform SDP
normalization on the access
side when attempting to hold the
device media.

<hold Choice useInactive, useBandwidth Specifies the scheme that will be

Announcement Attributes used to modify the answer SDP
Method> when an announcement (MOH) is
being played to the held party.

<isTrusted> Choice true, false Specifies if this identity/device

profile operates on a trusted
network or not.

<e164 Choice true, false Specifies if this identity/device

Capable> profile supports E.164 formatted
strings or not.

<route Choice true, false The network routing service

Advance> is designed to go through a
list of contacts and try each
destination one by one. If the
first destination fails, it tries the
second one; if the second fails,
it tries the third one, and so on.
This behavior is called route
advancing. The routeAdvance
parameter indicates whether or
not the network routing service
should do route advancing. If
this flag is set to "true", the route
processing continues if the first
destination fails. If this flag is
set to "false" the call is released
immediately if the first destination
fails.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 220
 Variable Field Type Valid Values Description

<forwarding Choice true, false Specifies whether

Override> forwardingOverride is enabled.

<pbx Choice true, false Specifies if this identity/device

Integration> profile supports private branch
exchange (PBX) integration or
not.

<requiresBroad Choice true, false Determines whether BroadWorks

WorksDigit is to perform the digit collection.
Collection>

<requiresBroad Choice true, false Specifies whether the device

WorksCall required the BroadWorks call
WaitingTone> waiting tone.

<addPCalled Choice true, false Enables adding P-Called-Party-

PartyId> ID header on terminating calls to
outgoing requests.

<wireless Choice true, false Specifies whether wireless

Integration> integration is enabled.

<static Choice true, false Specifies if this identity/

Registration device profile supports static
Capable> registrations or not.

<requiresMWI Choice true, false Determines whether a

Subscription> subscription to the message-
summary package is required for
sending MWI to a device.

<useHistory Choice true, false The useHistoryInfoHeaderOn

InfoHeaderOn AccessSide device policy is
AccessSide> off, and the system inserts a
Diversion header in all INVITE
messages on the access side
(current and default system
behavior).

<ringbackTone Choice rtp-session, rtp-earlySession, Specifies which type of early

EarlyMedia localRingback-noEarlyMedia media session, if any, this
Support> identity/device profile supports.

<aocCapable> Choice true, false Setting this parameter to true

identifies the device as capable of
receiving and processing Advice
of Charge messages.

<supportCall Choice true, false The SIP system default for

CenterMIME whether an agent's device
Type> supports the Call Center MIME
type.

<support Choice true, false Indicates that the device is

Emergency capable of sending a re-INVITE
Disconnect on disconnect for emergency
Control> calls.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 221
 Variable Field Type Valid Values Description

<support Choice true, false Specifies if this Identity/Device

Identity Type supports identity information
InUPDATEand in UPDATE/Re-INVITE message.
ReINVITE>

<enable Choice true, false Monitoring is enabled when set to

Monitoring> true.

<bypassMedia Choice true, false Indicates whether media

Treatment> treatments are bypassed for the
device type.

<resetEvent> Choice reSync, checkSync, none Specifies the type of reset event.

<trunkMode> Choice pilot, proxy, user Replaces the existing

'useBusinessTrunkingContact'
option with configurable values
'pilot', 'proxy' & 'user'.

<webBased String 1 to 80 characters The URL extension for web-

ConfigURL based configuration.
Extension>

<deviceAccess Choice http, https, ftp, tftp The device access protocol.
Protocol>

<tagMode> Choice none, system, sysAndCustom The tag mode.

<tagSet> String 1 to 30 characters The tag set.

<allowDevice Choice true, false When set to "true", allows a

ProfileCustom custom tag set for a device type.
TagSet>

<allowGroup Choice true, false When set to "true", allows a

CustomTag custom tag set for a group.
Set>

<sendEmail Choice true, false Specifies whether to send e-mail

NotifUponReset notification when a reset fails.
Failure>

<device String 1 to 80 characters The device access FQDN.

AccessFQDN>

<deviceAccess Integer 1 through 65535 The device access port number.

PortNumber>

<deviceAccess String 1 to 80 characters The device access context name.

ContextName>

<defaultDevice String 1 to 40 characters The default device language.

Language>

<defaultDevice String 1 to 40 characters The default device encoding, for

Encoding> example "UTF-8".

<userName> String 1 to 30 characters The user name.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 222
 Variable Field Type Valid Values Description

<useHttpDigest Choice true, false Specifies whether HTTP digest

Authentication> should be used to authenticate
devices.

<macBasedFile Choice true, false Specifies whether MAC should be

Authentication> used to authenticate device files.

<userName Choice true, false Specifies whether user name

PasswordFile and password should be used to
Authentication> authenticate device files.

<macInNon Choice true, false Specifies whether to include MAC

RequestURI> address in non-request URI.

<macFormat String 1 to 256 characters MAC format in non-request URI.

InNon
RequestURI>

<unscreened Choice profilePresentationIdentity, Specifies the presentation identity

Presentation unscreenedPresentationIdentity, of the originator.
IdentityPolicy> unscreenedPresentationIdentity
WithProfileDomain

<supportRF Choice true, false When this parameter is set to

C3398> false, the Application Server
allows remote to local ringback
transitions. When this parameter
is set to true, the Application
Server does not allow remote to
local ringback transitions unless it
determines that the remote side is
another BroadWorks server. The
default value is false.

<support Choice true, false This parameter determines if this

VisualDevice device type supports the Visual
Management> Device Management portal.

<supportClient Choice true, false This parameter determines

SessionInfo> whether the device type supports
the ability to communicate client
session information.

<supportCall Choice true, false This parameter determines

InfoConference whether the device type supports
SubscriptionURI> the ability to use the Call-Info
conference subscription URI to
subscribe to the conference event
package.

<support Choice true, false This parameter determines

RemoteParty whether the device type supports
Info> the ability to process the X-
BroadWorks-Remote-Party-Info
header (when available) which
could be used to perform contact
lookup.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 223
 Variable Field Type Valid Values Description

<supportCause Choice true, false This parameter determines if the

Parameter> cause parameter is supported.
Valid values are "false" and
"true". When the value is set to
"false", the mapping between
History-Info header and Diversion
header acts in accordance to
the existing configuration. When
the value is set to "true", the
cause URI parameter in History-
Info as specified in RFC 4458
is supported which enables the
mapping between History-Info
header and Diversion header in
accordance to RFC 6044.

6.13.2.5 delete
This command allows a user to delete a SIP identity/device profile from the system.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP> level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters The name of the identity/device

profile.

6.13.2.6 clear
This command allows a user to clear the attributes of a SIP identity/device profile.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters The name of the SIP device type.

<attribute> MultipleChoice webBasedConfigURLExtension, The name of the attribute(s) to

tagSet, deviceAccessFQDN, clear.
deviceAccessPortNumber, device
AccessContextName, default
DeviceLanguage, defaultDevice
Encoding, userName, macFormat
InNonRequestURI

6.13.2.7 export
The export command produces a Device Type Archive File (DTAF) for the given device type name.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 224
 export <name> <destinationPath>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters This is the name of device type to

export.

<destination String 1 to 255 characters The full absolute path where the
Path> DTAF file will be stored.

6.13.2.8 import
The import command creates a Device Type from a Device Type Archive File (DTAF) file.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP> level.
2) Enter:
import <sourceFile>↵
where:
Variable Field Type Valid Values Description

<sourceFile> String 1 to 255 characters The full absolute path of the

DATF file from which to import.

6.13.2.9 Files
This level is used to manage Files per Device Type.
6.13.2.9.1 get
This command is used to view Device Type File-related attributes.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP/Files> level.
2) Enter:
get <deviceTypeName>↵
where:
Variable Field Type Valid Values Description

<deviceType String 1 to 40 characters The name of the device type.

Name>

6.13.2.9.2 detail
This command is used to view Device Type File attributes.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP/Files> level.
2) Enter:
detail <deviceTypeName> <fileFormat>↵
where:
Variable Field Type Valid Values Description

<deviceType String 1 to 40 characters The name of the device type.

Name>

<fileFormat> String 1 to 128 characters The file format.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 225
6.13.2.9.3 add
This command is used to add a new Device Type File.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP/Files> level.
2) Enter:
add <deviceTypeName> <fileFormat> <remoteFileFormat> <fileCategory> <fileCustomization>
<fileSource> <useHttpDigestAuthentication> <macBasedFileAuthentication>
<userNamePasswordFileAuthentication> <macInNonRequestURI> <allowHttp> <allowHttps>
<allowTftp> <enableCaching> [<attribute>] <true>↵
where:
Variable Field Type Valid Values Description

<deviceType String 1 to 40 characters The name of the device type.

Name>

<fileFormat> String 1 to 128 characters The file format.

<remoteFile String 1 to 128 characters The remote file format.

Format>

<fileCategory> Choice static, dynamicGroup, dynamic The file category.

Profile

<file Choice disallowed, administrator, When set to "disallowed", file

Customization> administratorAndUser customization is not allowed.
When set to "administrator",
file customization is allowed
for administrators. When set
to "administratorAndUser", file
customization is allowed for
administrators and users.

<fileSource> Choice manual, custom The file source.

Variable: custom

custom Specifies that the file source is

"custom" and gives the custom
file uploadPath.

<uploadFile String 1 to 256 characters The upload file path for the
Path> custom file source.

<useHttpDigest Choice true, false Specifies whether HTTP digest-

Authentication> based authentication should be
used.

<macBasedFile Choice true, false Specifies whether MAC-based file

Authentication> authentication is enabled.

<userName Choice true, false Specifies whether user name

PasswordFile and password-based file
Authentication> authentication is enabled.

<macInNon Choice true, false Specifies whether MAC in non-

RequestURI> request URI is enabled.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 226
 Variable Field Type Valid Values Description

<allowHttp> Choice true, false When true, specifies that the

HTTP protocol is allowed for file
download, otherwise is forbidden
(default is true).

<allowHttps> Choice true, false When true, specifies that the

HTTPS protocol is allowed for file
download, otherwise is forbidden
(default is true).

<allowTftp> Choice true, false When true, specifies that the

TFTP protocol is allowed for file
download, otherwise is forbidden
(default is true).

<enable Choice true, false Enables file caching for the

Caching> specified file on the XSP.

<attribute> MultipleChoice allowUploadFromDevice, mac Additional attributes to include

FormatInNonRequestURI through the add command.

<allowUpload Choice true, false When set to "true", allows the file
FromDevice> to be uploaded from the device,
otherwise upload of the file will be
blocked.

<true> Allows the file to be uploaded

from the device.

<macFormat String 1 to 256 characters Specifies the MAC format in non-

InNon request URI.
RequestURI>

6.13.2.9.4 set
This command is used to modify Device Type File-related attributes.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP/Files> level.
2) Enter:
set <deviceTypeName> <fileFormat> <attribute>↵
where:
Variable Field Type Valid Values Description

<deviceType String 1 to 40 characters The name of the identity/device

Name> profile.

<fileFormat> String 1 to 128 characters The file format.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 227
 Variable Field Type Valid Values Description

<attribute> MultipleChoice fileCustomization, fileSource, The name of an attribute to

uploadFilePath, useHttpDigest modify.
Authentication, macBased
FileAuthentication, userName
PasswordFileAuthentication, mac
InNonRequestURI, macFormatIn
NonRequestURI, allowHttp, allow
Https, allowTftp, enableCaching,
allowUploadFromDevice, default
ExtendedFileCaptureMode

<file Choice disallowed, administrator, When set to "disallowed", file

Customization> administratorAndUser customization is not allowed.
When set to "administrator",
file customization is allowed
for administrators. When set
to "administratorAndUser", file
customization is allowed for
administrators and users.

<fileSource> Choice manual, custom The file source.

<uploadFile String 1 to 256 characters The upload file path for the
Path> custom file source.

<useHttpDigest Choice true, false Specifies whether HTTP digest-

Authentication> based authentication should be
used.

<macBasedFile Choice true, false Specifies whether MAC-based file

Authentication> authentication is enabled.

<userName Choice true, false Specifies whether user name

PasswordFile and password-based file
Authentication> authentication is enabled.

<macInNon Choice true, false Specifies whether MAC in non-

RequestURI> request URI is enabled.

<macFormat String 1 to 256 characters Specifies the MAC format in non-

InNon request URI.
RequestURI>

<allowHttp> Choice true, false When true, specifies that the

HTTP protocol is allowed for file
download, otherwise is forbidden
(default is true).

<allowHttps> Choice true, false When true, specifies that the

HTTPS protocol is allowed for file
download, otherwise is forbidden
(default is true).

<allowTftp> Choice true, false When true, specifies that the

TFTP protocol is allowed for file
download, otherwise is forbidden
(default is true).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 228
 Variable Field Type Valid Values Description

<enable Choice true, false Enables file caching for the

Caching> specified file on the XSP.

<allowUpload Choice true, false When set to "true", allows the file
FromDevice> to be uploaded from the device,
otherwise upload of the file will be
blocked.

<default Choice true, false This parameter is the default

ExtendedFile value assigned to the extended
CaptureMode> file capture attribute of a newly
created profile instance.

6.13.2.9.5 delete
This command is used to delete an existing Device Type File from the system.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP/Files> level.
2) Enter:
delete <deviceTypeName> <fileFormat>↵
where:
Variable Field Type Valid Values Description

<deviceType String 1 to 40 characters The name of the device type.

Name>

<fileFormat> String 1 to 128 characters The file format.

6.13.2.9.6 clear
This command is used to clear Device Type File-related attributes.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP/Files> level.
2) Enter:
clear <deviceTypeName> <fileFormat> <attribute>↵
where:
Variable Field Type Valid Values Description

<deviceType String 1 to 40 characters The name of the device type.

Name>

<fileFormat> String 1 to 128 characters The file format.

<attribute> MultipleChoice macFormatInNonRequestURI The name of the attribute(s) to

clear.

6.13.2.9.7 apply
This command is used to apply an attribute value to all of the profile instances.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP/Files> level.
2) Enter:
apply <deviceTypeName> <fileFormat> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 229
 Variable Field Type Valid Values Description

<deviceType String 1 to 40 characters The name of the device type.

Name>

<fileFormat> String 1 to 128 characters The file format.

<attribute> MultipleChoice defaultExtendedFileCaptureMode The name of the attribute(s) to

apply.

<default Choice true, false This parameter enables or

ExtendedFile disables the extended file capture
CaptureMode> on upload from a device. When
enabled, new files uploaded from
a device are kept in the extended
capture file repository until a
configurable threshold is reached.
Once the threshold is reached,
the oldest is deleted. When
disabled, new files uploaded from
a device overwrite the previous
version in the file repository.
NOTE: The association between
devices and file repositories
is made under the Fileserver
context.

6.13.2.10 Languages
This level is used to view, add, modify, and delete Language entries.
6.13.2.10.1 get
This command is used to view Language-related attributes.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP/Languages> level.
2) Enter:
get <deviceTypeName>↵
where:
Variable Field Type Valid Values Description

<deviceType String 1 to 40 characters The name of the device type.

Name>

6.13.2.10.2 set
This command is used to modify Language-related attributes.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP/Languages> level.
2) Enter:
set <deviceTypeName> <broadworksLanguage> <deviceLanguage>↵
where:
Variable Field Type Valid Values Description

<deviceType String 1 to 40 characters The name of the device type.

Name>

<broadworks String 1 to 40 characters The BroadWorks language.

Language>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 230
 Variable Field Type Valid Values Description

<device String 1 to 40 characters The device language.

Language>

6.13.2.10.3 clear
This command is used to clear Language-related attributes.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP/Languages> level.
2) Enter:
clear <deviceTypeName> <broadworksLanguage> <attribute>↵
where:
Variable Field Type Valid Values Description

<deviceType String 1 to 40 characters The name of the device type.

Name>

<broadworks String 1 to 40 characters The BroadWorks language.

Language>

<attribute> MultipleChoice deviceLanguage The name of the attribute(s) to

clear.

6.13.2.11 LineOrdering
This level is used to manage the Session Initiation Protocol (SIP) device type line ordering attributes.
6.13.2.11.1 get
This command is used to view the status of a line ordering mode update task.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP/LineOrdering> level.
2) Enter:
get↵
6.13.2.11.2 set
This command is used to change the line ordering mode of an existing device type.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP/LineOrdering> level.
2) Enter:
set <deviceTypeName> <mode>↵
where:
Variable Field Type Valid Values Description

<deviceType String 1 to 40 characters The device type name.

Name>

<mode> Choice dynamic, static The line ordering mode: static or

dynamic.

6.13.2.11.3 cancel
This command is used to gracefully stop a line ordering mode update task.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP/LineOrdering> level.
2) Enter:
cancel↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 231
6.13.2.12 Services
This level is used to manage SIP device type services.
6.13.2.12.1 get
This command is used to view SIP Device Type Services-related attributes.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP/Services> level.
2) Enter:
get <deviceTypeName>↵
where:
Variable Field Type Valid Values Description

<deviceType String 1 to 40 characters The device type name.

Name>

6.13.2.12.2 set
This command is used to modify SIP Device Type Services-related attributes.
1) Ensure you are at the /AS_CLI/System/DeviceType/SIP/Services> level.
2) Enter:
set <deviceTypeName> <attribute>↵
where:
Variable Field Type Valid Values Description

<deviceType String 1 to 40 characters The device type name.

Name>

<attribute> MultipleChoice supportsPolycomPhoneServices The name of an attribute to

modify.

<supports Choice true, false Specifies whether Polycom

PolycomPhone Phone Services are supported.
Services>

6.14 Domain
The system administrator can specify a domain name for the system, which is used for subscriber
identification on BroadWorks. The domain name is used for subscriber identification in SIP and for the
digest authentication realm in SIP. With the domainName system parameter, the system administrator can
set both the SIP authentication realm and the domain for routing messages for BroadWorks subscribers
using one command.

6.14.1 get
The domain name is viewed using this command.
1) Ensure you are at the /AS_CLI/System/Domain> level.
2) Enter:
get↵

6.14.2 set
The set command is used to reset the system's domain name, so that the default realm of "BroadWorks"
is used for SIP authentication and SIP subscriber identification is handled via the Application Server
addresses as specified via the configured interfaces.Changes to the domainName take effect
immediately.WARNING: This parameter should be set with caution. Every time this parameter is changed,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 232
 it invalidates the authentication password for all subscribers in the system with the authentication service.
Changing this parameter requires every BroadWorks subscriber with the authentication service to re-enter
his or her authentication password. Note that the system must be restarted for the new default system
domain to take effect.
1) Ensure you are at the /AS_CLI/System/Domain> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice defaultSystemDomainName, use The name of an attribute to

AliasForDomain modify.

<defaultSystem String 2 to 80 characters The default system-wide domain

DomainName> name. This cannot be set to an
existing domain.

<useAliasFor Choice true, false Determines if an alias is used for

Domain> the domain name.

6.15 EventNotification
This level is used to view and modify Event Notification-related attributes.

6.15.1 get
This command is used to view Event Notification-related attributes.
1) Ensure you are at the /AS_CLI/System/EventNotification> level.
2) Enter:
get↵

6.15.2 set
This command is used to modify Event Notification-related attributes.
1) Ensure you are at the /AS_CLI/System/EventNotification> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 233
 Variable Field Type Valid Values Description

<attribute> MultipleChoice sipSubscriptionMaxExpirationIn The name of an attribute to

Seconds, ocicUserSubscription modify.
MaxExpirationInSeconds, ocic
GroupAdminSubscriptionMax
ExpirationInSeconds, ocicSp
AdminSubscriptionMaxExpiration
InSeconds, ocicSysAdmin
SubscriptionMaxExpirationIn
Seconds, ocicSubscriptionQuery
MaxResponseSize, userMax
ChannelExpirationSeconds,
groupAdminMaxChannel
ExpirationSeconds, spAdmin
MaxChannelExpirationSeconds,
systemAdminMaxChannel
ExpirationSeconds, channel
StatefulExpirationMinutes,
subscriptionResyncEventsPer
Second

<sip Integer 3600 through 2147483647 Sets the maximum expiration

Subscription time in seconds for the SIP
MaxExpiration subscription event. The default
InSeconds> value is 86400 seconds.

<ocicUser Integer 3600 through 2147483647 OCI-C user subscription

Subscription maximum expiration time in
MaxExpiration seconds.
InSeconds>

<ocicGroup Integer 3600 through 2147483647 OCI-C group administrator

Admin subscription maximum expiration
Subscription time in seconds.
MaxExpiration
InSeconds>

<ocicSpAdmin Integer 3600 through 2147483647 OCI-C service provider

Subscription administrator subscription
MaxExpiration maximum expiration time in
InSeconds> seconds.

<ocicSysAdmin Integer 3600 through 2147483647 OCI-C system/provisioning

Subscription administrator subscription
MaxExpiration maximum expiration time in
InSeconds> seconds.

<ocic Integer 1 through 2147483647 The maximum number of entries

Subscription that can be returned in an OCI-C
QueryMax subscription query.
ResponseSize>

<userMax Integer 3600 through 2147483647 The maximum allowed channel

Channel expiration value for Users.
Expiration
Seconds>

<groupAdmin Integer 3600 through 2147483647 The maximum allowed channel

MaxChannel expiration value for group admins.
Expiration
Seconds>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 234
 Variable Field Type Valid Values Description

<spAdmin Integer 3600 through 2147483647 The maximum allowed channel

MaxChannel expiration value for service
Expiration provider admins.
Seconds>

<systemAdmin Integer 3600 through 2147483647 The maximum allowed channel

MaxChannel expiration value for the system
Expiration admins.
Seconds>

<channel Integer 0 through 60 The number of minutes before a

Stateful stateful expiration occurs.
Expiration
Minutes>

<subscription Integer 1 through 5000 The rate to throttle the

ResyncEvents SubscriptionResyncEvents per
PerSecond> second.

6.15.3 ChannelSets
The Event Notification Channel Sets.

6.15.3.1 get
This command is used to view Event Channels sets. If the search produces over 1,000 entries, an
error message will be displayed and user should refine the search criteria to narrow the search. The
subscriberId used in the search criteria may be either a user Id or an administrator Id.
1) Ensure you are at the /AS_CLI/System/EventNotification/ChannelSets> level.
2) Enter:
get [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice subscriberIdStarts, subscriberId The name of an attribute to

Contains, subscriberIdEqualTo modify.

<subscriberId String 0 to 161 characters Displays only channel sets whose

Starts> subscriber ID starts with the
specified string.

<subscriberId String 0 to 161 characters Displays only channel sets

Contains> whose subscriber ID contains the
specified string.

<subscriberId String 1 to 161 characters Displays only channel sets

EqualTo> whose subscriber ID matches the
specified string.

6.15.3.2 Channels
This level is used to view and delete Event Notification Channel entries in the system.
6.15.3.2.1 get
This command is used to view Event Channels for the specified channel set Id and the specified subscriber
Id. The subscriber Id may be either a user Id or an administrator Id. If the value for the Expires column
contains a value of max int (2147483647) then the Expires column will show a value of Never.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 235
 1) Ensure you are at the /AS_CLI/System/EventNotification/ChannelSets/Channels> level.
2) Enter:
get <channelSetId> <subscriberId>↵
where:
Variable Field Type Valid Values Description

<channelSetId> String 1 to 256 characters Displays only channels whose

channel set ID matches the
specified string.

<subscriberId> String 1 to 161 characters Displays only channels whose

subscriber ID matches the
specified string.

6.15.3.2.2 delete
This command is used to delete the Event Notification Channel specified by the channelId.
1) Ensure you are at the /AS_CLI/System/EventNotification/ChannelSets/Channels> level.
2) Enter:
delete <channelId>↵
where:
Variable Field Type Valid Values Description

<channelId> String 1 to 256 characters Deletes the channel whose

channel ID matches the specified
string.

6.15.4 Subscription
This level is used to view, add, modify, and delete Subscriptions entries in the system.

6.15.4.1 get
This command issues a subscription request for the specified user ID. A subscription is a request to
monitor the events of other users. Currently only off hook and do not disturb (DND) events are reported.
1) Ensure you are at the /AS_CLI/System/EventNotification/Subscription> level.
2) Enter:
get [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice subscriberId, targetType, event Get command filtering criteria.

Package, channelSetId

<subscriberId> String 2 to 161 characters Defines the subscriber id for the

subscriptions to be displayed.

<targetType> Choice system, serviceProvider, group, Defines the Target Type for the
user, endpoint, list subscriptions to be displayed.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 236
 Variable Field Type Valid Values Description

<event Choice cap-offhook, cap-dnd, message- Defines the Event Package for
Package> summary, call-info, calling- the subscriptions to be listed.
name, cap-call-detail, line-
seize, cap-cpe, agent-availabil
ity, dialog, ac-meta, as-ftr,
acd-state, join-cc, cfa, line-
status, call-compl-orig, call-
compl-term, vm-msg-summary,
call-center-queue, basic-call,
advanced-call, advanced-call2,
hoteling, broadworks-anywhere,
call-forwarding-always, call-
forwarding-busy, call-forwarding
-no-answer, commpilot-expre
ss, call-waiting, do-not-disturb,
hoteling-guest, music-on-hold,
remote-office, sequential-ring
, simultaneous-ring-personal,
ACD-agent, ACD-configuration,
call-transfer, last-number-red
ial, n-way-call, three-way-call,
third-party-voice-mail-support,
voice-messaging, call-center-sta
tus, basic-call-xsi, standard-call,
advanced-call-xsi, acd-queue,
route-point-queue, voice-mail,
call-center-agent-monitoring,
call-center-monitoring, meet-
me-conference, call-recording,
flexible-seating-guest, security-
classification, call-park, call-park-
xsi, collaborate-room

<channelSetId> String 1 to 256 characters Defines the Channel Set Id for the
subscriptions to be displayed.

6.15.4.2 detail
This command is used display Subscription detail attributes.
1) Ensure you are at the /AS_CLI/System/EventNotification/Subscription> level.
2) Enter:
detail <id>↵
where:
Variable Field Type Valid Values Description

<id> Integer 1 through 2147483647 The user ID of the person

for whom you want to view
registration location.

6.15.4.3 delete
This command removes the subscription to the event notification mechanism for a specific user.
1) Ensure you are at the /AS_CLI/System/EventNotification/Subscription> level.
2) Enter:
delete [<id>]↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 237
 where:
Variable Field Type Valid Values Description

<id> Integer 1 through 2147483647 The user ID of the person whose

subscription you want to remove.

6.16 GeneralSettings
This level is used to view and modify the general settings of the BroadWorks server.

6.16.1 get
This command is used to view general attributes.
1) Ensure you are at the /AS_CLI/System/GeneralSettings> level.
2) Enter:
get↵

6.16.2 set
This command is used to modify general attributes.
1) Ensure you are at the /AS_CLI/System/GeneralSettings> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice preferIPv4Stack, configureIPFilter The name of an attribute to

modify.

<preferIPv4 Choice true, false This parameter specifies

Stack> the value of the
java.net.preferIPv4Stack property
used to start starting java
processes. The default value is
"true". It must be set to "false" to
to use IPv6 for the process.

<configureIP Choice true, false This parameter indicates whether

Filter> or not Broadworks configure the
IP filtering functionality of the OS.
In case the functionality currently
supported by Broadworks is
not sufficient, an administrator
could manually configure the IP
filtering function by setting this
parameter to false. When doing,
the file produced by Broadworks
containing the rules are still
produced but are not transferred
into the OS.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 238
6.17 Licensing
The use of BroadWorks and the Application Server is conditional on licensing agreements. Information
regarding licensing can be viewed and modified.

6.17.1 get
This command is used to view Licensing-related attributes.
1) Ensure you are at the /AS_CLI/System/Licensing> level.
2) Enter:
get↵

6.17.2 LicenseManager
This level is used to view and modify the License Manager settings.

6.17.2.1 getpermission
This command forces the License Manager to execute the entire license permission request process,
including the validation of the license.
1) Ensure you are at the /AS_CLI/System/Licensing/LicenseManager> level.
2) Enter:
getpermission↵

6.17.2.2 showpermission
This command shows the current license permission state of the License Manager.
1) Ensure you are at the /AS_CLI/System/Licensing/LicenseManager> level.
2) Enter:
showpermission↵

6.17.2.3 Bcct
This level is used to view and modify the BroadWorks Common Communication Transport (BCCT)
settings.
6.17.2.3.1 Ports
This level is used to view and modify the BroadWorks Common Communication Transport (BCCT) ports
settings.
6.17.2.3.1.1 get
This command is used to view the BroadWorks Common Communication Transport (BCCT) ports settings.
1) Ensure you are at the /AS_CLI/System/Licensing/LicenseManager/Bcct/Ports> level.
2) Enter:
get↵
6.17.2.3.1.2 set
This command is used to modify the BroadWorks Common Communication Transport (BCCT) ports
settings.
1) Ensure you are at the /AS_CLI/System/Licensing/LicenseManager/Bcct/Ports> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 239
 Variable Field Type Valid Values Description

<attribute> MultipleChoice secured Identifies an attribute to modify.

<secured> Integer 1024 through 65535 This parameter specifies the

Transport Layer Security (TLS)
secured port for the license
manager.

6.17.2.4 GeneralSettings
This level is used to view and modify the general settings.
6.17.2.4.1 get
This command is used to view general settings-related attributes.
1) Ensure you are at the /AS_CLI/System/Licensing/LicenseManager/GeneralSettings>
level.
2) Enter:
get↵
6.17.2.4.2 set
This command is used to modify general settings-related attributes.
1) Ensure you are at the /AS_CLI/System/Licensing/LicenseManager/GeneralSettings>
level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice nfmURI, nfmResponseTimeout The name of an attribute to

InSeconds, licenseProcessing modify.
PeriodInMinutes

<nfmURI> String 1 to 1024 characters This parameter specified the

Network Function Manager farm
Uniform Resource Identifier
(URI). This URI is used by
the node to request license
permission usage to the Network
Function Manager.

<nfmResponse Integer 1 through 20 This parameter determines

TimeoutIn the maximum amount of time
Seconds> the license manager waits for
a response from the Network
Function Manager's license
management web application for
a license request.

<license Integer 1440 through 14400 This parameter specifies at which

Processing interval the license processing is
PeriodIn executed (in minutes).
Minutes>

6.17.2.4.3 clear
This command is used to clear (set to no value) general settings-related attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 240
 1) Ensure you are at the /AS_CLI/System/Licensing/LicenseManager/GeneralSettings>
level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice nfmURI The name of the attribute to clear.

6.17.2.5 GracePeriods
This level is used to view and modify the grace periods settings.
6.17.2.5.1 get
This command is used to view grace periods settings-related attributes.
1) Ensure you are at the /AS_CLI/System/Licensing/LicenseManager/GracePeriods> level.
2) Enter:
get↵
6.17.2.5.2 set
This command is used to modify grace periods settings-related attributes.
1) Ensure you are at the /AS_CLI/System/Licensing/LicenseManager/GracePeriods> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice mediumSeverityThreshold, high The name of an attribute to

SeverityThreshold, criticalSeverity modify.
Threshold

<medium Integer 1 through 100 This parameter specifies how

Severity long (in % of total grace period)
Threshold> the license manager waits before
sending a medium severity
notification after a grace period
starts.

<highSeverity Integer 1 through 100 This parameter specifies how

Threshold> long (in % of total grace period)
the license manager waits
before sending a high severity
notification after a grace period
starts.

<criticalSeverity Integer 1 through 100 This parameter specifies how

Threshold> long (in % of total grace period)
the license manager waits
before sending a critical severity
notification after a grace period
starts.

6.17.2.6 LicenseStore
This level is used to view and manage the BroadWorks License Store.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 241
6.17.2.6.1 delete
This command deletes the specified license version from the License Manager store. Only non-active local
license can be deleted, NFM provided license can only be managed from the NFM.
1) Ensure you are at the /AS_CLI/System/Licensing/LicenseManager/LicenseStore> level.
2) Enter:
delete <version>↵
where:
Variable Field Type Valid Values Description

<version> String 1 to 10 characters This parameter specifies the

version of the license to delete.

6.17.2.6.2 import
This command imports a license file into the License Manager license store.
1) Ensure you are at the /AS_CLI/System/Licensing/LicenseManager/LicenseStore> level.
2) Enter:
import <fileName>↵
where:
Variable Field Type Valid Values Description

<fileName> String 1 to 300 characters This parameter specifies the

license file to import into the
License Manager license store.

6.17.2.6.3 showLicenses
This command shows the content of the License Manager license store.
1) Ensure you are at the /AS_CLI/System/Licensing/LicenseManager/LicenseStore> level.
2) Enter:
showLicenses↵

6.17.2.7 Logging
This level is used to view and modify logging for the License Manager.
6.17.2.7.1 get
This command is used to view logging-related attributes.
1) Ensure you are at the /AS_CLI/System/Licensing/LicenseManager/Logging> level.
2) Enter:
get↵
6.17.2.7.2 set
This command is used to modify logging-related attributes.
1) Ensure you are at the /AS_CLI/System/Licensing/LicenseManager/Logging> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 242
 Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, severity, priority, max This parameter specifies the
QueueSize, showThreadName attribute to be modified.

<enabled> Choice true, false This parameter turns the logging

on and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn default logging severity level.

<priority> Integer 1 through 5 This parameter specifies the

priority of the logging thread. The
value "1" indicates the lowest
priority and "5" indicates the
highest.

<maxQueue Integer 0 through 2147483647 This parameter specifies the

Size> maximum size of the logging
queue.

<showThread Choice true, false This parameter enables thread

Name> name logging.

6.17.2.7.3 InputChannels
This level is used to view, modify, or clear input channels entries.
6.17.2.7.3.1 get
This command is used to view input channels-related attributes.
1) Ensure you are at the /AS_CLI/System/Licensing/LicenseManager/Logging/
InputChannels> level.
2) Enter:
get↵
6.17.2.7.3.2 set
This command is used to modify input channels-related attributes.
1) Ensure you are at the /AS_CLI/System/Licensing/LicenseManager/Logging/
InputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice LicenseManager, Generic, This parameter specifies the

BroadsoftCommon name of the logging input
CommunicationTransport, channel.
BroadsoftCommon
CommunicationTransportKeep
Alive, NameService, Timer,
SMAP

<attribute> MultipleChoice enabled, severity The name of an attribute to

modify.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 243
 Variable Field Type Valid Values Description

<enabled> Choice true, false This parameter turns the logging

to the logging input channel on
and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn severity level of the logging input
channel.

6.17.2.7.3.3 clear
This command is used to clear input channels-related attributes.
1) Ensure you are at the /AS_CLI/System/Licensing/LicenseManager/Logging/
InputChannels> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice LicenseManager, Generic, This parameter specifies the

BroadsoftCommon name of the logging input
CommunicationTransport, channel.
BroadsoftCommon
CommunicationTransportKeep
Alive, NameService, Timer,
SMAP

<attribute> MultipleChoice severity The name of an attribute to clear.

6.17.2.7.4 OutputChannels
This level is used to view, modify, or clear output channels.
6.17.2.7.4.1 get
This command is used to view output channels-related attributes.
1) Ensure you are at the /AS_CLI/System/Licensing/LicenseManager/Logging/
OutputChannels> level.
2) Enter:
get↵
6.17.2.7.4.2 set
This command is used to modify output channels-related attributes.
1) Ensure you are at the /AS_CLI/System/Licensing/LicenseManager/Logging/
OutputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Stdout, File This parameter specifies the

name of the logging output
channel.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 244
 Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, directory, filePrefix, file The name of an attribute to

SizeInMB, numberOfFiles modify.

<enabled> Choice true, false This parameter turns the logging

to the logging output channel on
and off.

<directory> String 1 to 256 characters This parameter specifies the

directory where the log files are
located.

<filePrefix> String 1 to 256 characters This parameter specifies the

prefix of the log files.

<fileSizeInMB> Integer 1 through 2000 This parameter specifies the

maximum size of a log file.

<numberOf Integer 1 through 65535 This parameter specifies the

Files> maximum number of log files that
exist before the old log files are
deleted.

6.18 ManagementAccessList
This level is used to view, add, set, delete, and clear a management access list entry.

6.18.1 get
This command is used to view management access list entry-related attributes.
1) Ensure you are at the /AS_CLI/System/ManagementAccessList> level.
2) Enter:
get↵

6.18.2 add
This command is used to add a new management access list entry-related attributes.
1) Ensure you are at the /AS_CLI/System/ManagementAccessList> level.
2) Enter:
add <host> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<host> String 1 to 39 characters This parameter specifies the

Internet Protocol (IP) address of
the network element that sends
requests to the BroadWorks
node.

<attribute> MultipleChoice description Additional attributes to include

through the add command.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 245
 Variable Field Type Valid Values Description

<description> String 1 to 80 characters This parameter specifies the

description of the entry.

6.18.3 set
This command is used to modify an existing management access list entry.
1) Ensure you are at the /AS_CLI/System/ManagementAccessList> level.
2) Enter:
set <host> <attribute>↵
where:
Variable Field Type Valid Values Description

<host> String 1 to 39 characters This parameter specifies the

Internet Protocol (IP) address of
the network element that sends
requests to the BroadWorks
node.

<attribute> MultipleChoice description The name of an attribute to

modify.

<description> String 1 to 80 characters This parameter specifies the

description of the entry.

6.18.4 delete
This command is used to delete an existing management access list entry.
1) Ensure you are at the /AS_CLI/System/ManagementAccessList> level.
2) Enter:
delete <host>↵
where:
Variable Field Type Valid Values Description

<host> String 1 to 39 characters This parameter specifies the

Internet Protocol (IP) address of
the network element that sends
requests to the BroadWorks
node.

6.18.5 clear
This command is used to clear management access list entry-related attributes.
1) Ensure you are at the /AS_CLI/System/ManagementAccessList> level.
2) Enter:
clear <host> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 246
 Variable Field Type Valid Values Description

<host> String 1 to 39 characters This parameter specifies the

Internet Protocol (IP) address of
the network element that sends
requests to the BroadWorks
node.

<attribute> MultipleChoice description The name of an attribute to

modify.

6.19 MediaFileSystem
This level is used to configure the way the media file server accesses audio and video files. The media
file server can access files using Hypertext Transfer Protocol (HTTP). In this case, the Application Server
provides the Uniform Resource Locator (URL) that specifies where the files are available. This URL
usually resolves in the host name of the Application Server that is handling the call. Web-based Distributed
Authoring and Versioning (WebDAV) is a set of extensions to the HTTP and allows users to collaboratively
edit and manage files on remote Web Servers. When using WebDAV (or secure WebDAV), the Media
Server directly accesses files that are stored on the external file server.

6.19.1 get
This command is used to view media file system-related attributes.
1) Ensure you are at the /AS_CLI/System/MediaFileSystem> level.
2) Enter:
get↵

6.19.2 set
This command is used to modify media file system-related attributes.
1) Ensure you are at the /AS_CLI/System/MediaFileSystem> level.
2) Enter:
set <mediaDirectory> <protocol>↵
where:
Variable Field Type Valid Values Description

<media String 1 to 256 characters Indicates the directory where all

Directory> audio/video files are located on
the server.

<protocol> Choice file, webdav Specifies if the local file system or

a remote webdav server it used.

Variable: file

file Use the local file system.

<replicated> Choice true, false Specifies if the local file system is

replicated or not.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 247
 Variable Field Type Valid Values Description

Variable: webdav

webdav Use a webdav based repository.

<secure> Choice true, false Specifies if the connection to the

webdav server is secure or not.

<fileFQDN> String 1 to 80 characters Webdav repository FQDN.

<userName> String 1 to 40 characters Webdav user name.

<password> String 1 to 40 characters Webdav password.

6.19.3 clear
This command is used to clear (set to no value) media file system-related attributes.
1) Ensure you are at the /AS_CLI/System/MediaFileSystem> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice userName, password The name of the attribute to

delete.

6.20 MobileNetwork
This level is used to manage Mobile Networks.

6.20.1 HomeNetwork
This level is used to manage Home Mobile Networks.

6.20.1.1 get
This command is used to view Home Network-related attributes. At least one of the parameters defined in
the multiple choice attribute needs to be specified in order to search all addresses in the home network.
If the search produces over 1,000 entries, an error message will be displayed and user should refine the
search criteria to narrow the search.
1) Ensure you are at the /AS_CLI/System/MobileNetwork/HomeNetwork> level.
2) Enter:
get <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice mscAddressStarts, mscAddress The name of an attribute to filter

Contains, mscAddressEqualTo on.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 248
 Variable Field Type Valid Values Description

<mscAddress String 0 to 23 characters MSC Address starts with search

Starts> criteria. Can be the start of an
E.164 number or a National
number that will be normalized
to an E.164 number using the
default system country code.

<mscAddress String 0 to 23 characters MSC Address contains search

Contains> criteria.

<mscAddress String 1 to 23 characters MSC Address exact match

EqualTo> search criteria.

6.20.1.2 add
This command is used to add a single address to the Home Network in the system.
1) Ensure you are at the /AS_CLI/System/MobileNetwork/HomeNetwork> level.
2) Enter:
add <mscAddress>↵
where:
Variable Field Type Valid Values Description

<mscAddress> String 1 to 23 characters MSC Address to add to the

Home Network. Can be an E.164
number or a National number that
will be normalized to an E.164
number using the default system
country code.

6.20.1.3 delete
This command is used to delete an address from the Home Network.
1) Ensure you are at the /AS_CLI/System/MobileNetwork/HomeNetwork> level.
2) Enter:
delete <mscAddress>↵
where:
Variable Field Type Valid Values Description

<mscAddress> String 1 to 23 characters MSC Address to delete from the

Home Network. Can be an E.164
number or a National number that
will be normalized to an E.164
number using the default system
country code.

6.20.2 RoamingNetwork
This level is used to manage Roaming Mobile Networks.

6.20.2.1 get
This command is used to view Roaming Network-related attributes. At least one of the parameters defined
in the multiple choice attribute needs to be specified in order to search all addresses in the roaming

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 249
 network. If the search produces over 1,000 entries, an error message will be displayed and user should
refine the search criteria to narrow the search.
1) Ensure you are at the /AS_CLI/System/MobileNetwork/RoamingNetwork> level.
2) Enter:
get <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice mscAddressStarts, mscAddress The name of an attribute to filter

Contains, mscAddressEqualTo on.

<mscAddress String 0 to 23 characters MSC Address starts with search

Starts> criteria. Can be the start of an
E.164 number or a National
number that will be normalized
to an E.164 number using the
default system country code.

<mscAddress String 0 to 23 characters MSC Address contains search

Contains> criteria.

<mscAddress String 1 to 23 characters MSC Address exact match

EqualTo> search criteria.

6.20.2.2 add
This command is used to add a single address to the Roaming Network.
1) Ensure you are at the /AS_CLI/System/MobileNetwork/RoamingNetwork> level.
2) Enter:
add <mscAddress> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<mscAddress> String 1 to 23 characters MSC Address to add to the

Roaming Network. Can be an
E.164 number or a National
number that will be normalized
to an E.164 number using the
default system country code.

<attribute> MultipleChoice networkTranslationIndex Additional attributes to include

through the add command.

<network String 1 to 128 characters Optional Network Translation

Translation Index used to identify the
Index> Enterprise and Public translations
used for the address.

6.20.2.3 set
This command is used to modify a single address in the Roaming Network.
1) Ensure you are at the /AS_CLI/System/MobileNetwork/RoamingNetwork> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 250
 set <mscAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<mscAddress> String 1 to 23 characters MSC Address to modify. Can be

an E.164 number or a National
number that will be normalized
to an E.164 number using the
default system country code.

<attribute> MultipleChoice networkTranslationIndex The name of an attribute to

modify.

<network String 1 to 128 characters Network Translation Index to be

Translation used for the roaming address.
Index>

6.20.2.4 delete
This command is used to delete an address from the Roaming Network.
1) Ensure you are at the /AS_CLI/System/MobileNetwork/RoamingNetwork> level.
2) Enter:
delete <mscAddress>↵
where:
Variable Field Type Valid Values Description

<mscAddress> String 1 to 23 characters MSC Address to delete. Can be

an E.164 number or a National
number that will be normalized
to an E.164 number using the
default system country code.

6.20.2.5 clear
This command is used to clear address-related attributes in the Roaming Network.
1) Ensure you are at the /AS_CLI/System/MobileNetwork/RoamingNetwork> level.
2) Enter:
clear <mscAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<mscAddress> String 1 to 23 characters MSC Address to clear. Can be

an E.164 number or a National
number that will be normalized
to an E.164 number using the
default system country code.

<attribute> MultipleChoice networkTranslationIndex The name of the attribute(s) to

clear.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 251
6.21 NetworkAccessLists
This level is used to configure network access lists for devices from which calls or messages are accepted
by the Application Server.

6.21.1 get
This command is used to view whether or not the system uses Access Control Lists to prevent network
access from unauthorized SIP devices.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists> level.
2) Enter:
get↵

6.21.2 set
This command is used to enable or disable the use of Access Control Lists to prevent or allow access from
unauthorized SIP devices.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice restrictSIPAccess The name of an attribute to

modify.

<restrictSIP Choice true, false Enables or disables the use of

Access> ACLs for SIP devices. Default is
false.

6.21.3 CAP
This level is used to view and modify Client Application Protocol (CAP) Access Control List (ACL) entry-
related attributes.

6.21.3.1 get
This command is used to view Client Application Protocol (CAP) Access Control List (ACL) entry-related
attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/CAP> level.
2) Enter:
get↵

6.21.3.2 add
This command is used to add a new Client Application Protocol (CAP) network device Access Control List
(ACL) entry.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/CAP> level.
2) Enter:
add <hostAddress> [<description>]↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 252
 Variable Field Type Valid Values Description

<hostAddress> String 1 to 80 characters The host name, domain name, or

IP address of the device.

<description> String 0 to 80 characters A character-based description of

the device from which calls are
permitted.

6.21.3.3 set
This command is used to modify Client Application Protocol (CAP) network device Access Control List
(ACL) entry-related attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/CAP> level.
2) Enter:
set <hostAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<hostAddress> String 1 to 80 characters The host name, domain name, or

IP address of the device.

<attribute> MultipleChoice description The name of an attribute to

modify.

<description> String 1 to 80 characters A character-based description of

the device from which calls are
permitted.

6.21.3.4 delete
This command is used to delete a Client Application Protocol (CAP) network device Access Control List
(ACL) entry.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/CAP> level.
2) Enter:
delete <hostAddress>↵
where:
Variable Field Type Valid Values Description

<hostAddress> String 1 to 80 characters The host name, domain name, or

IP address of the device.

6.21.3.5 clear
This command is used to clear (set to no value) Client Application Protocol (CAP) network device Access
Control List (ACL) entry-related attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/CAP> level.
2) Enter:
clear <hostAddress> <clearAttribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 253
 Variable Field Type Valid Values Description

<hostAddress> String 1 to 80 characters The host name, domain name, or

IP address of the device.

<clearAttribute> MultipleChoice description The name of the attribute(s) to

clear.

6.21.4 ExtAuth
This level is used to view and modify external authentication Access Control List (ACL)-related attributes.

6.21.4.1 get
This command is used to view external authentication Access Control List (ACL)-related attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/ExtAuth> level.
2) Enter:
get [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice ipAddress, description The name of an attribute to filter

on.

<ipAddress> String 1 to 39 characters The IP address of the device.

<description> String 1 to 80 characters The description of the device.

6.21.4.2 add
This command is used to add a new external authentication Access Control List (ACL) entry.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/ExtAuth> level.
2) Enter:
add <ipAddress> [<description>]↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters The IP address of the network

device from which calls are
permitted.

<description> String 0 to 80 characters A character-based description of

the device from which calls are
permitted.

6.21.4.3 set
This command is used to modify external authentication Access Control List (ACL)-related entry attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/ExtAuth> level.
2) Enter:
set <ipAddress> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 254
 Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters The IP address of the network

device from which calls are
permitted.

<attribute> MultipleChoice description The name of an attribute to

modify.

<description> String 1 to 80 characters A character-based description of

the device from which calls are
permitted.

6.21.4.4 delete
This command is used to delete an existing external authentication Access Control List (ACL) entry.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/ExtAuth> level.
2) Enter:
delete <ipAddress>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters The IP address of the network

device from which calls are
permitted.

6.21.4.5 clear
This command is used to clear (set to no value) external authentication Access Control List (ACL)-related
entry attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/ExtAuth> level.
2) Enter:
clear <ipAddress> <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters The IP address of the network

device from which calls are
permitted.

<clearAttribute> MultipleChoice description The name of the attribute(s) to

clear.

6.21.5 OCI
The Open Client Interface (OCI) level is used to display, add, configure, or delete OCI ACL entry-related
attributes.

6.21.5.1 CallControl
This level is used to manage OCI CallControl-related attributes.
6.21.5.1.1 get
This command allows you to view OCI-related attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/CallControl> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 255
 2) Enter:
get [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice ipAddress, description The name of an attribute to filter

on.

<ipAddress> String 1 to 39 characters The IP address of the device.

<description> String 1 to 80 characters The description of the device.

6.21.5.1.2 add
This command allows you to add a new OCI ACL entry.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/CallControl> level.
2) Enter:
add <ipAddress> [<description>]↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters Indicates the IP address of the

specified access control entry,
which is an external system.

<description> String 1 to 80 characters The description of the access

control entry (external system).

6.21.5.1.3 set
This command allows you to modify OCI-related attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/CallControl> level.
2) Enter:
set <ipAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters Indicates the IP address of the

specified access control list entry,
which is the external system.

<attribute> MultipleChoice description The name of an attribute to

modify.

<description> String 1 to 80 characters The description of the access

control list entry (external
system).

6.21.5.1.4 delete
This command allows you to delete an existing OCI external system ACL entry from the system.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/CallControl> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 256
 delete <ipAddress>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters Indicates the IP Address of the

specified access control list entry.

6.21.5.1.5 clear
This command allows you to clear OCI-related attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/CallControl> level.
2) Enter:
clear <ipAddress> <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters Indicates the IP address of the

specified access control list entry,
which is the external system.

<clearAttribute> MultipleChoice description The name of the attribute(s) to

clear.

6.21.5.1.6 Application
The Application ACL (Access Control List) for an OCI-C application controls the addresses from which
OCI-C connections are allowed for a specific application. If no Application ACL is configured for an
application, then OCI-C connections are allowed for the application from all addresses in the Network ACL
for the OCI-C Interface. If Application ACL is configured for an application, then only those addresses
are allowed to have OCI-C connections for the application. Note that Network ACL has precedence
over Application ACL, and Application ACL must be a subset of Network ACL. This is not enforced by
provisioning, but if an address is added to the Application ACL but not the Network ACL, then OCI-C
connections from the address are rejected since the client is not valid per the Network ACL. This level is
used to view, add, modify, and delete Application entries.
6.21.5.1.6.1 get
This command is used to view OCI Call Control Application ACL Entry-related attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/CallControl/
Application> level.
2) Enter:
get <applicationId>↵
where:
Variable Field Type Valid Values Description

<applicationId> String 1 to 80 characters The application identifier.

6.21.5.1.6.2 add
This command is used to add a new OCI Call Control Application ACL Entry. The ipAddress given must be
present in the parent OCI Call Control ACL list.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/CallControl/
Application> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 257
 add <applicationId> <ipAddress> [<description>]↵
where:
Variable Field Type Valid Values Description

<applicationId> String 1 to 80 characters The application identifier.

<ipAddress> String 1 to 39 characters The address of the application

host.

<description> String 1 to 80 characters A description of the application.

6.21.5.1.6.3 set
This command is used to modify OCI Call Control Application ACL Entry-related attributes. The ipAddress
given must be present in the parent OCI Call Control ACL list.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/CallControl/
Application> level.
2) Enter:
set <applicationId> <ipAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<applicationId> String 1 to 80 characters The application identifier.

<ipAddress> String 1 to 39 characters The address of the application

host.

<attribute> MultipleChoice description The name of an attribute to

modify.

<description> String 1 to 80 characters A description of the application.

6.21.5.1.6.4 delete
This command is used to delete an existing OCI Call Control Application ACL Entry from the system.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/CallControl/
Application> level.
2) Enter:
delete <applicationId> <ipAddress>↵
where:
Variable Field Type Valid Values Description

<applicationId> String 1 to 80 characters The application identifier.

<ipAddress> String 1 to 39 characters The address of the application

host.

6.21.5.1.6.5 clear
This command is used to clear OCI Call Control Application ACL Entry-related attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/CallControl/
Application> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 258
 2) Enter:
clear <applicationId> <ipAddress> <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<applicationId> String 1 to 80 characters The application identifier.

<ipAddress> String 1 to 39 characters The address of the application

host.

<clearAttribute> MultipleChoice description The name of the attribute(s) to

clear.

6.21.5.2 Provisioning
This level is used to manage OCI Provisioning Access Control-related attributes.
6.21.5.2.1 get
This command is used to view OCI Provisioning Access Control-related attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/Provisioning> level.
2) Enter:
get [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice hostAddress, description The name of an attribute to filter

on.

<hostAddress> String 1 to 80 characters The IP address, host name, or

domain of the device.

<description> String 1 to 80 characters The description of the device.

6.21.5.2.2 add
This command is used to add a new OCI Provisioning Access Control.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/Provisioning> level.
2) Enter:
add <hostAddress> [<description>]↵
where:
Variable Field Type Valid Values Description

<hostAddress> String 1 to 80 characters Indicates the IP address or

fully qualified host name of the
specified access control list entry,
which is the external system.

<description> String 1 to 80 characters The description of the access

control list entry (external
system).

6.21.5.2.3 set
This command is used to modify OCI Provisioning Access Control-related attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 259
 1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/Provisioning> level.
2) Enter:
set <hostAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<hostAddress> String 1 to 80 characters Indicates the IP address or

fully qualified host name of the
specified access control list entry,
which is the external system.

<attribute> MultipleChoice description The name of an attribute to

modify.

<description> String 1 to 80 characters The description of the access

control list entry (external
system).

6.21.5.2.4 delete
This command is used to delete an existing OCI Provisioning Access Control from the system.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/Provisioning> level.
2) Enter:
delete <hostAddress>↵
where:
Variable Field Type Valid Values Description

<hostAddress> String 1 to 80 characters Indicates the IP address or

fully qualified host name of the
specified access control list entry,
which is the external system.

6.21.5.2.5 clear
This command is used to clear OCI Provisioning Access Control-related attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/Provisioning> level.
2) Enter:
clear <hostAddress> <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<hostAddress> String 1 to 80 characters Indicates the IP address or

fully qualified host name of the
specified access control list entry,
which is the external system.

<clearAttribute> MultipleChoice description The name of the attribute(s) to

clear.

6.21.5.3 Reporting
The Open Client Interface (OCI) Reporting Interface provides a reporting interface for the Application
Server. The Application Server relays successfully executed OCI modification requests to external systems
over the OCI Reporting Interface so that these systems have an up-to-date view of configuration data.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 260
 The external systems can include, but are not limited to, third-party services platforms, customer care
platforms, and data mining applications. An access control list (ACL) is used to indicate which external
systems can connect to the Application Server for notifications. The system administrator uses this level to
configure the access control list for OCI reporting by adding the address for external systems to the access
control list. An address can be an IP address or a fully qualified host name. External systems whose
addresses are in the access control list are permitted to connect to the Application Server. One connection
is permitted per IP address. The Application Server then sends OCIReportingReportNotifications to all
connections.
6.21.5.3.1 get
This command is used to view OCI Reporting ACL entry-related attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/Reporting> level.
2) Enter:
get [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice hostAddress, description The name of an attribute to filter

on.

<hostAddress> String 1 to 80 characters The IP address, host name, or

domain of the device.

<description> String 1 to 80 characters The description of the device.

6.21.5.3.2 add
This command allows you to add a new OCI-reporting ACL entry.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/Reporting> level.
2) Enter:
add <hostAddress> <restrictMessages> [<description>]↵
where:
Variable Field Type Valid Values Description

<hostAddress> String 1 to 80 characters Indicates the IP address or

fully qualified host name of the
specified access control list entry,
which is the external system.

<restrict Choice true, false Specifies whether messages from

Messages> this host should be restricted.

<description> String 1 to 80 characters The description of the access

control list entry (external
system).

6.21.5.3.3 set
This command allows you to modify OCI reporting-related attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/Reporting> level.
2) Enter:
set <hostAddress> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 261
 Variable Field Type Valid Values Description

<hostAddress> String 1 to 80 characters Indicates the IP address or fully

qualified host name.

<attribute> MultipleChoice restrictMessages, description The name of an attribute to

modify.

<restrict Choice true, false Specifies whether messages from

Messages> this host should be restricted.

<description> String 1 to 80 characters The description of the access

control list entry (external
system).

6.21.5.3.4 delete
This command allows you to delete an existing OCI-reporting external system ACL entry from the system.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/Reporting> level.
2) Enter:
delete <hostAddress>↵
where:
Variable Field Type Valid Values Description

<hostAddress> String 1 to 80 characters Indicates the IP address or

fully qualified host name of the
specified access control list entry,
which is the external system.

6.21.5.3.5 clear
This command allows you to clear OCI reporting-related attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/Reporting> level.
2) Enter:
clear <hostAddress> <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<hostAddress> String 1 to 80 characters Indicates the IP address or

fully qualified host name of the
specified access control list entry,
which is the external system.

<clearAttribute> MultipleChoice description The name of the attribute(s) to

clear.

6.21.5.3.6 MessageTypes
This level is used to manage OCI Reporting ACL Message Types-related attributes.
6.21.5.3.6.1 get
This command is used to view OCI Reporting ACL Message Types-related attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/Reporting/
MessageTypes> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 262
 get <hostAddress>↵
where:
Variable Field Type Valid Values Description

<hostAddress> String 1 to 80 characters Indicates the IP address or

fully qualified host name of the
specified access control list entry,
which is the external system.

6.21.5.3.6.2 add
This command is used to add new OCI Reporting ACL Message Types.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/Reporting/
MessageTypes> level.
2) Enter:
add <hostAddress> <messageNameStartsWith>↵
where:
Variable Field Type Valid Values Description

<hostAddress> String 1 to 80 characters Indicates the IP address or

fully qualified host name of the
specified access control list entry,
which is the external system.

<message String 1 to 256 characters The string that the message

NameStarts starts with.
With>

6.21.5.3.6.3 delete
This command is used to delete an existing OCI Reporting ACL Message Types from the system.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/OCI/Reporting/
MessageTypes> level.
2) Enter:
delete <hostAddress> [<messageNameStartsWith>]↵
where:
Variable Field Type Valid Values Description

<hostAddress> String 1 to 80 characters Indicates the IP address or

fully qualified host name of the
specified access control list entry,
which is the external system.

<message String 1 to 256 characters The string that the message

NameStarts starts with.
With>

6.21.6 SIP
This level is used to view and modify the Internet Protocol (IP) addresses configured for Session Initiation
Protocol (SIP) network devices. These are the IP addresses from which network messages (SIP) will
be honored. The Application Server's own IP addresses must be entered for inter-group calling to be
permitted. It is recommended that you also add the IP addresses of the other core BroadWorks servers to

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 263
 the SIP access control list, including the Network Server, Media Server, and Conferencing Server. Only IP
addresses may be used; fully qualified domain names (FQDNs) are not accepted.

6.21.6.1 get
This command is used to view the Internet Protocol (IP) addresses configured for Session Initiation
Protocol (SIP) network devices.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/SIP> level.
2) Enter:
get↵

6.21.6.2 add
This command is used to add Session Initiation Protocol (SIP) network devices to the access list.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/SIP> level.
2) Enter:
add <ipAddress> <transportType> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters The IP address of the network

device from which calls are
permitted.

<transport Choice udp, tcp, all Specifies which transport type

Type> is used by this device. When
unspecified is selected, either
protocol is allowed.

<attribute> MultipleChoice description The name of an attribute to add

through the add command.

<description> String 1 to 80 characters A character-based description of

the device from which calls are
permitted.

6.21.6.3 set
This command is used to modify the attributes of the Internet Protocol (IP) addresses configured for
Session Initiation Protocol (SIP) network devices.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/SIP> level.
2) Enter:
set <ipAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters The IP address of the network

device from which calls are
permitted.

<attribute> MultipleChoice transportType, description The name of an attribute to

modify.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 264
 Variable Field Type Valid Values Description

<transport Choice udp, tcp, all Specifies which transport type

Type> is used by this device. When
unspecified is selected, either
protocol is allowed.

<description> String 1 to 80 characters A character-based description of

the device from which calls are
permitted.

6.21.6.4 delete
This command is used to delete Session Initiation Protocol (SIP) network devices from the access list.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/SIP> level.
2) Enter:
delete <ipAddress>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters The IP address of the network

device from which calls are
permitted.

6.21.6.5 clear
This command is used to clear (set to no value) the Internet Protocol (IP) addresses or description
configured for Session Initiation Protocol (SIP) network devices.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/SIP> level.
2) Enter:
clear <ipAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters Indicates the IP address or

fully qualified host name of the
specified access control list entry,
which is the external system.

<attribute> MultipleChoice description The name of the attribute to

delete.

6.21.7 SMDI
The Simplified Message Desk Interface (SMDI) level is used to configure devices from which calls will be
accepted. Enter IP addresses from which network messages (SMDI) will be honored.

6.21.7.1 get
This command is used to view SMDI ACL entry-related attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/SMDI> level.
2) Enter:
get [<attribute>]↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 265
 where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice ipAddress, description The name of an attribute to filter

on.

<ipAddress> String 1 to 39 characters The IP address of the device.

<description> String 1 to 80 characters The description of the device.

6.21.7.2 add
This command is used to add a new SMDI network device ACL entry.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/SMDI> level.
2) Enter:
add <ipAddress> [<description>]↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters The host name, domain name, or

IP address of the device.

<description> String 0 to 80 characters A character-based description of

the device from which calls are
permitted.

6.21.7.3 set
This command is used to modify SMDI ACL entry-related attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/SMDI> level.
2) Enter:
set <ipAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters The host name, domain name, or

IP address of the device.

<attribute> MultipleChoice description The name of an attribute to

modify.

<description> String 1 to 80 characters A character-based description of

the device from which calls are
permitted.

6.21.7.4 delete
This command is used to delete an existing SMDI network device ACL entry from the system.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/SMDI> level.
2) Enter:
delete <ipAddress>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 266
 where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters The host name, domain name, or

IP address of the device.

6.21.7.5 clear
This command is used to clear SMDI ACL entry-related attributes.
1) Ensure you are at the /AS_CLI/System/NetworkAccessLists/SMDI> level.
2) Enter:
clear <ipAddress> <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters Indicates the IP address or

fully qualified host name of the
specified access control list entry,
which is the external system.

<clearAttribute> MultipleChoice description The name of the attribute(s) to

clear.

6.22 OverloadControls
This level is used to view and modify overload control settings for the Application Server. Since the
Application Server is a line-side facing element for BroadWorks, it can experience an overload condition.
In a disaster or emergency scenario, the Application Server may receive a burst of call originations from
access devices. The OverloadControls feature allows the Application Server to gracefully manage an
overload condition without affecting calls in progress. The Application Server constantly samples input
queue delays. A configurable sample size N is defined (default is 100). If the average value of the last N
queue delay becomes too long, then an overload condition is triggered. The Application Server maintains
two overloaded zones: yellow and red. (The green zone represents a non-overload situation.) Each zone
has a separate configurable queue delay threshold that, when exceeded, causes the Application Server to
go to the next zone. It is possible to go directly from the green to red overload zone. Once in an overload
zone, the server continues to monitor queue delays. When the queue delay average lowers below another
predefined threshold, the server is eligible to go to the next lower overload zone (red to yellow or yellow to
green). However, to avoid hysteresis (constantly alternating between overload zones), there is a minimum
time period that must be met. The minimum time period value does not apply to transitioning to a higher
overload zone, only returning to a lower one. In the yellow zone, the Application Server continues to
process existing calls in progress. If new call originations are detected, only half of them are processed and
the other half are denied. The server continues to process messages for existing calls in progress because
some of the messages may be BYE or CANCEL requests which remove calls, thereby reducing the load
on the server. In the red zone, the Application Server continues to process existing calls in progress. If
new call originations are detected, they are denied. The Application Server remains in the corresponding
overload zone until the queue delay returns to an acceptable threshold value and the minimum time period
in the zone is met. If the system is configured to allow emergency calls during overload, then originations
matching the call type "Emergency" in the system calling plan are allowed to progress. Calls are denied
on the originating side. A user is allowed to add additional call terminations (for example, using flash, or
the Call Manager). However, additional originations from the device are not allowed. Unless the user is
already on a call, Call Manager originated calls are also denied during overload. The Call Manager shows
a "Forbidden" message.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 267
6.22.1 get
This command is used to view the Overload Controls settings.
1) Ensure you are at the /AS_CLI/System/OverloadControls> level.
2) Enter:
get↵

6.22.2 set
This command is used to modify the Overload Controls settings.
1) Ensure you are at the /AS_CLI/System/OverloadControls> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, percentMemoryInUse The name of an attribute to

ToEnterYellow, percentMemory modify.
InUseToEnterRed, percent
MemoryInUseToLeaveYellow,
percentMemoryInUseToLeave
Red, mgcpOverloadAction, sip
OverloadAction, sipReplicated
OverloadAction, allowEmergency
CallsInOverload, maxPacket
AgeInMsecs, maxPacketAge
DuringOverloadInMsecs, support
CongestionManagement, min
RetryAfterInSeconds, max
RetryAfterInSeconds, neighbor
MaxServiceUnavailablePeriod
InSeconds, neighborTraffic
SamplingPeriodInSeconds,
aggregateQueueMonitoring

<enabled> Choice true, false Enables or disables Overload

Controls.

<percent Integer 50 through 100 Specifies the amount of memory

MemoryInUse usage needed for the system to
ToEnterYellow> enter the yellow overloaded zone.

<percent Integer 70 through 100 Specifies the amount of memory

MemoryInUse usage needed for the system to
ToEnterRed> enter the red overloaded zone.

<percent Integer 40 through 100 Specifies the amount of memory

MemoryIn usage needed for the system to
UseToLeave leave the yellow overloaded zone.
Yellow>

<percent Integer 60 through 100 Specifies the amount of memory

MemoryInUse usage needed for the system to
ToLeaveRed> leave the red overloaded zone.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 268
 Variable Field Type Valid Values Description

<mgcpOverload Choice error, drop Specifies the action to be

Action> performed on an incoming
message. Error - Respond to the
message with "409 Processing
Overload" error. Drop - Do not
respond.

<sipOverload Choice error, decline, drop, redirect, Specifies the action to be

Action> unavailable performed on an incoming
message. Redirect - Respond to
the message with "302 Moved
Temporarily" error. Error -
Respond to the message with
"503 Service Unavailable"
error. Decline - Respond to
the message with 603 + Retry-
After. Drop - Do not respond.
Unavailable - Respond to the
message with 480 + Retry-After.

<sipReplicated Choice decline, unavailable The action to take for SIP

Overload messages related to dialogs
Action> eligible for replication that are
not processed during overload.
Decline - Respond to the
message with 603 + Retry-After.
Unavailable - Respond to the
message with 480 + Retry-After.

<allow Choice true, false When set to "true", emergency

Emergency calls are allowed during overload.
CallsIn Note that due to the nature of
Overload> MGCP messaging, emergency
calls from MGCP devices are
blocked in the same manner
as normal calls, regardless of
the system's emergency call
configuration.

<maxPacket Integer 500 through 60000 Specifies the maximum time in

AgeDuring milliseconds for a message to
OverloadIn remain in queue during overload.
Msecs>

<maxPacket Integer 500 through 60000 Specifies the maximum time in

AgeInMsecs> milliseconds for a message to
remain in queue.

<support Choice true, false Specifies whether the Retry-After

Congestion support and related congestion
Management> algorithm is enabled or disabled.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 269
 Variable Field Type Valid Values Description

<minRetryAfter Integer 1 through 3600 Specifies the minimum time that

InSeconds> the neighboring network element
has to wait before sending
messages to the Application
Server. The Retry-After header
value included in the SIP 503
Retry-After header, sent to the
neighboring NE in response
to a dropped message, is a
number selected randomly from
the range between this and
the maxRetryAfterInSeconds
values (effective only if the
supportCongestionManagement
option is set to "true").

<maxRetryAfter Integer 1 through 3600 Specifies the maximum time that

InSeconds> the neighboring network element
has to wait before sending
messages to the Application
Server. The Retry-After header
value included in the SIP 503
Retry-After header, sent to the
neighboring NE in response
to a dropped message, is a
number selected randomly from
the range between this and
the minRetryAfterInSeconds
values (effective only if the
supportCongestionManagement
option is set to "true").

<neighbor Integer 1 through 3600 This parameter specifies the

MaxService maximum time that a neighbor
Unavailable is considered unavailable.
PeriodIn This is done to prevent the
Seconds> Application Server from placing
the downstream neighbor in
congestion control state for an
unreasonable period.

<neighbor Integer 1 through 60 The time period, in seconds,

TrafficSampling over which the neighbor traffic is
PeriodIn sampled to determine traffic load
Seconds> and detect overload condition.

<aggregate Choice true, false Enables monitoring using an

Queue aggregate of data from the
Monitoring> processing queues, versus each
queue separately.

6.22.3 CallP
This level is used to view and modify Overload Controls settings related to call processing.

6.22.3.1 get
This command is used to view Overload Controls settings related to call processing.
1) Ensure you are at the /AS_CLI/System/OverloadControls/CallP> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 270
 2) Enter:
get↵

6.22.3.2 set
This command is used to modify Overload Controls settings related to call processing.
1) Ensure you are at the /AS_CLI/System/OverloadControls/CallP> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice sampleSize, minTimeInZoneIn The name of an attribute to

Msecs, delayInMsecsToEnter modify.
Yellow, delayInMsecsToEnter
Red, delayInMsecsToLeave
Yellow, delayInMsecsToLeave
Red

<sampleSize> Integer 10 through 50000 Specifies queue delay sample

size needed before the overload
controls are activated.

<minTimeIn Integer 1000 through 600000 The minimum amount of time in

ZoneInMsecs> milliseconds that the server must
stay in a specific zone before
returning to a lower one.

<delayInMsecs Integer 500 through 60000 The average queue delay

ToEnterYellow> in milliseconds required to
enter the yellow zone. This
value must be greater than the
DelayToLeaveYellow value but
less than the DelayToLeaveRed
value.

<delayInMsecs Integer 500 through 60000 The average queue delay

ToEnterRed> in milliseconds required to
enter the red zone. This value
must be greater than the
DelayToLeaveRed value.

<delayInMsecs Integer 500 through 60000 The average queue delay in

ToLeave milliseconds required to exit the
Yellow> yellow zone. This value must be
less than the DelayToEnterYellow
value.

<delayInMsecs Integer 500 through 60000 The average queue delay in

ToLeaveRed> milliseconds required to exit the
red zone. This value must be
greater than DelayToEnterYellow
value but less than the
DelayToEnterRed value.

6.22.4 ManagedNeighbors
This level is used to view, add, modify, and delete ManagedNeighbors-related information.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 271
6.22.4.1 Capabilities
This level is used to view and modify the managed neighbor capability parameters. These parameters are
used to store manually set capability parameters for multiple-managed neighbor instances.
6.22.4.1.1 get
This command is used to view neighbor capability parameters.
1) Ensure you are at the /AS_CLI/System/OverloadControls/ManagedNeighbors/
Capabilities> level.
2) Enter:
get↵
6.22.4.1.2 add
This command is used to add a new neighbor and its capability parameters.
1) Ensure you are at the /AS_CLI/System/OverloadControls/ManagedNeighbors/
Capabilities> level.
2) Enter:
add <ipAddress> <retryAfterReceiver> <retryAfterSender> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The managed neighbor IP

address.

<retryAfter Choice true, false Specifies whether the neighbor is

Receiver> a Retry-After receiver.

<retryAfter Choice true, false Specifies whether the neighbor is

Sender> a Retry-After sender.

<attribute> MultipleChoice description Additional attributes to include

through the add command.

<description> String 1 to 80 characters A description of the neighbor.

6.22.4.1.3 set
This command is used to modify managed neighbor capabilities.
1) Ensure you are at the /AS_CLI/System/OverloadControls/ManagedNeighbors/
Capabilities> level.
2) Enter:
set <ipAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The managed neighbor IP

address.

<attribute> MultipleChoice retryAfterReceiver, retryAfter The name of an attribute to

Sender, description modify.

<retryAfter Choice true, false Specifies whether the neighbor is

Receiver> a Retry-After receiver.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 272
 Variable Field Type Valid Values Description

<retryAfter Choice true, false Specifies whether the neighbor is

Sender> a Retry-After sender.

<description> String 1 to 80 characters A description of the managed

neighbor.

6.22.4.1.4 delete
This command is used to remove a managed neighbor with manually set capabilities controls from the
group of Managed Neighbors.
1) Ensure you are at the /AS_CLI/System/OverloadControls/ManagedNeighbors/
Capabilities> level.
2) Enter:
delete <ipAddress>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The managed neighbor IP

address.

6.22.4.1.5 clear
This command is used to clear (set to no value) optional parameters of a neighbor.
1) Ensure you are at the /AS_CLI/System/OverloadControls/ManagedNeighbors/
Capabilities> level.
2) Enter:
clear <ipAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The managed neighbor IP

address.

<attribute> MultipleChoice description The name of the attribute(s) to

clear.

6.22.4.2 States
This level is used to view and modify states settings for all managed neighbors.
6.22.4.2.1 get
This command is used to view states settings for all Managed Neighbors.
1) Ensure you are at the /AS_CLI/System/OverloadControls/ManagedNeighbors/States>
level.
2) Enter:
get↵
6.22.4.2.2 add
This command is used to create a new managed neighbor for the purpose of assigning states for that
neighbor.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 273
 1) Ensure you are at the /AS_CLI/System/OverloadControls/ManagedNeighbors/States>
level.
2) Enter:
add <ipAddress> <inService> <overloaded> <inhibited> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The managed neighbor IP

address.

<inService> Choice true, false Used to manually set the

neighbor state to in-service.

<overloaded> Choice true, false Used to manually set the

neighbor state to overloaded.

<inhibited> Choice true, false Used to manually set the

neighbor state to inhibited.

<attribute> MultipleChoice description Additional attributes to include

through the add command.

<description> String 1 to 80 characters A description of the managed

neighbor.

6.22.4.2.3 set
This command is used to modify managed neighbor states.
1) Ensure you are at the /AS_CLI/System/OverloadControls/ManagedNeighbors/States>
level.
2) Enter:
set <ipAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The managed neighbor IP

address.

<attribute> MultipleChoice inService, overloaded, inhibited, The name of an attribute to

description modify.

<inService> Choice true, false Used to manually set the

neighbor state to in-service.

<overloaded> Choice true, false Used to manually set the

neighbor state to overloaded.

<inhibited> Choice true, false Used to manually set the

neighbor state to inhibited.

<description> String 1 to 80 characters A description of the managed

neighbor.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 274
6.22.4.2.4 delete
This command is used to delete a neighbor with manually set state controls from the group of managed
neighbors.
1) Ensure you are at the /AS_CLI/System/OverloadControls/ManagedNeighbors/States>
level.
2) Enter:
delete <ipAddress>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The managed neighbor IP

address.

6.22.4.2.5 clear
This command is used to clear (set to no value) optional parameters of a managed neighbor.
1) Ensure you are at the /AS_CLI/System/OverloadControls/ManagedNeighbors/States>
level.
2) Enter:
clear <ipAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The managed neighbor IP

address.

<attribute> MultipleChoice description The name of the attribute(s) to

clear.

6.22.5 NonCallP
This level is used to view and modify non-callp overload controls settings.

6.22.5.1 get
This command is used to view non-callp overload controls settings.
1) Ensure you are at the /AS_CLI/System/OverloadControls/NonCallP> level.
2) Enter:
get↵

6.22.5.2 set
Use this command modify non-callp overload controls settings.
1) Ensure you are at the /AS_CLI/System/OverloadControls/NonCallP> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 275
 Variable Field Type Valid Values Description

<attribute> MultipleChoice sampleSize, minTimeInZoneIn The name of an attribute to

Msecs, delayInMsecsToEnter modify.
Yellow, delayInMsecsToEnter
Red, delayInMsecsToLeave
Yellow, delayInMsecsToLeave
Red, callpQDelayInMsecsToEnter
Yellow, callpQDelayInMsecsTo
EnterRed, callpQDelayInMsecs
ToLeaveYellow, callpQDelayIn
MsecsToLeaveRed

<sampleSize> Integer 10 through 50000 Specifies queue delay sample

size needed before the overload
controls are activated.

<minTimeIn Integer 1000 through 600000 The minimum amount of time in

ZoneInMsecs> milliseconds that the server must
stay in a specific zone before
returning to a lower one.

<delayInMsecs Integer 500 through 60000 The average queue delay

ToEnterYellow> in milliseconds required to
enter the yellow zone. This
value must be greater than the
DelayToLeaveYellow value but
less than the DelayToLeaveRed
value.

<delayInMsecs Integer 500 through 60000 The average queue delay

ToEnterRed> in milliseconds required to
enter the red zone. This value
must be greater than the
DelayToLeaveRed value.

<delayInMsecs Integer 500 through 60000 The average queue delay in

ToLeave milliseconds required to exit the
Yellow> yellow zone. This value must be
less than the DelayToEnterYellow
value.

<delayInMsecs Integer 500 through 60000 The average queue delay in

ToLeaveRed> milliseconds required to exit the
red zone. This value must be
greater than DelayToEnterYellow
value but less than the
DelayToEnterRed value.

<callpQDelayIn Integer 500 through 60000 Specifies the call processing

MsecsToLeave decode queue delay required to
Red> exit the red zone.

<callpQDelayIn Integer 500 through 60000 Specifies the call processing

MsecsToLeave decode queue delay required to
Yellow> exit the yellow zone.

<callpQDelayIn Integer 500 through 60000 Specifies the call processing

MsecsToEnter decode queue delay required to
Red> enter the red zone.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 276
 Variable Field Type Valid Values Description

<callpQDelayIn Integer 500 through 60000 Specifies the call processing

MsecsToEnter decode queue delay required to
Yellow> enter the yellow zone.

6.23 Peering
This level is used to replicate the Application Server database to all Application Servers on the network
to achieve redundancy. The servers fulfill either a primary or backup role with respect to replication and
can therefore switch roles (secondary becoming primary) during interruptions to maintain full service.
Replication configuration can be complex, as the values returned by the get command only represent the
desired replication configuration, and not the actual one. Read this section before you configure replication.
Following are some additional notes regarding peering. * Desired versus Actual Configuration Values
returned by the get command, may not reflect the actual state of replication. These values only reflect the
desired replication configuration. Similarly, using the add command does not automatically add a server
to the replication process. It only informs the Application Server that this server should be added the next
time replication is started. To effectively synchronize the actual view and the desired view, stop and then
restart replication.WARNING: During the short interval when synchronizing the actual view and the desired
view, the Application Server could theoretically lose replication records. * Stopping Replication If two
Application Servers, for example NS01 and NS02, are replicated and replication is stopped on NS01, NS02
does not know this and therefore tries to send NS01 replication updates. NS01 is assumed to be down
and these updates are buffered on NS02. Eventually, the update buffer fills and NS02 does not accept
any more database modifications until communication is restored with NS01. Therefore, when removing
an Application Server from the replication scheme, it is important to stop and restart replication on every
server that had a related replication. * Masters versus Slaves Masters accept database modifications
(provisioning) whereas slaves do not. The concept of slaves is introduced to facilitate maintenance and
reduce network traffic. Contrary to masters, slaves only need to know about masters in their own cluster
(specifically, they do not need to know about masters or slaves in other clusters). Two geographically
distant clusters would have their masters propagate replication updates to the slaves, thus reducing
network traffic. * Clustering Clustering is currently not supported. * Host Names TimesTen requires that
host names be limited to 1 through 30 characters and are limited to any combination of letters (A-Z), digits
(0-9), and $, #, @, _. The first character must be a letter. If the host name is longer than 30 characters, an
alias can be created in the/etc/hostsfile.

6.23.1 get
This command is used to display attributes related to replication.
1) Ensure you are at the /AS_CLI/System/Peering> level.
2) Enter:
get↵

6.23.2 set
Modify Peer Application Server-related attributes to change replication attributes. The IP address, host
name, and domain name can be modified. Other attributes that can be modified include whether or not the
Application Server is a master or a slave server, and whether or not the Application Server is a primary
server. Modify peer Application Server-related attributes when the IP address or peer type changes.
1) Ensure you are at the /AS_CLI/System/Peering> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 277
 Variable Field Type Valid Values Description

<attribute> Choice replicationPort The name of an attribute to

modify.

Variable: replicationPort

replicationPort Option to specify a port.

<portOption> Choice random, port When set to "random", the

database automatically pick up a
replication > 32000 at replication
startup time. When set to "port",
allows an operator to specify a
specific port to use.

Variable: port

port Manual port configuration.

<portNumber> Integer 1024 through 65535 Actual replication port in case of

portOption is set to "port".

6.23.3 lock
Locking allows the system to block access to other replication Application Servers. It is typically used to
prevent files from being overwritten by another peer Application Server on the network while the replication
database file is being written to by its own Application Server. Manual locking is useful for blocking access
to the replication database file (from another Application Server) to perform maintenance.
1) Ensure you are at the /AS_CLI/System/Peering> level.
2) Enter:
lock [<hostName>]↵
where:
Variable Field Type Valid Values Description

<hostName> String 1 to 200 characters Specify the canonical host name

of the peer Application Server
or a remote Application Server;
if the host name is longer than
80 characters, an alias can be
created in the /etc/hosts file.
Use the "all" keywork instead of
hostname, to lock all Application
Servers in the cluster. When
no host name is specified, the
current Application Server is
locked.

6.23.4 start
The replication process of the Application Server database is started using this command. Database
peering begins for all Application Servers that currently exists as a peer Application Server in the network.
Whenever there is a change to an Application Server database in the network, the changes are replicated
dynamically to all other Application Servers. The message field Replication Manually Started is True if
manual replication has started.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 278
 1) Ensure you are at the /AS_CLI/System/Peering> level.
2) Enter:
start↵

6.23.5 status
The status of the Application Server database can be viewed using this command. The message field
Replication Manually Started is True if manual replication is running.
1) Ensure you are at the /AS_CLI/System/Peering> level.
2) Enter:
status↵

6.23.6 stop
The replication process of the Application Server database can be stopped at any time (for example, for
replacement). Replication will only begin again once it has been started. Any changes made during the
time the replication process has been stopped will not be replicated once the process has started again.
The message field Replication Manually Started will be False if the manual replication has stopped.
1) Ensure you are at the /AS_CLI/System/Peering> level.
2) Enter:
stop↵

6.23.7 unlock
Unlocking allows replication to proceed by allowing access to the replication database from other peer
Application Servers.
1) Ensure you are at the /AS_CLI/System/Peering> level.
2) Enter:
unlock [<hostName>]↵
where:
Variable Field Type Valid Values Description

<hostName> String 1 to 200 characters Specify the canonical host name

of the peer Application Server
or a remote Application Server;
if the host name is longer than
80 characters, an alias can be
created in the /etc/hosts file.
Use the "all" keywork instead
of hostname, to unlock all
Application Servers in the cluster.
When no host name is specified,
the current Application Server is
unlocked.

6.23.8 Peers
This level is used to view, add, delete, and modify network peers.

6.23.8.1 get
Peer Application Server-related attributes such as the host name, IP address, type, primary, and state, are
viewed using this command.NOTE: When configuring replication, it is important to use the canonical host
name of the server, which can be obtained by typing the hostname command without arguments. Using the
IP address or an alias causes replication to fail due to a TimesTen limitation.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 279
 1) Ensure you are at the /AS_CLI/System/Peering/Peers> level.
2) Enter:
get↵

6.23.8.2 add
When adding a new peer Application Server to the system, the host name, IP address, and peer type are
set. For file replication, secure shell access is configured.
1) Ensure you are at the /AS_CLI/System/Peering/Peers> level.
2) Enter:
add <hostName> <ipAddress>↵
where:
Variable Field Type Valid Values Description

<hostName> String 1 to 205 characters The canonical host name of the

new peer Application Server.

<ipAddress> String 1 to 205 characters The IP address of the new Peer

Application Server. The host
name of the Application Server
can also be used if the host name
to IP address mapping is defined
in the /etc/hosts file.

6.23.8.3 set
Modify Peer Application Server-related attributes.
1) Ensure you are at the /AS_CLI/System/Peering/Peers> level.
2) Enter:
set <hostName> <attribute>↵
where:
Variable Field Type Valid Values Description

<hostName> String 1 to 205 characters The host name of the peer server.

<attribute> MultipleChoice ipAddress, isPrimary The name of an attribute to

modify.

<ipAddress> String 1 to 205 characters IP address, host name, or domain

of the peer server.

<isPrimary> String true Indicates if the peer server is the

primary server.

6.23.8.4 delete
This command is used to remove a Peer Application Server.
1) Ensure you are at the /AS_CLI/System/Peering/Peers> level.
2) Enter:
delete <hostName>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 280
 Variable Field Type Valid Values Description

<hostName> String 1 to 205 characters The host name of the peer server.

6.24 ProfileTuning
This level is used to view and modify the profile tuning for the server.

6.24.1 GeneralSettings
This level is used to view and modify the general settings of profile tuning.

6.24.1.1 get
This command is used to view the general settings of profile tuning.
1) Ensure you are at the /AS_CLI/System/ProfileTuning/GeneralSettings> level.
2) Enter:
get↵

6.24.1.2 set
This command is used to modify the general settings of profile tuning.
1) Ensure you are at the /AS_CLI/System/ProfileTuning/GeneralSettings> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice profileTuningName The name of an attribute to

modify.

<profileTuning Choice default This parameter specifies the

Name> name of the selected profile
tuning.

6.24.1.3 clear
This command is used to clear (set to no value) the general settings of profile tuning.
1) Ensure you are at the /AS_CLI/System/ProfileTuning/GeneralSettings> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice profileTuningName The name of the attribute to clear.

6.25 Redundancy
If a primary Application Server is taken offline for maintenance or if a failure condition occurs on the
network and a primary Application Server is offline for any reason, redundancy allows for uninterrupted call
manager services. The primary Application Server database, replicated to one or more backup Application

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 281
 Servers, temporarily becomes the primary Application Server through a process known as rollover. The
primary Application Server, when again online, uses a RollBackTimer to determine the time (in minutes)
to wait before attempting to move subscribers back to hosting on the primary Application Server. If the
primary Application Server cannot be reached, the subscribers continue to be hosted on the backup
Application Server.

6.25.1 get
Redundancy-related attributes, such as the RedunRollBackTimer and
SendSipOptionMessageUponMigration, are viewed using this command.
1) Ensure you are at the /AS_CLI/System/Redundancy> level.
2) Enter:
get↵

6.25.2 set
Redundancy-related attributes, such as the RedunRollBackTimer and
SendSipOptionMessageUponMigration, are modified using this command.
1) Ensure you are at the /AS_CLI/System/Redundancy> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice redunRollBackTimer, sendSip The name of an attribute to

OptionMessageUponMigration modify.

<redunRollBack Integer 0 through 3600 The time to wait before sending

Timer> a message to synchronize the
backup server database with the
primary server database.

<sendSip Choice true, false Indicates if OPTION message

OptionMessage should be sent from the primary
UponMigration> Application Server to the user's
device, prior to migrating the user
back on the primary AS.

6.25.3 GeoProxy
This level is used to view and modify geographic redundancy proxy settings.

6.25.3.1 get
This command is used to view geographic redundancy proxy attributes.
1) Ensure you are at the /AS_CLI/System/Redundancy/GeoProxy> level.
2) Enter:
get↵

6.25.3.2 set
This command is used to set geographic redundancy proxy attributes.
1) Ensure you are at the /AS_CLI/System/Redundancy/GeoProxy> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 282
 set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if the

geographic redundancy proxy
capability is enabled or disabled.

6.25.3.3 UnreachableFromPrimary
This level is used to view users that are unreachable from the primary Application Server.
6.25.3.3.1 get
This command is used to view users that are unreachable from the primary Application Server.
1) Ensure you are at the /AS_CLI/System/Redundancy/GeoProxy/UnreachableFromPrimary>
level.
2) Enter:
get↵

6.25.4 MigratedUsers
This level is used to view, add, modify, and delete MigratedUsers entries.

6.25.4.1 get
This command is used to view migrated users-related attributes. All the migrated users are listed.
1) Ensure you are at the /AS_CLI/System/Redundancy/MigratedUsers> level.
2) Enter:
get↵

6.25.5 PeerSIPConnectionMonitoring
This level is used to view and modify the settings for monitoring the peer SIP connection separately from
the redundancy link.

6.25.5.1 get
This command is used to view the peer SIP connection monitoring attributes.
1) Ensure you are at the /AS_CLI/System/Redundancy/PeerSIPConnectionMonitoring> level.
2) Enter:
get↵

6.25.5.2 set
This command is used to set the peer SIP connection monitoring attributes.
1) Ensure you are at the /AS_CLI/System/Redundancy/PeerSIPConnectionMonitoring> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 283
 Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, heartbeatIntervalIn The name of an attribute to

Milliseconds, heartbeatTimeoutIn modify.
Milliseconds

<enabled> Choice true, false This parameter determines if the

peer SIP connection is monitored
separately from the redundancy
link.

<heartbeat Integer 10 through 3600000 This parameter specifies the time

IntervalIn interval (in milliseconds) between
Milliseconds> each SIP OPTIONS message
sent to monitor the peer SIP
connection.

<heartbeat Integer 10 through 18000000 This parameter specifies the

TimeoutIn number of seconds before the
Milliseconds> peer SIP connection is reported
as down (in milliseconds) without
a response to a SIP OPTIONS
message.

6.26 Registration
Registration is used to eliminate all registered contacts associated with a particular user. In earlier versions
of BroadWorks, assigning the user a new location would clear the contacts.

6.26.1 get
This command displays registration-related attributes.
1) Ensure you are at the /AS_CLI/System/Registration> level.
2) Enter:
get↵

6.26.2 set
This command is used to modify the registration location of a user in the database.
1) Ensure you are at the /AS_CLI/System/Registration> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice extensionTimeInSeconds, The name of an attribute to

postUpgradeExtensionTime modify.
InSeconds, maxRegistration
TimeInSeconds, denyCalls
FromUnregisteredUsers, min
RegistrationTimeInSeconds,
enableMinRegistrationTime,
enforceMinRegistrationTime,
captureViaHeader

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 284
 Variable Field Type Valid Values Description

<extensionTime Integer 0 through 86400 Indicates an extension to the time

InSeconds> the Application Server honors
registrations.

<postUpgrade Integer 0 through 858993458 Indicates an extension to the time

ExtensionTime the Application Server honors
InSeconds> registrations after an upgrade.
May also apply after a fresh
install in cases when a previously
backed-up database is restored,
or when subscriber configuration
occurs within the time interval
determined by this attribute.

<max Integer 3600 through 429496729 The maximum time, in seconds,

Registration during which a SIP phone can
TimeIn register its location. Requests
Seconds> for longer registration times are
truncated to this time.

<deny Choice true, false If set to true, indicates that calls

CallsFrom from unregistered users should
Unregistered be denied.
Users>

<enableMin Choice true, false This attribute enables or disables

Registration a minimum registration interval
Time> for the Session Initiation Protocol
(SIP).

<min Integer 0 through 429496729 Specifies the minimum interval

Registration at which registrations are
TimeIn written to the database. To
Seconds> avoid loss of service, the
extensionTimeInSeconds
attribute should have double
the value of this attribute. The
default value is 1200 seconds (20
minutes).

<enforceMin Choice true, false When set to "true", a SIP

Registration 423 message response is
Time> returned when a REGISTER
message is received with an
Expires value less than the
minRegistrationTimeInSeconds
attribute.

<captureVia Choice true, false When set to "true", the following

Header> information will be captured from
the registration via header and
used to update the registration
information: Public IP, Public
Port, Private IP and Private Port.

6.26.3 Contacts
This level is used to view and delete Contacts entries in the system.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 285
6.26.3.1 get
This command is used to view registered locations. It displays the dynamic or static registration locations in
the database.
1) Ensure you are at the /AS_CLI/System/Registration/Contacts> level.
2) Enter:
get <level> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<level> Choice serviceProvider, group, user, line This parameter specifies the level
Port, system for the registration locations you
want to view.

Variable: serviceProvider

serviceProvider This command is used to specify

the service provider whose
registration locations you want to
view.

<svcProvider String 1 to 30 characters The service provider ID for

Id> the service provider whose
registration locations you want to
view.

Variable: group

group This command is used to specify

service provider ID and group ID
for the group whose registration
locations you want to view.

<svcProvider String 1 to 30 characters The service provider ID for

Id> the service provider whose
registration locations you want to
view.

<groupId> String 1 to 30 characters The group ID for the group whose

registration locations you want to
view.

Variable: user

user This command is used to specify

the user ID of the person whose
registration location you want to
view.

<userId> String 2 to 161 characters The user ID of the person whose

registration location you want to
view.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 286
 Variable Field Type Valid Values Description

Variable: linePort

linePort This command is used to specify

the line port for the registration
locations you want to view.

<linePortId> String 1 to 161 characters The line port for the registration
locations you want to view.

<system> This command specifies that you

wish to view all the registration
locations.

<attribute> MultipleChoice deviceType, deviceLevel, device Get command filtering criteria.

Name, endpointType, expired, uri
Starts, uriContains, uriEqualTo,
contactStarts, contactContains,
contactEqualTo

<deviceType> String 1 to 40 characters The device type for the

registration locations you want to
view.

<deviceLevel> Choice system, serviceProvider, group The device level for the
registration locations you want to
view.

<deviceName> String 1 to 40 characters The device name for the

registration locations you want to
view.

<endpoint Choice primary, sharedCallAppearance, The endpoint type for the

Type> videoAddOn registration locations you want to
view.

<expired> Choice true, false When set to "false", specifies

that you want to view registration
locations that are not expired.
When set to "true", specifies that
you want to view registration
locations that are expired.

<uriStarts> String 0 to 161 characters URI starts with search criteria.

<uriContains> String 0 to 161 characters URI contains search criteria.

<uriEqualTo> String 1 to 161 characters URI equal to search criteria.

<contactStarts> String 0 to 161 characters Contact starts with search criteria.

<contact String 0 to 161 characters Contact contains search criteria.

Contains>

<contactEqual String 1 to 161 characters contact equal to search criteria.

To>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 287
6.26.3.2 delete
This command is used to delete the registration location of a user. Only dyanamic and DN registrations are
deleted.
1) Ensure you are at the /AS_CLI/System/Registration/Contacts> level.
2) Enter:
delete <userId>↵
where:
Variable Field Type Valid Values Description

<userId> String 2 to 161 characters The user ID of the person whose

registration location you want to
delete.

6.27 Resources
This level is used to view and modify the physical resources of the server.

6.27.1 Memory
This level is used to view and modify the memory allocation rules for the applications running on the
server.

6.27.1.1 get
This command is used to show memory allocation general settings. They include the over-allocation
protection, which will adjust the container memory allocation if the configured memory settings exceed
physical memory available.
1) Ensure you are at the /AS_CLI/System/Resources/Memory> level.
2) Enter:
get↵

6.27.1.2 set
This command is used to set memory allocation general settings.
1) Ensure you are at the /AS_CLI/System/Resources/Memory> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice overAllocationProtection The name of an attribute to

modify.

<overAllocation Choice true, false This parameter controls whether

Protection> the software manager adjusts the
containers memory allocation if
the configured memory settings
exceed the physical memory
available. The default value is
"true".

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 288
6.27.1.3 Containers
This level is used to view and modify the memory allocation rules for each container.
6.27.1.3.1 get
This command is used to display container memory allocation settings and runtime values.
1) Ensure you are at the /AS_CLI/System/Resources/Memory/Containers> level.
2) Enter:
get↵
6.27.1.3.2 set
This command is used to modify the memory allocation settings for a container. For the purpose of the set
command, the memory can be expressed as an amount of memory (in megs) or a percentage of physical
memory. Modifying one of the values causes the other to be recalculated.
1) Ensure you are at the /AS_CLI/System/Resources/Memory/Containers> level.
2) Enter:
set <containerName> <attribute>↵
where:
Variable Field Type Valid Values Description

<container String 1 to 255 characters This parameter specifies the

Name> container name.

<attribute> MultipleChoice amount, percentage The name of an attribute to

modify.

<amount> Integer 0 through 65535 This parameter specifies the

amount of memory that is
allocated to a container (in megs).

<percentage> Real 0.0 through 100.0 This parameter specifies the

percentage of physical memory
that is allocated to a container.

6.28 RoutePoint
This level is used to manage the Route Point attributes.

6.28.1 ApplicationController
This level is used to view, add, and delete Application Controller entries.

6.28.1.1 get
This command is used to view Application Controller-related attributes.
1) Ensure you are at the /AS_CLI/System/RoutePoint/ApplicationController> level.
2) Enter:
get↵

6.28.1.2 add
This command is used to add a new Application Controller.
1) Ensure you are at the /AS_CLI/System/RoutePoint/ApplicationController> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 289
 add <name> <subscriberId> <channelSetId>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters The Application Controller name.

<subscriberId> String 1 to 161 characters The Subscriber to associate to

the application controller. The
subscriber can either be an
administrator or a user.

<channelSetId> String 1 to 256 characters Free-form text that identifies the

event channel set.

6.28.1.3 delete
This command is used to delete an existing Application Controller.
1) Ensure you are at the /AS_CLI/System/RoutePoint/ApplicationController> level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters The Application Controller name.

6.28.2 ExternalSystem
This level is used to view, add, modify, delete, and clear External System entries.

6.28.2.1 get
This command is used to view Route Point External System-related attributes.
1) Ensure you are at the /AS_CLI/System/RoutePoint/ExternalSystem> level.
2) Enter:
get↵

6.28.2.2 add
This command is used to add a new Route Point External System.
1) Ensure you are at the /AS_CLI/System/RoutePoint/ExternalSystem> level.
2) Enter:
add <name> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters The Route Point External System

name.

<attribute> MultipleChoice description Additional attributes to include

through the add command.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 290
 Variable Field Type Valid Values Description

<description> String 1 to 80 characters The Route Point External System

description.

6.28.2.3 set
This command is used to modify a Route Point External System-related attributes.
1) Ensure you are at the /AS_CLI/System/RoutePoint/ExternalSystem> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters The Route Point External System

name.

<attribute> MultipleChoice newName, description Additional attributes to include

through the set command.

<newName> String 1 to 40 characters The new Route Point External

System name.

<description> String 1 to 80 characters The Route Point External System

description.

6.28.2.4 delete
This command is used to delete an existing Route Point External System.
1) Ensure you are at the /AS_CLI/System/RoutePoint/ExternalSystem> level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters The Route Point External System

name.

6.28.2.5 clear
This command is used to clear Route Point External System-related attributes.
1) Ensure you are at the /AS_CLI/System/RoutePoint/ExternalSystem> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters The Route Point External System

name.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 291
 Variable Field Type Valid Values Description

<attribute> MultipleChoice description Additional attributes to include

through the clear command.

<description> String 1 to 80 characters The Route Point External System

description.

6.28.2.6 ApplicationController
This level is used to view, add, and delete Application Controller entries.
6.28.2.6.1 get
This command is used to view Application Controller-related attributes.
1) Ensure you are at the /AS_CLI/System/RoutePoint/ExternalSystem/
ApplicationController> level.
2) Enter:
get <ExternalSystem>↵
where:
Variable Field Type Valid Values Description

<External String 1 to 40 characters The Route Point External System

System> name.

6.28.2.6.2 add
This command is used to assign an application controller to a route point external system.
1) Ensure you are at the /AS_CLI/System/RoutePoint/ExternalSystem/
ApplicationController> level.
2) Enter:
add <ExternalSystem> <ApplicationController>↵
where:
Variable Field Type Valid Values Description

<External String 1 to 40 characters The Route Point External System

System> name.

<Application String 1 to 40 characters The Application Controller name.

Controller>

6.28.2.6.3 delete
This command is used to unassign an application controller from a route point external system.
1) Ensure you are at the /AS_CLI/System/RoutePoint/ExternalSystem/
ApplicationController> level.
2) Enter:
delete <ExternalSystem> <ApplicationController>↵
where:
Variable Field Type Valid Values Description

<External String 1 to 40 characters The Route Point External System

System> name.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 292
 Variable Field Type Valid Values Description

<Application String 1 to 40 characters The Application Controller name.

Controller>

6.28.2.7 Utilization
This level is used to view Utilization entries.
6.28.2.7.1 get
This command is used to view Utilization-related attributes.
1) Ensure you are at the /AS_CLI/System/RoutePoint/ExternalSystem/Utilization> level.
2) Enter:
get <ExternalSystem>↵
where:
Variable Field Type Valid Values Description

<External String 1 to 40 characters The Route Point External System

System> name.

6.29 Security
This level is used to view and modify the Access Control List (ACL) security options for the server.

6.29.1 BlackList
This level is used to view and modify the Access Control List (ACL) black list security options for the
BroadWorks server.

6.29.1.1 get
This command is used to display network security-related attributes. It displays the Access Control List
(ACL) black list that filters inbound network packets to the BroadWorks server. Packets that match entries
in the black list are processed by the BroadWorks server.
1) Ensure you are at the /AS_CLI/System/Security/BlackList> level.
2) Enter:
get↵

6.29.1.2 add
This command is used to add an entry to the Access Control List (ACL) black list.
1) Ensure you are at the /AS_CLI/System/Security/BlackList> level.
2) Enter:
add <SourceAddress> <Mask> <DestinationAddress> <destinationPortFirst>
<destinationPortLast> <protocol>↵
where:
Variable Field Type Valid Values Description

<Source String 1 to 80 characters This parameter specifies the

Address> sourceIp/sourceMask pair as
a subnet range of IPs. The
sourceIp is always the string
representation of the IP whether
IPv4 or IPv6.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 293
 Variable Field Type Valid Values Description

<Mask> String 1 to 80 characters This parameter specifies the

source mask. It is in dotted string
format for IPv4 (for example,
255.255.0.0) or the number of bits
in the mask for IPv4 and IPv6.

<Destination String 1 to 80 characters This parameter specifies the

Address> destination IP address of the
packet matches against this
IP address. This is one of the
configured IP addresses of the
BroadWorks server.

<destination Integer 0 through 65535 This parameter specifies the

PortFirst> first port of the range of inbound
packets that match against a
range of destination ports. For
protocol Internet Control Message
Protocol (ICMP), this is "0".

<destination Integer 0 through 65535 This parameter specifies the

PortLast> last port of the range of inbound
packets that match against a
range of destination ports. For
protocol Internet Control Message
Protocol (ICMP), this is "0".

<protocol> Choice TCP, UDP, ICMP This parameter determines the

received network packet matches
against this protocol. Values
include" "tcp", "udp", or "icmp".

6.29.1.3 delete
This command is used to remove an entry from the Access Control List (ACL) black list.
1) Ensure you are at the /AS_CLI/System/Security/BlackList> level.
2) Enter:
delete <SourceAddress> <Mask> <DestinationAddress> <destinationPortFirst>
<destinationPortLast> <protocol>↵
where:
Variable Field Type Valid Values Description

<Source String 1 to 80 characters This parameter specifies the

Address> sourceIp/sourceMask pair as
a subnet range of IPs. The
sourceIp/sourceMask pair defines
a subnet range of IPs. The
sourceIp is always the string
representation of the IP whether
IPv4 or IPv6.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 294
 Variable Field Type Valid Values Description

<Mask> String 1 to 80 characters This parameter specifies the

sourceMask is in dotted string for
IPv4 (for example, 255.255.0.0)
or the number of bits in the mask
for IPv4 and IPv6.

<Destination String 1 to 80 characters This parameter specifies the

Address> destination IP address of the
packet matches against this
IP address. This is one of the
configured IP addresses of the
BroadWorks server.

<destination Integer 0 through 65535 This parameter specifies the

PortFirst> first port of the range of inbound
packets that match against a
range of destination ports. For
protocol Internet Control Message
Protocol (ICMP), this is "0".

<destination Integer 0 through 65535 This parameter specifies the

PortLast> last port of the range of inbound
packets that match against a
range of destination ports. For
protocol Internet Control Message
Protocol (ICMP), this is "0".

<protocol> Choice TCP, UDP, ICMP This parameter determines the

received network packet matches
against this protocol. Values
include: "tcp", "udp", or "icmp".

6.29.2 WhiteList
This level is used to view and modify the Access Control List (ACL) white list security options for the
BroadWorks server.

6.29.2.1 get
This command is used to display the network security-related attributes. It displays the Access Control List
white list that filters inbound network packets to the BroadWorks Server. Packets match entries in the white
list to be processed by the BroadWorks server.
1) Ensure you are at the /AS_CLI/System/Security/WhiteList> level.
2) Enter:
get↵

6.29.2.2 add
This command is used to add an entry to the Access Control List ( ACL) white list.
1) Ensure you are at the /AS_CLI/System/Security/WhiteList> level.
2) Enter:
add <SourceAddress> <Mask> <DestinationAddress> <destinationPortFirst>
<destinationPortLast> <protocol>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 295
 Variable Field Type Valid Values Description

<Source String 1 to 80 characters This parameter specifies the

Address> sourceIp/sourceMask pair as
a subnet range of IPs. The
sourceIp is always the string
representation of the IP whether
IPv4 or IPv6.

<Mask> String 1 to 80 characters This parameter specifies the

sourceMask is in dotted string for
IPv4 (for example, 255.255.0.0)
or the number of bits in the mask
for IPv4 and IPv6.

<Destination String 1 to 80 characters This parameter specifies the

Address> destination IP address of the
packet matches against this
IP address. This is one of the
configured IP addresses of the
BroadWorks Server.

<destination Integer 0 through 65535 This parameter specifies the

PortFirst> first port of the range of inbound
packets that match against a
range of destination ports. For
protocol Internet Control Message
Protocol (ICMP), this is "0".

<destination Integer 0 through 65535 This parameter specifies the

PortLast> last port of the range of inbound
packets that match against a
range of destination ports. For
protocol Internet Control Message
Protocol (ICMP), this is "0".

<protocol> Choice TCP, UDP, ICMP This parameter determines the

received network packet matches
against this protocol. Values
include: "tcp", "udp", or "icmp".

6.29.2.3 delete
This command is used to remove an entry from the Access Control List (ACL) white list.
1) Ensure you are at the /AS_CLI/System/Security/WhiteList> level.
2) Enter:
delete <SourceAddress> <Mask> <DestinationAddress> <destinationPortFirst>
<destinationPortLast> <protocol>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 296
 Variable Field Type Valid Values Description

<Source String 1 to 80 characters This parameter specifies the

Address> sourceIp/sourceMask pair as
a subnet range of IPs. The
sourceIp/sourceMask pair defines
a subnet range of IPs. The
sourceIp is always the string
representation of the IP whether
IPv4 or IPv6.

<Mask> String 1 to 80 characters This parameter specifies the

sourceMask is in dotted string for
IPv4 (for example, 255.255.0.0)
or the number of bits in the mask
for IPv4 and IPv6.

<Destination String 1 to 80 characters This parameter specifies the

Address> destination IP address of the
packet matches against this
IP address. This is one of the
configured IP addresses of the
BroadWorks Server.

<destination Integer 0 through 65535 This parameter specifies the

PortFirst> first port of the range of inbound
packets that match against a
range of destination ports. For
protocol Internet Control Message
Protocol (ICMP), this is "0".

<destination Integer 0 through 65535 This parameter specifies the

PortLast> last port of the range of inbound
packets that match against a
range of destination ports. For
protocol Internet Control Message
Protocol (ICMP), this is "0".

<protocol> Choice TCP, UDP, ICMP This parameter determines the

received network packet matches
against this protocol. Values
include: "tcp", "udp", or "icmp".

6.30 SessionDataReplication
This level is used to view and modify the session data replication attributes.

6.30.1 get
This command is used to view the session data replication attributes.
1) Ensure you are at the /AS_CLI/System/SessionDataReplication> level.
2) Enter:
get↵

6.30.2 set
This command is used to modify the session data replication attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 297
 1) Ensure you are at the /AS_CLI/System/SessionDataReplication> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, connectionPort The name of an attribute to

modify.

<enabled> Choice true, false Enable or disable session data

replication.

<connection Integer 1025 through 65535 Port to establish session

Port> data replication between the
Application Servers in the cluster.

6.31 StartupParam
Start-up parameter commands provide an administrative interface to manage Application Server start-
up parameters, that is, parameters passed to the Application Server java process at start up. Examples
of start-up parameters include activation of accounting events, e-mail protocol timeout values, and
so on. NOTE: You must restart Application Server processes after adding or changing values so that
configuration changes take effect.

6.31.1 get
This command is used to view System Startup Parameters.
1) Ensure you are at the /AS_CLI/System/StartupParam> level.
2) Enter:
get [<name>]↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 298
 Variable Field Type Valid Values Description

<name> Choice bw.sip.numNonCallThreads, The name of the system startup

bw.sip.accessinterfaceviahost, parameter to view.
bw.soap.max.threads, bw
.meetmeconferencing.xsiEvents
Threshold, bw.asr.source
.ip, bw.sip.msclustercontac
tincludeudptransport, bw.ps
.ocip.groupAndEntCallLog
TransactionsNumThreads,
bw.sip.networkclusterc
ontacthost, bw.sip.maxsipcallinvit
ingpersipuacaller, bw.sip
.geoproxy.optionspollingi
ntervalmilliseconds, bw.callhalf
.numThreads, bw.callcenter
.statusDowngradeDelay
Period, bw.numberportabili
ty.max.threads, bw.ims.min
.threads, bw.sip.tcp.sendBuffer
Size, bw.sip.accessrecordrou
teincludetcptransport, bw.sip
.networkclustercontactport, bw
.sip.accessrecordrouteport, bw
.ecl.numProcessors, bw.sip
.maxsipcallinvitingpersipuacalled,
bw.sip.replicated.msclustercontac
thost, bw.sip.peernetworkinte
rfacetransport, bw.sip
.peernetworkrecordroutehost, bw
.cpl.maxNumHttpWorkerThreads,
bw.routepoint.failThrottle
Interval, bw.sip.statelessproxy
.shorttermtrackingseconds, bw
.sip.replicated.networkclusterc
ontacthost, bw.nameservice
.timeBoundedPoolSize, bw
.callcenter.monitoringPeriod
Throttling, bw.diameter.xs.max
PoolSize, bw.sip.networkinterfac
eport, bw.ocic.numEncoder
Threads, bw.ecl.numEventQueue
Files, bw.routepoint.numCall
ToProcessPerInterval, bw.sip
.replicated.accessclusterco
ntacthost, bw.nameservice.cache
Policy, bw.sip.udp.receiveBuffer
Size, bw.sip.maxsipcallpersi
pua, bw.sip.peernetworkreco
rdrouteport, java.ldap.connect
.timeout, bw.sip.replicated
.accessinterfaceviahost, bw
.callcenter.remoteHostAddress,
bw.xs.oci.timeoutInSeconds,
org.apache.commons.logging.
Log, bw.nameservice.nCache
Policy, bw.sip.peernetworkreco
rdrouteincludetcptransport,
bw.sip.peernetworkreco
rdrouteincludeudptransport,
bw.sip.networkclusterc

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 299
 Variable Field Type Valid Values Description
ontactincludeudptransport, bw
.sh.numThreads, bw.persistence
.xla.server.port, privateIPv6
Address, bw.sip.msclustercontac
tport, bw.ps.dms.numThreads,
bw.mediacr.watchdogTimeout,
bw.sip.accessrecordrou
teincludeudptransport, bw.sip
.networkinterfacetransport, bw
.sip.peeraccessinterfaceport, bw
.diameter.xs.listeningAddress,
bw.eccr.eventQueueFileSize,
bw.ecl.eventQueueMemSize,
bw.sh.systemRefreshPublic
IdentitiesPerHour, bw.ocic
.numDecoderThreads, bw.sip
.peeraccessinterfacetransport,
bw.sip.msclustercontac
tincludetcptransport, bw.xs.oci
.reconnectIntervalInSeconds,
dtdLocation, publicIPv6Address,
bw.sip.msclustercontacthost,
bw.nameservice.denyTime
BoundedDuplicateLookups, bw
.diameter.ps.maxPoolSize, bw
.http.mediaif, bw.numberportabili
ty.min.threads, bw.nameservice
.nCacheTtlSecs, bw.mediacr
.numberOfThreads, bw.soap
.min.threads, bw.sip.replicated
.networkinterfaceviahost,
bw.mediacr.tcpConnection
Timeout, bw.sip.peernetworkinte
rfaceport, bw.ims.max.threads,
bw.servicecontrol.numThreads,
bw.sip.peeraccessinterfacehost,
bw.cpl.cplHttpRequestTimeout,
bw.diameter.xs.identity, customer
SoundFileDir, bw.accounting.num
Threads, bw.mgcp.numThreads,
bw.eccr.numProcessors,
bw.sip.networkrecordro
utehost, bw.database, bw.sip
.networkinterfacehost, bw.eccr
.numEventQueueFiles, bw.sip
.networkclustercontactincludetcp
transport, bw.sip.statelessproxy
.audittimerseconds, bw.ps
.ocip.slowOCIPTransactions
NumThreads, bw.sip.callid
Suffix, bw.nameservice.cache
TtlSecs, bw.mgcp.numEncoder
Threads, bw.sip.statelessproxy
.longtermtransactionlimit, bw
.sip.networkrecordrouteport, bw
.diameter.ps.identity, bw.cpl.min
NumHttpWorkerThreads, bw.sip
.peernetworkinterfacehost, bw.sip
.accessclustercontactincludetcpt
ransport, privateIPAddress,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 300
 Variable Field Type Valid Values Description
bw.nameservice.unreachable
ServerLingerSecs, bw.sip.num
EncoderThreads, bw.service
.calltypequery, bw.sip.replicated
.msinterfaceviahost, bw.sip
.networkrecordrouteincludeudptra
nsport, bw.diameter.ps.listening
Address, bw.sip.statelessproxy
.threads, publicIPAddress, bw
.cap.numEncoderThreads, bw.sip
.networkrecordrouteincludetcptra
nsport, bw.mediacr.warning
Timeout, bw.sip.geoproxy
.maxoptionsperinterval, bw.sip
.accessclustercontactport, bw
.sip.accessrecordroutehost,
bw.sip.numThreads, bw.sip
.msinterfaceviahost, bw.sip
.accessclustercontacthost, bw
.accounting.useuuidforlinux
systemid, bw.sip.networkinterfac
eviahost, bw.cap.numDecoder
Threads, bw.callhalf.numNon
CallThreads, bw.nameservice
.useAdditionalSrvRrs, bw.ecl
.eventQueueFileSize, bw.sip
.accessclustercontactincludeudpt
ransport, bw.sip.statelessproxy
.longtermtrackingseconds

6.31.2 set
System property-related attributes, such as the mail POP3 timeout or mail IMAP connection timeout, are
changed using this command.
1) Ensure you are at the /AS_CLI/System/StartupParam> level.
2) Enter:
set <name>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 301
 Variable Field Type Valid Values Description

<name> Choice bw.sip.numNonCallThreads, The name of the system

bw.sip.accessinterfaceviahost, parameter to change.
bw.soap.max.threads, bw
.meetmeconferencing.xsiEvents
Threshold, bw.asr.source
.ip, bw.sip.msclustercontac
tincludeudptransport, bw.ps
.ocip.groupAndEntCallLog
TransactionsNumThreads,
bw.sip.networkclusterc
ontacthost, bw.sip.maxsipcallinvit
ingpersipuacaller, bw.sip
.geoproxy.optionspollingi
ntervalmilliseconds, bw.callhalf
.numThreads, bw.callcenter
.statusDowngradeDelay
Period, bw.numberportabili
ty.max.threads, bw.ims.min
.threads, bw.sip.tcp.sendBuffer
Size, bw.sip.accessrecordrou
teincludetcptransport, bw.sip
.networkclustercontactport, bw
.sip.accessrecordrouteport, bw
.ecl.numProcessors, bw.sip
.maxsipcallinvitingpersipuacalled,
bw.sip.replicated.msclustercontac
thost, bw.sip.peernetworkinte
rfacetransport, bw.sip
.peernetworkrecordroutehost, bw
.cpl.maxNumHttpWorkerThreads,
bw.routepoint.failThrottle
Interval, bw.sip.statelessproxy
.shorttermtrackingseconds, bw
.sip.replicated.networkclusterc
ontacthost, bw.nameservice
.timeBoundedPoolSize, bw
.callcenter.monitoringPeriod
Throttling, bw.diameter.xs.max
PoolSize, bw.sip.networkinterfac
eport, bw.ocic.numEncoder
Threads, bw.ecl.numEventQueue
Files, bw.routepoint.numCall
ToProcessPerInterval, bw.sip
.replicated.accessclusterco
ntacthost, bw.nameservice.cache
Policy, bw.sip.udp.receiveBuffer
Size, bw.sip.maxsipcallpersi
pua, bw.sip.peernetworkreco
rdrouteport, java.ldap.connect
.timeout, bw.sip.replicated
.accessinterfaceviahost, bw
.callcenter.remoteHostAddress,
bw.xs.oci.timeoutInSeconds,
org.apache.commons.logging.
Log, bw.nameservice.nCache
Policy, bw.sip.peernetworkreco
rdrouteincludetcptransport,
bw.sip.peernetworkreco
rdrouteincludeudptransport,
bw.sip.networkclusterc

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 302
 Variable Field Type Valid Values Description
ontactincludeudptransport, bw
.sh.numThreads, bw.persistence
.xla.server.port, privateIPv6
Address, bw.sip.msclustercontac
tport, bw.ps.dms.numThreads,
bw.mediacr.watchdogTimeout,
bw.sip.accessrecordrou
teincludeudptransport, bw.sip
.networkinterfacetransport, bw
.sip.peeraccessinterfaceport, bw
.diameter.xs.listeningAddress,
bw.eccr.eventQueueFileSize,
bw.ecl.eventQueueMemSize,
bw.sh.systemRefreshPublic
IdentitiesPerHour, bw.ocic
.numDecoderThreads, bw.sip
.peeraccessinterfacetransport,
bw.sip.msclustercontac
tincludetcptransport, bw.xs.oci
.reconnectIntervalInSeconds,
dtdLocation, publicIPv6Address,
bw.sip.msclustercontacthost,
bw.nameservice.denyTime
BoundedDuplicateLookups, bw
.diameter.ps.maxPoolSize, bw
.http.mediaif, bw.numberportabili
ty.min.threads, bw.nameservice
.nCacheTtlSecs, bw.mediacr
.numberOfThreads, bw.soap
.min.threads, bw.sip.replicated
.networkinterfaceviahost,
bw.mediacr.tcpConnection
Timeout, bw.sip.peernetworkinte
rfaceport, bw.ims.max.threads,
bw.servicecontrol.numThreads,
bw.sip.peeraccessinterfacehost,
bw.cpl.cplHttpRequestTimeout,
bw.diameter.xs.identity, customer
SoundFileDir, bw.accounting.num
Threads, bw.mgcp.numThreads,
bw.eccr.numProcessors,
bw.sip.networkrecordro
utehost, bw.database, bw.sip
.networkinterfacehost, bw.eccr
.numEventQueueFiles, bw.sip
.networkclustercontactincludetcp
transport, bw.sip.statelessproxy
.audittimerseconds, bw.ps
.ocip.slowOCIPTransactions
NumThreads, bw.sip.callid
Suffix, bw.nameservice.cache
TtlSecs, bw.mgcp.numEncoder
Threads, bw.sip.statelessproxy
.longtermtransactionlimit, bw
.sip.networkrecordrouteport, bw
.diameter.ps.identity, bw.cpl.min
NumHttpWorkerThreads, bw.sip
.peernetworkinterfacehost, bw.sip
.accessclustercontactincludetcpt
ransport, privateIPAddress,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 303
 Variable Field Type Valid Values Description
bw.nameservice.unreachable
ServerLingerSecs, bw.sip.num
EncoderThreads, bw.service
.calltypequery, bw.sip.replicated
.msinterfaceviahost, bw.sip
.networkrecordrouteincludeudptra
nsport, bw.diameter.ps.listening
Address, bw.sip.statelessproxy
.threads, publicIPAddress, bw
.cap.numEncoderThreads, bw.sip
.networkrecordrouteincludetcptra
nsport, bw.mediacr.warning
Timeout, bw.sip.geoproxy
.maxoptionsperinterval, bw.sip
.accessclustercontactport, bw
.sip.accessrecordroutehost,
bw.sip.numThreads, bw.sip
.msinterfaceviahost, bw.sip
.accessclustercontacthost, bw
.accounting.useuuidforlinux
systemid, bw.sip.networkinterfac
eviahost, bw.cap.numDecoder
Threads, bw.callhalf.numNon
CallThreads, bw.nameservice
.useAdditionalSrvRrs, bw.ecl
.eventQueueFileSize, bw.sip
.accessclustercontactincludeudpt
ransport, bw.sip.statelessproxy
.longtermtrackingseconds

<bw.sip Integer 180 through 86400 This parameter specifies the

.statelessproxy minimum length of time (in
.longtermtrackin seconds) a long-term transaction
gseconds> is tracked before it is moved to
short-term tracking.

<bw.sip Choice true, false This parameter controls the

.accessclusterco User Datagram Protocol (UDP)
ntactincludeudpt transport.
ransport> If the value is set to "true", a
transport parameter with a value
of "udp" is included in the Contact
header of the Session Initiation
Protocol (SIP) message. It is
included within Contact header
of SIP messages sent toward
access devices using the UDP
transport.

<bw.ecl.event Integer 512 through 4096 This parameter specifies the

QueueFile size of the event queue file (in
Size> kilobytes).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 304
 Variable Field Type Valid Values Description

<bw Choice true, false This parameter controls the use

.nameservice of additional Resource Record
.useAdditional (RR) sections of the Service
SrvRrs> Locator (SRV) lookup response.
When the value is set to "true",
it indicates that an A lookup
resulting from SRV lookups uses
the pre-resolved A resource
records from the additional
RR section of the SRV lookup
response. Local caching must be
enabled for this setting to have an
effect.

<bw.callhalf Integer 1 through 128 This parameter specifies the

.numNonCall number of threads affected
Threads> by non-call-related call-half
processing.

<bw.cap.num Integer 1 through 128 This parameter specifies the

Decoder number of decoder threads for
Threads> the Client Application Protocol
(CAP).
This parameter is configured
automatically during server
installation, based on the number
of installed Central Processing
Units (CPU) cores.

<bw.sip String 1 to 80 characters This parameter specifies the

.networkinterfac Internet Protocol (IP) address (or
eviahost> hostname) of the location on the
Application Server where access-
side devices send responses.
It is included in the Via sent-by
field of Session Initiation Protocol
(SIP) requests sent toward
access-side devices.
If this parameter is empty, the
Public IP Address is used.
If the Public IP Address is not set,
the IP Address from resolving
localhost is used.

<bw.accounting Choice true, false This parameter enables the

.useuuidforlinux use of the Universally Unique
systemid> Identifier (UUID) as the system ID
(to use in accounting) for Linux
installs. When the value is set
to "false", BroadWorks uses the
Media Access Control (MAC)
address.

<bw.sip String 1 to 80 characters This parameter specifies the

.accessclusterco value to populate the CONTACT
ntacthost> host portion of Session Initiation
Protocol (SIP) messages.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 305
 Variable Field Type Valid Values Description

<bw.sip String 1 to 80 characters This parameter specifies the

.msinterfaceviah Internet Protocol (IP) address (or
ost> host name) indicating the location
on this Application Server where
Media Servers send responses.
This parameter is included within
the Via sent-by field of Initiation
Protocol (SIP) requests sent
toward Media Servers.
If it is not configured and the
Private IP Address and Public
IP Address are configured, the
Private IP Address is used.
If only the Public IP Address is
configured, it is used.
Otherwise, the IP Address from
the resolving local host is used.

<bw.sip.num Integer 1 through 128 This parameter specifies the

Threads> number of threads affected by
call-related processing.

<bw.sip String 1 to 80 characters This parameter specifies the IP

.accessrecordrou address or hostname used by
tehost> the secondary Application Server
proxy to populate a Record-
Route entry host for access
side requests routing to this
Application Server instance
or cluster. When the reverse
cluster access side hostname
is populated, it allows a non
responsive secondary Application
Server to be successfully
bypassed. If the value is "nil"
and IPv4 is supported, the
value of the publicIPAddress
parameter is used if not "nil".
If nil, "localhost" is resolved for
use. If the value is "nil" and only
IPv6 is supported, the value of
the publicIPv6Address is used
if the value for this parameter
is not "nil". If the value for this
parameter is "nil", a known IPv6
address is used.

<bw.sip Integer 1025 through 65535 This parameter specifies the

.accessclusterco port. This parameter must be
ntactport> set to "nil" to ensure that the
access device does a Service
Locator (SRV) record lookup on
the contact host.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 306
 Variable Field Type Valid Values Description

<bw.sip Integer 1 through 2147483647 This parameter specifies the

.geoproxy maximum number of SIP
.maxoptionsperin OPTIONS messages that
terval> can be sent to test device
connectivity within the configured
interval. This parameter is
used in conjunction with the
optionsPollingIntervalInMsec
parameter.

<bw.mediacr Integer 0 through 120 This parameter specifies the

.warning delay before a warning is logged
Timeout> if a thread is unresponsive.
Use "0" to turn off the warning.

<bw.sip Choice true, false This parameter determines if the

.networkrecordro SIP-URI transport value TCP is
uteincludetcptra included when a Record-Route
nsport> entry is added (or rewritten) and
sent over TCP to a network-side
device.

<bw.cap Integer 1 through 128 This parameter specifies the

.numEncoder number of encoder threads for
Threads> the Client Application Protocol
(CAP).
This parameter is configured
automatically during server
installation based on the number
of installed Central Processing
Units (CPU) cores.

<publicIP String 1 to 39 characters This parameter specifies the

Address> public Internet Protocol (IP)
address of the Application Server.
All access-side (toward access
devices) traffic use this interface.

<bw.sip Integer 1 through 1024 This parameter specifies the

.statelessproxy number of threads that are
.threads> created for a stateless proxy.

<bw.diameter String 1 to 39 characters This parameter specifies the

.ps.listening address to which the Execution
Address> Server Diameter stack binds
a server socket for incoming
connections.

<bw.sip Choice true, false This parameter determines if the

.networkrecordro SIP-URI transport value UDP is
uteincludeudptra included when a Record-Route
nsport> entry is added (or rewritten) and
sent over UDP to a network-side
device.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 307
 Variable Field Type Valid Values Description

<bw.sip String 1 to 80 characters This parameter specifies the

.replicated IP address or host name of the
.msinterfaceviah location on the Application Server
ost> where Media Servers send
responses. It is included within
the Via sent-by SIP requests sent
towards Media Servers. If it is not
set, the geo-redundancy value
acts as a default.

<bw.service Choice true, false This parameter enables a pre-call

.calltypequery> translation to a mobile softswitch
through a Session Initiation
Protocol (SIP) INFO request
with a Require options tag of
"broadworkscalltypequery".

<bw.sip.num Integer 1 through 128 This parameter specifies the

Encoder number of threads affected by
Threads> encoder-related processing.

<bw Integer 0 through 2147483647 This parameter specifies the

.nameservice minimum time interval (in
.unreachable seconds) during which no Domain
ServerLinger Name System (DNS) request is
Secs> sent to a server that is detected
as unreachable.

<privateIP String 1 to 15 characters This parameter specifies the

Address> private Internet Protocol (IP)
address of the Application Server.
This interface address is used for
all network-side Session Initiation
Protocol (SIP) traffic (toward
the Network Server, Media
Server, and any Public Switched
Telephone Network [PSTN]
interconnect contacts returned by
the Network Server). By default,
the SIP Via and Contact headers
are populated with the Public IP
Address and Private IP Address
respectively. If the address field
of a header is empty and the
Private IP Address and Public IP
Address are defined, the Private
IP Address is used. If only the
Public IP Address is defined, the
Public IP Address is used.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 308
 Variable Field Type Valid Values Description

<bw.sip Choice true, false This parameter controls the

.accessclusterco Transmission Control Protocol
ntactincludetcpt (TCP). If the value is set to "true",
ransport> a transport parameter with a
value of "tcp" is included in the
Contact header of the Session
Initiation Protocol (SIP) message.
It is included within Contact
header of SIP messages sent
toward access devices using the
TCP transport.

<bw.sip String 1 to 80 characters This parameter specifies the

.peernetworkinte network-side Session Initiation
rfacehost> Protocol (SIP) interface host for
the peer Application Server.

<bw.cpl Integer 1 through 128 This parameter specifies the

.minNum minimum number of worker
HttpWorker threads in the HTTP worker
Threads> thread pool.

<bw.diameter String 1 to 80 characters This parameter specifies the

.ps.identity> Diameter identity associated with
the Execution Server (included in
the Origin-Host AVP of outgoing
Diameter messages).
NOTE: The value cannot end with
a period (.).

<bw.sip Integer 0 through 65535 This parameter is used by the

.networkrecordro secondary Application Server
uteport> proxy to populate a Record-
Route entry’s port if the value
of the network record route host
is not "nil". The default value
is "nil" which indicates that the
port should not be sent. If the
value is not "nil", it should equal
the configured SIP listening port
(which defaults to "5060"). Note
that this prevents the sender from
performing a Naming Authority
Pointer (NAPTR) and Service
Locator (SRV) lookup. If the
value of the network record route
host is "nil", the configured SIP
listening port is used.

<bw.sip Integer 1 through 2147483647 This parameter specifies

.statelessproxy the maximum number of
.longtermtransac simultaneously tracked long-term
tionlimit> transactions.

<bw.mgcp Integer 1 through 128 This parameter specifies the

.numEncoder number of decoder threads for
Threads> the Media Gateway Control
Protocol (MGCP).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 309
 Variable Field Type Valid Values Description

<bw Integer 0 through 2147483647 This parameter specifies the

.nameservice amount of time (in seconds) a
.cacheTtlSecs> successfully looked-up record is
cached if the Cache policy is set
to "Configured".

<bw.sip.callid String 1 to 80 characters This parameter allows configuring

Suffix> a custom value to use instead
of the "AS IP Address or FQDN"
part of the Call-ID generated by
the Application Server.

<bw.ps.ocip Integer 1 through 128 This parameter specifies the

.slowOCIP number of slow Open Client
Transactions Interface-Provisioning (OCI-P)
NumThreads> transactions threads running on
the Provisioning Server.

<bw.sip Integer 60 through 86400 This parameter specifies the

.statelessproxy audit interval for moving expired
.audittimersecon transactions from long-term to
ds> short-term tracking.

<bw.sip Choice true, false This parameter controls the

.networkclusterc Transmission Control Protocol
ontactincludetcp (TCP).
transport> If the value is set to "true", a
transport parameter with a value
of "tcp" is included in the Contact
header of the Session Initiation
Protocol (SIP) message. It is
included within Contact header
of SIP messages sent toward
access devices using the TCP
transport.

<bw.eccr.num Integer 2048 through 1000000 This parameter specifies the

EventQueue number of files created to store
Files> events that cannot be stored to
the centralized database.

<bw.sip String 1 to 80 characters This parameter specifies the

.networkinterfac network-side Session Initiation
ehost> Protocol (SIP) interface host for
the Application Server.

<bw.database> String 0 to 2147483647 characters This parameter specifies the Data

Source Name (DSN) to be used
for the database.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 310
 Variable Field Type Valid Values Description

<bw.sip String 1 to 80 characters This parameter specifies the IP

.networkrecordro address or hostname used by
utehost> the secondary Application Server
proxy to populate a Record-
Route entry host for access-
side requests routing to this
Application Server instance
or cluster. When the reverse
cluster access-side hostname
is populated, it allows a non
responsive secondary Application
Server to be successfully by-
passed. If the value is "nil"
and IPv4 is supported, the
privateIPAddress is used if
the value for this parameter
is not "nil". If the value of the
privateIPAddress is "nil", the
value of the publicIPAddress
parameter is used if the value for
this parameter is not "nil". If the
value for this parameter is "nil",
the "localhost" is resolved for use.
If the value is "nil" and only IPv6
is supported, the value of the
privateIPv6Address parameter is
used if the value of the parameter
is not "nil". If the value for the
privateIPv6Address parameter
is "nil", the publicIPv6Address
parameter is used if the value of
the parameter is not "nil". If the
value of the parameter is "nil", a
known IPv6 address is used.

<bw.eccr.num Integer 1 through 128 This parameter specifies the

Processors> number of threads to handle call
center reporting events.
Events handled by a processor
are converted into Structured
Query Language (SQL)
statements and written to the
centralized database.

<bw.mgcp.num Integer 1 through 128 This parameter specifies the

Threads> number of receiver threads for the
Media Gateway Control Protocol
(MGCP).

<bw.accounting Integer 1 through 128 This parameter specifies the

.numThreads> number of threads dedicated to
accounting-related tasks.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 311
 Variable Field Type Valid Values Description

<customer String 0 to 2147483647 characters This parameter specifies the

SoundFileDir> prefix of the path pointing to the
place where customized .WAV
files (for example, custom Auto
Attendant greetings, custom
user voice mail greetings, and
personalized names) are stored.
NOTE: Changing this parameter
may not have the expected result
since uploading a custom .WAV
file from the web does not take
this property into account, nor
does recording the .WAV files
through the voice portal.

<bw.diameter String 1 to 80 characters This parameter specifies a

.xs.identity> server-specific Diameter identity
associated with the Execution
Server.
This value is the same as
the value of the Diameter
identity associated with the
Execution Server in the
executionServerSubsystem/
diameter. This parameter is
required when operating in relay
mode.

<bw.cpl.cpl Integer 5 through 60 This parameter specifies the time

HttpRequest (in seconds) before the request
Timeout> times out.

<bw.sip String 1 to 80 characters This parameter specifies the

.peeraccessinter access-side Session Initiation
facehost> Protocol (SIP) interface host for
the peer Application Server.

<bw Integer 1 through 128 This parameter specifies the

.servicecontrol number of worker threads for the
.numThreads> Service Control.

<bw.ims.max Integer 1 through 128 This parameter specifies the

.threads> maximum number of Voice
Messaging threads.

<bw.sip Integer 1025 through 65535 This parameter specifies the

.peernetworkinte network-side Session Initiation
rfaceport> Protocol (SIP) interface port for
the peer Application Server.

<bw.mediacr Integer 1 through 120 This parameter specifies the

.tcpConnection connection time-out when
Timeout> opening a new Transmission
Control Protocol (TCP)
connection toward a Media
Server.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 312
 Variable Field Type Valid Values Description

<bw.sip String 1 to 80 characters This parameter specifies the

.replicated IP address or host name of the
.networkinterfac location on this Application Server
eviahost> where network-side devices send
responses. It is included within
the Via sent-by SIP requests sent
towards network-side devices. If
it is not set, the geo-redundancy
value acts as a default.

<bw.soap.min Integer 0 through 128 This parameter specifies the

.threads> minimum number of Simple
Object Access Protocol (SOAP)
threads.

<bw.mediacr Integer 1 through 1000 This parameter specifies the

.numberOf number of receiving threads for
Threads> messages from the Media Server.

<bw Integer 0 through 2147483647 This parameter specifies the

.nameservice.n amount of time (in seconds) a
CacheTtlSecs> looked-up record with a negative
response is kept in the negative
cache if the negative Cache
policy is set to "Configured".

<bw Integer 1 through 128 This parameter specifies the

.numberportabili minimum number of Number
ty.min.threads> Portability lookup threads.

<bw.http String 1 to 80 characters This parameter specifies the

.mediaif> Internet Protocol (IP) address that
the Application Server uses when
signaling the Media Server. This
parameter is only used with the
file protocol. It is not used with the
Web-based Distributed Authoring
and Versioning (WebDAV)
protocol.

<bw.diameter Integer 1 through 2147483647 This parameter specifies the

.ps.maxPool number of Execution Server
Size> Diameter worker threads.

<bw Choice true, false This parameter controls the use

.nameservice of duplicate lookups with the
.denyTime same name and type from two
Bounded time-bounded threads.
Duplicate
Lookups>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 313
 Variable Field Type Valid Values Description

<bw.sip String 1 to 80 characters This parameter specifies

.msclustercontac the contact host portion of
thost> Session Initiation Protocol (SIP)
messages.
The parameter value is included
within Contact headers of SIP
messages sent toward Media
Servers.
If it is not configured and the
Private IP Address and Public
IP Address parameters are
configured, the Private IP
Address is used.
If only the public IP Address is
configured, it is used.
Otherwise, the IP Address from
the resolving localhost is used.

<publicIPv6 String 1 to 39 characters This parameter specifies the

Address> server default IPv6 address. Used
by SIP instead of publicIPAddress
when sipIpVersion is IPv6.
Unused when not using IPv6.

<dtdLocation> String 0 to 2147483647 characters This parameter specifies the

location of the Call Processing
Language (CPL) Document Type
Definition (DTD) file. The CPL
DTD controls the syntax of the
CPL scripts that are used on
BroadWorks.

<bw.xs.oci Integer 10 through 3600 This parameter specifies the

.reconnect time (in seconds) between
IntervalIn each reconnection attempt from
Seconds> the Execution Server to the
Provisioning Server.
This parameter is used when
the Execution Server Open
Client Interface (OCI) connection
between the Execution Server
and the Provisioning Server is
down.

<bw.sip Choice true, false This parameter controls the

.msclustercontac Transmission Control Protocol
tincludetcptrans (TCP).
port> If the value is set to "true", a
transport parameter with a value
of "tcp" is included in the Contact
header of the Session Initiation
Protocol (SIP) message. It is
included within Contact header
of SIP messages sent toward
access devices using the TCP
transport.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 314
 Variable Field Type Valid Values Description

<bw.sip Choice TCP, UDP This parameter specifies the

.peeraccessinter access-side Session Initiation
facetransport> Protocol (SIP) interface transport
protocol for the peer Application
Server.

<bw.ocic Integer 1 through 128 This parameter specifies the

.numDecoder number of decoder threads for
Threads> the Open Client Interface-Call
Control (OCI-C) protocol.

<bw.sh.system Integer 0 through 2147483647 This parameter specifies the rate

RefreshPublic at which the Application Server
IdentitiesPer refreshes public identities during
Hour> a system refresh.

<bw.ecl.event Integer 4 through 64 This parameter specifies the

QueueMem number of queue entries allowed
Size> for every megabyte of memory.

<bw.eccr.event Integer 512 through 8192 This parameter specifies the

QueueFile size of the event queue file (in
Size> kilobytes).

<bw.diameter String 1 to 39 characters This parameter specifies the

.xs.listening address that the Execution
Address> Server Diameter stack binds a
server socket to for incoming
connections.

<bw.sip Integer 1025 through 65535 This parameter specifies the

.peeraccessinter access-side Session Initiation
faceport> Protocol (SIP) interface port for
the peer Application Server.

<bw.sip Choice TCP, UDP This parameter specifies the

.networkinterfac network-side Session Initiation
etransport> Protocol (SIP) interface transport
for the Application Server.

<bw.sip Choice true, false This parameter determines

.accessrecordrou whether the SIP-URI transport
teincludeudptran value UDP is included when a
sport> Record-Route entry is added (or
rewritten) and sent over UDP
to an access-side device. The
default value is "false".

<bw.mediacr Integer 0 through 120 This parameter specifies the

.watchdog delay before the processing
Timeout> thread restarts if unresponsive.
Use "0" to turn off the watchdog.

<bw.ps.dms Integer 1 through 128 This parameter specifies the

.numThreads> number of Internet Protocol
(IP) Device Configuration
Management threads running on
the Provisioning Server.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 315
 Variable Field Type Valid Values Description

<bw.sip Integer 0 through 65535 This parameter specifies the

.msclustercontac contact port sent to the Media
tport> Server.
Set the value of this parameter to
"nil" to ensure the network device
does a Service Locator (SRV)
record lookup on the contact host.

<privateIPv6 String 1 to 39 characters This parameter specifies the

Address> server default private IPv6
address. Used by SIP instead
of privateIPAddress when
sipIpVersion is IPv6. Unused
when not using IPv6.

<bw Integer 0 through 65535 This parameter specifies the port

.persistence.xla used by RemoteXLA.
.server.port>

<bw.sh.num Integer 1 through 128 This parameter specifies the

Threads> number of threads for the
Provisioning Server (at the
application session level) to
process Sh interface transactions.

<bw.sip Choice true, false This parameter controls the

.networkclusterc User Datagram Protocol (UDP)
ontactincludeudp transport.
transport> If the value is set to "true", a
transport parameter with a value
of "udp" is included in the Contact
header of the Session Initiation
Protocol (SIP) message. It is
included within the Contact
header of SIP messages sent
toward access devices using the
UDP transport.

<bw.sip Choice true, false This parameter determines

.peernetworkreco whether the SIP-URI transport
rdrouteincludeud value UDP is included when a
ptransport> Record-Route entry is added (or
rewritten) and sent over UDP to
network-side peer Application
Server.

<bw.sip Choice true, false This parameter determines

.peernetworkreco whether the SIP-URI transport
rdrouteincludetc value TCP is included when a
ptransport> Record-Route entry is added (or
rewritten) and sent to a network-
side peer Application Server. The
default value is "true".

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 316
 Variable Field Type Valid Values Description

<bw Choice Never, Configured, Honor_DNS This parameter specifies the

.nameservice.n negative Cache policy.
CachePolicy> When this parameter value
is set to "HONOR_DNS", the
Domain Name System (DNS)
client uses the minimum value of
the response's Start of Authority
(SOA) record.

<org.apache String 0 to 2147483647 characters This parameter specifies

.commons the address of the Apache
.logging.Log> logs channel that handles
the integration of the Apache
Commons Logging framework
(a simple logging interface
abstracting logging application
programming interface [API])
with the BroadWorks logging
framework.
The log object points to an input
channel. The name of the input
channel is derived from the class
name.
Following are the six logging
levels, in order from the least
to the most serious: "trace",
"debug", "info", "warn", "error",
and "fatal".

<bw.xs.oci Integer 2 through 15 This parameter specifies the

.timeoutIn request time-out for requests to
Seconds> the Provisioning Server on the
Execution Server-Open Client
Interface (OCI) link.
The Execution Server stops
waiting for a response when the
value for the time-out is reached.

<bw.callcenter String 1 to 80 characters This parameter specifies the

.remoteHost remote network address.
Address> This parameter must
be configured on both
Application Servers to allow
the communication between an
Execution Server process and a
Provisioning Server process that
is not colocated.

<bw.sip String 1 to 80 characters This parameter specifies the IP

.replicated address or host name indicating
.accessinterface the location on this BroadWorks
viahost> Application Server where access-
side devices should send
responses. It is included within
Via sent-by SIP requests sent
towards access-side devices. If
it is not set, the geo-redundancy
value acts as a default.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 317
 Variable Field Type Valid Values Description

<java.ldap Integer 0 through 2147483647 This parameter specifies the

.connect time-out (in seconds) for the
.timeout> connection from the Provisioning
Server to the Lightweight
Directory Access Protocol (LDAP)
server.

<bw.sip Integer 0 through 65535 This parameter is used by the

.peernetworkreco secondary Application Server
rdrouteport> proxy to populate a Record-Route
entry’s port if the value of the
network peer record route host
is not "nil". The default value
is "nil" which indicates that the
port should not be sent. If the
value is not "nil", it should equal
the configured SIP listening port
(which defaults to "5060"). Note
that this prevents the sender from
performing a Naming Authority
Pointer (NAPTR) and Service
Locator (SRV) lookup. If the value
of the network peer record route
host is "nil", the configured SIP
listening port is used.

<bw.sip Integer 1 through 2147483647 This parameter specifies the

.maxsipcallpersi maximum number of Session
pua> Initiation Protocol (SIP) call
occurrences stored for each SIP-
User Agent (UA) instance.
This parameter reduces
the impact of forking (log
occurrences) caused by a large
number of SIP call occurrences
accumulated for each SIP-UA
instance.

<bw.sip.udp Integer 131072 through 33554432 This parameter specifies the size
.receiveBuffer (in bytes) of the attributes-related
Size> Session Initiation Protocol (SIP)
User Datagram Protocol (UDP)
receive buffer.

<bw Choice Never, Configured, Honor_DNS This parameter specifies the

.nameservice Cache policy.
.cachePolicy> When this parameter value is set
to "HONOR_DNS", the Domain
Name System (DNS) client uses
the response's Time To Live
(TTL) value.

<bw.sip String 1 to 80 characters This parameter specifies the

.replicated CONTACT host portion of
.accessclusterco Session Initiation Protocol (SIP)
ntacthost> messages. If it is not set, the
geo-redundancy value acts as a
default.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 318
 Variable Field Type Valid Values Description

<bw.routepoint Integer 1 through 100 This parameter specifies the

.numCallTo number of calls processed and
ProcessPer routed to the failed route point
Interval> destination at each interval.

<bw.ecl.num Integer 2048 through 1000000 This parameter specifies the

EventQueue number of files created to store
Files> events that temporarily cannot
be stored to the centralized
database.

<bw.ocic Integer 1 through 128 This parameter specifies the

.numEncoder number of encoder threads for
Threads> the Open Client Interface-Call
Control (OCI-C) protocol.

<bw.sip Integer 1025 through 65535 This parameter specifies the

.networkinterfac network-side Session Initiation
eport> Protocol (SIP) interface port for
the Application Server.

<bw.diameter Integer 1 through 2147483647 This parameter specifies the

.xs.maxPool number of the Execution Server
Size> Diameter worker threads.

<bw.callcenter Integer 1 through 60 This parameter specifies the

.monitoring throttling period for the call center
Period monitoring notifications.
Throttling> The Application Server sends
at most one notification for the
configured throttling value in
seconds.

<bw Integer 1 through 384 This parameter specifies the

.nameservice number of threads assigned to
.timeBounded time-bounded Name Service
PoolSize> queries.

<bw.sip String 1 to 80 characters This parameter specifies the

.replicated CONTACT host portion of SIP
.networkclusterc messages. If it is not set, the
ontacthost> geo-redundancy value acts as a
default.

<bw.sip Integer 32 through 180 This parameter specifies the

.statelessproxy minimum length of time (in
.shorttermtracki seconds) a short-term transaction
ngseconds> is tracked.

<bw.routepoint Integer 500 through 30000 This parameter specifies the

.failThrottle failover throttling interval (in
Interval> milliseconds).

<bw.cpl Integer 1 through 128 This parameter specifies the

.maxNum maximum number of worker
HttpWorker threads in the Hypertext Transfer
Threads> Protocol (HTTP) worker thread
pool.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 319
 Variable Field Type Valid Values Description

<bw.sip String 1 to 80 characters This is an IP address or

.peernetworkreco hostname used by the secondary
rdroutehost> Application Server proxy to
populate a Record-Route entry
host for network-side requests
routing to this Application
Server instance from a peer
Application Server. If set,
this parameter should be a
network-side IP-address or
hostname corresponding to the
peer network interface to this
Application Server instance.
If the value is "nil" and IPv4
is supported, the value of the
privateIPAddress parameter
is used if the value of this
parameter is not "nil". If the
vlaue of the privateIPAddress
parameter is "nil", the value of
the publicIPAddress parameter
is used if the value of this
parameter is not "nil". If the
value of this parameter is "nil",
the "localhost" is resolved for
use. If the value is "nil" and
only IPv6 is supported, the
value of the privateIPv6Address
parameter is used if the value for
this parameter is not "nil". If the
value for the privateIPv6Address
parameter is "nil", the value of the
publicIPv6Address parameter is
used if the value of this parameter
is not "nil". If the value of this
parameter is "nil", a known IPv6
address is used.

<bw.sip Choice TCP, UDP This parameter specifies the

.peernetworkinte network-side Session Initiation
rfacetransport> Protocol (SIP) interface transport
protocol for the peer Application
Server.

<bw.sip String 1 to 80 characters This parameter specifies

.replicated theCONTACT host portion of SIP
.msclustercontac messages. It is included within
thost> Contact headers of Session
Initiation Protocol (SIP) messages
that are sent towards Media
Servers. If it is not set, the geo-
redundancy value acts as a
default.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 320
 Variable Field Type Valid Values Description

<bw.sip Integer 1 through 2147483647 This parameter specifies the

.maxsipcallinvit maximum number of Session
ingpersipuacalled> Initiation Protocol (SIP) call
occurrences in the INVITING
state stored for each SIP User
Agent (UA) instance when
acting as a called party (SIP-UA
received INVITE).
This parameter reduces
the impact of forking (log
occurrences) caused by a large
number of SIP call occurrences
accumulated for each SIP-UA
instance.
When the value is exceeded, the
Application Server releases the
call instead of sending another
INVITE provisional response to
create another early dialog for the
INVITE.

<bw.ecl.num Integer 1 through 128 This parameter specifies the

Processors> number of threads to handle
call log events. Events handled
by a processor are converted
into Structured Query Language
(SQL) statements and written to
the centralized database.

<bw.sip Integer 0 through 65535 This parameter is used by the

.accessrecordrou secondary Application Server
teport> proxy to populate a Record-
Route entry's port if the value
of the access record route host
is not "nil". The default value
is "nil" which indicates that the
port should not be sent. If the
value is not "nil", it should equal
the configured Session Initiation
Protocol (SIP) listening port
(which defaults to "5060"). Note
that this prevents the sender from
performing a Naming Authority
Pointer (NAPTR) and Service
Locator (SRV) lookup. If the value
for the access record route host is
"nil", the configured SIP listening
port is used.

<bw.sip Integer 1025 through 65535 This parameter specifies the

.networkclusterc network contact port.
ontactport> This parameter must be set to
"nil" to ensure that the network
device performs a Service
Locator (SRV) record lookup on
the contact host.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 321
 Variable Field Type Valid Values Description

<bw.sip Choice true, false This parameter determines

.accessrecordrou whether the SIP-URI transport
teincludetcptran value TCP is included when a
sport> Record-Route entry is added (or
rewritten) and sent to an access-
side device over TCP. The default
value is "true".

<bw.sip.tcp Integer 0 through 2147483647 This parameter specifies the size

.sendBuffer (in bytes) of the Transmission
Size> Control Protocol (TCP) send
buffer for the Session Initiation
Protocol (SIP).
When the parameter is set to a
non-zero value, it replaces the
Operating System (OS) value for
the buffer size.

<bw.ims.min Integer 1 through 128 This parameter specifies the

.threads> minimum number of Voice
Messaging threads.

<bw Integer 1 through 128 This parameter specifies the

.numberportabili maximum number of Number
ty.max Portability lookup threads.
.threads>

<bw.callcenter Integer 1 through 300 This parameter specifies the

.status time period (in seconds) when
Downgrade the status is downgraded
DelayPeriod> (from Normal to Empty or from
Threshold Exceeded to Normal)
before a call center status update
is sent.

<bw.callhalf Integer 1 through 128 This parameter specifies the

.numThreads> number of threads affected by
call-related call-half processing.

<bw.sip Integer 1 through 2147483647 This parameter specifies

.geoproxy the interval that controls the
.optionspollingi rate of that SIP OPTIONS
ntervalmilliseco messages are sent to test device
nds> connectivity. This parameter
is used in conjunction with
the maxOptionsPerInterval
parameter.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 322
 Variable Field Type Valid Values Description

<bw.sip Integer 1 through 2147483647 This parameter specifies the

.maxsipcallinvit maximum number of Session
ingpersipuacaller> Initiation Protocol (SIP) call
occurrences in the INVITING
state stored for each SIP-User
Agent (UA) instance when acting
as a caller (SIP-UA sent INVITE).
This parameter reduces
the impact of forking (log
occurrences) caused by a large
number of SIP call occurrences
accumulated for each SIP-UA
instance.
When the value is exceeded, the
Application Server cancels the
INVITE.

<bw.sip String 1 to 80 characters This parameter specifies the

.networkclusterc host network address. This
ontacthost> parameter is used to populate
the CONTACT host portion of
Session Initiation Protocol (SIP)
messages.

<bw.ps.ocip Integer 1 through 128 This parameter is used to control

.groupAnd the number of threads in a pool
EntCallLog that is designated to process the
Transactions group and enterprise enhanced
NumThreads> call logs query Open Client
Interface-Provisioning (OCI-P)
requests.

<bw.sip Choice true, false This parameter controls the

.msclustercontac User Datagram Protocol (UDP)
tincludeudptrans transport.
port> If the value is set to "true", a
transport parameter with a value
of "udp" is included in the Contact
header of the Session Initiation
Protocol (SIP) message. It is
included within Contact header
of SIP messages sent toward
access devices using the UDP
transport.

<bw.asr.source String 1 to 80 characters This parameter specifies the

.ip> source address of the Application
Server Registration (ASR)
protocol.

<bw Integer 500 through 5000 The throttling period for the
.meetmeconferenc MeetMe conferencing XSI events.
ing.xsiEvents The Application Server will
Threshold> combine participant events of
the same type for a conference
during this period to reduce the
number of events sent.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 323
 Variable Field Type Valid Values Description

<bw.soap.max Integer 0 through 128 This parameter specifies the

.threads> maximum number of Simple
Object Access Protocol (SOAP)
threads.

<bw.sip String 1 to 80 characters This parameter specifies the

.accessinterface Internet Protocol (IP) address (or
viahost> hostname) of the location on the
Application Server where access-
side devices send responses.
It is included in the Via sent-by
field of Session Initiation Protocol
(SIP) requests sent toward
access-side devices.
If this parameter is empty, the
Public IP Address is used.
If the Public IP Address is not set,
the IP Address of the resolving
localhost is used.

<bw.sip.num Integer 1 through 128 This parameter specifies the

NonCall number of threads affected by
Threads> non-call-related processing.

6.31.3 clear
System startup parameters are cleared (set to no value) using this command.
1) Ensure you are at the /AS_CLI/System/StartupParam> level.
2) Enter:
clear <name>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 324
 Variable Field Type Valid Values Description

<name> Choice bw.sip.peernetworkreco The name of the system startup

rdrouteport, bw.sip.callid parameter to clear.
Suffix, bw.sip.accessinterface
viahost, bw.http.mediaif, bw.asr
.source.ip, bw.sip.replicated
.accessinterfaceviahost, bw.sip
.networkclustercontacthost, bw
.sip.networkrecordrouteport, bw
.sip.peernetworkinterfacehost,
bw.sip.replicated.networkinterfac
eviahost, privateIPAddress, bw
.callcenter.remoteHostAddress,
bw.sip.replicated.msinterfaceviah
ost, bw.sip.peernetworkinte
rfaceport, bw.sip.peernetworkreco
rdrouteincludetcptransport,
bw.sip.networkrecordro
uteincludeudptransport, bw.sip
.accessrecordrouteincludetcptran
sport, bw.sip.peernetworkreco
rdrouteincludeudptransport, bw
.sip.networkclustercontactport,
bw.sip.accessrecordrou
teport, publicIPAddress, bw
.sip.peeraccessinterfacehost,
bw.sip.networkrecordro
uteincludetcptransport, bw.sip
.replicated.msclustercontac
thost, privateIPv6Address, bw.sip
.peernetworkinterfacetransport,
bw.sip.msclustercontactport, bw
.sip.peernetworkrecordroutehost,
bw.sip.accessrecordrou
teincludeudptransport, bw.sip
.networkinterfacetransport, bw
.sip.accessclustercontactport,
bw.sip.accessrecordrou
tehost, bw.sip.msinterfaceviah
ost, bw.sip.peeraccessinter
faceport, bw.sip.replicated
.networkclustercontacthost, bw
.sip.accessclustercontacthost, bw
.sip.networkinterfaceviahost, bw
.sip.networkrecordroutehost, bw
.sip.networkinterfacehost, bw.sip
.peeraccessinterfacetransport,
bw.sip.networkinterfaceport,
publicIPv6Address, bw.sip
.msclustercontacthost, bw.sip
.replicated.accessclusterco
ntacthost

6.32 Util
This level is used to view, modify, add, delete, and use the system utilities.

6.32.1 ASDump
The ASDump level is used to dump Application Server data to the Network Server.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 325
6.32.1.1 dump
This command is used to upload a file of Application Server data to the Network Server. The data contains
phone numbers and alias information provisioned on the Application Server.
1) Ensure you are at the /AS_CLI/System/Util/ASDump> level.
2) Enter:
dump <fileName>↵
where:
Variable Field Type Valid Values Description

<fileName> String 1 to 300 characters The name of the file to be

uploaded.

6.32.2 BTLU
The level is used to generate a Business Trunking License Units (BTLU) report.

6.32.2.1 generateReport
This command is used to generate a Business Trunking License Units (BLTU) report. The command
generates a report with the system high-water mark entries for the last 30 days. If the command is
executed with the detail option, the report also includes enterprise and service provider-group high-water
mark entries for the last 30 days.
1) Ensure you are at the /AS_CLI/System/Util/BTLU> level.
2) Enter:
generateReport [<option>]↵
where:
Variable Field Type Valid Values Description

<option> Choice detail Report generation option. If

option is set in the command,
the BTLU report also includes
enterprise and service-provider
group high-water mark entries for
the last 30 days.

6.32.3 CallTrace
The Call Trace utility allows you to trace specific calls or Meet-Me Conference events. You can use
this utility by specifying a time range or specific files followed by a call scenario in order to extract the
relevant messages from the Execution Server (XS) debug logs. The XSi and OCI events are also logged.
If using the date mode, you specify the following: A start time, which should be in the XS logs time format
YYYY.MM.DD-HH:mm:ss or if you specify a time only (HH:mm:ss) the current day will be used. Note that
for both format seconds can be omitted. Hours should be in 24-hour time.
Example: 2012.05.21-16:34:00.
An end time, which should be in the XS logs format as well. Hours should be in 24-hour time. The
maximum time span allowed is four hours. If the end time is more than four hours after the start time, the
utility changes the end time to the start time plus four hours.
Example (will use current day): 17:20:00.

If using the files mode, you can specify up to 3 files using the file1, file2 and file3 parameters. Note that
wildcards are supported in file names.
Example: file1 xslog1.txt file2 xslog2.txt.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 326
 A directory number (DN) or user ID to identify either the terminating or originating party of a call. DNs
should be in E.164 format. Users without a provisioned DN may be specified by user ID. If the tool is used
for a Meet-Me Conference event the DN should be the bridge number and you must specify the conference
PIN with the confId parameter.

The log directory and output file are optional and by default /var/broadworks/logs/appserver will be used for
both. Output file will be in the following format: CallTraceYYYY.MM.DD-HH.mm.ss.txt.

Other filters such as log severity and log channel may be specified. The severity filter works based
on the following severity level hierarchy: [Debug, FieldDebug, Info, Notice, Warn]. Example: If you
select "Info", log entries matching the "Info", "Notice" and "Warn" severity levels will be matched. If the
includeQueryUser option is activated, the output file will include the output of QueryUser utility for the given
DN or userId. If the verbose option is activated, the output will be printed on screen as well.

Example: run +15146975601 byDate 2012.05.29-11:00:00 2012.05.29-14:00:00

Example: run south01@mtlasdev.net byFiles file1 XSLog2012.06.11-13.51.08.txt includeQueryUser

6.32.3.1 run
This command is used to retrieve logged call activity for a particular user in the system or for a Meet-Me
Conference event. This command extracts a call trace from the debug logs, based on date range or files,
user ID or DN, and other filters (optional).
1) Ensure you are at the /AS_CLI/System/Util/CallTrace> level.
2) Enter:
run <address> <searchMode> [<extraOptions>]↵
where:
Variable Field Type Valid Values Description

<address> String 1 to 161 characters The directory number (DN) or

user ID used to identify either the
terminating or originating party
of a call. DNs should be in E.164
format. If looking for a Meet-Me
Conference event, the DN should
be the bridge number.

<searchMode> Choice byDate, byFiles There are 2 modes available

to retrieve call logs. You can
specify a time range (Max 4
hours) in which the event occured
using the "byDate" option and
by specifying the startTime and
endTime parameters. If you
want to use specific files use the
"byFiles" option and specify the
files using the logFiles parameter.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 327
 Variable Field Type Valid Values Description

Variable: byDate

byDate Specifies that the searchMode is

set to use a time range.

<startTime> String 5 to 19 characters The start time used to extract

the desired information from the
debug log. This attribute must
conform to the Execution Server
time format YYYY.MM.DD-
HH:mm:ss or the time only
HH:mm:ss in which case the
current day will be used as date.
Note that for both format seconds
can be omitted. Hours should be
in the 24-hour time. Example:
2012.05.21-16:00:02 or 13:04:00.

<endTime> String 5 to 19 characters The end time used to extract

the desired information from the
debug log. This attribute must
conform to the Execution Server
time format YYYY.MM.DD-
HH:mm:ss or the time only
HH:mm:ss in which case the
current day will be used as date.
Note that for both format seconds
can be omitted. Hours should be
in the 24-hour time. Example:
2012.05.21-16:00:02 or 13:04:00.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 328
 Variable Field Type Valid Values Description

Variable: byFiles

byFiles Specifies that the searchMode is

set to use files specified by the
file1, file2 and/or file3 parameters.

<logFiles> MultipleChoice file1, file2, file3 The log files used to extract the
desired information from the
debug log. You can specify up
to 3 files using the file1, file2
and file3 parameters. Note that
wildcards are supported in file
names. Example: file1 xslog1.txt
file2 xslog2.txt. Example: file1
xslog*.txt.

<file1> String 1 to 255 characters Log file in which to CallTrace

utility should search (wildcards
accepted).

<file2> String 1 to 255 characters Log file in which to CallTrace

utility should search (wildcards
accepted).

<file3> String 1 to 255 characters Log file in which to CallTrace

utility should search (wildcards
accepted).

<extraOptions> MultipleChoice confId, logDirectory, outputFile, Specified extra options to tailor

severities, inputChannels the usage of the Call Trace utility.

<confId> String 6 to 12 characters This parameter will activate the

Meet-Me Conference lookup
mode. You must specify the PIN
number of the desired conference
and the address input has to
be the bridge DN. Example:
5896564.

<logDirectory> String 1 to 255 characters The directory in which the script

will look for log files. May be used
in combination with the logFiles
parameter or to specify the log
directory when doing a search by
date and you are not using the
default log directory. Default: /var/
broadworks/logs/appserver.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 329
 Variable Field Type Valid Values Description

<outputFile> String 1 to 255 characters Name of the output file where

the resulted logs will be saved.
By default, the results are stored
in CallTraceYYYY.MM.DD-
HH.mm.ss.txt. Output file will
always be generated in the same
directory as input files. If you
want to print results on screen as
well use the verbose parameter.
Example: callTraceOuput.txt.

<severities> Choice debug, fieldDebug, info, notice, Severities are filtered based
warn on the following severity level
hierarchy (lowest to highest):
[Debug, FieldDebug, Info, Notice,
Warn]. If "Info" is selected,
log entries matching the "Info"
severity and those above
("Notice" and "Warn") will be
matched. Example: FieldDebug.

<input MultipleChoice generic, accounting, callP, SMAP, Will filter the resulting logs
Channels> sip, sipMedia, MGCP, timer, OC only keeping logs that match
I-C, mediaCr, CAP, provisioning one of the channels specified.
Validation Example: Sip CallP - Each
channel separated by a space
character and must match one
of the following default channels:
[Generic, Accounting, CallP,
SMAP, Sip, SipMedia, MGCP,
Timer, OCI-C, MediaCr, CAP,
ProvisioningValidation].

<includeQuery Choice includeQueryUser This option will append the

User> QueryUser utility output to the
resulting logs at the end of the
output file. It will also be printed
on screen if the verbose option is
activated.

<verbose> Choice verbose This option will print the results

on screen as well as in the output
file. Some extra information on
the process is also printed on
screen.

6.32.4 EnhancedReporting
Enhanced reporting utility.

6.32.4.1 CallCenter
Enhanced Call Center Reporting (ECCR) utility.
6.32.4.1.1 resumeEventTransfer
This command is used to resume the transfer of Enhanced Call Center Reporting (ECCR) events to the
centralized database.
1) Ensure you are at the /AS_CLI/System/Util/EnhancedReporting/CallCenter> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 330
 resumeEventTransfer↵
6.32.4.1.2 synchronize
This command is used to synchronize the agent, call center, Dialed Number Identification Service (DNIS),
and supervisor information to the centralized database.
1) Ensure you are at the /AS_CLI/System/Util/EnhancedReporting/CallCenter> level.
2) Enter:
synchronize <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> Choice group, enterprise, all Synchronize command filtering

criteria.

Variable: group

group This parameter synchronizes

the group's agent, call center,
Dialed Number Identification
Service (DNIS), and supervisor
information to the centralized
database.

<service String 1 to 30 characters This parameter specifies the

ProviderId> service provider ID.

<groupId> String 1 to 30 characters This parameter specifies the

group ID.

Variable: enterprise

enterprise This parameter synchronizes the

enterprise's agent, call center,
Dialed Number Identification
Service (DNIS), and supervisor
information to the centralized
database.

<enterpriseId> String 1 to 30 characters This parameter specifies the

enterprise ID.

<all> This parameter synchronizes

the system's agent, call center,
Dialed Number Identification
Service (DNIS), and supervisor
information to the centralized
database.

6.32.4.1.3 EventArchive
This level is used to access Enhanced Call Center Reporting (ECCR) event archive utilities.
6.32.4.1.3.1 get
This command is used to view the Enhanced Call Center Reporting (ECCR) event archive settings.
1) Ensure you are at the /AS_CLI/System/Util/EnhancedReporting/CallCenter/
EventArchive> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 331
 2) Enter:
get↵
6.32.4.1.3.2 set
This command is used to modify the Enhanced Call Center Reporting (ECCR) event archive settings.
1) Ensure you are at the /AS_CLI/System/Util/EnhancedReporting/CallCenter/
EventArchive> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, maxStorageUsageInG The name of an attribute to

Byte modify.

<enabled> Choice true, false This parameter determines

whether Enhanced Call Center
Reporting (ECCR) event files are
archived.

<maxStorage Integer 10 through 1000000 This parameter specifies the

UsageInGByte> maximum amount of storage the
Enhanced Call Center Reporting
(ECCR) event archive uses (in
gigabytes). If archiving a new
ECCR event file exceeds this
limit, then all files for the oldest
day stored in the ECCR event
archive are deleted to create
space for the new file.

6.32.4.1.3.3 listArchivedDates
This command is used to view the dates that have archived Enhanced Call Center Reporting (ECCR)
event data. The format of each date is: YYYY.MM.DD-HH.mm.ss
1) Ensure you are at the /AS_CLI/System/Util/EnhancedReporting/CallCenter/
EventArchive> level.
2) Enter:
listArchivedDates↵
6.32.4.1.3.4 remove
This command is used to remove all Enhanced Call Center Reporting (ECCR) archived events, starting
from the oldest day stored in the archive and ending with the end day provided. If no end day is provided,
the entire ECCR archive is removed.
1) Ensure you are at the /AS_CLI/System/Util/EnhancedReporting/CallCenter/
EventArchive> level.
2) Enter:
remove [<endDate>]↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 332
 Variable Field Type Valid Values Description

<endDate> String 19 to 19 characters This parameter specifies the

day archive removal ends. The
time is in the following format:
YYYY.MM.DD-HH.mm.ss The
listArchivedDates command is
used to display candidates for the
endDate parameter.

6.32.4.1.3.5 replay
This command is used to send all Enhanced Call Center Reporting (ECCR) archived events, starting from
the date provided and ending with the most recent date archived, to the ECCR schema instance on the
Database Server. The command is intended for data recovery scenarios, following a database restoration
from a backup. When an event replay is initiated starting from the time of the backup, the data in the ECCR
schema instance on the Database Server is restored upon completion.
1) Ensure you are at the /AS_CLI/System/Util/EnhancedReporting/CallCenter/
EventArchive> level.
2) Enter:
replay [<startDate>]↵
where:
Variable Field Type Valid Values Description

<startDate> String 19 to 19 characters This parameter specifies the

date archive replay begins. The
time is in the following format:
YYYY.MM.DD-HH.mm.ss The
listArchivedDates command is
used to display candidates for the
startDate parameter.

6.32.4.2 CallLogs
This level is used to access Enhanced Call Logs (ECL) utilities.
6.32.4.2.1 resumeEventTransfer
This command is used to resume the transfer of Enhanced Call Logs (ECL) events to the centralized
database.
1) Ensure you are at the /AS_CLI/System/Util/EnhancedReporting/CallLogs> level.
2) Enter:
resumeEventTransfer↵
6.32.4.2.2 EventArchive
This level is used to access Enhanced Call Logs (ECL) event archive utilities.
6.32.4.2.2.1 get
This command is used to view the Enhanced Call Logs (ECL) event archive settings. These values apply
to all ECL schema instances.
1) Ensure you are at the /AS_CLI/System/Util/EnhancedReporting/CallLogs/
EventArchive> level.
2) Enter:
get↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 333
6.32.4.2.2.2 set
This command is used to modify the Enhanced Call Logs (ECL) event archive settings. These values apply
to all ECL schema instances.
1) Ensure you are at the /AS_CLI/System/Util/EnhancedReporting/CallLogs/
EventArchive> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, maxStorageUsageInG The name of an attribute to

Byte modify.

<enabled> Choice true, false This parameter determines

whether Enhanced Call Logs
(ECL) event files are archived.

<maxStorage Integer 10 through 1000000 This parameter specifies the

UsageInGByte> maximum amount of storage the
Enhanced Call Logs (ECL) event
archive uses (in gigabytes) for
each ECL schema instance. If
archiving a new ECL event file
exceeds this limit, then all files for
the oldest day stored in the ECL
event archive for the instance are
deleted to create space for the
new file.

6.32.4.2.2.3 listArchivedDates
This command is used to view the dates that have archived Enhanced Call Logs (ECL) event data for a
particular ECL schema instance. The format of each date is: YYYY.MM.DD-HH.mm.ss
1) Ensure you are at the /AS_CLI/System/Util/EnhancedReporting/CallLogs/
EventArchive> level.
2) Enter:
listArchivedDates <schemaInstance>↵
where:
Variable Field Type Valid Values Description

<schema String 1 to 255 characters This parameter specifies the

Instance> name of the Enhanced Call Logs
(ECL) schema instance.

6.32.4.2.2.4 remove
This command is used to remove all Enhanced Call Logs (ECL) archived events for an ECL schema
instance, starting from the oldest day stored in the archive and ending with the end day provided. If no end
day is provided, the entire archive for the ECL schema instance is removed.
1) Ensure you are at the /AS_CLI/System/Util/EnhancedReporting/CallLogs/
EventArchive> level.
2) Enter:
remove <schemaInstance> [<endDate>]↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 334
 where:
Variable Field Type Valid Values Description

<schema String 1 to 255 characters This parameter specifies the

Instance> name of the Enhanced Call Logs
(ECL) schema instance.

<endDate> String 19 to 19 characters This parameter specifies the

day archive removal ends. The
time is in the following format:
YYYY.MM.DD-HH.mm.ss The
listArchivedDates command is
used to display candidates for the
endDate parameter.

6.32.4.2.2.5 replay
This command is used to resend all Enhanced Call Logs (ECL) archived events for a particular ECL
schema instance, starting from the date provided and ending with the most recent date archived, to the
ECL schema instance on the Database Server. The command is intended for data recovery scenarios,
following a database restoration from a backup. If an event replay is initiated starting from the time of the
backup, the data in the ECL schema instance on the Database Server is restored upon completion.
1) Ensure you are at the /AS_CLI/System/Util/EnhancedReporting/CallLogs/
EventArchive> level.
2) Enter:
replay <schemaInstance> [<startDate>]↵
where:
Variable Field Type Valid Values Description

<schema String 1 to 255 characters This parameter specifies the

Instance> name of the Enhanced Call Logs
(ECL) schema instance.

<startDate> String 19 to 19 characters This parameter specifies the

date archive replay begins. The
time is in the following format:
YYYY.MM.DD-HH.mm.ss The
listArchivedDates command is
used to display candidates for the
startDate parameter.

6.32.5 ListFiles
This level is used to view the list of custom audio/video files. You may view files associated with a specific
user, group, or service provider.

6.32.5.1 get
This command allows you to view the list of custom audio/video files. You may view files associated with a
specific user, group, or service provider.
1) Ensure you are at the /AS_CLI/System/Util/ListFiles> level.
2) Enter:
get <type>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 335
 Variable Field Type Valid Values Description

<type> Choice sp, group, user Filtering criteria.

<user> String 2 to 161 characters The name of the user.

<group> String 1 to 30 characters The name of the group.

<sp> String 1 to 30 characters The name of the service provider.

6.32.6 Messaging
The Messaging level is used to create a file containing the IMP data intended to be sent to a Messaging
Server.

6.32.6.1 dump
This command is used to create a file of user data for all users that have Messaging services. The user
data contains user profile informations and Messaging services related information for that user.
1) Ensure you are at the /AS_CLI/System/Util/Messaging> level.
2) Enter:
dump <fileName>↵
where:
Variable Field Type Valid Values Description

<fileName> String 1 to 300 characters The name of the file to be

uploaded on a Messaging Server.

6.32.7 QueryGroup
This level is used to view query group tool attributes.

6.32.7.1 get
This command is used to view query group tool attributes.
1) Ensure you are at the /AS_CLI/System/Util/QueryGroup> level.
2) Enter:
get <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider for

Id> the group.

<groupId> String 1 to 30 characters The ID of the group.

6.32.8 QueryUser
This level is used to view query user tool attributes.

6.32.8.1 get
This command is used to view query user tool attributes.
1) Ensure you are at the /AS_CLI/System/Util/QueryUser> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 336
 2) Enter:
get <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> Choice userId, phone Filtering criteria.

<userId> String 2 to 161 characters The ID of the service provider to

which the user belongs.

<phone> String 1 to 23 characters The phone number of the user.

6.32.9 SubscriberExport
This level is used to invoke a subscriber export.

6.32.9.1 export
This command is used to export .CSV files containing select subscriber data. Only one instance of this
command can run at one time.
1) Ensure you are at the /AS_CLI/System/Util/SubscriberExport> level.
2) Enter:
export↵

6.33 Zone
This level is used to manage the system level zones.

6.33.1 get
This command is used to get a list of all zones.
1) Ensure you are at the /AS_CLI/System/Zone> level.
2) Enter:
get↵

6.33.2 add
This command is used to add a new zone.
1) Ensure you are at the /AS_CLI/System/Zone> level.
2) Enter:
add <zoneName>↵
where:
Variable Field Type Valid Values Description

<zoneName> String 1 to 80 characters The name of the zone.

6.33.3 delete
This command is used to delete an existing zone.
1) Ensure you are at the /AS_CLI/System/Zone> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 337
 delete <zoneName>↵
where:
Variable Field Type Valid Values Description

<zoneName> String 1 to 80 characters The name of the zone.

6.33.4 usage
This command is used to get a list of all office zones using a given zone.
1) Ensure you are at the /AS_CLI/System/Zone> level.
2) Enter:
usage <zoneName>↵
where:
Variable Field Type Valid Values Description

<zoneName> String 1 to 80 characters This is the name of the zone to

get the list of associated office
zones for.

6.33.5 IPAddress
This level is used to manage the IP Address to zone mapping.

6.33.5.1 get
This command is used to view IP Addresses assigned to zone. At least one of the parameters defined
in the multiple choice attribute needs to be specified in order to search all IP addresses for a zone. If the
search produces over 1,000 entries, an error message will be displayed and user should refine the search
criteria to narrow the search.
1) Ensure you are at the /AS_CLI/System/Zone/IPAddress> level.
2) Enter:
get <zoneName> <attribute>↵
where:
Variable Field Type Valid Values Description

<zoneName> String 1 to 80 characters The name of the zone.

<attribute> MultipleChoice ipAddressStartsWith The name of an attribute to filter

on.

<ipAddress String 0 to 39 characters IP Address starts with search

StartsWith> criteria. This can be the start of
a range. The ipAddress end of a
range cannot be searched.

6.33.5.2 add
This command is used to add an IP Address or an IP Address range to a zone.
1) Ensure you are at the /AS_CLI/System/Zone/IPAddress> level.
2) Enter:
add <zoneName> <ipAddressStart> [<ipAddressEnd>]↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 338
 where:
Variable Field Type Valid Values Description

<zoneName> String 1 to 80 characters The name of the zone.

<ipAddress String 1 to 39 characters The IP address starting the

Start> range.

<ipAddress String 1 to 39 characters The IP address ending the range.

End>

6.33.5.3 delete
This command is used to delete a single IP address or a range of addresses from a zone. The IP address
or range mentioned should be an exact match of either an individual entry or a range.
1) Ensure you are at the /AS_CLI/System/Zone/IPAddress> level.
2) Enter:
delete <zoneName> <ipAddressStart> [<ipAddressEnd>]↵
where:
Variable Field Type Valid Values Description

<zoneName> String 1 to 80 characters The name of the zone.

<ipAddress String 1 to 39 characters The IP address starting the

Start> range.

<ipAddress String 1 to 39 characters The IP address ending the range.

End>

6.33.6 LocationBasedPhysicalLocations
This level is used to manage the zone to location based physical location associations.

6.33.6.1 get
This command is used to view location based physical locations assigned to zone. At least one of the
parameters defined in the multiple choice attribute needs to be specified in order to search all physical
locations for a zone. If the search produces over 1,000 entries, an error message will be displayed and
user should refine the search criteria to narrow the search.
1) Ensure you are at the /AS_CLI/System/Zone/LocationBasedPhysicalLocations> level.
2) Enter:
get <zoneName> <attribute>↵
where:
Variable Field Type Valid Values Description

<zoneName> String 1 to 80 characters This is the name of the zone the

location is associated with.

<attribute> MultipleChoice physicalLocationStarts, physical The name of an attribute to filter

LocationContains, physical on.
LocationEqualTo

<physical String 0 to 1024 characters Location based physical location

LocationStarts> starts with search criteria.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 339
 Variable Field Type Valid Values Description

<physical String 0 to 1024 characters Location based physical location

Location contains search criteria.
Contains>

<physical String 0 to 1024 characters Location based physical location

LocationEqual exact match search criteria.
To>

6.33.6.2 add
This command is used to add a single location based physical location to a zone.
1) Ensure you are at the /AS_CLI/System/Zone/LocationBasedPhysicalLocations> level.
2) Enter:
add <zoneName> <physicalLocation>↵
where:
Variable Field Type Valid Values Description

<zoneName> String 1 to 80 characters This is the name of the zone the

location is associated with.

<physical String 1 to 1024 characters Location based physical location

Location> associated with a zone.

6.33.6.3 delete
This command is used to delete a single location based physical location from a zone.
1) Ensure you are at the /AS_CLI/System/Zone/LocationBasedPhysicalLocations> level.
2) Enter:
delete <zoneName> <physicalLocation>↵
where:
Variable Field Type Valid Values Description

<zoneName> String 1 to 80 characters This is the name of the zone the

location is associated with.

<physical String 1 to 1024 characters location based physical location

Location> associated with a zone to be
deleted.

6.33.7 ZoneCallingPhysicalLocation
This level is used to manage the zone to zone calling physical location association.

6.33.7.1 get
This command is used to view the zone calling physical location associated with a zone.
1) Ensure you are at the /AS_CLI/System/Zone/ZoneCallingPhysicalLocation> level.
2) Enter:
get <zoneName>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 340
 Variable Field Type Valid Values Description

<zoneName> String 1 to 80 characters This is the name of the zone the

location is associated with.

6.33.7.2 set
This command is used to modify the zone calling physical location associated with a zone.
1) Ensure you are at the /AS_CLI/System/Zone/ZoneCallingPhysicalLocation> level.
2) Enter:
set <zoneName> <attribute>↵
where:
Variable Field Type Valid Values Description

<zoneName> String 1 to 80 characters This is the name of the zone the

location is associated with.

<attribute> MultipleChoice physicalLocation The name of an attribute to

modify.

<physical String 1 to 1024 characters The zone calling physical location

Location> to be associated with the zone.

6.33.7.3 clear
This command is used to clear a zone calling physical location from a zone.
1) Ensure you are at the /AS_CLI/System/Zone/ZoneCallingPhysicalLocation> level.
2) Enter:
clear <zoneName> <attribute>↵
where:
Variable Field Type Valid Values Description

<zoneName> String 1 to 80 characters This is the name of the zone the

location is associated with.

<attribute> MultipleChoice physicalLocation The name of the attribute(s) to

clear.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 341
7 Applications

This level is used to view and modify applications entries.

7.1 CommPilot
This level is used to view and modify the Application Server CommPilot portal.

7.1.1 ClientApplicationLaunchUrls
This level is used to view and modify the Client Application Launch Uniform Resource Locators (URLs).

7.1.1.1 get
This command is used to view the Client Application Launch URL's.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/ClientApplicationLaunchUrls>
level.
2) Enter:
get↵

7.1.1.2 set
This command is used to set the Client Application Launch URL's.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/ClientApplicationLaunchUrls>
level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice callcenter, receptionist, moderator The name of an attribute to

modify.

<callcenter> String 1 to 255 characters This parameter specifies the base

for the final Uniform Resource
Locator (URL) CommPilot
constructs to contact the Call
Center application. If none is
specified, the URL is derived
from the CommPilot's settings
(protocol, host, post) and a
default context path for the
application.

<receptionist> String 1 to 255 characters This parameter specifies the

base for the final Uniform
Resource Locator (URL)
CommPilot constructs to contact
the Receptionist application. If
none is specified, the URL is
derived from the CommPilot's
settings (protocol, host, post)
and a default context path for the
application.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 342
 Variable Field Type Valid Values Description

<moderator> String 1 to 255 characters This parameter specifies the base

of the final Uniform Resource
Locator (URL) it constructs to
contact the Moderator Client
application. If none is specified,
the URL is derived from the
CommPilot's settings (protocol,
host, post) and a default context
path for the application.

7.1.1.3 clear
This command is used to clear the Client Application Launch URL's.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/ClientApplicationLaunchUrls>
level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice callcenter, receptionist, moderator The name of the attribute(s) to

clear.

7.1.2 FileTransfer
This level is used to configure the file transfer related settings of the CommPilot application.

7.1.2.1 get
This command is used to view the file transfer settings.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/FileTransfer> level.
2) Enter:
get↵

7.1.2.2 set
This command is used to modify the file transfer settings.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/FileTransfer> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice username, password Identifies an attribute to be

modified.

<username> String 1 to 30 characters This parameter specifies the

announcement repository user
name.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 343
 Variable Field Type Valid Values Description

<password> Password 1 to 40 characters This parameter specifies the

(prompted) announcement repository
password.

7.1.2.3 Link
This level is used to configure the link related settings.
7.1.2.3.1 get
This command is used to view the file transfer link settings.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/FileTransfer/Link> level.
2) Enter:
get↵
7.1.2.3.2 set
This command is used to modify the file transfer link settings.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/FileTransfer/Link> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice connectionPoolSize, connection Identifies an attribute to be

Timeout modified.

<connection Integer 1 through 2147483647 This parameter specifies the

PoolSize> maximum number of concurrent
connections allowed in the pool.

<connection Integer 1 through 300 This parameter specifies the

Timeout> maximum period of inactivity
allowed on a connection before
the connection is declared
failed (in seconds). This time
period includes the connection
establishment and response
reception.

7.1.3 GeneralSettings
This level is used to view and modify the general settings of the CommPilot portal.

7.1.3.1 get
This command is used to view the General Settings of the CommPilot application.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/GeneralSettings> level.
2) Enter:
get↵

7.1.3.2 set
This command is used to modify CommPilot General Settings-related attributes.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/GeneralSettings> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 344
 2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice loginAuthorizationLevel, user The name of an attribute to

CookieSupportEnabled, call modify.
ManagerPortalEnabled, sslMode,
systemDomain, csrfFormToken
CacheSizePerSession

<login Choice none, user, department, group, This parameter specifies the
Authorization serviceProvider, provisioning minimum authorization level for
Level> Admin, all the portal.

<userCookie Choice true, false This parameter enables the use

Support of a user ID/password cookie.
Enabled>

<callManager Choice true, false This parameter turns the

PortalEnabled> CommPilot Call Manager on and
off when a user logs in. When it is
set to "false", the CommPilot web
portal is enabled.

<sslMode> Choice on, off, full This parameter specifies the

Secure Sockets Layer (SSL)
mode for the CommPilot web
portal.

<system String 1 to 80 characters This parameter specifies the

Domain> domain to append to the user ID
in requests.

<csrfForm Integer 1 through 50 This parameter specifies the

TokenCache maximum number of Cross-Site
SizePer Request Forgery (CSRF) form
Session> tokens that can be valid at the
same time for a given session.

7.1.3.3 clear
This command is used to clear General Settings-related attributes.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/GeneralSettings> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice systemDomain, csrfFormToken The name of the attribute(s) to

CacheSizePerSession clear.

7.1.4 Logging
This level is used to view and modify the logging for the CommPilot application.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 345
7.1.4.1 get
This command is used to view logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/Logging> level.
2) Enter:
get↵

7.1.4.2 set
This command is used to modify logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/Logging> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, severity, priority, max The name of an attribute to

QueueSize, showThreadName modify.

<enabled> Choice true, false This parameter turns the logging

on and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn default logging severity level.

<priority> Integer 1 through 5 This parameter specifies the

priority of the logging thread. The
value "1" indicates the lowest
priority and "5" indicates the
highest.

<maxQueue Integer 0 through 2147483647 This parameter specifies the

Size> maximum size of the logging
queue.

<showThread Choice true, false This parameter enables thread

Name> name logging.

7.1.4.3 InputChannels
This level is used to configure the input channels for the CommPilot application.
7.1.4.3.1 get
This command is used to view input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/Logging/InputChannels> level.
2) Enter:
get↵
7.1.4.3.2 set
This command is used to modify input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/Logging/InputChannels> level.
2) Enter:
set <name> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 346
 Variable Field Type Valid Values Description

<name> Choice Generic, Debug, Broadsoft This parameter specifies the

CommonCommunication name of the logging input
Transport, BroadsoftCommon channel.
CommunicationTransportKeep
Alive, SMAP, NameService, BW
CommunicationUtility

<attribute> MultipleChoice enabled, severity The name of an attribute to

modify.

<enabled> Choice true, false This parameter turns the logging

to the logging input channel on
and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn severity level of the logging input
channel.

7.1.4.3.3 clear
This command is used to clear input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/Logging/InputChannels> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Generic, Debug, Broadsoft This parameter specifies the

CommonCommunication name of the logging input
Transport, BroadsoftCommon channel.
CommunicationTransportKeep
Alive, SMAP, NameService, BW
CommunicationUtility

<attribute> MultipleChoice severity The name of an attribute to clear.

7.1.4.3.4 Categories
This level is used to view, add, and remove logging categories.
7.1.4.3.4.1 get
This command is used to view Logging Categories-related entries.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/Logging/InputChannels/
Categories> level.
2) Enter:
get↵
7.1.4.3.4.2 add
This command is used to add new Logging Categories entry.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/Logging/InputChannels/
Categories> level.
2) Enter:
add <name> <include>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 347
 where:
Variable Field Type Valid Values Description

<name> Choice SMAP Logging InputChannel name.

Variable: SMAP

SMAP SMAP Logging InputChannel.

<category> Choice Type, DN, Group A category type.

<include> String 1 to 40 characters Include option.

7.1.4.3.4.3 delete
This command is used to remove Logging Categories-related entries.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/Logging/InputChannels/
Categories> level.
2) Enter:
delete <name> <include>↵
where:
Variable Field Type Valid Values Description

<name> Choice SMAP InputChannel name.

Variable: SMAP

SMAP

<category> Choice Type, DN, Group A category type.

<include> String 1 to 40 characters Include option.

7.1.4.4 OutputChannels
This level is used to view, modify, or clear output channels.
7.1.4.4.1 get
This command is used to view output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/Logging/OutputChannels> level.
2) Enter:
get↵
7.1.4.4.2 set
This command is used to modify output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/Logging/OutputChannels> level.
2) Enter:
set <name> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 348
 Variable Field Type Valid Values Description

<name> Choice Stdout, File This parameter specifies the

name of the logging output
channel.

<attribute> MultipleChoice enabled, directory, filePrefix, file The name of an attribute to

SizeInMB, numberOfFiles modify.

<enabled> Choice true, false This parameter turns the logging

to the logging output channel on
and off.

<directory> String 1 to 256 characters This parameter specifies the

directory where the log files are
located.

<filePrefix> String 1 to 256 characters This parameter specifies the

prefix of the log files.

<fileSizeInMB> Integer 1 through 2000 This parameter specifies the

maximum size of a log file.

<numberOf Integer 1 through 65535 This parameter specifies the

Files> maximum number of log files that
exist before the old log files are
deleted.

7.1.5 RelativeUrl
This level is used to support relative Uniform Resource Locators (URLs) in the CommPilot application.

7.1.5.1 get
This command is used to view relative url's attributes.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/RelativeUrl> level.
2) Enter:
get↵

7.1.5.2 set
This command is used to modify relative url's-related attributes.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/RelativeUrl> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, standalonePrefix The name of an attribute to

modify.

<enabled> Choice true, false This parameter enables the use

of relative Uniform Resource
Locators (URLs).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 349
 Variable Field Type Valid Values Description

<standalone String 1 to 80 characters This parameter specifies the

Prefix> Uniform Resource Locator (URL)
prefix for the CommPilot Web
Server farm.

7.1.5.3 clear
This command is used to clear relative url's-related attributes.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/RelativeUrl> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice standalonePrefix The name of the attribute(s) to

clear.

7.1.5.4 AliasesPrefix
This level is used to modify the aliases prefix for the CommPilot application.
7.1.5.4.1 get
This command is used to view the Aliases Prefix for the CommPilot application.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/RelativeUrl/AliasesPrefix>
level.
2) Enter:
get↵
7.1.5.4.2 add
This command is used to add a new Aliases Prefix to the system.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/RelativeUrl/AliasesPrefix>
level.
2) Enter:
add <interfaceIp> <alias> <prefix>↵
where:
Variable Field Type Valid Values Description

<interfaceIp> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface Internet Protocol (IP)
address.

<alias> String 1 to 80 characters This parameter specifies the

name of the alias.

<prefix> String 1 to 80 characters This parameter specifies the

Uniform Resource Locator (URL)
prefix of the alias.

7.1.5.4.3 set
This command is used to modify Aliases Prefix-related attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 350
 1) Ensure you are at the /AS_CLI/Applications/CommPilot/RelativeUrl/AliasesPrefix>
level.
2) Enter:
set <interfaceIp> <alias> <attribute>↵
where:
Variable Field Type Valid Values Description

<interfaceIp> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface Internet Protocol (IP)
address.

<alias> String 1 to 80 characters This parameter specifies the

name of the alias.

<attribute> MultipleChoice prefix The name of an attribute to

modify.

<prefix> String 1 to 80 characters This parameter specifies the

Uniform Resource Locator (URL)
prefix of the alias.

7.1.5.4.4 delete
This command is used to delete an existing Aliases Prefix from the system.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/RelativeUrl/AliasesPrefix>
level.
2) Enter:
delete <interfaceIp> <alias>↵
where:
Variable Field Type Valid Values Description

<interfaceIp> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface Internet Protocol (IP)
address.

<alias> String 1 to 80 characters This parameter specifies the

name of the alias.

7.1.6 VisualDeviceManagement
This level is used to view and modify the visual device management settings of the CommPilot portal.

7.1.6.1 get
This command is used to view the visual device management settings of the CommPilot application.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/VisualDeviceManagement> level.
2) Enter:
get↵

7.1.6.2 set
This command is used to modify visual device management-related attributes.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/VisualDeviceManagement> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 351
 set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice FQDN The name of an attribute to

modify.

<FQDN> Domain/Host 1 to 80 characters This parameter specifies the

Visual Device Management
server fully qualified domain
name (FQDN). Use the form
"host.domain". Note that the value
of this parameter is not in the
form of an IP address.

7.1.6.3 clear
This command is used to clear visual device management-related attributes.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/VisualDeviceManagement> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice FQDN The name of the attribute(s) to

clear.

7.1.7 WebBranding
This level is used to view and modify web branding for CommPilot. In a CommPilot Web Server farm,
servers are identified as web branding masters (recommended two servers). Each time an administrator
accesses a Web Branding administration page, the administrator is automatically redirected to a branding
master.

7.1.7.1 get
This command is used to view the Web Branding configuration for the CommPilot application.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/WebBranding> level.
2) Enter:
get↵

7.1.7.2 set
This command is used to modify Web Branding-related attributes.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/WebBranding> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice master, masterFqdn, slaveFqdn The name of an attribute to

modify.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 352
 Variable Field Type Valid Values Description

<master> Choice true, false This parameter specifies the

CommPilot web portal as a web
branding master.

<masterFqdn> String 1 to 80 characters This parameter specifies the fully

qualified domain name (FQDN) of
the branding master (for example,
xsp1.mtl.broadsoft.com).

<slaveFqdn> String 1 to 80 characters This parameter specifies

the fully qualified domain
name (FQDN) of the web
branding slave (for example,
xsp2.mtl.broadsoft.com).

7.1.7.3 clear
This command is used to clear Web Branding-related attributes.
1) Ensure you are at the /AS_CLI/Applications/CommPilot/WebBranding> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice masterFqdn, slaveFqdn

7.2 DeviceManagementFiles
This level is used to configure the interface to the file repository for the Device Management Files
application.

7.2.1 Logging
This level is used to view and modify the logging for the Device Management Files application.

7.2.1.1 get
This command is used to view logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/DeviceManagementFiles/Logging> level.
2) Enter:
get↵

7.2.1.2 set
This command is used to modify logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/DeviceManagementFiles/Logging> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 353
 Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, severity, priority, max The name of an attribute to

QueueSize, showThreadName modify.

<enabled> Choice true, false This parameter turns the logging

on and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn default logging severity level.

<priority> Integer 1 through 5 This parameter specifies the

priority of the logging thread. The
value "1" indicates the lowest
priority and "5" indicates the
highest.

<maxQueue Integer 0 through 2147483647 This parameter specifies the

Size> maximum size of the logging
queue.

<showThread Choice true, false This parameter enables thread

Name> name logging.

7.2.1.3 InputChannels
This level is used to view, modify, or clear input channels entries.
7.2.1.3.1 get
This command is used to view input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/DeviceManagementFiles/Logging/
InputChannels> level.
2) Enter:
get↵
7.2.1.3.2 set
This command is used to modify input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/DeviceManagementFiles/Logging/
InputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Generic, FileRepos, BW This parameter specifies the

CommunicationUtility name of the logging input
channel.

<attribute> MultipleChoice enabled, severity The name of an attribute to

modify.

<enabled> Choice true, false This parameter turns the logging

to the logging input channel on
and off.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 354
 Variable Field Type Valid Values Description

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn severity level of the logging input
channel.

7.2.1.3.3 clear
This command is used to clear input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/DeviceManagementFiles/Logging/
InputChannels> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Generic, FileRepos, BW This parameter specifies the

CommunicationUtility name of the logging input
channel.

<attribute> MultipleChoice severity The name of an attribute to clear.

7.2.1.4 OutputChannels
This level is used to view, modify, or clear output channels.
7.2.1.4.1 get
This command is used to view output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/DeviceManagementFiles/Logging/
OutputChannels> level.
2) Enter:
get↵
7.2.1.4.2 set
This command is used to modify output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/DeviceManagementFiles/Logging/
OutputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Stdout, File This parameter specifies the

name of the logging output
channel.

<attribute> MultipleChoice enabled, directory, filePrefix, file The name of an attribute to

SizeInMB, numberOfFiles modify.

<enabled> Choice true, false This parameter turns the logging

to the logging output channel on
and off.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 355
 Variable Field Type Valid Values Description

<directory> String 1 to 256 characters This parameter specifies the

directory where the log files are
located.

<filePrefix> String 1 to 256 characters This parameter specifies the

prefix of the log files.

<fileSizeInMB> Integer 1 through 2000 This parameter specifies the

maximum size of a log file.

<numberOf Integer 1 through 65535 This parameter specifies the

Files> maximum number of log files that
exist before the old log files are
deleted.

7.3 ExecutionAndProvisioning
This level is used to view and modify the Application Execution And Provisioning application.

7.3.1 Encryption
This level is used to configure security options for this application.

7.3.1.1 changeDefaultEncryptionKey
This command is used to change the default encryption key and using the new key to re-encrypt any data
encrypted using the default encryption key. The Application Server must be in a stopped state in order to
run this command.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/Encryption>
level.
2) Enter:
changeDefaultEncryptionKey↵

7.3.2 PS
This level is used to view and modify the Broadworks Provisioning Server process.

7.3.2.1 Bcct
This level is used to view and modify the BCCT.
7.3.2.1.1 get
This command is used to view the BCCT-related attributes for the PS.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Bcct> level.
2) Enter:
get↵
7.3.2.1.2 set
This command is used to modify the BCCT-related attributes for the PS.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Bcct> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 356
 Variable Field Type Valid Values Description

<attribute> MultipleChoice nbOfWorkerThreads, backlog Attribute(s) to modify.

QueueSize, keepAlivePeriod

<nbOfWorker Integer 1 through 50 Number of worker threads.

Threads>

<backlogQueue Integer 1 through 10000 Backlog queue size.

Size>

<keepAlive Integer 1 through 600 Kill Alive Period.

Period>

7.3.2.2 Database
This level is used to view and modify the database used by the Execution Server.
7.3.2.2.1 Databases
This level is used to view and modify the databases-related attributes.
7.3.2.2.1.1 get
This command is used to view Oracle persistency databases configured in the application.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Database/
Databases> level.
2) Enter:
get↵
7.3.2.2.1.2 add
This command is used to add Oracle persistency databases to the application configuration. It should
match the base name of the centralized database specified during the Database Server installation.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Database/
Databases> level.
2) Enter:
add <name> <password>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the label

to identify the database.

<password> Password 1 to 40 characters This parameter specifies the

(prompted) database schema password.

7.3.2.2.1.3 set
This command is used to modify Oracle Persistency databases attributes in the application configuration.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Database/
Databases> level.
2) Enter:
set <name> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 357
 Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the label

to identify the database.

<attribute> MultipleChoice password The name of an attribute to

modify.

<password> Password 1 to 40 characters This parameter specifies the

(prompted) database schema password.

7.3.2.2.1.4 delete
This command is used to remove Oracle persistency databases from the application configuration.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Database/
Databases> level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the label

to identify the database.

7.3.2.2.1.5 Sites
This level is used to view and modify the sites-related attributes.
7.3.2.2.1.5.1 get
This command is used to view Database Server Observer sites configured in the application.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Database/
Databases/Sites> level.
2) Enter:
get <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the label

to identify the database.

7.3.2.2.1.5.2 add
This command is used to add the Oracle persistency database sites to the application configuration.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Database/
Databases/Sites> level.
2) Enter:
add <name> <hostName> <portNumber> <preferred>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 358
 Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the label

to identify the database.

<hostName> String 1 to 80 characters This parameter specifies the

database site host name.

<portNumber> Integer 1024 through 65535 This parameter specifies the

database site port number.

<preferred> Choice true, false This parameter determines

whether this is the preferred
database site for this application.

7.3.2.2.1.5.3 set
This command is used to modify the Oracle persistency databases attributes in the application
configuration.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Database/
Databases/Sites> level.
2) Enter:
set <name> <hostName> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the label

to identify the database.

<hostName> String 1 to 80 characters This parameter specifies the

database site host name.

<attribute> MultipleChoice portNumber, preferred The name of an attribute to

modify.

<portNumber> Integer 1024 through 65535 This parameter specifies the

database site port number.

<preferred> Choice true, false This parameter determines

whether this is the preferred
database site for this application.

7.3.2.2.1.5.4 delete
This command is used to remove Database Server Observer site from the application configuration.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Database/
Databases/Sites> level.
2) Enter:
delete <name> <hostName>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the label

to identify the database.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 359
 Variable Field Type Valid Values Description

<hostName> String 1 to 80 characters This parameter specifies the

database site host name.

7.3.2.2.1.5.5 validate
This command is used to validate the configuration of the sites and the connection to the Database Server.
In addition, it is used to display the status of the sites. A description of the site status follows: Primary: The
primary database resides on this site. Physical Standby: The physical standby database resides on this
site. Logical Standby: The logical standby database resides on this site. Not Available: A database is not
available on this site or is not running. To troubleshoot, verify that the database is installed and working
properly and that BroadWorks is running on the site's node(s). Unreachable: This site or the database
listener is unreachable. To troubleshoot, check the network connection to the site and make sure that
BroadWorks is running on the site's node(s). Password Mismatch: The password set in the CLI does not
match the password set for the database. To troubleshoot, reset the password for the database in the CLI.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Database/
Databases/Sites> level.
2) Enter:
validate↵
7.3.2.2.2 Schemas
This level is used to view and modify the schema-related attributes.
7.3.2.2.2.1 get
This command is used to view Oracle persistency schemas configured in the application.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Database/
Schemas> level.
2) Enter:
get↵
7.3.2.2.2.2 Instances
This level is used to view and modify the schemas instances-related attributes.
7.3.2.2.2.2.1 get
This command is used to view Oracle persistency schemas instances configured in the application.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Database/
Schemas/Instances> level.
2) Enter:
get <schemaType>↵
where:
Variable Field Type Valid Values Description

<schemaType> Choice bwecl This parameter specifies the

schema type.

7.3.2.2.2.2.2 add
This command is used to add Oracle persistency schemas instances in the application configuration.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Database/
Schemas/Instances> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 360
 add <schemaType> <name> <password> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<schemaType> Choice bwecl This parameter specifies the

schema type.

<name> String 1 to 80 characters This parameter specifies the

database schema name.
Only letters, numbers and the
underscore are allowed in name.

<password> Password 1 to 40 characters This parameter specifies the

(prompted) database schema password.

<attribute> MultipleChoice database Additional attributes to include

through the add command.

<database> String 1 to 80 characters This parameter specifies the

database schema.

7.3.2.2.2.2.3 set
This command is used to modify Oracle persistency schemas instances in the application configuration.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Database/
Schemas/Instances> level.
2) Enter:
set <schemaType> <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<schemaType> Choice bwecl This parameter specifies the

schema type.

<name> String 1 to 80 characters This parameter specifies the

database schema name.
Only letters, numbers and the
underscore are allowed in name.

<attribute> MultipleChoice password, database The name of an attribute to

modify.

<password> Password 1 to 40 characters This parameter specifies the

(prompted) database schema password.

<database> String 1 to 80 characters This parameter specifies the

database schema.

7.3.2.2.2.2.4 delete
This command is used to delete Oracle persistency schemas instances in the application.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Database/
Schemas/Instances> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 361
 delete <schemaType> <name>↵
where:
Variable Field Type Valid Values Description

<schemaType> Choice bwecl This parameter specifies the

schema type.

<name> String 1 to 80 characters This parameter specifies the

database schema name.
Only letters, numbers and the
underscore are allowed in name.

7.3.2.2.2.2.5 clear
This command is used to clear Oracle persistency schemas instances attributes in the application.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Database/
Schemas/Instances> level.
2) Enter:
clear <schemaType> <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<schemaType> Choice bwecl This parameter specifies the

schema type.

<name> String 1 to 80 characters This parameter specifies the

database schema name.
Only letters, numbers and the
underscore are allowed in name.

<attribute> MultipleChoice database The name of the attribute(s) to

clear.

7.3.2.2.2.2.6 validate
This command is used to validate the configuration of the schemas and the connection to the Database
Server. In addition, it is used to display the status of the schema. A description of the schema status
follows: Read/Write: Read and write access is provided for the schema. Read Only: Read-only access
is provided for the schema. Not Available: The schema is not available. To troubleshoot: * Check the
status of the site. If the status of the site is "Not Available", "Password Mismatch", or "Unreachable",
address the corresponding issues until the status displays "Primary" or "Physical Standby" or "Logical
Standby" indicating that the site is available. * When the site is available, use the get command at the
Database Server CLI Applications/DbManagement/ DbManager/Schemas level to verify if the schema
exists. * If the schema does not exist, use the deploy command to deploy the schema to the database.
Password Mismatch: The password set in the CLI does not match the password set for the schema. To
troubleshoot, reset the password for the schema in the CLI. Account Locked: The schema account is
locked. To troubleshoot, unlock the schema account at the Database Server.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Database/
Schemas/Instances> level.
2) Enter:
validate↵

7.3.2.3 Logging
This level is used to view and modify the logging for the Provisioning Server.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 362
7.3.2.3.1 get
This command is used to view logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Logging>
level.
2) Enter:
get↵
7.3.2.3.2 set
This command is used to modify logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Logging>
level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, severity, priority, max The name of an attribute to

QueueSize, showThreadName modify.

<enabled> Choice true, false This parameter turns the logging

on and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn default logging severity level.

<priority> Integer 1 through 5 This parameter specifies the

priority of the logging thread. The
value "1" indicates the lowest
priority and "5" indicates the
highest.

<maxQueue Integer 0 through 2147483647 This parameter specifies the

Size> maximum size of the logging
queue.

<showThread Choice true, false This parameter enables thread

Name> name logging.

7.3.2.3.3 InputChannels
This level is used to view and modify the input channels-related information for the Provisioning Server.
7.3.2.3.3.1 get
This command is used to view input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Logging/
InputChannels> level.
2) Enter:
get↵
7.3.2.3.3.2 set
This command is used to modify input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Logging/
InputChannels> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 363
 2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Generic, Timer, Audit, Common This parameter specifies the
Persistency, Broadsoft name of the logging input
CommonCommunication channel.
Transport, BroadsoftCommon
CommunicationTransportKeep
Alive, ServiceOS, SMAP, File
System, HttpClient, Name
Service, ShInterface, Device
Management, Diameter, Call
Center, BroadWorksMobile
Manager, OCI-P, Subscriber
Export

<attribute> MultipleChoice enabled, severity The name of an attribute to

modify.

<enabled> Choice true, false This parameter turns the logging

to the logging input channel on
and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn severity level of the logging input
channel.

7.3.2.3.3.3 clear
This command is used to clear input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Logging/
InputChannels> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Generic, Timer, Audit, Common This parameter specifies the
Persistency, Broadsoft name of the logging input
CommonCommunication channel.
Transport, BroadsoftCommon
CommunicationTransportKeep
Alive, ServiceOS, SMAP, File
System, HttpClient, Name
Service, ShInterface, Device
Management, Diameter, Call
Center, BroadWorksMobile
Manager, OCI-P, Subscriber
Export

<attribute> MultipleChoice severity The name of an attribute to clear.

7.3.2.3.3.4 AuditLog
This level is used to view and modify the audit logs for the Provisioning Server.
7.3.2.3.3.4.1 get

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 364
 This command is used to view Audit Logs-related entries.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Logging/
InputChannels/AuditLog> level.
2) Enter:
get↵
7.3.2.3.3.4.2 set
This command is used to modify Audit Logs-related entries.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Logging/
InputChannels/AuditLog> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice getRequest, accountInfo, verbose Attribute(s) to modify.

<getRequest> Choice true, false Enables get request to be logged.

<accountInfo> Choice true, false Enables account information to

be logged.

<verbose> Choice true, false Enables complete message to be

logged.

7.3.2.3.3.5 Categories
This level is used to view, add, and remove logging categories.
7.3.2.3.3.5.1 get
This command is used to view Logging Categories-related entries.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Logging/
InputChannels/Categories> level.
2) Enter:
get↵
7.3.2.3.3.5.2 add
This command is used to add new Logging Categories entry.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Logging/
InputChannels/Categories> level.
2) Enter:
add <name> <include>↵
where:
Variable Field Type Valid Values Description

<name> Choice SMAP Logging InputChannel name.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 365
 Variable Field Type Valid Values Description

Variable: SMAP

SMAP SMAP Logging InputChannel.

<category> Choice Type, DN, Group A category type.

<include> String 1 to 40 characters Include option.

7.3.2.3.3.5.3 delete
This command is used to remove Logging Categories-related entries.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Logging/
InputChannels/Categories> level.
2) Enter:
delete <name> <include>↵
where:
Variable Field Type Valid Values Description

<name> Choice SMAP InputChannel name.

Variable: SMAP

SMAP SMAP Logging InputChannel.

<category> Choice Type, DN, Group A category type.

<include> String 1 to 40 characters Include option.

7.3.2.3.4 OutputChannels
This level is used to view, modify, or clear output channels.
7.3.2.3.4.1 get
This command is used to view output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Logging/
OutputChannels> level.
2) Enter:
get↵
7.3.2.3.4.2 set
This command is used to modify output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/Logging/
OutputChannels> level.
2) Enter:
set <name> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 366
 Variable Field Type Valid Values Description

<name> Choice Stdout, File, AuditLog This parameter specifies the

name of the logging output
channel.

<attribute> MultipleChoice enabled, directory, filePrefix, file The name of an attribute to

SizeInMB, numberOfFiles modify.

<enabled> Choice true, false This parameter turns the logging

to the logging output channel on
and off.

<directory> String 1 to 256 characters This parameter specifies the

directory where the log files are
located.

<filePrefix> String 1 to 256 characters This parameter specifies the

prefix of the log files.

<fileSizeInMB> Integer 1 through 2000 This parameter specifies the

maximum size of a log file.

<numberOf Integer 1 through 65535 This parameter specifies the

Files> maximum number of log files that
exist before the old log files are
deleted.

7.3.2.4 SecurityLogging
This level is used to view and modify the security logging for the Provisioning Server.
7.3.2.4.1 get
This command is used to view logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/
SecurityLogging> level.
2) Enter:
get↵
7.3.2.4.2 set
This command is used to modify logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/
SecurityLogging> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, severity, priority, max The name of an attribute to

QueueSize, showThreadName modify.

<enabled> Choice true, false This parameter turns the logging

on and off.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 367
 Variable Field Type Valid Values Description

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn default logging severity level.

<priority> Integer 1 through 5 This parameter specifies the

priority of the logging thread. The
value "1" indicates the lowest
priority and "5" indicates the
highest.

<maxQueue Integer 0 through 2147483647 This parameter specifies the

Size> maximum size of the logging
queue.

<showThread Choice true, false This parameter enables thread

Name> name logging.

7.3.2.4.3 InputChannels
This level is used to view, modify, or clear input channels entries.
7.3.2.4.3.1 get
This command is used to view input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/
SecurityLogging/InputChannels> level.
2) Enter:
get↵
7.3.2.4.3.2 set
This command is used to modify input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/
SecurityLogging/InputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice UserAuthenticationFailure, This parameter specifies the

Authentication, SIPAuthentication name of the logging input
Lock, DeviceProfileAuthentication channel.
Lock, CredentialChange,
SubscriberChange

<attribute> MultipleChoice enabled, severity The name of an attribute to

modify.

<enabled> Choice true, false This parameter turns the logging

to the logging input channel on
and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn severity level of the logging input
channel.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 368
7.3.2.4.3.3 clear
This command is used to clear input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/
SecurityLogging/InputChannels> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice UserAuthenticationFailure, This parameter specifies the

Authentication, SIPAuthentication name of the logging input
Lock, DeviceProfileAuthentication channel.
Lock, CredentialChange,
SubscriberChange

<attribute> MultipleChoice severity The name of an attribute to clear.

7.3.2.4.4 OutputChannels
This level is used to view, modify, or clear output channels.
7.3.2.4.4.1 get
This command is used to view output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/
SecurityLogging/OutputChannels> level.
2) Enter:
get↵
7.3.2.4.4.2 set
This command is used to modify output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/PS/
SecurityLogging/OutputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice File This parameter specifies the

name of the logging output
channel.

<attribute> MultipleChoice enabled, directory, filePrefix, file The name of an attribute to

SizeInMB, numberOfFiles modify.

<enabled> Choice true, false This parameter turns the logging

to the logging output channel on
and off.

<directory> String 1 to 256 characters This parameter specifies the

directory where the log files are
located.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 369
 Variable Field Type Valid Values Description

<filePrefix> String 1 to 256 characters This parameter specifies the

prefix of the log files.

<fileSizeInMB> Integer 1 through 2000 This parameter specifies the

maximum size of a log file.

<numberOf Integer 1 through 65535 This parameter specifies the

Files> maximum number of log files that
exist before the old log files are
deleted.

7.3.3 XS
This level is used to view and modify the Execution Server attributes.

7.3.3.1 Bcct
This level is used to view and modify the BCCT.
7.3.3.1.1 get
This command is used to view the BCCT-related attributes for the XS.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Bcct> level.
2) Enter:
get↵
7.3.3.1.2 set
This command is used to modify the BCCT-related attributes for the XS.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Bcct> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice nbOfWorkerThreads, backlog Attribute(s) to modify.

QueueSize, keepAlivePeriod

<nbOfWorker Integer 1 through 50 Number of worker threads.

Threads>

<backlogQueue Integer 1 through 10000 Backlog queue size.

Size>

<keepAlive Integer 1 through 600 Kill Alive Period.

Period>

7.3.3.2 Database
This level is used to configure the database used by this application.
7.3.3.2.1 Databases
This level is used to view and modify the databases-related attributes.
7.3.3.2.1.1 get
This command is used to view Oracle persistency databases configured in the application.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Database/
Databases> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 370
 2) Enter:
get↵
7.3.3.2.1.2 add
This command is used to add Oracle persistency databases to the application configuration. It should
match the base name of the centralized database specified during the Database Server installation.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Database/
Databases> level.
2) Enter:
add <name> <password>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the label

to identify the database.

<password> Password 1 to 40 characters This parameter specifies the

(prompted) database schema password.

7.3.3.2.1.3 set
This command is used to modify Oracle Persistency databases attributes in the application configuration.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Database/
Databases> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the label

to identify the database.

<attribute> MultipleChoice password The name of an attribute to

modify.

<password> Password 1 to 40 characters This parameter specifies the

(prompted) database schema password.

7.3.3.2.1.4 delete
This command is used to remove Oracle persistency databases from the application configuration.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Database/
Databases> level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the label

to identify the database.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 371
7.3.3.2.1.5 Sites
This level is used to view and modify the sites-related attributes.
7.3.3.2.1.5.1 get
This command is used to view Database Server Observer sites configured in the application.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Database/
Databases/Sites> level.
2) Enter:
get <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the label

to identify the database.

7.3.3.2.1.5.2 add
This command is used to add the Oracle persistency database sites to the application configuration.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Database/
Databases/Sites> level.
2) Enter:
add <name> <hostName> <portNumber> <preferred>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the label

to identify the database.

<hostName> String 1 to 80 characters This parameter specifies the

database site host name.

<portNumber> Integer 1024 through 65535 This parameter specifies the

database site port number.

<preferred> Choice true, false This parameter determines

whether this is the preferred
database site for this application.

7.3.3.2.1.5.3 set
This command is used to modify the Oracle persistency databases attributes in the application
configuration.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Database/
Databases/Sites> level.
2) Enter:
set <name> <hostName> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the label

to identify the database.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 372
 Variable Field Type Valid Values Description

<hostName> String 1 to 80 characters This parameter specifies the

database site host name.

<attribute> MultipleChoice portNumber, preferred The name of an attribute to

modify.

<portNumber> Integer 1024 through 65535 This parameter specifies the

database site port number.

<preferred> Choice true, false This parameter determines

whether this is the preferred
database site for this application.

7.3.3.2.1.5.4 delete
This command is used to remove Database Server Observer site from the application configuration.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Database/
Databases/Sites> level.
2) Enter:
delete <name> <hostName>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the label

to identify the database.

<hostName> String 1 to 80 characters This parameter specifies the

database site host name.

7.3.3.2.1.5.5 validate
This command is used to validate the configuration of the sites and the connection to the Database Server.
In addition, it is used to display the status of the sites. A description of the site status follows: Primary: The
primary database resides on this site. Physical Standby: The physical standby database resides on this
site. Logical Standby: The logical standby database resides on this site. Not Available: A database is not
available on this site or is not running. To troubleshoot, verify that the database is installed and working
properly and that BroadWorks is running on the site's node(s). Unreachable: This site or the database
listener is unreachable. To troubleshoot, check the network connection to the site and make sure that
BroadWorks is running on the site's node(s). Password Mismatch: The password set in the CLI does not
match the password set for the database. To troubleshoot, reset the password for the database in the CLI.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Database/
Databases/Sites> level.
2) Enter:
validate↵
7.3.3.2.2 Schemas
This level is used to view and modify the schema-related attributes.
7.3.3.2.2.1 get
This command is used to view Oracle persistency schemas configured in the application.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Database/
Schemas> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 373
 2) Enter:
get↵
7.3.3.2.2.2 Instances
This level is used to view and modify the schemas instances-related attributes.
7.3.3.2.2.2.1 get
This command is used to view Oracle persistency schemas instances configured in the application.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Database/
Schemas/Instances> level.
2) Enter:
get <schemaType>↵
where:
Variable Field Type Valid Values Description

<schemaType> Choice bweccr, bwecl This parameter specifies the

schema type.

7.3.3.2.2.2.2 add
This command is used to add Oracle persistency schemas instances in the application configuration.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Database/
Schemas/Instances> level.
2) Enter:
add <schemaType> <name> <password> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<schemaType> Choice bwecl This parameter specifies the

schema type.

<name> String 1 to 80 characters This parameter specifies the

database schema name.
Only letters, numbers and the
underscore are allowed in name.

<password> Password 1 to 40 characters This parameter specifies the

(prompted) database schema password.

<attribute> MultipleChoice database Additional attributes to include

through the add command.

<database> String 1 to 80 characters This parameter specifies the

database schema.

7.3.3.2.2.2.3 set
This command is used to modify Oracle persistency schemas instances in the application configuration.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Database/
Schemas/Instances> level.
2) Enter:
set <schemaType> <name> <attribute>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 374
 where:
Variable Field Type Valid Values Description

<schemaType> Choice bweccr, bwecl This parameter specifies the

schema type.

<name> String 1 to 80 characters This parameter specifies the

database schema name.
Only letters, numbers and the
underscore are allowed in name.

<attribute> MultipleChoice password, database The name of an attribute to

modify.

<password> Password 1 to 40 characters This parameter specifies the

(prompted) database schema password.

<database> String 1 to 80 characters This parameter specifies the

database schema.

7.3.3.2.2.2.4 delete
This command is used to delete Oracle persistency schemas instances in the application.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Database/
Schemas/Instances> level.
2) Enter:
delete <schemaType> <name>↵
where:
Variable Field Type Valid Values Description

<schemaType> Choice bwecl This parameter specifies the

schema type.

<name> String 1 to 80 characters This parameter specifies the

database schema name.
Only letters, numbers and the
underscore are allowed in name.

7.3.3.2.2.2.5 clear
This command is used to clear Oracle persistency schemas instances attributes in the application.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Database/
Schemas/Instances> level.
2) Enter:
clear <schemaType> <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<schemaType> Choice bweccr, bwecl This parameter specifies the

schema type.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 375
 Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the

database schema name.
Only letters, numbers and the
underscore are allowed in name.

<attribute> MultipleChoice database The name of the attribute(s) to

clear.

7.3.3.2.2.2.6 validate
This command is used to validate the configuration of the schemas and the connection to the Database
Server. In addition, it is used to display the status of the schema. A description of the schema status
follows: Read/Write: Read and write access is provided for the schema. Read Only: Read-only access
is provided for the schema. Not Available: The schema is not available. To troubleshoot: * Check the
status of the site. If the status of the site is "Not Available", "Password Mismatch", or "Unreachable",
address the corresponding issues until the status displays "Primary" or "Physical Standby" or "Logical
Standby" indicating that the site is available. * When the site is available, use the get command at the
Database Server CLI Applications/DbManagement/ DbManager/Schemas level to verify if the schema
exists. * If the schema does not exist, use the deploy command to deploy the schema to the database.
Password Mismatch: The password set in the CLI does not match the password set for the schema. To
troubleshoot, reset the password for the schema in the CLI. Account Locked: The schema account is
locked. To troubleshoot, unlock the schema account at the Database Server.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Database/
Schemas/Instances> level.
2) Enter:
validate↵

7.3.3.3 Logging
This level is used to view and modify the logging.
7.3.3.3.1 get
This command is used to view logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Logging>
level.
2) Enter:
get↵
7.3.3.3.2 set
This command is used to modify logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Logging>
level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, severity, priority, max The name of an attribute to

QueueSize, showThreadName modify.

<enabled> Choice true, false This parameter turns the logging

on and off.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 376
 Variable Field Type Valid Values Description

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn default logging severity level.

<priority> Integer 1 through 5 This parameter specifies the

priority of the logging thread. The
value "1" indicates the lowest
priority and "5" indicates the
highest.

<maxQueue Integer 0 through 2147483647 This parameter specifies the

Size> maximum size of the logging
queue.

<showThread Choice true, false This parameter enables thread

Name> name logging.

7.3.3.3.3 InputChannels
This level is used to view and modify the input channels for the Execution Server.
7.3.3.3.3.1 get
This command is used to view input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Logging/
InputChannels> level.
2) Enter:
get↵
7.3.3.3.3.2 set
This command is used to modify input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Logging/
InputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Generic, Accounting, Call This parameter specifies the

P, SMAP, Sip, SipMedia, name of the logging input
MGCP, Timer, NRSLog, channel.
CommonPersistency, Broadsoft
CommonCommunication
Transport, BroadsoftCommon
CommunicationTransport
KeepAlive, ServiceOS, Event
Notification, FileSystem, Http
Client, ProvisioningValidation,
Overload, SMDI, SMPP, Name
Service, OCI-C, CallCenter, CA
P, Diameter, StateReplication,
ECCR, MediaCr, CallLog, CPE
Mon, RedundancyLink

<attribute> MultipleChoice enabled, severity The name of an attribute to

modify.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 377
 Variable Field Type Valid Values Description

<enabled> Choice true, false This parameter turns the logging

to the logging input channel on
and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn severity level of the logging input
channel.

7.3.3.3.3.3 clear
This command is used to clear input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Logging/
InputChannels> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Generic, Accounting, Call This parameter specifies the

P, SMAP, Sip, SipMedia, name of the logging input
MGCP, Timer, NRSLog, channel.
CommonPersistency, Broadsoft
CommonCommunication
Transport, BroadsoftCommon
CommunicationTransport
KeepAlive, ServiceOS, Event
Notification, FileSystem, Http
Client, ProvisioningValidation,
Overload, SMDI, SMPP, Name
Service, OCI-C, CallCenter, CA
P, Diameter, StateReplication,
ECCR, MediaCr, CallLog, CPE
Mon, RedundancyLink

<attribute> MultipleChoice severity The name of an attribute to clear.

7.3.3.3.3.4 Categories
This level is used to view, add, and remove logging categories.
7.3.3.3.3.4.1 get
This command is used to view Logging Categories-related entries.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Logging/
InputChannels/Categories> level.
2) Enter:
get↵
7.3.3.3.3.4.2 add
This command is used to add new Logging Categories entry.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Logging/
InputChannels/Categories> level.
2) Enter:
add <name> <include>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 378
 Variable Field Type Valid Values Description

<name> Choice CallP, SMAP, Sip, SipMedia, InputChannel name.

MGCP

Variable: CallP

CallP CallP Logging InputChannel.

<category> Choice Type, DN, Group A category type.

Variable: SMAP

SMAP

<category> Choice Type, DN, Group A category type.

Variable: Sip

Sip SIP Logging InputChannel.

<category> Choice DN, Group A category type.

Variable: SipMedia

SipMedia SipMedia Logging InputChannel.

<category> Choice DN A category type.

Variable: MGCP

MGCP MGCP Logging InputChannel.

<category> Choice DN, Group A category type.

<include> String 1 to 40 characters Include option.

7.3.3.3.3.4.3 delete
This command is used to remove Logging Categories-related entries.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Logging/
InputChannels/Categories> level.
2) Enter:
delete <name> <include>↵
where:
Variable Field Type Valid Values Description

<name> Choice CallP, SMAP, Sip, SipMedia, Logging InputChannel name.

MGCP

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 379
 Variable Field Type Valid Values Description

Variable: CallP

CallP CallP Logging InputChannel.

<category> Choice Type, DN, Group A category type.

Variable: SMAP

SMAP SMAP Logging InputChannel.

<category> Choice Type, DN, Group A category type.

Variable: Sip

Sip SIP Logging InputChannel.

<category> Choice DN, Group A category type.

Variable: SipMedia

SipMedia SipMedia Logging InputChannel.

<category> Choice DN A category type.

Variable: MGCP

MGCP MGCP Logging InputChannel.

<category> Choice DN, Group A category type.

<include> String 1 to 40 characters Include option.

7.3.3.3.4 OutputChannels
This level is used to view, modify, or clear output channels.
7.3.3.3.4.1 get
This command is used to view output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Logging/
OutputChannels> level.
2) Enter:
get↵
7.3.3.3.4.2 set
This command is used to modify output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/Logging/
OutputChannels> level.
2) Enter:
set <name> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 380
 Variable Field Type Valid Values Description

<name> Choice Stdout, File This parameter specifies the

name of the logging output
channel.

<attribute> MultipleChoice enabled, directory, filePrefix, file The name of an attribute to

SizeInMB, numberOfFiles modify.

<enabled> Choice true, false This parameter turns the logging

to the logging output channel on
and off.

<directory> String 1 to 256 characters This parameter specifies the

directory where the log files are
located.

<filePrefix> String 1 to 256 characters This parameter specifies the

prefix of the log files.

<fileSizeInMB> Integer 1 through 2000 This parameter specifies the

maximum size of a log file.

<numberOf Integer 1 through 65535 This parameter specifies the

Files> maximum number of log files that
exist before the old log files are
deleted.

7.3.3.4 SecurityLogging
This level is used to view and modify the security logging for the Execution Server.
7.3.3.4.1 get
This command is used to view logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/
SecurityLogging> level.
2) Enter:
get↵
7.3.3.4.2 set
This command is used to modify logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/
SecurityLogging> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, severity, priority, max The name of an attribute to

QueueSize, showThreadName modify.

<enabled> Choice true, false This parameter turns the logging

on and off.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 381
 Variable Field Type Valid Values Description

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn default logging severity level.

<priority> Integer 1 through 5 This parameter specifies the

priority of the logging thread. The
value "1" indicates the lowest
priority and "5" indicates the
highest.

<maxQueue Integer 0 through 2147483647 This parameter specifies the

Size> maximum size of the logging
queue.

<showThread Choice true, false This parameter enables thread

Name> name logging.

7.3.3.4.3 InputChannels
This level is used to view, modify, or clear input channels entries.
7.3.3.4.3.1 get
This command is used to view input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/
SecurityLogging/InputChannels> level.
2) Enter:
get↵
7.3.3.4.3.2 set
This command is used to modify input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/
SecurityLogging/InputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice VoicePortalAuthentication, SIP This parameter specifies the

AuthenticationLock name of the logging input
channel.

<attribute> MultipleChoice enabled, severity The name of an attribute to

modify.

<enabled> Choice true, false This parameter turns the logging

to the logging input channel on
and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn severity level of the logging input
channel.

7.3.3.4.3.3 clear
This command is used to clear input channels-related attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 382
 1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/
SecurityLogging/InputChannels> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice VoicePortalAuthentication, SIP This parameter specifies the

AuthenticationLock name of the logging input
channel.

<attribute> MultipleChoice severity The name of an attribute to clear.

7.3.3.4.4 OutputChannels
This level is used to view, modify, or clear output channels.
7.3.3.4.4.1 get
This command is used to view output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/
SecurityLogging/OutputChannels> level.
2) Enter:
get↵
7.3.3.4.4.2 set
This command is used to modify output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/ExecutionAndProvisioning/XS/
SecurityLogging/OutputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice File This parameter specifies the

name of the logging output
channel.

<attribute> MultipleChoice enabled, directory, filePrefix, file The name of an attribute to

SizeInMB, numberOfFiles modify.

<enabled> Choice true, false This parameter turns the logging

to the logging output channel on
and off.

<directory> String 1 to 256 characters This parameter specifies the

directory where the log files are
located.

<filePrefix> String 1 to 256 characters This parameter specifies the

prefix of the log files.

<fileSizeInMB> Integer 1 through 2000 This parameter specifies the

maximum size of a log file.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 383
 Variable Field Type Valid Values Description

<numberOf Integer 1 through 65535 This parameter specifies the

Files> maximum number of log files that
exist before the old log files are
deleted.

7.4 JWSFiles
This level is used to configure the application that serves the Java Web Start application.

7.4.1 Logging
This level is used to control logging.

7.4.1.1 get
This command is used to view logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/JWSFiles/Logging> level.
2) Enter:
get↵

7.4.1.2 set
This command is used to modify logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/JWSFiles/Logging> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, severity, priority, max The name of an attribute to

QueueSize, showThreadName modify.

<enabled> Choice true, false This parameter turns the logging

on and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn default logging severity level.

<priority> Integer 1 through 5 This parameter specifies the

priority of the logging thread. The
value "1" indicates the lowest
priority and "5" indicates the
highest.

<maxQueue Integer 0 through 2147483647 This parameter specifies the

Size> maximum size of the logging
queue.

<showThread Choice true, false This parameter enables thread

Name> name logging.

7.4.1.3 InputChannels
This level is used to view, modify, or clear input channels entries.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 384
7.4.1.3.1 get
This command is used to view input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/JWSFiles/Logging/InputChannels> level.
2) Enter:
get↵
7.4.1.3.2 set
This command is used to modify input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/JWSFiles/Logging/InputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Generic, FileRepos, BW This parameter specifies the

CommunicationUtility name of the logging input
channel.

<attribute> MultipleChoice enabled, severity The name of an attribute to

modify.

<enabled> Choice true, false This parameter turns the logging

to the logging input channel on
and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn severity level of the logging input
channel.

7.4.1.3.3 clear
This command is used to clear input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/JWSFiles/Logging/InputChannels> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Generic, FileRepos, BW This parameter specifies the

CommunicationUtility name of the logging input
channel.

<attribute> MultipleChoice severity The name of an attribute to clear.

7.4.1.4 OutputChannels
This level is used to view, modify, or clear output channels.
7.4.1.4.1 get
This command is used to view output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/JWSFiles/Logging/OutputChannels> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 385
 get↵
7.4.1.4.2 set
This command is used to modify output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/JWSFiles/Logging/OutputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Stdout, File This parameter specifies the

name of the logging output
channel.

<attribute> MultipleChoice enabled, directory, filePrefix, file The name of an attribute to

SizeInMB, numberOfFiles modify.

<enabled> Choice true, false This parameter turns the logging

to the logging output channel on
and off.

<directory> String 1 to 256 characters This parameter specifies the

directory where the log files are
located.

<filePrefix> String 1 to 256 characters This parameter specifies the

prefix of the log files.

<fileSizeInMB> Integer 1 through 2000 This parameter specifies the

maximum size of a log file.

<numberOf Integer 1 through 65535 This parameter specifies the

Files> maximum number of log files that
exist before the old log files are
deleted.

7.4.2 Users
This level is used to view, modify, add, and delete user-related attributes.

7.4.2.1 get
This command is used to view the users-related attributes.
1) Ensure you are at the /AS_CLI/Applications/JWSFiles/Users> level.
2) Enter:
get↵

7.4.2.2 add
This command is used to add users.
1) Ensure you are at the /AS_CLI/Applications/JWSFiles/Users> level.
2) Enter:
add <username> <accessPriv>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 386
 Variable Field Type Valid Values Description

<username> String 1 to 30 characters This parameter specifies the

access user name.

<accessPriv> MultipleChoice get, put, delete This parameter specifies the

privileges associated with the
user.

7.4.2.3 set
This command is used to modify the users-related attributes.
1) Ensure you are at the /AS_CLI/Applications/JWSFiles/Users> level.
2) Enter:
set <username> <attribute>↵
where:
Variable Field Type Valid Values Description

<username> String 1 to 30 characters This parameter specifies the

access user name.

<attribute> MultipleChoice password, accessPriv The name of an attribute to

modify.

<accessPriv> MultipleChoice get, put, delete This parameter specifies the

privileges associated with the
user.

7.4.2.4 delete
This command is used to delete users.
1) Ensure you are at the /AS_CLI/Applications/JWSFiles/Users> level.
2) Enter:
delete <username>↵
where:
Variable Field Type Valid Values Description

<username> String 1 to 30 characters This parameter specifies the

access user name.

7.5 MediaFiles
This level is used to use a Web-based Distributed Authoring and Versioning (WebDAV) interface for
serving Media Server files.

7.5.1 GeneralSettings
This level is used to view and modify the general settings.

7.5.1.1 get
This command is used to view general settings-related attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 387
 1) Ensure you are at the /AS_CLI/Applications/MediaFiles/GeneralSettings> level.
2) Enter:
get↵

7.5.1.2 set
This command is used to modify general settings-related attributes.
1) Ensure you are at the /AS_CLI/Applications/MediaFiles/GeneralSettings> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice rootDirectory, userAuthentication The name of an attribute to

modify.

<rootDirectory> String 1 to 255 characters This parameter specifies the

name of the root directory of the
file system.

<user Choice none, basic, digest This parameter specifies the type
Authentication> of user authentication.

7.5.2 Logging
This level is used to view and modify the logging for the Media Files application.

7.5.2.1 get
This command is used to view logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/MediaFiles/Logging> level.
2) Enter:
get↵

7.5.2.2 set
This command is used to modify logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/MediaFiles/Logging> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, severity, priority, max The name of an attribute to

QueueSize, showThreadName modify.

<enabled> Choice true, false This parameter turns the logging

on and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn default logging severity level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 388
 Variable Field Type Valid Values Description

<priority> Integer 1 through 5 This parameter specifies the

priority of the logging thread. The
value "1" indicates the lowest
priority and "5" indicates the
highest.

<maxQueue Integer 0 through 2147483647 This parameter specifies the

Size> maximum size of the logging
queue.

<showThread Choice true, false This parameter enables thread

Name> name logging.

7.5.2.3 InputChannels
This level is used to view, modify, or clear input channels entries.
7.5.2.3.1 get
This command is used to view input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/MediaFiles/Logging/InputChannels> level.
2) Enter:
get↵
7.5.2.3.2 set
This command is used to modify input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/MediaFiles/Logging/InputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Generic, FileRepos, BW This parameter specifies the

CommunicationUtility name of the logging input
channel.

<attribute> MultipleChoice enabled, severity The name of an attribute to

modify.

<enabled> Choice true, false This parameter turns the logging

to the logging input channel on
and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn severity level of the logging input
channel.

7.5.2.3.3 clear
This command is used to clear input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/MediaFiles/Logging/InputChannels> level.
2) Enter:
clear <name> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 389
 Variable Field Type Valid Values Description

<name> Choice Generic, FileRepos, BW This parameter specifies the

CommunicationUtility name of the logging input
channel.

<attribute> MultipleChoice severity The name of an attribute to clear.

7.5.2.4 OutputChannels
This level is used to view, modify, or clear output channels.
7.5.2.4.1 get
This command is used to view output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/MediaFiles/Logging/OutputChannels> level.
2) Enter:
get↵
7.5.2.4.2 set
This command is used to modify output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/MediaFiles/Logging/OutputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Stdout, File This parameter specifies the

name of the logging output
channel.

<attribute> MultipleChoice enabled, directory, filePrefix, file The name of an attribute to

SizeInMB, numberOfFiles modify.

<enabled> Choice true, false This parameter turns the logging

to the logging output channel on
and off.

<directory> String 1 to 256 characters This parameter specifies the

directory where the log files are
located.

<filePrefix> String 1 to 256 characters This parameter specifies the

prefix of the log files.

<fileSizeInMB> Integer 1 through 2000 This parameter specifies the

maximum size of a log file.

<numberOf Integer 1 through 65535 This parameter specifies the

Files> maximum number of log files that
exist before the old log files are
deleted.

7.5.3 Users
This level is used to view, modify, add, and delete user-related attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 390
7.5.3.1 get
This command is used to view the users-related attributes.
1) Ensure you are at the /AS_CLI/Applications/MediaFiles/Users> level.
2) Enter:
get↵

7.5.3.2 add
This command is used to add users.
1) Ensure you are at the /AS_CLI/Applications/MediaFiles/Users> level.
2) Enter:
add <username> <accessPriv>↵
where:
Variable Field Type Valid Values Description

<username> String 1 to 30 characters This parameter specifies the

access user name.

<accessPriv> MultipleChoice get, put, delete This parameter specifies the

privileges associated with the
user.

7.5.3.3 set
This command is used to modify the users-related attributes.
1) Ensure you are at the /AS_CLI/Applications/MediaFiles/Users> level.
2) Enter:
set <username> <attribute>↵
where:
Variable Field Type Valid Values Description

<username> String 1 to 30 characters This parameter specifies the

access user name.

<attribute> MultipleChoice password, accessPriv The name of an attribute to

modify.

<accessPriv> MultipleChoice get, put, delete This parameter specifies the

privileges associated with the
user.

7.5.3.4 delete
This command is used to delete users.
1) Ensure you are at the /AS_CLI/Applications/MediaFiles/Users> level.
2) Enter:
delete <username>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 391
 Variable Field Type Valid Values Description

<username> String 1 to 30 characters This parameter specifies the

access user name.

7.6 OCIFiles
This level is used to configure the application that serves Open Client Interface (OCI) files for Hypertext
Transfer Protocol (HTTP) put and retrieve commands.

7.6.1 Logging
This level is used to control logging.

7.6.1.1 get
This command is used to view logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OCIFiles/Logging> level.
2) Enter:
get↵

7.6.1.2 set
This command is used to modify logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OCIFiles/Logging> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, severity, priority, max The name of an attribute to

QueueSize, showThreadName modify.

<enabled> Choice true, false This parameter turns the logging

on and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn default logging severity level.

<priority> Integer 1 through 5 This parameter specifies the

priority of the logging thread. The
value "1" indicates the lowest
priority and "5" indicates the
highest.

<maxQueue Integer 0 through 2147483647 This parameter specifies the

Size> maximum size of the logging
queue.

<showThread Choice true, false This parameter enables thread

Name> name logging.

7.6.1.3 InputChannels
This level is used to view, modify, or clear input channels entries.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 392
7.6.1.3.1 get
This command is used to view input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OCIFiles/Logging/InputChannels> level.
2) Enter:
get↵
7.6.1.3.2 set
This command is used to modify input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OCIFiles/Logging/InputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Generic, FileRepos, BW This parameter specifies the

CommunicationUtility name of the logging input
channel.

<attribute> MultipleChoice enabled, severity The name of an attribute to

modify.

<enabled> Choice true, false This parameter turns the logging

to the logging input channel on
and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn severity level of the logging input
channel.

7.6.1.3.3 clear
This command is used to clear input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OCIFiles/Logging/InputChannels> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Generic, FileRepos, BW This parameter specifies the

CommunicationUtility name of the logging input
channel.

<attribute> MultipleChoice severity The name of an attribute to clear.

7.6.1.4 OutputChannels
This level is used to view, modify, or clear output channels.
7.6.1.4.1 get
This command is used to view output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OCIFiles/Logging/OutputChannels> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 393
 get↵
7.6.1.4.2 set
This command is used to modify output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OCIFiles/Logging/OutputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice File This parameter specifies the

name of the logging output
channel.

<attribute> MultipleChoice enabled, directory, filePrefix, file The name of an attribute to

SizeInMB, numberOfFiles modify.

<enabled> Choice true, false This parameter turns the logging

to the logging output channel on
and off.

<directory> String 1 to 256 characters This parameter specifies the

directory where the log files are
located.

<filePrefix> String 1 to 256 characters This parameter specifies the

prefix of the log files.

<fileSizeInMB> Integer 1 through 2000 This parameter specifies the

maximum size of a log file.

<numberOf Integer 1 through 65535 This parameter specifies the

Files> maximum number of log files that
exist before the old log files are
deleted.

7.7 OCIOverSoap
This level is used to configure the Open Client Interface-Provisioning (OCI-P) Simple Object Access
Protocol (SOAP) interface.

7.7.1 GeneralSettings
This level is used to configure the general settings of the Open Client Interface-Provisioning (OCI-P) over
Simple Object Access Protocol (SOAP).

7.7.1.1 get
This command is used to view the general settings of the Open Client Interface-Provisioning (OCI-P) over
Simple Object Access Protocol (SOAP) attributes.
1) Ensure you are at the /AS_CLI/Applications/OCIOverSoap/GeneralSettings> level.
2) Enter:
get↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 394
7.7.1.2 set
This command is used to modify the general settings of the Open Client Interface-Provisioning (OCI-P)
over Simple Object Access Protocol (SOAP) attributes.
1) Ensure you are at the /AS_CLI/Applications/OCIOverSoap/GeneralSettings> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice clientInactivityTimeoutInMinutes The name of an attribute to

modify.

<clientInactivity Integer 1 through 60 Sets the inactivity timeout from

TimeoutIn client, in minutes.
Minutes>

7.7.2 Logging
This level is used to control logging.

7.7.2.1 get
This command is used to view logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OCIOverSoap/Logging> level.
2) Enter:
get↵

7.7.2.2 set
This command is used to modify logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OCIOverSoap/Logging> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, severity, priority, max The name of an attribute to

QueueSize, showThreadName modify.

<enabled> Choice true, false This parameter turns the logging

on and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn default logging severity level.

<priority> Integer 1 through 5 This parameter specifies the

priority of the logging thread. The
value "1" indicates the lowest
priority and "5" indicates the
highest.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 395
 Variable Field Type Valid Values Description

<maxQueue Integer 0 through 2147483647 This parameter specifies the

Size> maximum size of the logging
queue.

<showThread Choice true, false This parameter enables thread

Name> name logging.

7.7.2.3 InputChannels
This level is used to view, modify, or clear input channels entries.
7.7.2.3.1 get
This command is used to view input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OCIOverSoap/Logging/InputChannels> level.
2) Enter:
get↵
7.7.2.3.2 set
This command is used to modify input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OCIOverSoap/Logging/InputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Generic, ProvisioningService, This parameter specifies the

ExecutionService name of the logging input
channel.

<attribute> MultipleChoice enabled, severity The name of an attribute to

modify.

<enabled> Choice true, false This parameter turns the logging

to the logging input channel on
and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn severity level of the logging input
channel.

7.7.2.3.3 clear
This command is used to clear input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OCIOverSoap/Logging/InputChannels> level.
2) Enter:
clear <name> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 396
 Variable Field Type Valid Values Description

<name> Choice Generic, ProvisioningService, This parameter specifies the

ExecutionService name of the logging input
channel.

<attribute> MultipleChoice severity The name of an attribute to clear.

7.7.2.4 OutputChannels
This level is used to view, modify, or clear output channels.
7.7.2.4.1 get
This command is used to view output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OCIOverSoap/Logging/OutputChannels>
level.
2) Enter:
get↵
7.7.2.4.2 set
This command is used to modify output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OCIOverSoap/Logging/OutputChannels>
level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Stdout, File This parameter specifies the

name of the logging output
channel.

<attribute> MultipleChoice enabled, directory, filePrefix, file The name of an attribute to

SizeInMB, numberOfFiles modify.

<enabled> Choice true, false This parameter turns the logging

to the logging output channel on
and off.

<directory> String 1 to 256 characters This parameter specifies the

directory where the log files are
located.

<filePrefix> String 1 to 256 characters This parameter specifies the

prefix of the log files.

<fileSizeInMB> Integer 1 through 2000 This parameter specifies the

maximum size of a log file.

<numberOf Integer 1 through 65535 This parameter specifies the

Files> maximum number of log files that
exist before the old log files are
deleted.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 397
7.7.3 OCSConnectivity
This level is used to configure the connection between the Open Client Interface (OCI) over Simple Object
Access Protocol (SOAP) application with the local Open Client Server (OCS).

7.7.3.1 get
This command is used to view the Open Client Server (OCS) connectivity-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OCIOverSoap/OCSConnectivity> level.
2) Enter:
get↵

7.7.3.2 set
This command is used to modify the Open Client Server (OCS) connectivity-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OCIOverSoap/OCSConnectivity> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice host, port, maxNumberOfOCIP The name of an attribute to

Connections, maxNumberOfCAP modify.
Connections, retryInitialization
IntervalInSeconds, waitTimeout
IntervalInSeconds

<host> String 1 to 80 characters Sets the host where the OCS is

running.

<port> Integer 1025 through 65535 Sets the port on OCS that web
service will connect to.

<maxNumber Integer 1 through 10 Sets the maximum number of

OfOCIP simultaneous connections to OCS
Connections> for OCI-P.

<maxNumber Integer 1 through 10 Sets the maximum number of

OfCAP simultaneous connections to OCS
Connections> for CAP.

<retry Integer 10 through 3600 Sets the number of seconds to

Initialization wait before rebuilding connection
IntervalIn to OCS.
Seconds>

<waitTimeout Integer 1 through 120 Sets the number of seconds to

IntervalIn wait before timing out a response
Seconds> from OCS.

7.8 OpenClientServer
This level is used to view and modify Open Client Server (OCS)-related attributes. The Network Server and
Application Server clusters communicate with the Open Client Server.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 398
7.8.1 CAPProxy
This level is used to view and modify the Client Application Protocol (CAP) proxy entries.

7.8.1.1 get
This command is used to view CAPProxy-related attributes in the system.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/CAPProxy> level.
2) Enter:
get↵

7.8.1.2 set
This command is used to set CAPProxy-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/CAPProxy> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, serverPort, num Identifies an attribute to be

Connections modified.

<enabled> Choice true, false This parameter enables the Client

Application Protocol (CAP) proxy.

<serverPort> Integer 1025 through 65535 This parameter specifies the

Client Application Protocol (CAP)
port for the Application Servers in
the cluster.

<num Integer 1 through 10 This parameter specifies the

Connections> number of permanent Client
Application Protocol (CAP)
connections to the Application
Server.

7.8.2 ExternalAuthentication
This level is used to view, modify, and clear external authentication entries.

7.8.2.1 AccessControlList
This level is used to view, add, modify, delete, and clear the Access Control List (ACL) entries.
7.8.2.1.1 get
This command is used to view External Authentication ACL entries in the system.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/
ExternalAuthentication/AccessControlList> level.
2) Enter:
get↵
7.8.2.1.2 add
This command is used to add a new External Authentication ACL entry in the system.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/
ExternalAuthentication/AccessControlList> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 399
 2) Enter:
add <ipAddress> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters This parameter specifies the

Internet Protocol (IP) address of
the host.

<attribute> MultipleChoice description Additional attributes to include

through the add command.

<description> String 1 to 80 characters This parameter specifies the

description of the Access Control
List (ACL) entry.

7.8.2.1.3 set
This command is used to modify an External Authentication ACL entry in the system.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/
ExternalAuthentication/AccessControlList> level.
2) Enter:
set <ipAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters This parameter specifies the

Internet Protocol (IP) address of
the host.

<attribute> MultipleChoice description Identifies an attribute to be

modified.

<description> String 1 to 80 characters This parameter specifies the

description of the Access Control
List (ACL) entry.

7.8.2.1.4 delete
This command is used to delete an existing External Authentication ACL entry from the system.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/
ExternalAuthentication/AccessControlList> level.
2) Enter:
delete <ipAddress>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters This parameter specifies the

Internet Protocol (IP) address of
the host.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 400
7.8.2.1.5 clear
This command is used to clear External Authentication ACL-related attributes in the system.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/
ExternalAuthentication/AccessControlList> level.
2) Enter:
clear <ipAddress> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters This parameter specifies the

Internet Protocol (IP) address of
the host.

<attribute> MultipleChoice description Identifies an attribute to be

cleared.

7.8.3 GeneralSettings
This level is used to view, modify, and clear the general settings.

7.8.3.1 get
This command is used to view the Open Client Server (OCS) general settings.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/GeneralSettings> level.
2) Enter:
get↵

7.8.3.2 set
This command is used to modify the Open Client Server (OCS) general settings.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/GeneralSettings> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice systemDomain, clientPort Identifies an attribute to be

Enabled, clientPort, secure modified.
ClientPortEnabled, secureClient
Port, enableCallCorrelationID,
disconnectOnInvalidSession

<system String 1 to 80 characters This parameter specifies the

Domain> domain to append to the user IDs
in requests.

<clientPort Choice true, false This parameter controls the use

Enabled> of an unsecure Transmission
Control Protocol (TCP) port.

<clientPort> Integer 1025 through 65535 This parameter specifies the

unsecure Transmission Control
Protocol (TCP) listening port.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 401
 Variable Field Type Valid Values Description

<secureClient Choice true, false This parameter enables the use

PortEnabled> of a secure Transmission Control
Protocol (TCP) port.

<secureClient Integer 1025 through 65535 This parameter specifies the

Port> secure Transmission Control
Protocol (TCP) listening port.

<enableCall Choice true, false This parameter controls the

CorrelationID> presence of call correlation
information in the application
logs.

<disconnectOn Choice true, false This parameter determines

InvalidSession> whether an error is sent to the
user using an invalid session
ID or the connection is simply
dropped.

7.8.3.3 clear
This command is used to clear General Setting-related attributes in the system.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/GeneralSettings> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice systemDomain Identifies an attribute to be

cleared.

7.8.4 JVMStatsCollector
This level is used to configure the Open Client Server (OCS) Java Virtual Machine (JVM) statistics collector
settings.

7.8.4.1 GeneralSettings
This level is used to configure the general settings of the Java Virtual Machine (JVM) statistics collector.
7.8.4.1.1 get
This command is used to view the general settings of the Java Virtual Machine (JVM) statistics collector.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/JVMStatsCollector/
GeneralSettings> level.
2) Enter:
get↵
7.8.4.1.2 set
The command is used to modify the general settings of the Java Virtual Machine (JVM) statistics collector.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/JVMStatsCollector/
GeneralSettings> level.
2) Enter:
set <attribute>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 402
 where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, statisticsRefreshPeriod The name of an attribute to

modify.

<enabled> Choice true, false This parameter enables or

disables data collection for JVM
statistics

<statistics Integer 1 through 86400 This parameter specifies the

RefreshPeriod> frequency at which BroadWorks
fetches PMs from JVM Mbeans

7.8.4.2 HeapUsageThreshold
This level is used to configure the heap usage threshold settings.
7.8.4.2.1 get
This command is used to view the heap usage threshold settings.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/JVMStatsCollector/
HeapUsageThreshold> level.
2) Enter:
get↵
7.8.4.2.2 set
The command is used to modify the heap usage threshold settings.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/JVMStatsCollector/
HeapUsageThreshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 0 through 100 This parameter specifies a value

for enabling a threshold crossing.

<resetValue> Integer 0 through 100 This parameter specifies a value

for clearing a threshold crossing.

7.8.4.3 NonHeapUsageThreshold
This level is used to configure the non-heap usage threshold settings.
7.8.4.3.1 get
This command is used to view the non-heap usage threshold settings.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/JVMStatsCollector/
NonHeapUsageThreshold> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 403
 get↵
7.8.4.3.2 set
The command is used to modify the non-heap usage threshold settings.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/JVMStatsCollector/
NonHeapUsageThreshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 0 through 100 This parameter specifies a value

for enabling a threshold crossing.

<resetValue> Integer 0 through 100 This parameter specifies a value

for clearing a threshold crossing.

7.8.5 Logging
This level is used to view and modify the logging for the Open Client Server.

7.8.5.1 get
This command is used to view logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/Logging> level.
2) Enter:
get↵

7.8.5.2 set
This command is used to modify logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/Logging> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, severity, priority, max The name of an attribute to

QueueSize, showThreadName modify.

<enabled> Choice true, false This parameter turns the logging

on and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn default logging severity level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 404
 Variable Field Type Valid Values Description

<priority> Integer 1 through 5 This parameter specifies the

priority of the logging thread. The
value "1" indicates the lowest
priority and "5" indicates the
highest.

<maxQueue Integer 0 through 2147483647 This parameter specifies the

Size> maximum size of the logging
queue.

<showThread Choice true, false This parameter enables thread

Name> name logging.

7.8.5.3 InputChannels
This level is used to view, modify, or clear input channels entries.
7.8.5.3.1 get
This command is used to view input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/Logging/
InputChannels> level.
2) Enter:
get↵
7.8.5.3.2 set
This command is used to modify input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/Logging/
InputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Generic, BroadsoftCommon This parameter specifies the

CommunicationTransport, name of the logging input
BroadsoftCommon channel.
CommunicationTransportKeep
Alive, OpenClientServer, SMAP,
NameService, GcLog

<attribute> MultipleChoice enabled, severity The name of an attribute to

modify.

<enabled> Choice true, false This parameter turns the logging

to the logging input channel on
and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn severity level of the logging input
channel.

7.8.5.3.3 clear
This command is used to clear input channels-related attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 405
 1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/Logging/
InputChannels> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Generic, BroadsoftCommon This parameter specifies the

CommunicationTransport, name of the logging input
BroadsoftCommon channel.
CommunicationTransportKeep
Alive, OpenClientServer, SMAP,
NameService, GcLog

<attribute> MultipleChoice severity The name of an attribute to clear.

7.8.5.4 OutputChannels
This level is used to view, modify, or clear output channels.
7.8.5.4.1 get
This command is used to view output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/Logging/
OutputChannels> level.
2) Enter:
get↵
7.8.5.4.2 set
This command is used to modify output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/Logging/
OutputChannels> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Stdout, File This parameter specifies the

name of the logging output
channel.

<attribute> MultipleChoice enabled, directory, filePrefix, file The name of an attribute to

SizeInMB, numberOfFiles modify.

<enabled> Choice true, false This parameter turns the logging

to the logging output channel on
and off.

<directory> String 1 to 256 characters This parameter specifies the

directory where the log files are
located.

<filePrefix> String 1 to 256 characters This parameter specifies the

prefix of the log files.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 406
 Variable Field Type Valid Values Description

<fileSizeInMB> Integer 1 through 2000 This parameter specifies the

maximum size of a log file.

<numberOf Integer 1 through 65535 This parameter specifies the

Files> maximum number of log files that
exist before the old log files are
deleted.

7.8.6 NSOCIProxy
This level is used to view, modify, and add Network Server Open Client Interface (OCI) proxy entries.

7.8.6.1 get
This command is used to view NSOCIProxy-related attributes in the system.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/NSOCIProxy> level.
2) Enter:
get↵

7.8.6.2 set
This command is used to modify NSOCIProxy-related attributes in the system.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/NSOCIProxy> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, commonCommunication Identifies an attribute to be

TransportNSPSPort, useSecure modified.
Sockets, messageQueue
Capacity, messageQueue
TimeoutSeconds

<enabled> Choice true, false Defines whether the NS Proxy is

enabled.

<common Integer 1025 through 65535 The listening OCI port on the
Communication Network Server.
TransportNSPS
Port>

<useSecure Choice true, false Defines whether the listening OCI

Sockets> port on the Network Server is a
secure port.

<message Integer 10 through 10000 The capacity of the Network

Queue Server message queue.
Capacity>

<message Integer 10 through 7200 The timeout period in seconds

QueueTimeout for the Network Server message
Seconds> queue.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 407
7.8.7 NameService
This level is used to view and modify the Name service settings. The Naming service defines the
interaction of the application with a Domain Name System (DNS) or local naming solution.

7.8.7.1 get
This command is used to view the Name service-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/NameService> level.
2) Enter:
get↵

7.8.7.2 set
This command is used to modify the Name service-related attributes.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/NameService> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice cachePolicy, cacheTTLSecs, Identifies an attribute to be

negativeCachePolicy, negative modified.
CacheTTLSecs, unreachable
ServerLingerSecs, useAdditional
SrvRrs

<cachePolicy> Choice Never, Configured, Honor_DNS This parameter specifies the

Cache policy.
When this parameter value is set
to "HONOR_DNS", the Domain
Name System (DNS) client uses
the response's Time To Live
(TTL) value.

<cacheTTL Integer 0 through 2147483647 This parameter specifies the

Secs> amount of time (in seconds) a
successfully looked-up record is
cached if the Cache policy is set
to "Configured".

<negative Choice Never, Configured, Honor_DNS This parameter specifies the

CachePolicy> negative Cache policy.
When this parameter value
is set to "HONOR_DNS", the
Domain Name System (DNS)
client uses the minimum value of
the response's Start of Authority
(SOA) record.

<negative Integer 0 through 2147483647 This parameter specifies the

CacheTTL amount of time (in seconds) a
Secs> looked-up record with a negative
response is kept in the negative
cache if the negative Cache
policy is set to "Configured".

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 408
 Variable Field Type Valid Values Description

<unreachable Integer 0 through 2147483647 This parameter specifies the

ServerLinger minimum time interval (in
Secs> seconds) during which no Domain
Name System (DNS) request is
sent to a server that is detected
as unreachable.

<useAdditional Choice true, false This parameter controls the use

SrvRrs> of additional Resource Record
(RR) sections of the Service
Locator (SRV) lookup response.
When the value is set to "true",
it indicates that an A lookup
resulting from SRV lookups uses
the pre-resolved A resource
records from the additional
RR section of the SRV lookup
response. Local caching must be
enabled for this setting to have an
effect.

7.8.8 OCIProxy
This level is used to view and modify Open Client Interface (OCI) proxy settings.

7.8.8.1 get
This command is used to view the Open Client Interface (OCI) proxy-related attributes in the system.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/OCIProxy> level.
2) Enter:
get↵

7.8.8.2 set
This command is used to modify the Open Client Interface (OCI) proxy-related attributes in the system.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/OCIProxy> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, enableLoginLevel Identifies an attribute to be

Screening, enableResponse modified.
Caching, responseCacheDuration
Hours, responseCacheRenew
PeriodMins, messageQueue
Capacity, messageQueue
TimeoutSeconds

<enabled> Choice true, false Defines whether the Open Client

Interface (OCI) proxy is enabled.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 409
 Variable Field Type Valid Values Description

<enable Choice true, false Defines whether the Open

LoginLevel Client Server (OCS) is to limit
Screening> its processing of Open Client
Interface (OCI) messages to a
defined list of allowed login levels.

<enable Choice true, false Defines whether Open Client

Response Interface (OCI) response caching
Caching> is enabled.

<response Integer 1 through 168 This is the lifetime of Open Client

CacheDuration Interface (OCI) responses in the
Hours> cache.

<response Integer 1 through 60 Extension to the lifetime of Open

CacheRenew Client Interface (OCI) responses
PeriodMins> in the cache. During this period,
values found in the cache are
considered valid, but trigger a
refresh of the cache.

<message Integer 10 through 10000 The capacity of the Open Client

Queue Interface (OCI) message queue.
Capacity>

<message Integer 10 through 7200 The timeout period in seconds of

QueueTimeout the Open Client Interface (OCI)
Seconds> message queue.

7.8.8.3 LoginLevelAllowed
This level is used to view, add, and delete the login level allowed entries.
7.8.8.3.1 get
This command is used to view the login level allowed entries.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/OCIProxy/
LoginLevelAllowed> level.
2) Enter:
get↵
7.8.8.3.2 add
This command is used to add a login level allowed entry.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/OCIProxy/
LoginLevelAllowed> level.
2) Enter:
add <loginLevel>↵
where:
Variable Field Type Valid Values Description

<loginLevel> MultipleChoice User, GroupDepartment, Group, Adds the selected login level.
ServiceProvider, Provisioning,
System, LawfulIntercept

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 410
7.8.8.3.3 delete
This command is used to delete a login level allowed entry.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/OCIProxy/
LoginLevelAllowed> level.
2) Enter:
delete <loginLevel>↵
where:
Variable Field Type Valid Values Description

<loginLevel> MultipleChoice User, GroupDepartment, Group, This is the login level to disallow.
ServiceProvider, Provisioning,
System, LawfulIntercept

7.8.8.4 ResponseCache
This level is used to view, add, or delete Open Client Interface (OCI) response cache entries.
7.8.8.4.1 get
This command is used to view the Open Client Interface-Provisioning (OCI-P) response cache entries.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/OCIProxy/
ResponseCache> level.
2) Enter:
get↵
7.8.8.4.2 add
This command is used to add an Open Client Interface-Provisioning (OCI-P) response cache entry.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/OCIProxy/
ResponseCache> level.
2) Enter:
add <requestName> <responseName> <minResponseLengthBytes> <enterpriseScope>
<groupScope>↵
where:
Variable Field Type Valid Values Description

<request String 1 to 1000 characters This parameter specifies

Name> the name of the Open Client
Interface-Provisioning (OCI-P)
request that has a response that
needs to be cached.

<response String 1 to 1000 characters This parameter specifies

Name> the name of the Open Client
Interface-Provisioning (OCI-
P) response that needs to be
cached.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 411
 Variable Field Type Valid Values Description

<minResponse Integer 1 through 2147483647 This parameter specifies the

LengthBytes> minimum size of the Open Client
Interface-Provisioning (OCI-
P) response that is cached (in
bytes). Any request smaller than
this number will not be cached.
This prevents the Open Client
Server from caching numerous
small Open Client Interface (OCI)
responses.

<enterprise Choice true, false This parameter enables and

Scope> disables the enterprise-level
storage of Open Client Interface
(OCI) requests.

<groupScope> Choice true, false This parameter enables and

disables the group-level storage
of Open Client Interface (OCI)
requests.

7.8.8.4.3 set
The command is used to modify an Open Client Interface-Provisioning (OCI-P) response cache entry.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/OCIProxy/
ResponseCache> level.
2) Enter:
set <requestName> <attribute>↵
where:
Variable Field Type Valid Values Description

<request String 1 to 1000 characters This parameter specifies

Name> the name of the Open Client
Interface-Provisioning (OCI-P)
request that has a response that
needs to be cached.

<attribute> MultipleChoice responseName, minResponse The name of an attribute to

LengthBytes, enterpriseScope, modify.
groupScope

<response String 1 to 1000 characters This parameter specifies

Name> the name of the Open Client
Interface-Provisioning (OCI-
P) response that needs to be
cached.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 412
 Variable Field Type Valid Values Description

<minResponse Integer 1 through 2147483647 This parameter specifies the

LengthBytes> minimum size of the Open Client
Interface-Provisioning (OCI-
P) response that is cached (in
bytes). Any request smaller than
this number will not be cached.
This prevents the Open Client
Server from caching numerous
small Open Client Interface (OCI)
responses.

<enterprise Choice true, false This parameter enables and

Scope> disables the enterprise-level
storage of Open Client Interface
(OCI) requests.

<groupScope> Choice true, false This parameter enables and

disables the group-level storage
of Open Client Interface (OCI)
requests.

7.8.8.4.4 delete
This command is used to delete an existing Open Client Interface-Provisioning (OCI-P) response cache
entry.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/OCIProxy/
ResponseCache> level.
2) Enter:
delete <requestName>↵
where:
Variable Field Type Valid Values Description

<request String 1 to 1000 characters This parameter specifies

Name> the name of the Open Client
Interface-Provisioning (OCI-P)
request that has a response that
needs to be cached.

7.8.8.4.5 RequestExclusionFilter
This level is used to view and modify the request exclusion filter entries.
7.8.8.4.5.1 get
This command is used to view the request exclusion filter entries.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/OCIProxy/
ResponseCache/RequestExclusionFilter> level.
2) Enter:
get <requestName>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 413
 Variable Field Type Valid Values Description

<request String 1 to 1000 characters This parameter specifies

Name> the name of the Open Client
Interface-Provisioning (OCI-P)
request that has a response that
needs to be cached.

7.8.8.4.5.2 add
This command is used to add a request exclusion filter entry.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/OCIProxy/
ResponseCache/RequestExclusionFilter> level.
2) Enter:
add <requestName> <regularExpression>↵
where:
Variable Field Type Valid Values Description

<request String 1 to 1000 characters This parameter specifies

Name> the name of the Open Client
Interface-Provisioning (OCI-P)
request that has a response that
needs to be cached.

<regular String 1 to 256 characters This parameter specifies a

Expression> regular expression.

7.8.8.4.5.3 delete
This command is used to delete an existing request exclusion filter entry.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/OCIProxy/
ResponseCache/RequestExclusionFilter> level.
2) Enter:
delete <requestName> <regularExpression>↵
where:
Variable Field Type Valid Values Description

<request String 1 to 1000 characters This parameter specifies

Name> the name of the Open Client
Interface-Provisioning (OCI-P)
request that has a response that
needs to be cached.

<regular String 1 to 256 characters This parameter specifies a

Expression> regular expression.

7.8.8.4.6 RequestInclusionFilter
This level is used to view and modify the request inclusion filter entries.
7.8.8.4.6.1 get
This command is used to view the request inclusion filter entries.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/OCIProxy/
ResponseCache/RequestInclusionFilter> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 414
 get <requestName>↵
where:
Variable Field Type Valid Values Description

<request String 1 to 1000 characters This parameter specifies

Name> the name of the Open Client
Interface-Provisioning (OCI-P)
request that has a response that
needs to be cached.

7.8.8.4.6.2 add
This command is used to add a request inclusion filter entry.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/OCIProxy/
ResponseCache/RequestInclusionFilter> level.
2) Enter:
add <requestName> <regularExpression>↵
where:
Variable Field Type Valid Values Description

<request String 1 to 1000 characters This parameter specifies

Name> the name of the Open Client
Interface-Provisioning (OCI-P)
request that has a response that
needs to be cached.

<regular String 1 to 256 characters This parameter specifies a

Expression> regular expression.

7.8.8.4.6.3 delete
This command is used to delete a request inclusion filter entry.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/OCIProxy/
ResponseCache/RequestInclusionFilter> level.
2) Enter:
delete <requestName> <regularExpression>↵
where:
Variable Field Type Valid Values Description

<request String 1 to 1000 characters This parameter specifies

Name> the name of the Open Client
Interface-Provisioning (OCI-P)
request that has a response that
needs to be cached.

<regular String 1 to 256 characters This parameter specifies a

Expression> regular expression.

7.8.9 SSLConfiguration
This level is used to view and modify Open Client Server (OCS)-related attributes. In addition, you can
generate a Secure Sockets Layer (SSL) key for a secure OCS connection and to load and update a new
SSL certificate file.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 415
7.8.9.1 get
This command is used to view the available interfaces for the Open Client Server (OCS) with their current
Secure Sockets Layer (SSL) configuration.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/SSLConfiguration> level.
2) Enter:
get↵

7.8.9.2 add
This command is used to add the Open Client Server (OCS) with the current Secure Sockets Layer (SSL)
configuration properties.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/SSLConfiguration> level.
2) Enter:
add <interface> <serverCertificate> <clientAuthReq>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface IP address.

<server Choice true, false This parameter dictates if the

Certificate> server presents a certificate for
its identity. When the value is set
to "true" and the client requests
the server identity, the server
presents its certificate. When
the value is set to "true" but the
client does not request the server
identity, the server identity is
anonymous. When the value is
set to "false", the server identity is
anonymous.

<clientAuth Choice true, false This parameter determines if

Req> the server requests the client
identity. When the value is set
to "true", the server requests the
client identity. When the value
is set to "false", the server does
not request the client identity.
When a client receives a request
for identity, it shall send its
certificate.

7.8.9.3 set
This command is used to modify the Open Client Server (OCS) Secure Sockets Layer (SSL) configuration
properties.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/SSLConfiguration> level.
2) Enter:
set <interface> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 416
 Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface IP address.

<attribute> MultipleChoice serverCertificate, clientAuthReq Name of an attribute to be

modified

<server Choice true, false This parameter dictates if the

Certificate> server presents a certificate for
its identity. When the value is set
to "true" and the client requests
the server identity, the server
presents its certificate. When
the value is set to "true" but the
client does not request the server
identity, the server identity is
anonymous. When the value is
set to "false", the server identity is
anonymous.

<clientAuth Choice true, false This parameter determines if

Req> the server requests the client
identity. When the value is set
to "true", the server requests the
client identity. When the value
is set to "false", the server does
not request the client identity.
When a client receives a request
for identity, it shall send its
certificate.

7.8.9.4 delete
This command is used to delete the Open Client Server (OCS) with the current Secure Sockets Layer
(SSL) configuration properties.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/SSLConfiguration> level.
2) Enter:
delete <interface>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface IP address.

7.8.9.5 sslExport
This command is used to export Secure Sockets Layer (SSL) files (certificate, key, or chain file). The SSL
file is taken from its location and copied to the ''/var/broadworks/tmp/'' directory.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/SSLConfiguration> level.
2) Enter:
sslExport <interface> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 417
 Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently Interface IP address.

defined on the server.

<attribute> MultipleChoice certificateFile, keyFile, chainFile Used to select which file to

export.

7.8.9.6 sslGenkey
This command is used to generate an SSL key for a secure OCS. A generated .csr (Certificate Signing
Request) file is written to the ''/var/broadworks/tmp'' directory under the name "name.csr", where name is
the interface IP address.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/SSLConfiguration> level.
2) Enter:
sslGenkey <interface> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This is the Open Client Server
defined on the server. (OCS) interface.

<attribute> MultipleChoice keyLength, country, stateOr Optional attribute to be set.

Province, city, organisationName,
organisationUnit, emailAddress,
challengePassword, common
Name

<keyLength> Integer 512 through 16384 The Secure Sockets Layer (SSL)
key length or key size, default
value (when not specified) is
"1024".

<country> String 2 to 2 characters The country code internatioal

abbrevation code.

<stateOr String 1 to 50 characters The state or province.

Province>

<city> String 1 to 50 characters The name of the city.

<organisation String 1 to 50 characters The organization name.

Name>

<organisation String 1 to 50 characters The organization unit.

Unit>

<email String 1 to 50 characters The e-mail address.

Address>

<challenge String 1 to 40 characters The challenge password.

Password>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 418
 Variable Field Type Valid Values Description

<common String 1 to 255 characters The common name. It must

Name> correspond to the host name
of this Open Client Server
(OCS). A "*" wildcard character
may be present in the left-
most name component of
the host if the certificate is to
be used on multiple servers
having the same domain. For
example, the common name
for host xsp1.broadsoft.com
could be *.broadsoft.com or
xsp*.broadsoft.com.

7.8.9.7 sslRemove
This command is used to remove the Secure Sockets Layer (SSL) file (chain file).
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/SSLConfiguration> level.
2) Enter:
sslRemove <interface> <attribute>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently The Open Client Server (OCS)
defined on the server. interface.

<attribute> MultipleChoice chainFile The type of file to be removed.

7.8.9.8 sslShow
This command is used to view the details of the X.509 certificate and certificate chain associated with the
provided interface. This command reflects the information as it is sent by the server to the software client.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/SSLConfiguration> level.
2) Enter:
sslShow <interface>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface IP address.

7.8.9.9 sslUpdate
This command is used to load and update a new Secure Sockets Layer (SSL) certificate file. The certificate
is taken from the specified path and copied to the proper location.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/SSLConfiguration> level.
2) Enter:
sslUpdate <interface> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 419
 Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently Enter a specific IP address or

defined on the server. select ALL.

<attribute> MultipleChoice certificateFile, keyFile, chainFile The name of an Secure Sockets

Layer (SSL) configuration
attribute to update.

<certificateFile> String 1 to 255 characters The file name for the certificate
file.

<keyFile> String 1 to 255 characters The file name for the certificate
chain file.

<chainFile> String 1 to 255 characters The file name for the key file.

7.8.9.10 ClientAuthentication
This level is used to view and modify the Open Client Server (OCS) client authentication properties.
7.8.9.10.1 Trusts
This level is used to generate Secure Sockets Layer (SSL) trust anchors.
7.8.9.10.1.1 get
This command is used to view the list of Trust Anchors.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/SSLConfiguration/
ClientAuthentication/Trusts> level.
2) Enter:
get↵
7.8.9.10.1.2 createTrust
This command is used to generate a Secure Sockets Layer (SSL) key and a trust anchor for a secure
Open Client Server (OCS) interface.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/SSLConfiguration/
ClientAuthentication/Trusts> level.
2) Enter:
createTrust <alias> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<alias> String 1 to 64 characters This parameter describes a name

specified by the administrator to
identify uniquely a trust anchor.

<attribute> MultipleChoice keyLength, country, stateOr This parameter describes an

Province, city, organisationName, optional attribute to be set.
organisationUnit, emailAddress,
challengePassword, common
Name

<keyLength> Integer 512 through 16384 This parameter specifies the key
length or key size. (default value
2048 when not specified).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 420
 Variable Field Type Valid Values Description

<country> String 2 to 2 characters This parameter describes the

country code international
abbreviation code.

<stateOr String 1 to 50 characters This parameter describes the

Province> state or province.

<city> String 1 to 50 characters This parameter describes the

name of the city.

<organisation String 1 to 50 characters This parameter describes the

Name> organization name.

<organisation String 1 to 50 characters This parameter describes the

Unit> organization unit.

<email String 1 to 50 characters This parameter describes the e-

Address> mail address.

<challenge String 1 to 40 characters This parameter describes the

Password> challenge password.

<common String 1 to 255 characters This parameter describes the

Name> common name. Generally,
the common name on a client
certificate is the proper name
of the organization requesting
a certificate. Alternatively,
it may follow any standard
already determined within
the organization owning the
certificate.

7.8.9.10.1.3 deleteTrust
This command is used to delete a trust anchor identified by its alias name.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/SSLConfiguration/
ClientAuthentication/Trusts> level.
2) Enter:
deleteTrust <alias>↵
where:
Variable Field Type Valid Values Description

<alias> String 1 to 64 characters This parameter is used to identify

which trust anchor to delete.

7.8.9.10.1.4 exportTrust
This command is used to export a file related to Secure Sockets Layer (SSL). The SSL file is extracted
from the BroadWorks trust store and copied to the /var/broadworks/tmp directory.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/SSLConfiguration/
ClientAuthentication/Trusts> level.
2) Enter:
exportTrust <alias> <attribute>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 421
 where:
Variable Field Type Valid Values Description

<alias> String 1 to 64 characters This parameter is used to identify

which trust anchor to export.

<attribute> MultipleChoice certificateFile, keyFile, pkcs12File This parameter is used to select

which file type to export.

Variable: pkcs12File

pkcs12File This parameter indicates to

export the certificate and key
in a Public-Key Cryptography
Standards (PKCS#12) formatted
keystore.

<pkcs12 Password 5 to 255 characters This parameter is used to specify

Password> (prompted) the password used to secure
the Public-Key Cryptography
Standards (PKCS#12) formatted
keystore.

7.8.9.10.1.5 showTrust
This command is used to view the details of the X.509 certificate associated with the trust anchor of the
provided interface.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/SSLConfiguration/
ClientAuthentication/Trusts> level.
2) Enter:
showTrust <alias>↵
where:
Variable Field Type Valid Values Description

<alias> String 1 to 64 characters This parameter is used to identify

which trust anchor to display.

7.8.9.10.1.6 updateTrust
This command is used to load and update a trust anchor file. The certificate is taken from the specified
path and copied to the proper location.
1) Ensure you are at the /AS_CLI/Applications/OpenClientServer/SSLConfiguration/
ClientAuthentication/Trusts> level.
2) Enter:
updateTrust <alias> <trustAnchorFile>↵
where:
Variable Field Type Valid Values Description

<alias> String 1 to 64 characters This parameter is used to identify

which trust anchor to update.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 422
 Variable Field Type Valid Values Description

<trustAnchor String 1 to 255 characters This parameter is used to identify

File> the file name for the trust anchor
file.

7.9 WebContainer
This level is used to view and modify the web container application.

7.9.1 Apache
This level is used to configure the Apache container.

7.9.1.1 GeneralSettings
This level is used to configure the Apache general settings.
7.9.1.1.1 get
This command is used to view the Apache general settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Apache/GeneralSettings>
level.
2) Enter:
get↵
7.9.1.1.2 set
The command is used to modify the Apache general settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Apache/GeneralSettings>
level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice logLevel, maxQueuedConnection, The name of an attribute to

usableWorkerThreads, threads modify.
PerWorker, statisticsRefresh
Period

<logLevel> Choice debug, info, notice, warn, error, This parameter specifies the log
crit, alert, emerg level.

<maxQueued Integer 1 through 2147483647 This parameter specifies the

Connection> maximum length of the queue of
pending connections.

<usableWorker Integer 100 through 100000 This parameter specifies the

Threads> number of configured usable
worker threads.

<threadsPer Integer 25 through 10000 This parameter specifies the

Worker> number of threads created by
each child process.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 423
 Variable Field Type Valid Values Description

<statistics Integer 1 through 86400 This parameter specifies the

RefreshPeriod> frequency at which BroadWorks
fetches PMs from the Apache
Web Server.

7.9.1.1.3 WorkersBusyThreshold
This level is used to view and modify the workers busy threshold settings.
7.9.1.1.3.1 get
This command is used to view the workers busy threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Apache/GeneralSettings/
WorkersBusyThreshold> level.
2) Enter:
get↵
7.9.1.1.3.2 set
The command is used to modify the workers busy threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Apache/GeneralSettings/
WorkersBusyThreshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 0 through 100 This parameter specifies a value

for enabling a threshold crossing.

<resetValue> Integer 0 through 100 This parameter specifies a value

for clearing a threshold crossing.

7.9.2 Tomcat
This level is used to view and modify the Tomcat container.

7.9.2.1 Executors
This level is used to view and modify the Tomcat executors.
7.9.2.1.1 AJP
This level is used to view and modify the Apache JServ Protocol (AJP) executor.
7.9.2.1.1.1 Queue
This level is used to view and modify the queue settings.
7.9.2.1.1.1.1 get
This command is used to view the queue settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/AJP/
Queue> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 424
 get↵
7.9.2.1.1.1.2 set
This command is used to modify the queue settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/AJP/
Queue> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice capacity The name of an attribute to

modify.

<capacity> Integer 0 through 2147483647 This parameter specifies the

maximum queue capacity. Tasks
are queued while waiting for
an available thread. When the
value is left unspecified (cleared),
queuing is unlimited: tasks are
queued as long as there is
enough memory available.

7.9.2.1.1.1.3 clear
This command is used to clear (set to no value) the queue settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/AJP/
Queue> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice capacity The name of the attribute(s) to

clear.

7.9.2.1.1.1.4 LatencyThreshold
This level is used to view and modify the latency threshold settings.
7.9.2.1.1.1.4.1 get
This command is used to view the latency threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/AJP/
Queue/LatencyThreshold> level.
2) Enter:
get↵
7.9.2.1.1.1.4.2 set
The command is used to modify the latency threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/AJP/
Queue/LatencyThreshold> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 425
 set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 1 through 2147483647 This parameter specifies a value

(in milliseconds) for enabling a
threshold crossing.

<resetValue> Integer 1 through 2147483647 This parameter specifies a value

(in milliseconds) for clearing a
threshold crossing.

7.9.2.1.1.1.5 SizeThreshold
This level is used to view and modify the size threshold settings.
7.9.2.1.1.1.5.1 get
This command is used to view the size threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/AJP/
Queue/SizeThreshold> level.
2) Enter:
get↵
7.9.2.1.1.1.5.2 set
The command is used to modify the size threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/AJP/
Queue/SizeThreshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 0 through 100 This parameter specifies a value

for enabling a threshold crossing.

<resetValue> Integer 0 through 100 This parameter specifies a value

for clearing a threshold crossing.

7.9.2.1.1.2 ThreadPool
This level is used to view and modify the thread pool settings.
7.9.2.1.1.2.1 get
This command is used to view the thread pool settings.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 426
 1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/AJP/
ThreadPool> level.
2) Enter:
get↵
7.9.2.1.1.2.2 set
The command is used to modify the thread pool settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/AJP/
ThreadPool> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice min, max, keepAliveTime The name of an attribute to

modify.

<min> Integer 1 through 10000 This parameter specifies the

minimum number of threads
to keep in steady state. Lower
thread counts are possible during
initialization.

<max> Integer 1 through 10000 This parameter specifies the

maximum number of threads this
pool contains.

<keepAlive Integer 1 through 3600 This parameter specifies the

Time> amount of idle time before an
excess thread is terminated (in
seconds).

7.9.2.1.1.2.3 UsageThreshold
This level is used to view and modify the usage threshold settings.
7.9.2.1.1.2.3.1 get
This command is used to view the usage threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/AJP/
ThreadPool/UsageThreshold> level.
2) Enter:
get↵
7.9.2.1.1.2.3.2 set
The command is used to modify the usage threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/AJP/
ThreadPool/UsageThreshold> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 427
 Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 0 through 100 This parameter specifies a value

for enabling a threshold crossing.

<resetValue> Integer 0 through 100 This parameter specifies a value

for clearing a threshold crossing.

7.9.2.1.2 CTI
This level is used to view and modify the Computer Telephony Integration (CTI) interface executor.
7.9.2.1.2.1 Queue
This level is used to view and modify the queue settings for the Computer Telephony Integration (CTI)
interface executor.
7.9.2.1.2.1.1 get
This command is used to view the queue settings for the Computer Telephony Integration (CTI) interface
executor.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI/
Queue> level.
2) Enter:
get↵
7.9.2.1.2.1.2 set
The command is used to modify the queue settings for the Computer Telephony Integration (CTI) interface
executor.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI/
Queue> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice capacity The name of an attribute to

modify.

<capacity> Integer 0 through 2147483647 This parameter specifies the

maximum queue capacity. Tasks
are queued while waiting for
an available thread. When the
value is left unspecified (cleared),
queuing is unlimited: tasks are
queued as long as there is
enough memory available.

7.9.2.1.2.1.3 clear
This command is used to clear (set to no value) the queue settings for the Computer Telephony Integration
(CTI) interface executor.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 428
 1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI/
Queue> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice capacity The name of the attribute(s) to

clear.

7.9.2.1.2.1.4 LatencyThreshold
This level is used to view and modify the latency threshold settings.
7.9.2.1.2.1.4.1 get
This command is used to view the latency threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI/
Queue/LatencyThreshold> level.
2) Enter:
get↵
7.9.2.1.2.1.4.2 set
The command is used to modify the latency threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI/
Queue/LatencyThreshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 1 through 2147483647 This parameter specifies a value

(in milliseconds) for enabling a
threshold crossing.

<resetValue> Integer 1 through 2147483647 This parameter specifies a value

(in milliseconds) for clearing a
threshold crossing.

7.9.2.1.2.1.5 SizeThreshold
This level is used to view and modify the size threshold settings.
7.9.2.1.2.1.5.1 get
This command is used to view the size threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI/
Queue/SizeThreshold> level.
2) Enter:
get↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 429
7.9.2.1.2.1.5.2 set
The command is used to modify the size threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI/
Queue/SizeThreshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 0 through 100 This parameter specifies a value

for enabling a threshold crossing.

<resetValue> Integer 0 through 100 This parameter specifies a value

for clearing a threshold crossing.

7.9.2.1.2.2 ThreadPool
This level is used to view and modify the thread pool settings.
7.9.2.1.2.2.1 get
This command is used to view the thread pool settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI/
ThreadPool> level.
2) Enter:
get↵
7.9.2.1.2.2.2 set
The command is used to modify the thread pool settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI/
ThreadPool> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice min, max, keepAliveTime The name of an attribute to

modify.

<min> Integer 1 through 10000 This parameter specifies the

minimum number of threads
to keep in steady state. Lower
thread counts are possible during
initialization.

<max> Integer 1 through 10000 This parameter specifies the

maximum number of threads this
pool contains.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 430
 Variable Field Type Valid Values Description

<keepAlive Integer 1 through 3600 This parameter specifies the

Time> amount of idle time before an
excess thread is terminated (in
seconds).

7.9.2.1.2.2.3 ProcessingTimeThreshold
This level is used to view and modify the processing time threshold settings.
7.9.2.1.2.2.3.1 get
This command is used to view the processing time threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI/
ThreadPool/ProcessingTimeThreshold> level.
2) Enter:
get↵
7.9.2.1.2.2.3.2 set
The command is used to modify the processing time threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI/
ThreadPool/ProcessingTimeThreshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 1 through 2147483647 This parameter specifies a value

(in milliseconds) for enabling a
threshold crossing.

<resetValue> Integer 1 through 2147483647 This parameter specifies a value

(in milliseconds) for clearing a
threshold crossing.

7.9.2.1.2.2.4 UsageThreshold
This level is used to view and modify the usage threshold settings.
7.9.2.1.2.2.4.1 get
This command is used to view the usage threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI/
ThreadPool/UsageThreshold> level.
2) Enter:
get↵
7.9.2.1.2.2.4.2 set
The command is used to modify the usage threshold settings.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 431
 1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/CTI/
ThreadPool/UsageThreshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 0 through 100 This parameter specifies a value

for enabling a threshold crossing.

<resetValue> Integer 0 through 100 This parameter specifies a value

for clearing a threshold crossing.

7.9.2.1.3 HTTPNio
This level is used to view and modify the Hypertext Transfer Protocol (HTTP) New I/O executor.
7.9.2.1.3.1 Queue
This level is used to view and modify the queue settings.
7.9.2.1.3.1.1 get
This command is used to view the queue settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio/
Queue> level.
2) Enter:
get↵
7.9.2.1.3.1.2 set
The command is used to modify the queue settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio/
Queue> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice capacity The name of an attribute to

modify.

<capacity> Integer 0 through 2147483647 This parameter specifies the

maximum queue capacity. Tasks
are queued while waiting for
an available thread. When the
value is left unspecified (cleared),
queuing is unlimited: tasks are
queued as long as there is
enough memory available.

7.9.2.1.3.1.3 clear

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 432
 This command is used to clear (set to no value) the queue settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio/
Queue> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice capacity The name of the attribute(s) to

clear.

7.9.2.1.3.1.4 LatencyThreshold
This level is used to view and modify the latency threshold settings.
7.9.2.1.3.1.4.1 get
This command is used to view the threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio/
Queue/LatencyThreshold> level.
2) Enter:
get↵
7.9.2.1.3.1.4.2 set
The command is used to modify the threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio/
Queue/LatencyThreshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 1 through 2147483647 This parameter specifies a value

(in milliseconds) for enabling a
threshold crossing.

<resetValue> Integer 1 through 2147483647 This parameter specifies a value

(in milliseconds) for clearing a
threshold crossing.

7.9.2.1.3.1.5 SizeThreshold
This level is used to view and modify the size threshold settings.
7.9.2.1.3.1.5.1 get
This command is used to view the size threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio/
Queue/SizeThreshold> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 433
 get↵
7.9.2.1.3.1.5.2 set
The command is used to modify the size threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio/
Queue/SizeThreshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 0 through 100 This parameter specifies a value

for enabling a threshold crossing.

<resetValue> Integer 0 through 100 This parameter specifies a value

for clearing a threshold crossing.

7.9.2.1.3.2 ThreadPool
This level is used to view and modify the thread pool settings.
7.9.2.1.3.2.1 get
This command is used to view the thread pool settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio/
ThreadPool> level.
2) Enter:
get↵
7.9.2.1.3.2.2 set
The command is used to modify the thread pool settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio/
ThreadPool> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice min, max, keepAliveTime The name of an attribute to

modify.

<min> Integer 1 through 10000 This parameter specifies the

minimum number of threads
to keep in steady state. Lower
thread counts are possible during
initialization.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 434
 Variable Field Type Valid Values Description

<max> Integer 1 through 10000 This parameter specifies the

maximum number of threads this
pool contains.

<keepAlive Integer 1 through 3600 This parameter specifies the

Time> amount of idle time before an
excess thread is terminated (in
seconds).

7.9.2.1.3.2.3 ProcessingTimeThreshold
This level is used to view and modify the processing time threshold settings.
7.9.2.1.3.2.3.1 get
This command is used to view the processing time threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio/
ThreadPool/ProcessingTimeThreshold> level.
2) Enter:
get↵
7.9.2.1.3.2.3.2 set
The command is used to modify the processing time threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio/
ThreadPool/ProcessingTimeThreshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 1 through 2147483647 This parameter specifies a value

(in milliseconds) for enabling a
threshold crossing.

<resetValue> Integer 1 through 2147483647 This parameter specifies a value

(in milliseconds) for clearing a
threshold crossing.

7.9.2.1.3.2.4 UsageThreshold
This level is used to view and modify the usage threshold settings.
7.9.2.1.3.2.4.1 get
This command is used to view the usage threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio/
ThreadPool/UsageThreshold> level.
2) Enter:
get↵
7.9.2.1.3.2.4.2 set

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 435
 The command is used to modify the usage threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Executors/HTTPNio/
ThreadPool/UsageThreshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 0 through 100 This parameter specifies a value

for enabling a threshold crossing.

<resetValue> Integer 0 through 100 This parameter specifies a value

for clearing a threshold crossing.

7.9.2.2 GeneralSettings
This level is used to view and modify the Tomcat general settings.
7.9.2.2.1 get
This command is used to view the Tomcat general settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/GeneralSettings>
level.
2) Enter:
get↵
7.9.2.2.2 set
The command is used to modify Tomcat general settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/GeneralSettings>
level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice uriEncoding, authentication The name of an attribute to

Encoding, statisticsRefreshPeriod modify.

<uriEncoding> Choice UTF-8, ISO-8859-1 This parameter specifies the

character encoding for URI
definition.

<authentication Choice UTF-8, ISO-8859-1 This parameter specifies the

Encoding> character encoding used to
decode the username and
password coming from the
authenticate header when using
basic authentication.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 436
 Variable Field Type Valid Values Description

<statistics Integer 1 through 86400 This parameter specifies the

RefreshPeriod> frequency at which BroadWorks
refreshes PMs within Tomcat.

7.9.2.3 JVMStatsCollector
This level is used to view and modify the Tomcat Java Virtual Machine (JVM) statistics collector settings.
7.9.2.3.1 GeneralSettings
This level is used to view and modify the Java Virtual Machine (JVM) statistics collector general settings.
7.9.2.3.1.1 get
This command is used to view the Java Virtual Machine (JVM) statistics collector general settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/JVMStatsCollector/
GeneralSettings> level.
2) Enter:
get↵
7.9.2.3.1.2 set
The command is used to modify the Java Virtual Machine (JVM) statistics collector general settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/JVMStatsCollector/
GeneralSettings> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, statisticsRefreshPeriod The name of an attribute to

modify.

<enabled> Choice true, false This parameter enables or

disables data collection for JVM
statistics

<statistics Integer 1 through 86400 This parameter specifies the

RefreshPeriod> frequency at which BroadWorks
fetches PMs from JVM Mbeans

7.9.2.3.2 HeapUsageThreshold
This level is used to view and modify the heap usage threshold settings.
7.9.2.3.2.1 get
This command is used to view the heap usage threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/JVMStatsCollector/
HeapUsageThreshold> level.
2) Enter:
get↵
7.9.2.3.2.2 set
The command is used to the heap usage threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/JVMStatsCollector/
HeapUsageThreshold> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 437
 set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 0 through 100 This parameter specifies a value

for enabling a threshold crossing.

<resetValue> Integer 0 through 100 This parameter specifies a value

for clearing a threshold crossing.

7.9.2.3.3 NonHeapUsageThreshold
This level is used to view and modify the non-heap usage threshold settings.
7.9.2.3.3.1 get
This command is used to view the non-heap usage threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/JVMStatsCollector/
NonHeapUsageThreshold> level.
2) Enter:
get↵
7.9.2.3.3.2 set
This command is used to modify the non-heap usage threshold settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/JVMStatsCollector/
NonHeapUsageThreshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, armValue, resetValue The name of an attribute to

modify.

<enabled> Choice true, false This parameter determines if a

threshold is active or not.

<armValue> Integer 0 through 100 This parameter specifies a value

for enabling a threshold crossing.

<resetValue> Integer 0 through 100 This parameter specifies a value

for clearing a threshold crossing.

7.9.2.4 Logging
This level is used to view and modify the Tomcat logging settings.
7.9.2.4.1 get
This command is used to view logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Logging> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 438
 2) Enter:
get↵
7.9.2.4.2 set
This command is used to modify logging-related attributes.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Logging> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, severity, priority, max The name of an attribute to

QueueSize, showThreadName modify.

<enabled> Choice true, false This parameter turns the logging

on and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn default logging severity level.

<priority> Integer 1 through 5 This parameter specifies the

priority of the logging thread. The
value "1" indicates the lowest
priority and "5" indicates the
highest.

<maxQueue Integer 0 through 2147483647 This parameter specifies the

Size> maximum size of the logging
queue.

<showThread Choice true, false This parameter enables thread

Name> name logging.

7.9.2.4.3 InputChannels
This level is used to view, modify, or clear input channels entries.
7.9.2.4.3.1 get
This command is used to view input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Logging/
InputChannels> level.
2) Enter:
get↵
7.9.2.4.3.2 set
This command is used to modify input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Logging/
InputChannels> level.
2) Enter:
set <name> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 439
 Variable Field Type Valid Values Description

<name> Choice Generic, NameService, Tomcat This parameter specifies the

Core, ExternalAuthenticator, Cti name of the logging input
Connector, GcLog, SMAP channel.

<attribute> MultipleChoice enabled, severity The name of an attribute to

modify.

<enabled> Choice true, false This parameter turns the logging

to the logging input channel on
and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn severity level of the logging input
channel.

7.9.2.4.3.3 clear
This command is used to clear input channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Logging/
InputChannels> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Generic, NameService, Tomcat This parameter specifies the

Core, ExternalAuthenticator, Cti name of the logging input
Connector, GcLog, SMAP channel.

<attribute> MultipleChoice severity The name of an attribute to clear.

7.9.2.4.4 OutputChannels
This level is used to view, modify, or clear output channels.
7.9.2.4.4.1 get
This command is used to view output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Logging/
OutputChannels> level.
2) Enter:
get↵
7.9.2.4.4.2 set
This command is used to modify output channels-related attributes.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/Logging/
OutputChannels> level.
2) Enter:
set <name> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 440
 Variable Field Type Valid Values Description

<name> Choice Stdout, File This parameter specifies the

name of the logging output
channel.

<attribute> MultipleChoice enabled, directory, filePrefix, file The name of an attribute to

SizeInMB, numberOfFiles modify.

<enabled> Choice true, false This parameter turns the logging

to the logging output channel on
and off.

<directory> String 1 to 256 characters This parameter specifies the

directory where the log files are
located.

<filePrefix> String 1 to 256 characters This parameter specifies the

prefix of the log files.

<fileSizeInMB> Integer 1 through 2000 This parameter specifies the

maximum size of a log file.

<numberOf Integer 1 through 65535 This parameter specifies the

Files> maximum number of log files that
exist before the old log files are
deleted.

7.9.2.5 NameService
This level is used to view and modify the attributes of the Naming Service. The Naming Service defines the
interaction of the application with a DNS or local naming solution.
7.9.2.5.1 get
This command is used to view the Naming Service peers.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/NameService> level.
2) Enter:
get↵
7.9.2.5.2 set
This command is used to modify the Naming Service-related attributes.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/NameService> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice cachePolicy, cacheTTLSecs, Identifies an attribute to be

negativeCachePolicy, negative modified.
CacheTTLSecs, unreachable
ServerLingerSecs, useAdditional
SrvRrs

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 441
 Variable Field Type Valid Values Description

<cachePolicy> Choice Never, Configured, Honor_DNS This parameter specifies the

Cache policy.
When this parameter value is set
to "HONOR_DNS", the Domain
Name System (DNS) client uses
the response's Time To Live
(TTL) value.

<cacheTTL Integer 0 through 2147483647 This parameter specifies the

Secs> amount of time (in seconds) a
successfully looked-up record is
cached if the Cache policy is set
to "Configured".

<negative Choice Never, Configured, Honor_DNS This parameter specifies the

CachePolicy> negative Cache policy.
When this parameter value
is set to "HONOR_DNS", the
Domain Name System (DNS)
client uses the minimum value of
the response's Start of Authority
(SOA) record.

<negative Integer 0 through 2147483647 This parameter specifies the

CacheTTL amount of time (in seconds) a
Secs> looked-up record with a negative
response is kept in the negative
cache if the negative Cache
policy is set to "Configured".

<unreachable Integer 0 through 2147483647 This parameter specifies the

ServerLinger minimum time interval (in
Secs> seconds) during which no Domain
Name System (DNS) request is
sent to a server that is detected
as unreachable.

<useAdditional Choice true, false This parameter controls the use

SrvRrs> of additional Resource Record
(RR) sections of the Service
Locator (SRV) lookup response.
When the value is set to "true",
it indicates that an A lookup
resulting from SRV lookups uses
the pre-resolved A resource
records from the additional
RR section of the SRV lookup
response. Local caching must be
enabled for this setting to have an
effect.

7.9.2.6 OverloadProtection
This level is used to view and modify the Tomcat overload protection settings.
7.9.2.6.1 Server
This level is used to view and modify the server overload protection settings
7.9.2.6.1.1 get
This command is used to view the server overload protection settings.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 442
 1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/
OverloadProtection/Server> level.
2) Enter:
get↵
7.9.2.6.1.2 set
The command is used to modify the server overload protection settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/
OverloadProtection/Server> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice period, limit The name of an attribute to

modify.

<period> Integer 1 through 300 This parameter specifies the

duration expressed in seconds
during which the total number
of transactions is limited for the
overall server.

<limit> Integer 1 through 65535 This parameter specifies the

maximum number of requests to
be allowed during the specified
period duration.

7.9.2.6.1.3 clear
This command is used to clear (set to no value) the server overload protection settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/
OverloadProtection/Server> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice limit The name of the attribute(s) to

clear.

7.9.2.6.2 Webapps
This level is used to view and modify the web application overload protection settings
7.9.2.6.2.1 get
This command is used to view the web application overload protection settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/
OverloadProtection/Webapps> level.
2) Enter:
get↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 443
7.9.2.6.2.2 add
This command is used to add the web application overload protection entry.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/
OverloadProtection/Webapps> level.
2) Enter:
add <name> <period> <limit>↵
where:
Variable Field Type Valid Values Description

<name> Choice CommPilot, DeviceManagement This parameter specifies the

Files, JWSFiles, MediaFiles, OCI name of the web application.
Files, OCIOverSoap

<period> Integer 1 through 300 This parameter specifies the

duration expressed in seconds
during which the total number
of transactions is limited for the
overall server.

<limit> Integer 1 through 65535 This parameter specifies the

maximum number of requests to
be allowed during the specified
period duration.

7.9.2.6.2.3 set
The command is used to modify the web application overload protection settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/
OverloadProtection/Webapps> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice CommPilot, DeviceManagement This parameter specifies the

Files, JWSFiles, MediaFiles, OCI name of the web application.
Files, OCIOverSoap

<attribute> MultipleChoice period, limit The name of an attribute to

modify.

<period> Integer 1 through 300 This parameter specifies the

duration expressed in seconds
during which the total number
of transactions is limited for the
overall server.

<limit> Integer 1 through 65535 This parameter specifies the

maximum number of requests to
be allowed during the specified
period duration.

7.9.2.6.2.4 delete
Use this command to delete the web application overload protection entry.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 444
 1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/
OverloadProtection/Webapps> level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> Choice CommPilot, DeviceManagement This parameter specifies the

Files, JWSFiles, MediaFiles, OCI name of the web application.
Files, OCIOverSoap

7.9.2.7 SessionManagement
This level is used to view and modify the Tomcat session management settings.
7.9.2.7.1 Server
This level is used to view and modify the server session management settings
7.9.2.7.1.1 get
This command is used to view the server session management settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/SessionManagement/
Server> level.
2) Enter:
get↵
7.9.2.7.1.2 set
The command is used to modify the server session management settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/SessionManagement/
Server> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice sessionTimeout The name of an attribute to

modify.

<session Integer 1 through 86400 This parameter specifies the

Timeout> duration expressed in seconds
after which an inactive session
times out.

7.9.2.7.1.3 clear
This command is used to clear (set to no value) the server session management settings.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/SessionManagement/
Server> level.
2) Enter:
clear <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 445
 Variable Field Type Valid Values Description

<attribute> MultipleChoice sessionTimeout The name of the attribute(s) to

clear.

7.9.2.7.2 Webapps
This level is used to view and modify the web application session management settings
7.9.2.7.2.1 get
This command is used to view the web applications session management-related attributes.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/SessionManagement/
Webapps> level.
2) Enter:
get↵
7.9.2.7.2.2 add
This command is used to add the web application session management entry.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/SessionManagement/
Webapps> level.
2) Enter:
add <name> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<name> Choice CommPilot, DeviceManagement This parameter specifies the

Files, JWSFiles, MediaFiles, OCI name of the web application.
Files, OCIOverSoap

<attribute> MultipleChoice sessionTimeout Name of the webapp

<session Integer 1 through 86400 This parameter specifies a web

Timeout> application specific duration
expressed in seconds after which
an inactive session times out.

7.9.2.7.2.3 set
This command is used to modify the web application session management-related attributes.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/SessionManagement/
Webapps> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice CommPilot, DeviceManagement This parameter specifies the

Files, JWSFiles, MediaFiles, OCI name of the web application.
Files, OCIOverSoap

<attribute> MultipleChoice sessionTimeout The name of an attribute to

modify.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 446
 Variable Field Type Valid Values Description

<session Integer 1 through 86400 This parameter specifies a web

Timeout> application specific duration
expressed in seconds after which
an inactive session times out.

7.9.2.7.2.4 delete
This command is used to delete the web application session management entry.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/SessionManagement/
Webapps> level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> Choice CommPilot, DeviceManagement This parameter specifies the

Files, JWSFiles, MediaFiles, OCI name of the web application.
Files, OCIOverSoap

7.9.2.7.2.5 clear
This command is used to clear (set to no value) the web application session management-related
attributes.
1) Ensure you are at the /AS_CLI/Applications/WebContainer/Tomcat/SessionManagement/
Webapps> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice CommPilot, DeviceManagement This parameter specifies the

Files, JWSFiles, MediaFiles, OCI name of the web application.
Files, OCIOverSoap

<attribute> MultipleChoice sessionTimeout The name of the attribute(s) to

clear.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 447
8 Monitoring

This level is used to check the status of the system, troubleshoot issues using logs and audit trails, and
review performance and reports.

8.1 Alarm
This level is used to view and modify alarms. BroadWorks servers trigger alarms and include the ability
to obtain and view these alarms. A BroadWorks server alarm can be informational, low severity, medium
severity, high severity, or critical severity.
Please refer to the application specific fault and alarms Management Information Base (MIB) for a detailed
list of alarms.

8.1.1 get
This command is used to get and search for system alarms. These are alarms are located in the local CLI
buffer.
1) Ensure you are at the /AS_CLI/Monitoring/Alarm> level.
2) Enter:
get [<attribute>] [<back>] <numAlarms>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice type, trapName, problem, A type of alarm sub-component to

subcomp, recommendation, filter on.
state, time, comp, sysname, trap
Severity, id

Variable: type

type This parameter identifies the filter

as a trap type.

<relation> Choice <=, ==, >=, HAS This nested parameter

determines the relation. *"<= ":
less than or equal to. *"==": equal
to. *>=: greater than or equal to.
*"HAS": is inclusive of.

<TrapType> Choice Notification, Alarm, Software This nester parameter

Error determines the trap type. *Use
''notification'' to display the traps
at informational purposes. *Use
''alarm'' to display the reporting
alarms. *Use ''software error'' to
display the software errors.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 448
 Variable Field Type Valid Values Description

Variable: trapName

trapName This parameter identifies the filter

as a trap name.

<relation> Choice <=, ==, >=, HAS This nested parameter

determines the relation. *"<= ":
less than or equal to. *"==": equal
to. *>=: greater than or equal to.
*"HAS": is inclusive of.

<Name> String 0 to 255 characters This nested parameter specifies

the trap name.

Variable: problem

problem This parameter identifies the filter

as problem text.

<relation> Choice <=, ==, >=, HAS This nested parameter

determines the relation. *"<= ":
less than or equal to. *"==": equal
to. *>=: greater than or equal to.
*"HAS": is inclusive of.

<ProblemText> String 0 to 255 characters This nested parameter specifies

a text element that may represent
an actual trap text (partially or
entirely).

Variable: subcomp

subcomp This parameter identifies the

filter as a BroadWorks software
component or area.

<relation> Choice <=, ==, >=, HAS This nested parameter

determines the relation. *"<= ":
less than or equal to. *"==": equal
to. *>=: greater than or equal to.
*"HAS": is inclusive of.

<Subcomponent> String 0 to 255 characters This nested parameter specifies

the software component within
the BroadWorks entity that
is reporting the alarm: "SIP",
"database", and so on. Refer to
the BroadWorks fault MIBs for a
list valid sub-components.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 449
 Variable Field Type Valid Values Description

Variable: recommendation

recommendation This parameter identifies the filter

as recommendation text.

<relation> Choice <=, ==, >=, HAS This nested parameter

determines the relation. *"<= ":
less than or equal to. *"==": equal
to. *>=: greater than or equal to.
*"HAS": is inclusive of.

<RecommendationString 0 to 255 characters This nested parameter specifies

Text> a text element that may represent
an actual trap recommended
action text (partially or entirely).

Variable: state

state This parameter identifies the filter

is based on the state of an alarm.

<relation> Choice <=, ==, >=, HAS This nested parameter

determines the relation. *"<= ":
less than or equal to. *"==": equal
to. *>=: greater than or equal to.
*"HAS": is inclusive of.

<AlarmState> Choice true, false This nested parameter

determines the state of an alarm.

Variable: time

time This parameter identifies the filter

based on the trap generation
time. The acceptable time formats
are as follow: * MM/DD/YY
hh:mm AM|PM * MM/DD/YY

<relation> Choice <=, ==, >=, HAS This nested parameter

determines the relation. *"<= ":
less than or equal to. *"==": equal
to. *>=: greater than or equal to.
*"HAS": is inclusive of.

<TimeStamp> String 0 to 255 characters This nested parameter specifies

the date and time the alarm was
generated.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 450
 Variable Field Type Valid Values Description

Variable: comp

comp This parameter identifies the filter

as an entity reporting the alarm.

<relation> Choice <=, ==, >=, HAS This nested parameter

determines the relation. *"<= ":
less than or equal to. *"==": equal
to. *>=: greater than or equal to.
*"HAS": is inclusive of.

<Component> String 0 to 255 characters This nested parameter

specifies the BroadWorks entity
reporting the alarm. Refer to the
BroadWorks fault MIBs for a list
valid entities.

Variable: sysname

sysname This parameter identifies the filter

as the system name.

<relation> Choice <=, ==, >=, HAS This nested parameter

determines the relation. *"<= ":
less than or equal to. *"==": equal
to. *>=: greater than or equal to.
*"HAS": is inclusive of.

<System String 0 to 255 characters This nested parameter specifies

Name> the host name of the system
running the BroadWorks
software.

Variable: trapSeverity

trapSeverity This parameter identifies the filter

based on alarm severity.

<relation> Choice <=, ==, >=, HAS This nested parameter

determines the relation. *"<= ":
less than or equal to. *"==": equal
to. *>=: greater than or equal to.
*"HAS": is inclusive of.

<Severity> Choice Informational, Low, Medium, This nested parameter

High, Critical determines the severity.
*"Informational Warning": no
immediate problems. *"Low":
minor problem with a possible
service impact. *"Medium": minor
problem with a minor service
impact. *"High": major problem
with a major service impact.
*"Critical": emergency system
outage.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 451
 Variable Field Type Valid Values Description

Variable: id

id This parameter identifies the filter

based on alarm ID.

<relation> Choice <=, ==, >=, HAS This nested parameter

determines the relation. *"<= ":
less than or equal to. *"==": equal
to. *>=: greater than or equal to.
*"HAS": is inclusive of.

<Identifier> Integer 0 through 2147483647 This nested parameter specifies

a sequentially generated number
that is used to uniquely identify
the alarm.

<back> String back This parameter specifies a report

based on the last N alarms.

<numAlarms> Integer 1 through 5000 This parameter specifies the

number of alarms to move back.

8.1.2 set
This command is used to view and modify the size of the CLI buffer for alarms. The recommended buffer
size is "1,000" alarms.
1) Ensure you are at the /AS_CLI/Monitoring/Alarm> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice localsize, size, logging The name of an attribute to

modify.

<localsize> Integer 1 through 5000 This parameter specifies the

local alarms backlog size
(in number of alarms). Note
that , alarms are searched and
displayed by accessing the local
backlog and not the Simple
Network Management Protocol
(SNMP) agent's backlog. This
parameter returns to its default
value ("1000") for each new CLI
session.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 452
 Variable Field Type Valid Values Description

<size> Integer 1 through 5000 This parameter specifies the

SNMP agent alarms backlog size
(in number of alarms). The SNMP
agent backlog size determines
how many alarms are stored in
memory and (optionally) on disk
and represents the maximum
number of alarms that can be
retrieved by CLI clients. When the
actual number of historical alarms
overflows the ''size''parameter,
the oldest alarms are deleted.
The''localsize''is limited by the
''size''.

<logging> Choice true, false This parameter turns logging

on and off. When the values is
"false", logging to disk is turned
off. Logging to disk allows alarms
to be persisted across SNMP
agent restarts. When the value
is "true", logging to disk is turned
on. Logging to disk allows alarms
to be persisted across SNMP
agent restarts.

8.1.3 clear
This command is used to delete alarms from the local CLI backlog buffer, from the SNMP agent backlog
buffer, and from disk.
1) Ensure you are at the /AS_CLI/Monitoring/Alarm> level.
2) Enter:
clear↵

8.1.4 close
This command is used to close the connection with the SNMP agent, which is used to obtain system
alarms and event logs generated by the BroadWorks Server.
1) Ensure you are at the /AS_CLI/Monitoring/Alarm> level.
2) Enter:
close↵

8.1.5 open
This command is used to open a connection with the SNMP agent to obtain system alarms and event logs
generated by the BroadWorks Server. When opening system alarms, the port to be used is specified. If a
port is not specified the agent default is used.
1) Ensure you are at the /AS_CLI/Monitoring/Alarm> level.
2) Enter:
open [<port>]↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 453
 Variable Field Type Valid Values Description

<port> Integer 1000 through 65535 This parameter specifies the port
used to communicate with the
SNMP agent. When not specified
the agent default is used.

8.1.6 show
This command is used to enable or disable real-time alarm echoing. When real-time alarm echoing is
enabled, alarms display at the CLI as they occur. When alarms occur, they appear in the window from
which this command was invoked. To avoid interrupting other BroadWorks Server CLI commands, open a
separate window.
1) Ensure you are at the /AS_CLI/Monitoring/Alarm> level.
2) Enter:
show <onoff>↵
where:
Variable Field Type Valid Values Description

<onoff> Choice true, false This parameter enables the alarm

show funtion. The ''on'' option
enables the alarm show function.
The ''off'' option disables the
alarm show function.

8.1.7 showConfig
This command is used to display the alarm-related configuration.
1) Ensure you are at the /AS_CLI/Monitoring/Alarm> level.
2) Enter:
showConfig↵

8.1.8 AlarmsTable
This level is used to clear a specific active alarm, clear all active alarms, list currently active alarms, resend
an active alarm, and resend all active alarms. When an alarm is raised, its state is set to "On". When an
alarm is resolved and cleared by the server, its state is set to "Off". When an alarm is manually cleared, its
state is set to "Cleared". "Off" and "Cleared" alarms are equivalent; however, a "Cleared" alarm indicates
that the alarm was cleared manually.

8.1.8.1 clear
This command is used to clear an alarm.
1) Ensure you are at the /AS_CLI/Monitoring/Alarm/AlarmsTable> level.
2) Enter:
clear <identifier>↵
where:
Variable Field Type Valid Values Description

<identifier> Integer 0 through 2147483647 This parameter specifies the

identifier of the alarm to resend.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 454
8.1.8.2 clearAll
This command is used to clear all active alarms.
1) Ensure you are at the /AS_CLI/Monitoring/Alarm/AlarmsTable> level.
2) Enter:
clearAll↵

8.1.8.3 list
This command is used to display the list of currently active alarms.
1) Ensure you are at the /AS_CLI/Monitoring/Alarm/AlarmsTable> level.
2) Enter:
list↵

8.1.8.4 resend
This command is used to resend a currently active alarm to a remote host.
1) Ensure you are at the /AS_CLI/Monitoring/Alarm/AlarmsTable> level.
2) Enter:
resend <identifier> <ipAddress> <port>↵
where:
Variable Field Type Valid Values Description

<identifier> Integer 0 through 2147483647 This parameter specifies the

identifier of the alarm to be
resent.

<ipAddress> String 1 to 80 characters This parameter identifies the

remote host that the alarm is sent
to.

<port> Integer 1 through 65535 This parameter specifies the port

number of the remote host.

8.1.8.5 resendAll
This command is used to resend all currently active alarms to a remote host.
1) Ensure you are at the /AS_CLI/Monitoring/Alarm/AlarmsTable> level.
2) Enter:
resendAll <ipAddress> <port>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters This parameter identifies the

remote host that the alarm is sent
to.

<port> Integer 1 through 65535 This parameter specifies the port

number of the remote host.

8.1.9 Threshold
This level is used to define thresholds against alarms defined for the BroadWorks Server.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 455
8.1.9.1 get
This command is used to view a list of the alarm thresholds defined on the BroadWorks server.
1) Ensure you are at the /AS_CLI/Monitoring/Alarm/Threshold> level.
2) Enter:
get [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice alarmName The name of an attribute to

modify.

<alarmName> String 1 to 128 characters This parameter specifies the

alarm name.

8.1.9.2 add
This command is used to add a new threshold against an alarm defined in the BroadWorks server.
1) Ensure you are at the /AS_CLI/Monitoring/Alarm/Threshold> level.
2) Enter:
add <alarmName> <maxNumTrapsPerTimePeriod> <timePeriodInSeconds> <status>
[<attribute>]↵
where:
Variable Field Type Valid Values Description

<alarmName> String 1 to 128 characters This parameter specifies the

alarm name.

<maxNum Integer 0 through 100000 This parameter specifies the

TrapsPerTime maximum number of traps for the
Period> time period.

<timePeriodIn Integer 1 through 2678400 This parameter specifies the time

Seconds> period (in seconds).

<status> Choice inactive, active This parameter determines if the

alarm is active or inactive.

<attribute> MultipleChoice problemTextVariable1, problem The name of an attribute to

TextVariable2, problemText modify. Note that problem text
Variable3, problemTextVariable4, variables can be defined.
problemTextVariable5

<problemText Integer 1 through 16 This parameter specifies a

Variable1> problem text variable filter (one of
five) that is defined per threshold.
When the agent compares the
content of this problem text
variable, the comparison is not
case sensitive.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 456
 Variable Field Type Valid Values Description

<problemText Integer 1 through 16 This parameter specifies a

Variable2> problem text variable filter (one of
five) that is defined per threshold.
When the agent compares the
content of this problem text
variable, the comparison is not
case sensitive.

<problemText Integer 1 through 16 This parameter specifies a

Variable3> problem text variable filter (one of
five) that is defined per threshold.
When the agent compares the
content of this problem text
variable, the comparison is not
case sensitive.

<problemText Integer 1 through 16 This parameter specifies a

Variable4> problem text variable filter (one of
five) that is defined per threshold.
When the agent compares the
content of this problem text
variable, the comparison is not
case sensitive.

<problemText Integer 1 through 16 This parameter specifies a

Variable5> problem text variable filter (one of
five) that is defined per threshold.
When the agent compares the
content of this problem text
variable, the comparison is not
case sensitive.

8.1.9.3 set
This command is used to modify a threshold against an alarm defined in the BroadWorks server.
1) Ensure you are at the /AS_CLI/Monitoring/Alarm/Threshold> level.
2) Enter:
set <alarmName> [<index>] <attribute>↵
where:
Variable Field Type Valid Values Description

<alarmName> String 1 to 128 characters This parameter specifies the

alarm name.

<index> Integer 0 through 65000 This parameter specifies the

index number.

<attribute> MultipleChoice maxNumTrapsPerTimePeriod, The name of an attribute to

timePeriodInSeconds, problem modify. Note that problem text
TextVariable1, problemText variables can be defined.
Variable2, problemTextVariable3,
problemTextVariable4, problem
TextVariable5, status

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 457
 Variable Field Type Valid Values Description

<maxNum Integer 0 through 100000 This parameter specifies the

TrapsPerTime maximum number of traps for the
Period> time period.

<timePeriodIn Integer 1 through 2678400 This parameter specifies the time

Seconds> period (in seconds).

<problemText Integer 1 through 16 This parameter specifies a

Variable1> problem text variable filter (one of
five) that is defined per threshold.
When the agent compares the
content of this problem text
variable, the comparison is not
case sensitive.

<problemText Integer 1 through 16 This parameter specifies a

Variable2> problem text variable filter (one of
five) that is defined per threshold.
When the agent compares the
content of this problem text
variable, the comparison is not
case sensitive.

<problemText Integer 1 through 16 This parameter specifies a

Variable3> problem text variable filter (one of
five) that is defined per threshold.
When the agent compares the
content of this problem text
variable, the comparison is not
case sensitive.

<problemText Integer 1 through 16 This parameter specifies a

Variable4> problem text variable filter (one of
five) that is defined per threshold.
When the agent compares the
content of this problem text
variable, the comparison is not
case sensitive.

<problemText Integer 1 through 16 This parameter specifies a

Variable5> problem text variable filter (one of
five) that is defined per threshold.
When the agent compares the
content of this problem text
variable, the comparison is not
case sensitive.

<status> Choice inactive, active This parameter determines if the

alarm is active or inactive.

8.1.9.4 delete
This command is used to delete an existing alarm threshold.
1) Ensure you are at the /AS_CLI/Monitoring/Alarm/Threshold> level.
2) Enter:
delete <alarmName> [<index>]↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 458
 where:
Variable Field Type Valid Values Description

<alarmName> String 1 to 128 characters This parameter specifies the

alarm name.

<index> Integer 0 through 65000 This parameter specifies the

index number.

8.1.9.5 clear
This command is used to clear all alarm threshold attributes.
1) Ensure you are at the /AS_CLI/Monitoring/Alarm/Threshold> level.
2) Enter:
clear <alarmName> [<index>] <attribute>↵
where:
Variable Field Type Valid Values Description

<alarmName> String 1 to 128 characters This parameter specifies the

alarm name.

<index> Integer 0 through 65000 This parameter specifies the

index number.

<attribute> MultipleChoice problemTextVariable1, problem The name of an attribute to

TextVariable2, problemText modify. Note that problem text
Variable3, problemTextVariable4, variables can be defined.
problemTextVariable5

8.1.9.6 Default
This level is used to set the system default alarm threshold attributes.
8.1.9.6.1 get
This command is used to view the system default alarm threshold attributes.
1) Ensure you are at the /AS_CLI/Monitoring/Alarm/Threshold/Default> level.
2) Enter:
get↵
8.1.9.6.2 set
This command is used to modify the system default alarm threshold attributes defined on the BroadWorks
server.
1) Ensure you are at the /AS_CLI/Monitoring/Alarm/Threshold/Default> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice maxNumTrapsPerTimePeriod, The name of an attribute to

timePeriodInSeconds, status, min modify.
Severity

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 459
 Variable Field Type Valid Values Description

<maxNum Integer 0 through 100000 This parameter specifies the

TrapsPerTime maximum number of traps for the
Period> time period.

<timePeriodIn Integer 1 through 2678400 This parameter specifies the time

Seconds> period (in seconds).

<status> Choice inactive, active This parameter determines if the

attribute is active or inactive.

<minSeverity> Choice informational, low, medium, high, This parameter determines

critical the severity level. Valid values
include: "informational", "low",
"medium", "high", and "critical".

8.2 PM
This level is used to navigate and view the values of the Management Information Base (MIB) nodes.
Performance Measurements (PMs) are used to monitor the BroadWorks server performance, as well as,
the operating system and hardware performance. To simplify navigation, PMs are organized in a tree
structure.

8.2.1 ConfigurationManagement
This level is used to navigate and view the values of the Management Information Base (MIB) nodes.
Performance Measurements (PMs) are used to monitor the BroadWorks server performance, as well as,
the operating system and hardware performance. To simplify navigation, PMs are organized in a tree
structure.

8.2.1.1 get
This command is used to view the Management Information Base (MIB) node values. MIB node values can
be viewed in the following ways: All performance measurements throughout the MIB nodes tree structure.
Performance measurements related to the current node. Performance measurements of a specified path.
1) Ensure you are at the /AS_CLI/Monitoring/PM/ConfigurationManagement> level.
2) Enter:
get [<option>] [<path>] [<tableKey>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -f This parameter displays

Performance Measurements
(PMs). Use the "-r" option to
display all PMs for the current
tree structure of the Management
Information Base (MIB) nodes.
Use the "-f" option to display a full
description of PMs.

<path> String 0 to 1023 characters This parameter specifies the path

of the node of the Performance
Measurements (PMs) to view.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 460
 Variable Field Type Valid Values Description

<tableKey> String 0 to 127 characters This parameter specifies the

value of a row key for a node (to
display as a table).

8.2.1.2 set
This command is used to modify a Management Information Base (MIB) node values.
1) Ensure you are at the /AS_CLI/Monitoring/PM/ConfigurationManagement> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> Choice counter, table The name of an attribute to

modify. Use the ''counter'' option
to set a scalar entry in a MIB
(outside of a table). Use the
''table'' option to set a value in a
table.

Variable: counter

counter This parameter specifies the

value of an individual counter.

<name> String 0 to 127 characters This nested parameter specifies

the name of a node in the
Management Information Base
(MIB).

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 461
 Variable Field Type Valid Values Description

Variable: table

table This parameter specifies the

value of the table, column, row, or
table entry.

<tableName> String 0 to 127 characters This nested parameter specifies

the name of a table in the
Management Information Base
(MIB).

<option> Choice all, column, row, entry This nested parameter

determines the options. Use
the "all" option to set all writable
values in a table at once. Use
the "column" option to set all
the writable values of a specific
column in a table. Use the "row"
option to set all the writable
values of a specific row in a
table. Use the "entry" option to
set a specific entry in a table;
specifying the row and column.

Variable: all

all This parameter specifies all of the

values in a table.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: column

column This parameter specifies the

values of a specific column in a
table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: row

row This parameter specifies the

values of a specific row in a table.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: entry

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 462
 Variable Field Type Valid Values Description

entry This parameter specifies the

values of a specific entry (row
and column) in a table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

8.2.1.3 cd
This command is used to navigate through the BroadWorks server Management Information Base (MIB)
nodes in a manner similar to the standard''cd''(change directory) command. Use the ''/''parameter to
navigate back to the root. Use the ''..''parameter to go back one level.
1) Ensure you are at the /AS_CLI/Monitoring/PM/ConfigurationManagement> level.
2) Enter:
cd [<path>]↵
where:
Variable Field Type Valid Values Description

<path> String 0 to 1023 characters This parameter specifies the CLI

context path.

8.2.1.4 ls
This command is used to view the next BroadWorks server Management Information Base (MIB) nodes in
a manner similar to the standard''ls''(list) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/ConfigurationManagement> level.
2) Enter:
ls [<option>] [<path>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -n This parameter determines the

options. Use the "-r" option to
show the tree structure of the
Management Information Base
(MIB) nodes. Use the "-n" option
to show the name of the nodes
containing values.

<path> String 0 to 1023 characters This parameter specifies the path

to the node.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 463
8.2.1.5 pwd
This command is used to view the current position in the BroadWorks server Management Information
Base (MIB) in a manner similar to the standard''pwd''(present working directory) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/ConfigurationManagement> level.
2) Enter:
pwd↵

8.2.2 Execution
This level is used to navigate and view the values of the Management Information Base (MIB) nodes.
Performance Measurements (PMs) are used to monitor the BroadWorks server performance, as well as,
the operating system and hardware performance. To simplify navigation, PMs are organized in a tree
structure.

8.2.2.1 get
This command is used to view the Management Information Base (MIB) node values. MIB node values can
be viewed in the following ways: All performance measurements throughout the MIB nodes tree structure.
Performance measurements related to the current node. Performance measurements of a specified path.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Execution> level.
2) Enter:
get [<option>] [<path>] [<tableKey>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -f This parameter displays

Performance Measurements
(PMs). Use the "-r" option to
display all PMs for the current
tree structure of the Management
Information Base (MIB) nodes.
Use the "-f" option to display a full
description of PMs.

<path> String 0 to 1023 characters This parameter specifies the path

of the node of the Performance
Measurements (PMs) to view.

<tableKey> String 0 to 127 characters This parameter specifies the

value of a row key for a node (to
display as a table).

8.2.2.2 set
This command is used to modify a Management Information Base (MIB) node values.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Execution> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 464
 Variable Field Type Valid Values Description

<attribute> Choice counter, table The name of an attribute to

modify. Use the ''counter'' option
to set a scalar entry in a MIB
(outside of a table). Use the
''table'' option to set a value in a
table.

Variable: counter

counter This parameter specifies the

value of an individual counter.

<name> String 0 to 127 characters This nested parameter specifies

the name of a node in the
Management Information Base
(MIB).

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 465
 Variable Field Type Valid Values Description

Variable: table

table This parameter specifies the

value of the table, column, row, or
table entry.

<tableName> String 0 to 127 characters This nested parameter specifies

the name of a table in the
Management Information Base
(MIB).

<option> Choice all, column, row, entry This nested parameter

determines the options. Use
the "all" option to set all writable
values in a table at once. Use
the "column" option to set all
the writable values of a specific
column in a table. Use the "row"
option to set all the writable
values of a specific row in a
table. Use the "entry" option to
set a specific entry in a table;
specifying the row and column.

Variable: all

all This parameter specifies all of the

values in a table.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: column

column This parameter specifies the

values of a specific column in a
table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: row

row This parameter specifies the

values of a specific row in a table.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: entry

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 466
 Variable Field Type Valid Values Description

entry This parameter specifies the

values of a specific entry (row
and column) in a table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

8.2.2.3 cd
This command is used to navigate through the BroadWorks server Management Information Base (MIB)
nodes in a manner similar to the standard''cd''(change directory) command. Use the ''/''parameter to
navigate back to the root. Use the ''..''parameter to go back one level.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Execution> level.
2) Enter:
cd [<path>]↵
where:
Variable Field Type Valid Values Description

<path> String 0 to 1023 characters This parameter specifies the CLI

context path.

8.2.2.4 ls
This command is used to view the next BroadWorks server Management Information Base (MIB) nodes in
a manner similar to the standard''ls''(list) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Execution> level.
2) Enter:
ls [<option>] [<path>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -n This parameter determines the

options. Use the "-r" option to
show the tree structure of the
Management Information Base
(MIB) nodes. Use the "-n" option
to show the name of the nodes
containing values.

<path> String 0 to 1023 characters This parameter specifies the path

to the node.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 467
8.2.2.5 pwd
This command is used to view the current position in the BroadWorks server Management Information
Base (MIB) in a manner similar to the standard''pwd''(present working directory) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Execution> level.
2) Enter:
pwd↵

8.2.3 HostRessources
This level is used to navigate and view the values of the Management Information Base (MIB) nodes.
Performance Measurements (PMs) are used to monitor the BroadWorks server performance, as well as,
the operating system and hardware performance. To simplify navigation, PMs are organized in a tree
structure.

8.2.3.1 get
This command is used to view the Management Information Base (MIB) node values. MIB node values can
be viewed in the following ways: All performance measurements throughout the MIB nodes tree structure.
Performance measurements related to the current node. Performance measurements of a specified path.
1) Ensure you are at the /AS_CLI/Monitoring/PM/HostRessources> level.
2) Enter:
get [<option>] [<path>] [<tableKey>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -f This parameter displays

Performance Measurements
(PMs). Use the "-r" option to
display all PMs for the current
tree structure of the Management
Information Base (MIB) nodes.
Use the "-f" option to display a full
description of PMs.

<path> String 0 to 1023 characters This parameter specifies the path

of the node of the Performance
Measurements (PMs) to view.

<tableKey> String 0 to 127 characters This parameter specifies the

value of a row key for a node (to
display as a table).

8.2.3.2 set
This command is used to modify a Management Information Base (MIB) node values.
1) Ensure you are at the /AS_CLI/Monitoring/PM/HostRessources> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 468
 Variable Field Type Valid Values Description

<attribute> Choice counter, table The name of an attribute to

modify. Use the ''counter'' option
to set a scalar entry in a MIB
(outside of a table). Use the
''table'' option to set a value in a
table.

Variable: counter

counter This parameter specifies the

value of an individual counter.

<name> String 0 to 127 characters This nested parameter specifies

the name of a node in the
Management Information Base
(MIB).

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 469
 Variable Field Type Valid Values Description

Variable: table

table This parameter specifies the

value of the table, column, row, or
table entry.

<tableName> String 0 to 127 characters This nested parameter specifies

the name of a table in the
Management Information Base
(MIB).

<option> Choice all, column, row, entry This nested parameter

determines the options. Use
the "all" option to set all writable
values in a table at once. Use
the "column" option to set all
the writable values of a specific
column in a table. Use the "row"
option to set all the writable
values of a specific row in a
table. Use the "entry" option to
set a specific entry in a table;
specifying the row and column.

Variable: all

all This parameter specifies all of the

values in a table.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: column

column This parameter specifies the

values of a specific column in a
table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: row

row This parameter specifies the

values of a specific row in a table.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: entry

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 470
 Variable Field Type Valid Values Description

entry This parameter specifies the

values of a specific entry (row
and column) in a table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

8.2.3.3 cd
This command is used to navigate through the BroadWorks server Management Information Base (MIB)
nodes in a manner similar to the standard''cd''(change directory) command. Use the ''/''parameter to
navigate back to the root. Use the ''..''parameter to go back one level.
1) Ensure you are at the /AS_CLI/Monitoring/PM/HostRessources> level.
2) Enter:
cd [<path>]↵
where:
Variable Field Type Valid Values Description

<path> String 0 to 1023 characters This parameter specifies the CLI

context path.

8.2.3.4 ls
This command is used to view the next BroadWorks server Management Information Base (MIB) nodes in
a manner similar to the standard''ls''(list) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/HostRessources> level.
2) Enter:
ls [<option>] [<path>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -n This parameter determines the

options. Use the "-r" option to
show the tree structure of the
Management Information Base
(MIB) nodes. Use the "-n" option
to show the name of the nodes
containing values.

<path> String 0 to 1023 characters This parameter specifies the path

to the node.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 471
8.2.3.5 pwd
This command is used to view the current position in the BroadWorks server Management Information
Base (MIB) in a manner similar to the standard''pwd''(present working directory) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/HostRessources> level.
2) Enter:
pwd↵

8.2.4 LicenseManager
This level is used to navigate and view the values of the Management Information Base (MIB) nodes.
Performance Measurements (PMs) are used to monitor the BroadWorks server performance, as well as,
the operating system and hardware performance. To simplify navigation, PMs are organized in a tree
structure.

8.2.4.1 get
This command is used to view the Management Information Base (MIB) node values. MIB node values can
be viewed in the following ways: All performance measurements throughout the MIB nodes tree structure.
Performance measurements related to the current node. Performance measurements of a specified path.
1) Ensure you are at the /AS_CLI/Monitoring/PM/LicenseManager> level.
2) Enter:
get [<option>] [<path>] [<tableKey>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -f This parameter displays

Performance Measurements
(PMs). Use the "-r" option to
display all PMs for the current
tree structure of the Management
Information Base (MIB) nodes.
Use the "-f" option to display a full
description of PMs.

<path> String 0 to 1023 characters This parameter specifies the path

of the node of the Performance
Measurements (PMs) to view.

<tableKey> String 0 to 127 characters This parameter specifies the

value of a row key for a node (to
display as a table).

8.2.4.2 set
This command is used to modify a Management Information Base (MIB) node values.
1) Ensure you are at the /AS_CLI/Monitoring/PM/LicenseManager> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 472
 Variable Field Type Valid Values Description

<attribute> Choice counter, table The name of an attribute to

modify. Use the ''counter'' option
to set a scalar entry in a MIB
(outside of a table). Use the
''table'' option to set a value in a
table.

Variable: counter

counter This parameter specifies the

value of an individual counter.

<name> String 0 to 127 characters This nested parameter specifies

the name of a node in the
Management Information Base
(MIB).

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 473
 Variable Field Type Valid Values Description

Variable: table

table This parameter specifies the

value of the table, column, row, or
table entry.

<tableName> String 0 to 127 characters This nested parameter specifies

the name of a table in the
Management Information Base
(MIB).

<option> Choice all, column, row, entry This nested parameter

determines the options. Use
the "all" option to set all writable
values in a table at once. Use
the "column" option to set all
the writable values of a specific
column in a table. Use the "row"
option to set all the writable
values of a specific row in a
table. Use the "entry" option to
set a specific entry in a table;
specifying the row and column.

Variable: all

all This parameter specifies all of the

values in a table.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: column

column This parameter specifies the

values of a specific column in a
table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: row

row This parameter specifies the

values of a specific row in a table.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: entry

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 474
 Variable Field Type Valid Values Description

entry This parameter specifies the

values of a specific entry (row
and column) in a table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

8.2.4.3 cd
This command is used to navigate through the BroadWorks server Management Information Base (MIB)
nodes in a manner similar to the standard''cd''(change directory) command. Use the ''/''parameter to
navigate back to the root. Use the ''..''parameter to go back one level.
1) Ensure you are at the /AS_CLI/Monitoring/PM/LicenseManager> level.
2) Enter:
cd [<path>]↵
where:
Variable Field Type Valid Values Description

<path> String 0 to 1023 characters This parameter specifies the CLI

context path.

8.2.4.4 ls
This command is used to view the next BroadWorks server Management Information Base (MIB) nodes in
a manner similar to the standard''ls''(list) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/LicenseManager> level.
2) Enter:
ls [<option>] [<path>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -n This parameter determines the

options. Use the "-r" option to
show the tree structure of the
Management Information Base
(MIB) nodes. Use the "-n" option
to show the name of the nodes
containing values.

<path> String 0 to 1023 characters This parameter specifies the path

to the node.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 475
8.2.4.5 pwd
This command is used to view the current position in the BroadWorks server Management Information
Base (MIB) in a manner similar to the standard''pwd''(present working directory) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/LicenseManager> level.
2) Enter:
pwd↵

8.2.5 Mib-II
This level is used to navigate and view the values of the Management Information Base (MIB) nodes.
Performance Measurements (PMs) are used to monitor the BroadWorks server performance, as well as,
the operating system and hardware performance. To simplify navigation, PMs are organized in a tree
structure.

8.2.5.1 get
This command is used to view the Management Information Base (MIB) node values. MIB node values can
be viewed in the following ways: All performance measurements throughout the MIB nodes tree structure.
Performance measurements related to the current node. Performance measurements of a specified path.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Mib-II> level.
2) Enter:
get [<option>] [<path>] [<tableKey>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -f This parameter displays

Performance Measurements
(PMs). Use the "-r" option to
display all PMs for the current
tree structure of the Management
Information Base (MIB) nodes.
Use the "-f" option to display a full
description of PMs.

<path> String 0 to 1023 characters This parameter specifies the path

of the node of the Performance
Measurements (PMs) to view.

<tableKey> String 0 to 127 characters This parameter specifies the

value of a row key for a node (to
display as a table).

8.2.5.2 set
This command is used to modify a Management Information Base (MIB) node values.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Mib-II> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 476
 Variable Field Type Valid Values Description

<attribute> Choice counter, table The name of an attribute to

modify. Use the ''counter'' option
to set a scalar entry in a MIB
(outside of a table). Use the
''table'' option to set a value in a
table.

Variable: counter

counter This parameter specifies the

value of an individual counter.

<name> String 0 to 127 characters This nested parameter specifies

the name of a node in the
Management Information Base
(MIB).

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 477
 Variable Field Type Valid Values Description

Variable: table

table This parameter specifies the

value of the table, column, row, or
table entry.

<tableName> String 0 to 127 characters This nested parameter specifies

the name of a table in the
Management Information Base
(MIB).

<option> Choice all, column, row, entry This nested parameter

determines the options. Use
the "all" option to set all writable
values in a table at once. Use
the "column" option to set all
the writable values of a specific
column in a table. Use the "row"
option to set all the writable
values of a specific row in a
table. Use the "entry" option to
set a specific entry in a table;
specifying the row and column.

Variable: all

all This parameter specifies all of the

values in a table.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: column

column This parameter specifies the

values of a specific column in a
table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: row

row This parameter specifies the

values of a specific row in a table.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: entry

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 478
 Variable Field Type Valid Values Description

entry This parameter specifies the

values of a specific entry (row
and column) in a table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

8.2.5.3 cd
This command is used to navigate through the BroadWorks server Management Information Base (MIB)
nodes in a manner similar to the standard''cd''(change directory) command. Use the ''/''parameter to
navigate back to the root. Use the ''..''parameter to go back one level.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Mib-II> level.
2) Enter:
cd [<path>]↵
where:
Variable Field Type Valid Values Description

<path> String 0 to 1023 characters This parameter specifies the CLI

context path.

8.2.5.4 ls
This command is used to view the next BroadWorks server Management Information Base (MIB) nodes in
a manner similar to the standard''ls''(list) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Mib-II> level.
2) Enter:
ls [<option>] [<path>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -n This parameter determines the

options. Use the "-r" option to
show the tree structure of the
Management Information Base
(MIB) nodes. Use the "-n" option
to show the name of the nodes
containing values.

<path> String 0 to 1023 characters This parameter specifies the path

to the node.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 479
8.2.5.5 pwd
This command is used to view the current position in the BroadWorks server Management Information
Base (MIB) in a manner similar to the standard''pwd''(present working directory) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Mib-II> level.
2) Enter:
pwd↵

8.2.6 OpenClientServer
This level is used to navigate and view the values of the Management Information Base (MIB) nodes.
Performance Measurements (PMs) are used to monitor the BroadWorks server performance, as well as,
the operating system and hardware performance. To simplify navigation, PMs are organized in a tree
structure.

8.2.6.1 get
This command is used to view the Management Information Base (MIB) node values. MIB node values can
be viewed in the following ways: All performance measurements throughout the MIB nodes tree structure.
Performance measurements related to the current node. Performance measurements of a specified path.
1) Ensure you are at the /AS_CLI/Monitoring/PM/OpenClientServer> level.
2) Enter:
get [<option>] [<path>] [<tableKey>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -f This parameter displays

Performance Measurements
(PMs). Use the "-r" option to
display all PMs for the current
tree structure of the Management
Information Base (MIB) nodes.
Use the "-f" option to display a full
description of PMs.

<path> String 0 to 1023 characters This parameter specifies the path

of the node of the Performance
Measurements (PMs) to view.

<tableKey> String 0 to 127 characters This parameter specifies the

value of a row key for a node (to
display as a table).

8.2.6.2 set
This command is used to modify a Management Information Base (MIB) node values.
1) Ensure you are at the /AS_CLI/Monitoring/PM/OpenClientServer> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 480
 Variable Field Type Valid Values Description

<attribute> Choice counter, table The name of an attribute to

modify. Use the ''counter'' option
to set a scalar entry in a MIB
(outside of a table). Use the
''table'' option to set a value in a
table.

Variable: counter

counter This parameter specifies the

value of an individual counter.

<name> String 0 to 127 characters This nested parameter specifies

the name of a node in the
Management Information Base
(MIB).

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 481
 Variable Field Type Valid Values Description

Variable: table

table This parameter specifies the

value of the table, column, row, or
table entry.

<tableName> String 0 to 127 characters This nested parameter specifies

the name of a table in the
Management Information Base
(MIB).

<option> Choice all, column, row, entry This nested parameter

determines the options. Use
the "all" option to set all writable
values in a table at once. Use
the "column" option to set all
the writable values of a specific
column in a table. Use the "row"
option to set all the writable
values of a specific row in a
table. Use the "entry" option to
set a specific entry in a table;
specifying the row and column.

Variable: all

all This parameter specifies all of the

values in a table.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: column

column This parameter specifies the

values of a specific column in a
table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: row

row This parameter specifies the

values of a specific row in a table.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: entry

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 482
 Variable Field Type Valid Values Description

entry This parameter specifies the

values of a specific entry (row
and column) in a table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

8.2.6.3 cd
This command is used to navigate through the BroadWorks server Management Information Base (MIB)
nodes in a manner similar to the standard''cd''(change directory) command. Use the ''/''parameter to
navigate back to the root. Use the ''..''parameter to go back one level.
1) Ensure you are at the /AS_CLI/Monitoring/PM/OpenClientServer> level.
2) Enter:
cd [<path>]↵
where:
Variable Field Type Valid Values Description

<path> String 0 to 1023 characters This parameter specifies the CLI

context path.

8.2.6.4 ls
This command is used to view the next BroadWorks server Management Information Base (MIB) nodes in
a manner similar to the standard''ls''(list) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/OpenClientServer> level.
2) Enter:
ls [<option>] [<path>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -n This parameter determines the

options. Use the "-r" option to
show the tree structure of the
Management Information Base
(MIB) nodes. Use the "-n" option
to show the name of the nodes
containing values.

<path> String 0 to 1023 characters This parameter specifies the path

to the node.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 483
8.2.6.5 pwd
This command is used to view the current position in the BroadWorks server Management Information
Base (MIB) in a manner similar to the standard''pwd''(present working directory) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/OpenClientServer> level.
2) Enter:
pwd↵

8.2.7 Provisioning
This level is used to navigate and view the values of the Management Information Base (MIB) nodes.
Performance Measurements (PMs) are used to monitor the BroadWorks server performance, as well as,
the operating system and hardware performance. To simplify navigation, PMs are organized in a tree
structure.

8.2.7.1 get
This command is used to view the Management Information Base (MIB) node values. MIB node values can
be viewed in the following ways: All performance measurements throughout the MIB nodes tree structure.
Performance measurements related to the current node. Performance measurements of a specified path.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Provisioning> level.
2) Enter:
get [<option>] [<path>] [<tableKey>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -f This parameter displays

Performance Measurements
(PMs). Use the "-r" option to
display all PMs for the current
tree structure of the Management
Information Base (MIB) nodes.
Use the "-f" option to display a full
description of PMs.

<path> String 0 to 1023 characters This parameter specifies the path

of the node of the Performance
Measurements (PMs) to view.

<tableKey> String 0 to 127 characters This parameter specifies the

value of a row key for a node (to
display as a table).

8.2.7.2 set
This command is used to modify a Management Information Base (MIB) node values.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Provisioning> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 484
 Variable Field Type Valid Values Description

<attribute> Choice counter, table The name of an attribute to

modify. Use the ''counter'' option
to set a scalar entry in a MIB
(outside of a table). Use the
''table'' option to set a value in a
table.

Variable: counter

counter This parameter specifies the

value of an individual counter.

<name> String 0 to 127 characters This nested parameter specifies

the name of a node in the
Management Information Base
(MIB).

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 485
 Variable Field Type Valid Values Description

Variable: table

table This parameter specifies the

value of the table, column, row, or
table entry.

<tableName> String 0 to 127 characters This nested parameter specifies

the name of a table in the
Management Information Base
(MIB).

<option> Choice all, column, row, entry This nested parameter

determines the options. Use
the "all" option to set all writable
values in a table at once. Use
the "column" option to set all
the writable values of a specific
column in a table. Use the "row"
option to set all the writable
values of a specific row in a
table. Use the "entry" option to
set a specific entry in a table;
specifying the row and column.

Variable: all

all This parameter specifies all of the

values in a table.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: column

column This parameter specifies the

values of a specific column in a
table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: row

row This parameter specifies the

values of a specific row in a table.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: entry

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 486
 Variable Field Type Valid Values Description

entry This parameter specifies the

values of a specific entry (row
and column) in a table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

8.2.7.3 cd
This command is used to navigate through the BroadWorks server Management Information Base (MIB)
nodes in a manner similar to the standard''cd''(change directory) command. Use the ''/''parameter to
navigate back to the root. Use the ''..''parameter to go back one level.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Provisioning> level.
2) Enter:
cd [<path>]↵
where:
Variable Field Type Valid Values Description

<path> String 0 to 1023 characters This parameter specifies the CLI

context path.

8.2.7.4 ls
This command is used to view the next BroadWorks server Management Information Base (MIB) nodes in
a manner similar to the standard''ls''(list) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Provisioning> level.
2) Enter:
ls [<option>] [<path>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -n This parameter determines the

options. Use the "-r" option to
show the tree structure of the
Management Information Base
(MIB) nodes. Use the "-n" option
to show the name of the nodes
containing values.

<path> String 0 to 1023 characters This parameter specifies the path

to the node.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 487
8.2.7.5 pwd
This command is used to view the current position in the BroadWorks server Management Information
Base (MIB) in a manner similar to the standard''pwd''(present working directory) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Provisioning> level.
2) Enter:
pwd↵

8.2.8 Subscriber
This level is used to navigate and view the values of the Management Information Base (MIB) nodes.
Performance Measurements (PMs) are used to monitor the BroadWorks server performance, as well as,
the operating system and hardware performance. To simplify navigation, PMs are organized in a tree
structure.

8.2.8.1 get
This command is used to view the Management Information Base (MIB) node values. MIB node values can
be viewed in the following ways: All performance measurements throughout the MIB nodes tree structure.
Performance measurements related to the current node. Performance measurements of a specified path.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Subscriber> level.
2) Enter:
get [<option>] [<path>] [<tableKey>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -f This parameter displays

Performance Measurements
(PMs). Use the "-r" option to
display all PMs for the current
tree structure of the Management
Information Base (MIB) nodes.
Use the "-f" option to display a full
description of PMs.

<path> String 0 to 1023 characters This parameter specifies the path

of the node of the Performance
Measurements (PMs) to view.

<tableKey> String 0 to 127 characters This parameter specifies the

value of a row key for a node (to
display as a table).

8.2.8.2 set
This command is used to modify a Management Information Base (MIB) node values.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Subscriber> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 488
 Variable Field Type Valid Values Description

<attribute> Choice counter, table The name of an attribute to

modify. Use the ''counter'' option
to set a scalar entry in a MIB
(outside of a table). Use the
''table'' option to set a value in a
table.

Variable: counter

counter This parameter specifies the

value of an individual counter.

<name> String 0 to 127 characters This nested parameter specifies

the name of a node in the
Management Information Base
(MIB).

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 489
 Variable Field Type Valid Values Description

Variable: table

table This parameter specifies the

value of the table, column, row, or
table entry.

<tableName> String 0 to 127 characters This nested parameter specifies

the name of a table in the
Management Information Base
(MIB).

<option> Choice all, column, row, entry This nested parameter

determines the options. Use
the "all" option to set all writable
values in a table at once. Use
the "column" option to set all
the writable values of a specific
column in a table. Use the "row"
option to set all the writable
values of a specific row in a
table. Use the "entry" option to
set a specific entry in a table;
specifying the row and column.

Variable: all

all This parameter specifies all of the

values in a table.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: column

column This parameter specifies the

values of a specific column in a
table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: row

row This parameter specifies the

values of a specific row in a table.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: entry

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 490
 Variable Field Type Valid Values Description

entry This parameter specifies the

values of a specific entry (row
and column) in a table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

8.2.8.3 cd
This command is used to navigate through the BroadWorks server Management Information Base (MIB)
nodes in a manner similar to the standard''cd''(change directory) command. Use the ''/''parameter to
navigate back to the root. Use the ''..''parameter to go back one level.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Subscriber> level.
2) Enter:
cd [<path>]↵
where:
Variable Field Type Valid Values Description

<path> String 0 to 1023 characters This parameter specifies the CLI

context path.

8.2.8.4 ls
This command is used to view the next BroadWorks server Management Information Base (MIB) nodes in
a manner similar to the standard''ls''(list) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Subscriber> level.
2) Enter:
ls [<option>] [<path>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -n This parameter determines the

options. Use the "-r" option to
show the tree structure of the
Management Information Base
(MIB) nodes. Use the "-n" option
to show the name of the nodes
containing values.

<path> String 0 to 1023 characters This parameter specifies the path

to the node.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 491
8.2.8.5 pwd
This command is used to view the current position in the BroadWorks server Management Information
Base (MIB) in a manner similar to the standard''pwd''(present working directory) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/Subscriber> level.
2) Enter:
pwd↵

8.2.9 UCD-SNMP
This level is used to navigate and view the values of the Management Information Base (MIB) nodes.
Performance Measurements (PMs) are used to monitor the BroadWorks server performance, as well as,
the operating system and hardware performance. To simplify navigation, PMs are organized in a tree
structure.

8.2.9.1 get
This command is used to view the Management Information Base (MIB) node values. MIB node values can
be viewed in the following ways: All performance measurements throughout the MIB nodes tree structure.
Performance measurements related to the current node. Performance measurements of a specified path.
1) Ensure you are at the /AS_CLI/Monitoring/PM/UCD-SNMP> level.
2) Enter:
get [<option>] [<path>] [<tableKey>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -f This parameter displays

Performance Measurements
(PMs). Use the "-r" option to
display all PMs for the current
tree structure of the Management
Information Base (MIB) nodes.
Use the "-f" option to display a full
description of PMs.

<path> String 0 to 1023 characters This parameter specifies the path

of the node of the Performance
Measurements (PMs) to view.

<tableKey> String 0 to 127 characters This parameter specifies the

value of a row key for a node (to
display as a table).

8.2.9.2 set
This command is used to modify a Management Information Base (MIB) node values.
1) Ensure you are at the /AS_CLI/Monitoring/PM/UCD-SNMP> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 492
 Variable Field Type Valid Values Description

<attribute> Choice counter, table The name of an attribute to

modify. Use the ''counter'' option
to set a scalar entry in a MIB
(outside of a table). Use the
''table'' option to set a value in a
table.

Variable: counter

counter This parameter specifies the

value of an individual counter.

<name> String 0 to 127 characters This nested parameter specifies

the name of a node in the
Management Information Base
(MIB).

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 493
 Variable Field Type Valid Values Description

Variable: table

table This parameter specifies the

value of the table, column, row, or
table entry.

<tableName> String 0 to 127 characters This nested parameter specifies

the name of a table in the
Management Information Base
(MIB).

<option> Choice all, column, row, entry This nested parameter

determines the options. Use
the "all" option to set all writable
values in a table at once. Use
the "column" option to set all
the writable values of a specific
column in a table. Use the "row"
option to set all the writable
values of a specific row in a
table. Use the "entry" option to
set a specific entry in a table;
specifying the row and column.

Variable: all

all This parameter specifies all of the

values in a table.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: column

column This parameter specifies the

values of a specific column in a
table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: row

row This parameter specifies the

values of a specific row in a table.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: entry

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 494
 Variable Field Type Valid Values Description

entry This parameter specifies the

values of a specific entry (row
and column) in a table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

8.2.9.3 cd
This command is used to navigate through the BroadWorks server Management Information Base (MIB)
nodes in a manner similar to the standard''cd''(change directory) command. Use the ''/''parameter to
navigate back to the root. Use the ''..''parameter to go back one level.
1) Ensure you are at the /AS_CLI/Monitoring/PM/UCD-SNMP> level.
2) Enter:
cd [<path>]↵
where:
Variable Field Type Valid Values Description

<path> String 0 to 1023 characters This parameter specifies the CLI

context path.

8.2.9.4 ls
This command is used to view the next BroadWorks server Management Information Base (MIB) nodes in
a manner similar to the standard''ls''(list) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/UCD-SNMP> level.
2) Enter:
ls [<option>] [<path>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -n This parameter determines the

options. Use the "-r" option to
show the tree structure of the
Management Information Base
(MIB) nodes. Use the "-n" option
to show the name of the nodes
containing values.

<path> String 0 to 1023 characters This parameter specifies the path

to the node.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 495
8.2.9.5 pwd
This command is used to view the current position in the BroadWorks server Management Information
Base (MIB) in a manner similar to the standard''pwd''(present working directory) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/UCD-SNMP> level.
2) Enter:
pwd↵

8.2.10 WebContainer
This level is used to navigate and view the values of the Management Information Base (MIB) nodes.
Performance Measurements (PMs) are used to monitor the BroadWorks server performance, as well as,
the operating system and hardware performance. To simplify navigation, PMs are organized in a tree
structure.

8.2.10.1 get
This command is used to view the Management Information Base (MIB) node values. MIB node values can
be viewed in the following ways: All performance measurements throughout the MIB nodes tree structure.
Performance measurements related to the current node. Performance measurements of a specified path.
1) Ensure you are at the /AS_CLI/Monitoring/PM/WebContainer> level.
2) Enter:
get [<option>] [<path>] [<tableKey>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -f This parameter displays

Performance Measurements
(PMs). Use the "-r" option to
display all PMs for the current
tree structure of the Management
Information Base (MIB) nodes.
Use the "-f" option to display a full
description of PMs.

<path> String 0 to 1023 characters This parameter specifies the path

of the node of the Performance
Measurements (PMs) to view.

<tableKey> String 0 to 127 characters This parameter specifies the

value of a row key for a node (to
display as a table).

8.2.10.2 set
This command is used to modify a Management Information Base (MIB) node values.
1) Ensure you are at the /AS_CLI/Monitoring/PM/WebContainer> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 496
 Variable Field Type Valid Values Description

<attribute> Choice counter, table The name of an attribute to

modify. Use the ''counter'' option
to set a scalar entry in a MIB
(outside of a table). Use the
''table'' option to set a value in a
table.

Variable: counter

counter This parameter specifies the

value of an individual counter.

<name> String 0 to 127 characters This nested parameter specifies

the name of a node in the
Management Information Base
(MIB).

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 497
 Variable Field Type Valid Values Description

Variable: table

table This parameter specifies the

value of the table, column, row, or
table entry.

<tableName> String 0 to 127 characters This nested parameter specifies

the name of a table in the
Management Information Base
(MIB).

<option> Choice all, column, row, entry This nested parameter

determines the options. Use
the "all" option to set all writable
values in a table at once. Use
the "column" option to set all
the writable values of a specific
column in a table. Use the "row"
option to set all the writable
values of a specific row in a
table. Use the "entry" option to
set a specific entry in a table;
specifying the row and column.

Variable: all

all This parameter specifies all of the

values in a table.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: column

column This parameter specifies the

values of a specific column in a
table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: row

row This parameter specifies the

values of a specific row in a table.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

Variable: entry

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 498
 Variable Field Type Valid Values Description

entry This parameter specifies the

values of a specific entry (row
and column) in a table.

<columnName> String 0 to 127 characters This nested parameter specifies

the name of a column.

<rowKey> Integer 0 through 2147483647 This nested parameter specifies

the value of a row index or key.

<value> Integer 0 through 2147483647 This nested parameter specifies

the value of a counter.

8.2.10.3 cd
This command is used to navigate through the BroadWorks server Management Information Base (MIB)
nodes in a manner similar to the standard''cd''(change directory) command. Use the ''/''parameter to
navigate back to the root. Use the ''..''parameter to go back one level.
1) Ensure you are at the /AS_CLI/Monitoring/PM/WebContainer> level.
2) Enter:
cd [<path>]↵
where:
Variable Field Type Valid Values Description

<path> String 0 to 1023 characters This parameter specifies the CLI

context path.

8.2.10.4 ls
This command is used to view the next BroadWorks server Management Information Base (MIB) nodes in
a manner similar to the standard''ls''(list) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/WebContainer> level.
2) Enter:
ls [<option>] [<path>]↵
where:
Variable Field Type Valid Values Description

<option> MultipleChoice -r, -n This parameter determines the

options. Use the "-r" option to
show the tree structure of the
Management Information Base
(MIB) nodes. Use the "-n" option
to show the name of the nodes
containing values.

<path> String 0 to 1023 characters This parameter specifies the path

to the node.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 499
8.2.10.5 pwd
This command is used to view the current position in the BroadWorks server Management Information
Base (MIB) in a manner similar to the standard''pwd''(present working directory) command.
1) Ensure you are at the /AS_CLI/Monitoring/PM/WebContainer> level.
2) Enter:
pwd↵

8.3 ProtocolMonitor
The Protocol Monitor Tool (PMT) is a low-level diagnostic tool that is used by the system administrator
to visualize the Application Server signaling pane (in-bound, out-bound). It can be used in conjunction
with other tools to identify a global service or network failure by validating the basic responsiveness of the
Application Server. The message trace provided helps a system administrator identify incorrect system or
user configuration resulting in a partial system malfunction.
The PMT is a specialized class of network protocol analyzer. It appears in a human readable form of
relevant application protocol data such as SIP, MGCP, SMTP, and so on, and eliminates all underlying
protocol data such as TCP/IP, Ethernet, and so on.
The PMT can be activated for a user and different protocols. When activated, the Application Server
delivers a readable representation of any message from the specified protocols that are related to the
specified user.
The PMT allows monitoring of all messages from protocols like SIP, MGCP, ASR, SMTP, POP3, and
IMAP.
All or designated protocols can be included in any trace. Relevant application protocol data for the
following protocols can be viewed:
* ACC protocol
* Application Server Redundancy protocol (ASR)
* Call Processing protocol (CallP)
* Internet Messaging Access Protocol (IMAP)
* Media Gateway Controller Protocol (MGCP)
* Post Office Protocol 3 (POP3)
* Session Initiated Protocol (SIP)
* Simple Mail Transfer Protocol (SMTP)
* Wireless Session Protocol (WSP)
A subscriber's DN, user ID, or group ID/extension is used to create a trace. More than one administrator
can monitor a subscriber at a time. However, each monitoring administrator sees only the protocol monitor
subscriber messages created by that administrator ID. Messages can be written to the screen or to a file.
Monitors opened by an administrator are closed when the Application Server reboots, when an
administrator is deleted from the system, or when a subscriber is deleted from the system.

8.3.1 get
Protocol monitor-related attributes, such as user ID, phone, group/extension, and device information, are
viewed using this command.
1) Ensure you are at the /AS_CLI/Monitoring/ProtocolMonitor> level.
2) Enter:
get [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice userId, phone, groupExtension, The name of an attribute to filter

deviceAddress, groupDevice on.
Name, serviceProviderDevice
Name, systemDeviceName

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 500
 Variable Field Type Valid Values Description

<userId> String 2 to 161 characters The userId command followed by

the authentication user ID name
of a subscriber to monitor.

<phone> String 0 to 23 characters The phone number command,

followed by the directory number
of the subscriber to monitor.

Variable: groupExtension

groupExtension The ID of the group followed by

the user extension.

<groupId> String 1 to 30 characters The ID of the group.

<extension> String 2 to 20 characters The user extension.

<device String 1 to 80 characters The IP address, host name, or

Address> domain name.

Variable: groupDeviceName

groupDeviceName Service provider.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The ID of the group.

<deviceName> String 1 to 40 characters The name of the device.

Variable: serviceProviderDeviceName

serviceProviderDeviceName The name of the service provider

device.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device.

Variable: systemDeviceName

systemDeviceName The name of the system device.

<deviceName> String 1 to 40 characters The name of the device.

8.3.2 add
Protocol monitor-related attributes, such as adding a monitor and protocols, are completed using this
command. A monitor can be added for a specific user on the system, as well as for a list of protocols. If the
protocol command is not used, all valid protocols are monitored.
1) Ensure you are at the /AS_CLI/Monitoring/ProtocolMonitor> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 501
 add <attribute> [<Protocols>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice userId, phone, groupExtension, Additional attributes to include

deviceAddress, groupDevice through the add command.
Name, serviceProviderDevice
Name, systemDeviceName

<userId> String 2 to 161 characters The userId command followed by

the authentication user ID name
of a subscriber to monitor.

<phone> String 0 to 23 characters The phone number command,

followed by the directory number
of the subscriber to monitor.

Variable: groupExtension

groupExtension The ID of the group followed by

the user extension.

<groupId> String 1 to 30 characters The ID of the group.

<extension> String 2 to 20 characters The user extension.

<device String 1 to 80 characters The IP address, host name, or

Address> domain name.

Variable: groupDeviceName

groupDeviceName Service provider.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The ID of the group.

<deviceName> String 1 to 40 characters The name of the device.

Variable: serviceProviderDeviceName

serviceProviderDeviceName The name of the service provider

device.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device.

Variable: systemDeviceName

systemDeviceName The name of the system device.

<deviceName> String 1 to 40 characters The name of the device.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 502
 Variable Field Type Valid Values Description

<Protocols> MultipleChoice acc, asr, callp, imap, mgcp, pop3, Specifies the name of a protocol
sip, smtp, timer, wsp, all to monitor.

<acc> Choice true, false Enables monitoring the ACC

protocol.

<asr> Choice true, false Enables monitoring the ASR

protocol.

<callp> Choice true, false Enables monitoring the CallP

protocol.

<imap> Choice true, false Enables monitoring the IMAP

protocol.

<mgcp> Choice true, false Enables monitoring the MGCP

protocol.

<pop3> Choice true, false Enables monitoring the POP3

protocol.

<sip> Choice true, false Enables monitoring the SIP

protocol.

<smtp> Choice true, false Enables monitoring the SMTP

protocol.

<timer> Choice true, false Enables monitoring the TIMERS.

<wsp> Choice true, false Enables monitoring the WSP

protocol.

<all> Choice true, false Enables monitoring all protocols.

8.3.3 set
Protocol monitor-related attributes, such as the protocols to monitor for a subscriber, are modified using
this command.
1) Ensure you are at the /AS_CLI/Monitoring/ProtocolMonitor> level.
2) Enter:
set <attribute> <Protocols>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice userId, phone, groupExtension,

deviceAddress, groupDevice
Name, serviceProviderDevice
Name, systemDeviceName

<userId> String 2 to 161 characters The userId command followed by

the authentication user ID name
of a subscriber to monitor.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 503
 Variable Field Type Valid Values Description

<phone> String 0 to 23 characters The phone number command,

followed by the directory number
of the subscriber to monitor.

Variable: groupExtension

groupExtension The ID of the group followed by

the user extension.

<groupId> String 1 to 30 characters The ID of the group.

<extension> String 2 to 20 characters The user extension.

<device String 1 to 80 characters The IP address, host name, or

Address> domain name.

Variable: groupDeviceName

groupDeviceName Service provider.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The ID of the group.

<deviceName> String 1 to 40 characters The name of the device.

Variable: serviceProviderDeviceName

serviceProviderDeviceName The name of the service provider

device.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device.

Variable: systemDeviceName

systemDeviceName The name of the system device.

<deviceName> String 1 to 40 characters The name of the device.

<Protocols> MultipleChoice acc, asr, callp, imap, mgcp, pop3, Specifies the name of a protocol
sip, smtp, timer, wsp, all to monitor.

<acc> Choice true, false Enables monitoring the ACC

protocol.

<asr> Choice true, false Enables monitoring the ASR

protocol.

<callp> Choice true, false Enables monitoring the CallP

protocol.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 504
 Variable Field Type Valid Values Description

<imap> Choice true, false Enables monitoring the IMAP

protocol.

<mgcp> Choice true, false Enables monitoring the MGCP

protocol.

<pop3> Choice true, false Enables monitoring the POP3

protocol.

<sip> Choice true, false Enables monitoring the SIP

protocol.

<smtp> Choice true, false Enables monitoring the SMTP

protocol.

<timer> Choice true, false Enables monitoring the TIMERS.

<wsp> Choice true, false Enables monitoring the WSP

protocol.

<all> Choice true, false Enables monitoring all protocols.

8.3.4 delete
Protocol monitor-related attributes, such as removing a subscriber to monitor, are completed using this
command. The command, without attributes, removes all monitors for all subscribers.
1) Ensure you are at the /AS_CLI/Monitoring/ProtocolMonitor> level.
2) Enter:
delete [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice userId, phone, groupExtension,

deviceAddress, groupDevice
Name, serviceProviderDevice
Name, systemDeviceName

<userId> String 2 to 161 characters The userId command followed by

the authentication user ID name
of a subscriber to monitor.

<phone> String 0 to 23 characters The phone number command,

followed by the directory number
of the subscriber to monitor.

Variable: groupExtension

groupExtension The ID of the group followed by

the user extension.

<groupId> String 1 to 30 characters The ID of the group.

<extension> String 2 to 20 characters The user extension.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 505
 Variable Field Type Valid Values Description

<device String 1 to 80 characters The IP address, host name, or

Address> domain name.

Variable: groupDeviceName

groupDeviceName Service provider.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The ID of the group.

<deviceName> String 1 to 40 characters The name of the device.

Variable: serviceProviderDeviceName

serviceProviderDeviceName The name of the service provider

device.

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device.

Variable: systemDeviceName

systemDeviceName The name of the system device.

<deviceName> String 1 to 40 characters The name of the device.

8.3.5 dumpToCLI
Protocol Monitor-related outputs, such as redirecting the monitoring output to the CLI, are completed using
this command.
1) Ensure you are at the /AS_CLI/Monitoring/ProtocolMonitor> level.
2) Enter:
dumpToCLI <action>↵
where:
Variable Field Type Valid Values Description

<action> Choice start, stop, status Controls the dumping of the

Protocol Monitor information to
the CLI.

8.3.6 dumpToFile
Protocol Monitor-related outputs, such as redirecting monitoring output to file, are completed using this
command.
1) Ensure you are at the /AS_CLI/Monitoring/ProtocolMonitor> level.
2) Enter:
dumpToFile <action>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 506
 where:
Variable Field Type Valid Values Description

<action> Choice start, stop, status Controls the dumping of the

Protocol Monitor information to
the CLI.

Variable: start

start Start dumping to file.

<fileName> String 1 to 300 characters The name of the dump file written
to disk.

8.4 Report
This level is used to generate reports from the Simple Network Management Protocol (SNMP)
Management Information Base (MIB). The BroadWorks server has a performance reporting tool used to
view a node's historical data, as well as the current load, and system health.

8.4.1 get
This command is used to display report-related attributes.
1) Ensure you are at the /AS_CLI/Monitoring/Report> level.
2) Enter:
get↵

8.4.2 set
This command is used to modify report-related attributes.
1) Ensure you are at the /AS_CLI/Monitoring/Report> level.
2) Enter:
set [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice pollingIntervalInMin, numberOf The name of an attribute to

ReportingDays modify.

<pollingInterval Choice 15, 30, 60, 720, 1440 The number of minutes between
InMin> reporting checks of the system.

<numberOf Integer 1 through 30 The number of days to report

Reporting when polling.
Days>

8.4.3 current
This command is used to display current (real-time) server statistics such as the number of active OSS and
sync sessions.
1) Ensure you are at the /AS_CLI/Monitoring/Report> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 507
 current↵

8.4.4 historyStats
This command is used to display server history statistics stored in the recent statistics file, which can be
displayed for the last month or a specific day in the last month.
1) Ensure you are at the /AS_CLI/Monitoring/Report> level.
2) Enter:
historyStats [<day>]↵
where:
Variable Field Type Valid Values Description

<day> Integer 1 through 31 Date of reporting information to

view.

8.4.5 recent
This command is used to display recent server statistics. The Recent Statistics Report displays data for the
last 24 hours and includes totals.
1) Ensure you are at the /AS_CLI/Monitoring/Report> level.
2) Enter:
recent↵

8.5 Threshold
The level is used to define thresholds against counters and gauges as defined in the BroadWorks server
Management Information Base (MIB).

8.5.1 get
This command is used to list thresholds defined on the BroadWorks server.
1) Ensure you are at the /AS_CLI/Monitoring/Threshold> level.
2) Enter:
get <attribute> [<option>]↵
where:
Variable Field Type Valid Values Description

<attribute> Choice counter, gauge Type of Management Information

Base (MIB) node to monitor, can
either be a "counter" or a "gauge".
Refer to the application specific
performance MIB for a list or
counters and gauges.

<option> MultipleChoice name, severity, description Option to filter on for the get
operation.

<name> String 1 to 80 characters The gauge of a counter in the

Management Information Base
(MIB).If used, the Get command
applies a case-sensitive prefix
match on all counter names.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 508
 Variable Field Type Valid Values Description

<severity> MultipleChoice informational, low, medium, high, "inactive": The threshold is

critical inactive."active": The threshold is
active.

<description> String 1 to 80 characters An operator-defined description of

this threshold.

8.5.2 add
This command is used to add a new threshold against a counter or gauge defined in the BroadWorks
server Management Information Base (MIB).
1) Ensure you are at the /AS_CLI/Monitoring/Threshold> level.
2) Enter:
add <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> Choice counter, gauge Type of Management Information

Base (MIB) node to monitor, can
either be a "counter" or a "gauge".
Refer to the application specific
performance MIB for a list or
counters and gauges.

Variable: counter

counter Counter based threshold.

<counter String 1 to 80 characters An operator-defined description of

Description> this threshold.

<counter String 1 to 80 characters The name of a counter in the

Name> Management Information Base
(MIB).

<initialValue> Integer 0 through 2147483647 When the counter is reset to 0,

the current comparison level is
set to this value.

<offsetValue> Integer 1 through 2147483647 The increment added to the

current comparison value
whenever the counter crosses the
current comparison value; may be
set to 0.

<severity> Choice informational, low, medium, high, "inactive": The threshold is

critical inactive."active": The threshold is
active.

<status> Choice inactive, active Inactive: The threshold is inactive.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 509
 Variable Field Type Valid Values Description

Variable: gauge

gauge Gauge based threshold.

<gauge String 1 to 80 characters An operator defined description of

Description> this threshold.

<gaugeName> String 1 to 80 characters The name of a gauge in the MIB.

<notifyLow> Integer 0 through 2147483647 The gauge value at which an

alarm is generated when the
gauge value reaches or crosses
the NotifyLow level in a falling
direction. Subsequent similar
crossings of the NotifyLow level
do not generate an alarm until the
gauge has reached or crossed
the corresponding NotifyHigh
level.

<notifyHigh> Integer 0 through 2147483647 The gauge value at which an

alarm is generated when the
gauge value reaches or crosses
the NotifyHigh level in a rising
direction. Subsequent similar
crossings of the NotifyHigh level
do not generate an alarm until the
gauge has reached or crossed
the corresponding NotifyLow
level.

<severity> Choice informational, low, medium, high, "inactive": The threshold is

critical inactive."active": The threshold is
active.

<status> Choice inactive, active Inactive: The threshold is inactive.

8.5.3 set
This command is used to modify threshold attributes.
1) Ensure you are at the /AS_CLI/Monitoring/Threshold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> Choice counter, gauge Type of MIB node to monitor,

can either be a "counter" or a
"gauge". Refer to the application
specific performance MIB for a list
or counters and gauges.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 510
 Variable Field Type Valid Values Description

Variable: counter

counter Counter based threshold.

<counter String 1 to 80 characters The name of a counter in the

Name> MIB.

<attribute> MultipleChoice description, initialValue, offset Type of MIB node to monitor,

Value, severity, status, rowIndex can either be a "counter" or a
"gauge". Refer to the application
specific performance MIB for a list
or counters and gauges.

<description> String 1 to 80 characters An operator-defined description of

this threshold.

<initialValue> Integer 0 through 2147483647 When the counter is reset to 0,

the current comparison level is
set to this value.

<offsetValue> Integer 1 through 2147483647 The increment added to the

current comparison value
whenever the counter crosses the
current comparison value; may be
set to 0.

<severity> Choice informational, low, medium, high, "inactive": The threshold is

critical inactive."active": The threshold is
active.

<status> Choice inactive, active Inactive: The threshold is inactive.

<rowIndex> Integer 0 through 65000 Optional parameter used to

reference a specific threshold
when two thresholds for the same
counter name are defined.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 511
 Variable Field Type Valid Values Description

Variable: gauge

gauge Gauge based threshold.

<gaugeName> String 1 to 80 characters The name of a gauge in the

Management Information Base
(MIB).

<attribute> MultipleChoice description, notifyLow, notifyHigh, Type of MIB node to monitor,

severity, status, rowIndex can either be a "counter" or a
"gauge". Refer to the application
specific performance MIB for a list
or counters and gauges.

<description> String 1 to 80 characters An operator-defined description of

this threshold.

<notifyLow> Integer 0 through 2147483647 The gauge value at which an

alarm is generated when the
gauge value reaches or crosses
the NotifyLow level in a falling
direction. Subsequent similar
crossings of the NotifyLow level
do not generate an alarm until the
gauge has reached or crossed
the corresponding NotifyHigh
level.

<notifyHigh> Integer 0 through 2147483647 The gauge value at which an

alarm is generated when the
gauge value reaches or crosses
the NotifyHigh level in a rising
direction. Subsequent similar
crossings of the NotifyHigh level
do not generate an alarm until the
gauge has reached or crossed
the corresponding NotifyLow
level.

<severity> Choice informational, low, medium, high, "inactive": The threshold is

critical inactive."active": The threshold is
active.

<status> Choice inactive, active Inactive: The threshold is inactive.

<rowIndex> Integer 0 through 65000 Optional parameter used to

reference a specific threshold
when two thresholds for the same
counter name are defined.

8.5.4 delete
This command is used to delete defined thresholds.
1) Ensure you are at the /AS_CLI/Monitoring/Threshold> level.
2) Enter:
delete <attribute>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 512
 where:
Variable Field Type Valid Values Description

<attribute> Choice counter, gauge Type of Management Information

Base (MIB) node to monitor, can
either be a "counter" or a "gauge".
Refer to the application specific
performance MIB for a list or
counters and gauges.

Variable: counter

counter Counter based threshold.

<counter String 1 to 80 characters The name of a counter in the

Name> Management Information Base
(MIB).

<rowIndex> Integer 0 through 65000 Optional parameter used to

reference a specific threshold
when two thresholds for the same
counter name are defined.

Variable: gauge

gauge Gauge based threshold.

<gaugeName> String 1 to 80 characters The name of a gauge in the

Management Information Base
(MIB).

<rowIndex> Integer 0 through 65000 Optional parameter used to

reference a specific threshold
when two thresholds for the same
counter name are defined.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 513
9 Maintenance

This level is used to view and modify maintenance entries to check the general status of the system and
the software that is currently running.

9.1 ContainerOptions
This level is used to view and modify special configuration options for Java containers. These options are
typically used to control specific behaviors introduced by patches.

9.1.1 get
This command is used to view the list of container options and their values.
1) Ensure you are at the /AS_CLI/Maintenance/ContainerOptions> level.
2) Enter:
get↵

9.1.2 add
This command is used to add a new container option.
1) Ensure you are at the /AS_CLI/Maintenance/ContainerOptions> level.
2) Enter:
add <container> <name> <value>↵
where:
Variable Field Type Valid Values Description

<container> Choice tomcat, apache, flash This parameter determines the

Policy, remotexla, execution, type of container.
provisioning, OCS, CommPilot,
DeviceManagementFiles, JWS
Files, MediaFiles, OCIFiles, OCI
OverSoap, snmpd, lmd, configd,
platform

<name> String 1 to 80 characters This parameter specifies the

option name.

<value> String 1 to 512 characters This parameter specifies the

option value.

9.1.3 set
This command is used to modify an existing container option.
1) Ensure you are at the /AS_CLI/Maintenance/ContainerOptions> level.
2) Enter:
set <container> <name> <value>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 514
 Variable Field Type Valid Values Description

<container> Choice tomcat, apache, flash This parameter determines the

Policy, remotexla, execution, type of container.
provisioning, OCS, CommPilot,
DeviceManagementFiles, JWS
Files, MediaFiles, OCIFiles, OCI
OverSoap, snmpd, lmd, configd,
platform

<name> String 1 to 80 characters This parameter specifies the

option name.

<value> String 1 to 512 characters This parameter specifies the

option value.

9.1.4 delete
This command is used to delete a container option.
1) Ensure you are at the /AS_CLI/Maintenance/ContainerOptions> level.
2) Enter:
delete <container> <name>↵
where:
Variable Field Type Valid Values Description

<container> Choice tomcat, apache, flash This parameter determines the

Policy, remotexla, execution, type of container.
provisioning, OCS, CommPilot,
DeviceManagementFiles, JWS
Files, MediaFiles, OCIFiles, OCI
OverSoap, snmpd, lmd, configd,
platform

<name> String 1 to 80 characters This parameter specifies the

option name.

9.1.5 removeObsolete
This command is used to remove the container options that are documented as obsolete.
1) Ensure you are at the /AS_CLI/Maintenance/ContainerOptions> level.
2) Enter:
removeObsolete↵

9.1.6 showOption
This command is used to view information about a specific container option.
1) Ensure you are at the /AS_CLI/Maintenance/ContainerOptions> level.
2) Enter:
showOption <name>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 515
 Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the

name of a container option. The
container option specified will
be searched across all available
containers.

9.1.7 showOptions
This command is used to view a list of container options or display information about a specific container.
1) Ensure you are at the /AS_CLI/Maintenance/ContainerOptions> level.
2) Enter:
showOptions [<criteria>]↵
where:
Variable Field Type Valid Values Description

<criteria> MultipleChoice filter, container This parameter specifies the

criteria of the container options
and the name of the container to
search.

Variable: filter

filter This parameter filters the output

of the container option definitions
to contain the definitions currently
available or the obsolete
definitions. When omitted, it
displays all container options.

<content> Choice available, obsolete This parameter determines if the

filter should match available or
obsolete container options.

Variable: container

container This parameter is used to view

the container options that apply to
the specified container. If omitted,
all the container options currently
available for this server are listed.

<container Choice tomcat, apache, flash Specifies the name of a specific

Name> Policy, remotexla, execution, container.
provisioning, OCS, CommPilot,
DeviceManagementFiles, JWS
Files, MediaFiles, OCIFiles, OCI
OverSoap, snmpd, lmd, configd,
platform

9.2 Extraview
This level is used to interact with ExtraView (BroadSoft's problem reporting system). It is used to upload a
file as an attachment to an ExtraView ticket to be sent to BroadSoft for troubleshooting.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 516
9.2.1 upload
This command is used to upload a document from the local server to an existing ExtraView ticket.
1) Ensure you are at the /AS_CLI/Maintenance/Extraview> level.
2) Enter:
upload <EVUserId> <EVId> <FileName> <FileDescription>↵
where:
Variable Field Type Valid Values Description

<EVUserId> String 2 to 80 characters This parameter specifies the

ExtraView user ID.

<EVId> Integer 10000 through 999999 This parameter specifies the

ExtraView ID number.

<FileName> String 1 to 300 characters This parameter specifies the file

name of the file to be uploaded.

<File String 1 to 80 characters This parameter specifies the

Description> description of the file to be
uploaded.

9.3 ManagedObjects
This level is used to view and modify Managed Objects (MOs).

9.3.1 get
This command is used to view Managed Object (MO)-related information.
1) Ensure you are at the /AS_CLI/Maintenance/ManagedObjects> level.
2) Enter:
get <option>↵
where:
Variable Field Type Valid Values Description

<option> Choice broadworks, devices, versions This parameter determines the

option. *Use the "broadworks"
option to view information about
the BroadWorks component
installed on the current host.
*Use the "devices" option to view
information about the devices
configured for use with the
current host. *Use the "versions"
option to view information about
the version of the BroadWorks
component installed on the
current host.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 517
 Variable Field Type Valid Values Description

Variable: broadworks

broadworks This parameter displays

information on the active
BroadWorks server: identity,
version, applications, web
container, and third-party
software.

<attribute> Choice full The name of an attribute.

Use the ''full'' option to get an
extended view of the status of the
BroadWorks server.

Variable: devices

devices This parameter displays device

information.

<filters> MultipleChoice deviceName, protocol, device This nested parameter

Type, adminState, opState determines the filter to use to
narrow the result of the get
command.

<deviceName> String 1 to 40 characters This nested parameter specifies

the name of a device. When it is
used, the GET command applies
a case-sensitive prefix match on
all device names.

<protocol> String 1 to 30 characters This nested parameter specifies

the protocol supported by the
device.

<deviceType> String 1 to 40 characters This nested parameter specifies

the type of the device to display.

<adminState> Choice locked, locking, unlocked This nested parameter specifies

the administrative state of the
device.

<opState> Choice enabled, disabled This nested parameter specifies

the operating state of the device.

<versions> Choice current, all This parameter displays

information on the installed
software on this server.

9.3.2 detail
This command is used to display detailed information about an application. Data presented in the output
includes the application name, version, install date, upgrade mode, status, and description.
1) Ensure you are at the /AS_CLI/Maintenance/ManagedObjects> level.
2) Enter:
detail <type>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 518
 where:
Variable Field Type Valid Values Description

<type> Choice application This parameter specifies the type

of element.

Variable: application

application This parameter displays

information of a BroadWorks
application.

<name> String 1 to 255 characters This nested parameter specifies

the name of the application.

<version> String 1 to 80 characters This nested parameter specifies

the version of the application.

9.3.3 set
This command is used to modify the Managed Object (MO)-related attributes.
1) Ensure you are at the /AS_CLI/Maintenance/ManagedObjects> level.
2) Enter:
set [<forceOption>] <option>↵
where:
Variable Field Type Valid Values Description

<forceOption> Choice force This parameter determines the

force option. Use the "force"
option to apply the change
immediately. Otherwise, a restart
of the application is required for
the changes to apply.

<option> Choice activeSoftwareVersion This parameter determines the

options.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 519
 Variable Field Type Valid Values Description

Variable: activeSoftwareVersion

activeSoftwareVersion This parameter specifies the

active software version.

<type> Choice server This nested parameter

determines the version of
the server. Use this option
when a different version of the
server needs to be activated.
The software automatically
determines if it needs to upgrade
or rollback.

Variable: server

server This parameter specifies server-

related information.

<identity> String 1 to 80 characters This nested parameter specifies

the name of the server identity
to set to "active". It is usually the
short name of a BroadWorks
server (for example, Profile
Server, Network Server, and so
on).

<version> String 1 to 80 characters This nested parameter specifies

the version of the software to
activate.

<revert> Choice revert This parameter provides the

ability to revert to a previous
release. Use the "revert" option to
perform a revert to the specified
previous release. Otherwise, a
rollback to the specified previous
release is performed.

Variable: revert

revert This parameter provides the

ability to revert to a previous
release. Use the "revert" option to
perform a revert to the specified
previous release. Otherwise, a
rollback to the specified previous
release is performed.

<backup String 0 to 80 characters This nested parameter specifies

Location> the full path of the database
backup file to use when
performing a revert.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 520
9.3.4 activate
This command is used to activate an application. Active applications can be configured, deployed, and
started.
1) Ensure you are at the /AS_CLI/Maintenance/ManagedObjects> level.
2) Enter:
activate <type>↵
where:
Variable Field Type Valid Values Description

<type> Choice application This parameter determines

the type. Use the "application"
option to activate a BroadWorks
application.

Variable: application

application This parameter determines the

"application" option to activate a
BroadWorks application.

<name> String 1 to 80 characters This nested parameter specifies

the name of the application.

<version> String 1 to 80 characters This nested parameter specifies

the application version.

<contextPath> String 1 to 80 characters This nested parameter specifies

the context path.

9.3.5 deactivate
This command is used to deactivate an application.
1) Ensure you are at the /AS_CLI/Maintenance/ManagedObjects> level.
2) Enter:
deactivate <type>↵
where:
Variable Field Type Valid Values Description

<type> Choice application This parameter determines which

software is deactivated.

Variable: application

application This parameter determines the

"application" option to deactivate
a BroadWorks application.

<nameOr String 1 to 255 characters The name or context path of the

ContextPath> application.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 521
9.3.6 deploy
This command is used to deploy an application.
1) Ensure you are at the /AS_CLI/Maintenance/ManagedObjects> level.
2) Enter:
deploy <type>↵
where:
Variable Field Type Valid Values Description

<type> Choice application This parameter determines which

software type is deployed.

Variable: application

application This parameter determines the

"application" option to deploy a
BroadWorks application.

<nameOr String 1 to 255 characters This nested parameter specifies

ContextPath> the name or context path of the
application.

9.3.7 lock
This command is used to lock the server. Upon normal completion, the server goes into the ''Lock'' state.
During the stop process, the server temporarily goes into the ''Locking'' state. This command can be run
when the server is in the ''Unlock'' state. Refer to the BroadWorks Software Management Guide for further
details on server state management.
1) Ensure you are at the /AS_CLI/Maintenance/ManagedObjects> level.
2) Enter:
lock [<option>] [<type>]↵
where:
Variable Field Type Valid Values Description

<option> Choice force This parameter determines the

option. Use the "force" option if
the lock must be enforced even if
the lock target is not ready to go
into the ''Lock'' state.

<type> Choice application This parameter specifies the type.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 522
 Variable Field Type Valid Values Description

Variable: application

application This parameter determines the

"application" option to lock a
BroadWorks application. If a
specific application must be
locked individually, this parameter
must be set. This is an optional
parameter and, if not set, the lock
applies to the whole server.

<name> String 1 to 80 characters This nested parameter specifies

the name of an application.

9.3.8 start
This command is used to start the server. Upon normal completion, the server goes into an ''Unlock'' state.
Note that this command can only be run when the server is in a ''Shutdown'' state.
1) Ensure you are at the /AS_CLI/Maintenance/ManagedObjects> level.
2) Enter:
start [<type>]↵
where:
Variable Field Type Valid Values Description

<type> Choice application This parameter specifies the type.

If a specific application or the
web container must be started
individually, this parameter
must be set. This is an optional
parameter and, if not set, the start
applies to the whole server.

Variable: application

application This parameter determines

the "application" option to start
a BroadWorks application.
If a specific application must
be started individually, this
parameter must be set. This is
an optional parameter and, if not
set, the start applies to the whole
server.

<name> String 1 to 80 characters This nested parameter specifies

the name of an application.

9.3.9 stop
This command is used to stop the server. Upon normal completion, the server goes into a ''Shutdown''
state. During the stop process, the server temporarily goes into the ''Shuttingdown '' state. This command
can be run from any state.
1) Ensure you are at the /AS_CLI/Maintenance/ManagedObjects> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 523
 2) Enter:
stop [<option>] [<type>]↵
where:
Variable Field Type Valid Values Description

<option> Choice force This parameter determines the

option. Use the "force" option if
the stop must be enforced even if
the target is not ready to go into
the ''Stopped'' state.

<type> Choice application This parameter specifies the type.

If a specific application or the
web container must be started
individually, this parameter
must be set. This is an optional
parameter and, if not set, the start
applies to the whole server.

Variable: application

application This parameter determines

the "application" option to stop
a BroadWorks application.
If a specific application must
be started individually, this
parameter must be set. This is
an optional parameter and, if not
set, the start applies to the whole
server.

<name> String 1 to 80 characters This nested parameter specifies

the name of an application.

9.3.10 undeploy
This command is used to undeploy an application.
1) Ensure you are at the /AS_CLI/Maintenance/ManagedObjects> level.
2) Enter:
undeploy <type>↵
where:
Variable Field Type Valid Values Description

<type> Choice application This parameter specifies the type.

If a specific application or the
web container must be started
individually, this parameter
must be set. This is an optional
parameter and, if not set, the start
applies to the whole server.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 524
 Variable Field Type Valid Values Description

Variable: application

application This parameter determines the

"application" option to undeploy a
BroadWorks application. Use the
"application" option to undeploy a
BroadWorks application.

<nameOr String 1 to 255 characters This nested parameter specifies

ContextPath> the name or context path of the
application.

9.3.11 unlock
This command is used to unlock the BroadWorks server. Once the command is executed, the server goes
into the Unlock state. This command is executed when the server is in the Lock state.
1) Ensure you are at the /AS_CLI/Maintenance/ManagedObjects> level.
2) Enter:
unlock [<type>]↵
where:
Variable Field Type Valid Values Description

<type> Choice application This parameter specifies the type.

If a specific application or the
web container must be started
individually, this parameter
must be set. This is an optional
parameter and, if not set, the start
applies to the whole server.

Variable: application

application This parameter determines the

"application" option to unlock a
BroadWorks application.

<name> String 1 to 80 characters This nested parameter specifies

the name of an application.

9.4 Patching
This level is used to display detailed information about patches or patch bundles. It is also used to apply
patches, check peers, execute operations, modify files, list patches or patch bundles, display the history of
a patch, refresh the patch database or remove a patch. This level provides additional services for patches
such as showing more details and performing batch operations based on a given filter (for example, apply
or remove installed patches and delete inactive patches).

9.4.1 detail
This command is used to display detailed information for the requested patch or patch bundle. Data
presented in the output for a patch includes the patch name, the current state of the patch, and the
date since it reached this current state. It also shows the first level of patches on which it depends

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 525
 (dependencies), the patches directly depending on it (dependents) and the name of the patch bundle(s) in
which it is found. Data presented in the output for a patch bundle displays a list of the bundled patches and
their states.
1) Ensure you are at the /AS_CLI/Maintenance/Patching> level.
2) Enter:
detail <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the

name of the patch or patch
bundle.

9.4.2 apply
This command is used to change the state of installed patches to "active". When an error occurs, all
patches are brought back to their initial state.
1) Ensure you are at the /AS_CLI/Maintenance/Patching> level.
2) Enter:
apply <names>↵
where:
Variable Field Type Valid Values Description

<names> String 1 to 1023 characters This parameter specifies names

of the patches or bundles to apply
delimited by colons.

9.4.3 checkPeer
This command is used to verify (on a redundant system) that all servers have the same active patches.
The command scans all peers and compiles a list of all active patches on all servers. It then compares the
list of each individual server with the full list and displays any missing patches for a particular server. This
command is exclusive meaning that requests for any other command, invoked by any client, are rejected
while this command is executing.
1) Ensure you are at the /AS_CLI/Maintenance/Patching> level.
2) Enter:
checkPeer↵

9.4.4 execute
This command is used to commit patch operations and make them effective. This command commits all
changes since the last time the "execute" was called, and makes them effective. Modifications to patches
states are not active until this call is made. This command is exclusive meaning that requests for any other
command, invoked by any client, are rejected while this command is executing.
1) Ensure you are at the /AS_CLI/Maintenance/Patching> level.
2) Enter:
execute [<force>]↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 526
 Variable Field Type Valid Values Description

<force> String force This parameter commits the

patch operations and makes them
effective.

9.4.5 getModifiedFile
This command is used to list the patches that modified the file requested in the query.
1) Ensure you are at the /AS_CLI/Maintenance/Patching> level.
2) Enter:
getModifiedFile <fileNameContains>↵
where:
Variable Field Type Valid Values Description

<fileName String 1 to 256 characters This parameter specifies a

Contains> pattern that is contained in one or
more file names.

9.4.6 listBundle
This command is used to display a list of patch bundles or one or more specific patch bundles.
1) Ensure you are at the /AS_CLI/Maintenance/Patching> level.
2) Enter:
listBundle [<criteria>]↵
where:
Variable Field Type Valid Values Description

<criteria> Choice bundleNameContains This parameter specifies the

criteria. Enter the name of the
desired patch bundle or a given
pattern that matches a pattern
found in one or more patch
bundle names.

Variable: bundleNameContains

bundleNameContains This parameter specifies

the filtering option. Use
''bundleNameContains'' to filter
based on the bundle name.

<bundleName> String 1 to 80 characters Specifies a pattern that is

contained in a number of patch
bundle names.

9.4.7 listPatch
This command is used to display a list of patches along with their states. All patches appear no matter if
they were installed or applied individually or as part of a patch bundle. Data presented in the output of this
command includes the patch name, the current state of the patch, and the date since the patch reached
the indicated state. Search criteria can be used to narrow the output of results. The patchNameContains

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 527
 is used to list patches matching a given pattern in their name, whereas the currentState is used to list
patches with a specified state.
1) Ensure you are at the /AS_CLI/Maintenance/Patching> level.
2) Enter:
listPatch [<criteria>]↵
where:
Variable Field Type Valid Values Description

<criteria> MultipleChoice patchNameContains, currentState This parameter specifies the

criteria. Enter the name of the
desired patch bundle or a given
pattern that matches a pattern
found in one or more patch
bundle names.

Variable: patchNameContains

patchNameContains This parameter specifies a filter

based on the content of the patch
name.

<patchName> String 1 to 80 characters Specifies a pattern that is

contained in a number of patch
names.

Variable: currentState

currentState This parameter specifies a filter

based on the current state of a
patch.

<state> Choice installed, active, installedPending The state of the patch.

Active, activePendingInstalled,
installedMissingDependencies,
missing

9.4.8 listRelation
This command displays all dependencies or dependents of a given patch along with their states.
1) Ensure you are at the /AS_CLI/Maintenance/Patching> level.
2) Enter:
listRelation <option> <patchName>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 528
 Variable Field Type Valid Values Description

<option> Choice dependencies, dependencyOf This parameter determines

the type of relation to display.
Values include "dependencies"
and "dependencyOf". Use the
"dependencies" option to view all
patches which are required to be
applied before the given patch.
Use the "dependencyOf" option
to view all patches which are
required to be removed before
the given patch.

<patchName> String 1 to 80 characters This parameter specifies the

name of the patch.

9.4.9 patchHistory
This command is used to display the history of one or more patches. Data presented in the output of this
command includes the patch name, the date of an event for the patch, and the state of the patch at that
time. Search criteria can be used to narrow the output of results. The "dateStartsAt" criterion is used to set
a starting date so that the results do not include events prior to this date. It is also possible to retrieve the
history of patches matching a given pattern in their name, or a combination of both criteria.
1) Ensure you are at the /AS_CLI/Maintenance/Patching> level.
2) Enter:
patchHistory [<criteria>]↵
where:
Variable Field Type Valid Values Description

<criteria> MultipleChoice patchNameContains, dateStarts This parameter specifies the

At name of the desired patch bundle
or a given pattern that matches
a pattern found in one or more
patch bundle names.

Variable: patchNameContains

patchNameContains This parameter specifies a filter

based on the content of the patch
name.

<patchName> String 1 to 80 characters Specifies a pattern that is

contained in a number of patch
names.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 529
 Variable Field Type Valid Values Description

Variable: dateStartsAt

dateStartsAt Filter based start at date.

<month> Integer 1 through 12 This nested parameter specifies

the the month of starting date so
that the results do not include
events prior to this date.

<day> Integer 1 through 31 This nested parameter specifies

the day of starting date so that
the results do not include events
prior to this date.

<year> Integer 2000 through 2014 This nested parameter specifies

the year of starting date so that
the results do not include events
prior to this date.

9.4.10 refresh
This command is used to refresh the patch database. This command is exclusive, which means that
requests for any other command, invoked by any client, are rejected while the refresh command is
executing. This command analyzes the patches installed on the system. From the gathered data, it
updates the internal database and processes dependencies.
1) Ensure you are at the /AS_CLI/Maintenance/Patching> level.
2) Enter:
refresh↵

9.4.11 remove
This command is used to change the state of active patches to "installed." When an error occurs, all
patches are brought back to their initial state.
1) Ensure you are at the /AS_CLI/Maintenance/Patching> level.
2) Enter:
remove <names>↵
where:
Variable Field Type Valid Values Description

<names> String 1 to 1023 characters This parameter specifies the

names of the patches or bundles
to remove delimited by colons.

9.5 Scheduler
This level is used to view and modify scheduler entries in the system.

9.5.1 get
This command is used to view the list of scheduled tasks.
1) Ensure you are at the /AS_CLI/Maintenance/Scheduler> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 530
 2) Enter:
get↵

9.5.2 add
This command is used to add a new scheduled task. You can configure a task to execute on a minute,
day, or date basis. Any given task can have multiple-scheduled entries. Following are examples: * The
command "taskx minute 2" means execute the task "x" every two minutes. * The command "taskx day
monday 0 30" means execute task "x" every Monday at 0h30. * The command "taskx date 15 2 15"
means execute task "x" on the 15th of each month at 2h15.'''NOTE''': To minimize the impact of running
concurrent scheduled tasks, use minutes that are different between tasks and that do not match the hour
(when applicable).
1) Ensure you are at the /AS_CLI/Maintenance/Scheduler> level.
2) Enter:
add <tasks> <frequency>↵
where:
Variable Field Type Valid Values Description

<tasks> Choice dbMaint, healthmon, backup, This parameter specifies the

autoCleanup, regAudit, dbSync BroadWorks maintenance task
Check, cpuMon, tech-support, type.
check_dbpages, serviceLicense
Collect, fileCollector, healthmon
Light, btluReport, securityMon

<frequency> Choice minute, daily, day, date This parameter specifies the task
frequency: * select ''minute" to
execute the task on a per-minute
basis; * ''daily'' to execute the task
every day at a specific hour and
minute; * ''day'' to execute the
task once a week on a specific
day, hour, and minute; * or ''date''
to execute the task once a month
on the specified date.

Variable: minute

minute This parameter specifies the

minute.

<value> Choice 1, 2, 3, 4, 5, 6, 10, 12, 15, 30, 60, This nested parameter specifies
120, 180, 240, 360, 480, 720, the frequency in minutes. For
1440 example, "1" means every
minute, "2" means every two
minutes and so on.

<offset> Integer 0 through 59 This nested parameter specifies

the start of the hour offset value
in minutes. It is important that
not all tasks are executed at the
same time. The different offset for
each task manages the execution
of tasks.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 531
 Variable Field Type Valid Values Description

Variable: daily

daily This parameter specifies the daily

option.

<hour> Integer 0 through 23 This nested parameter specifies a

day in the week.

<minute> Integer 0 through 59 This parameter specifies the

minute.

Variable: day

day This parameter specifies a

specific day in the week.

<day> Choice monday, tuesday, wednesday, This parameter specifies a

thursday, friday, saturday, sunday specific day in the week.

<hour> Integer 0 through 23 This nested parameter specifies a

day in the week.

<minute> Integer 0 through 59 This parameter specifies the

minute.

Variable: date

date This parameter specifies a

specific day in the month.

<date> Integer 1 through 28 This parameter specifies a

specific day in the month.

<hour> Integer 0 through 23 This nested parameter specifies a

day in the week.

<minute> Integer 0 through 59 This parameter specifies the

minute.

9.5.3 delete
This command is used to remove a scheduled task from the list. Scheduled tasks must be deleted using
their corresponding ID number.
1) Ensure you are at the /AS_CLI/Maintenance/Scheduler> level.
2) Enter:
delete <id>↵
where:
Variable Field Type Valid Values Description

<id> Integer 0 through 255 This parameter specifies the ID

for the scheduled task.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 532
9.5.4 FileCollector
This level is used to view and modify file collector task attributes.

9.5.4.1 get
This command is used to view the file collector task attributes.
1) Ensure you are at the /AS_CLI/Maintenance/Scheduler/FileCollector> level.
2) Enter:
get↵

9.5.4.2 set
This command is used to modify the file collector task attributes.
1) Ensure you are at the /AS_CLI/Maintenance/Scheduler/FileCollector> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice uri, keepFileAfterTransfer, user The name of an attribute to

modify.

<uri> String 0 to 255 characters This parameter specifies the

URI to identify the remote log
repository.

<keepFileAfter Choice true, false This parameter determines if the

Transfer> files are preserved after transfer.

<user> String 1 to 30 characters This parameter specifies the user

to connect to the log repository
web application.

9.5.4.3 clear
This command is used to clear the user attribute of the file collector task.
1) Ensure you are at the /AS_CLI/Maintenance/Scheduler/FileCollector> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> Choice user The name of an attribute to clear.

9.5.4.4 SrcDestPathsContext
This level is used to add and modify file collector task source and destination paths.
9.5.4.4.1 get
This command is used to view the file collector task source and destination paths.
1) Ensure you are at the /AS_CLI/Maintenance/Scheduler/FileCollector/
SrcDestPathsContext> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 533
 get↵
9.5.4.4.2 add
This command is used to add the source and destination paths to the file collector task.
1) Ensure you are at the /AS_CLI/Maintenance/Scheduler/FileCollector/
SrcDestPathsContext> level.
2) Enter:
add <sourcePath> <destinationPath>↵
where:
Variable Field Type Valid Values Description

<sourcePath> String 1 to 255 characters This parameter specifies the

source path of the logs on the
local machine. This source path
can contain wildcards.

<destination String 1 to 255 characters This parameter specifies the

Path> destination path of the remote
machine.

9.5.4.4.3 delete
This command is used to remove the source and destination paths from the file collector task.
1) Ensure you are at the /AS_CLI/Maintenance/Scheduler/FileCollector/
SrcDestPathsContext> level.
2) Enter:
delete <sourcePath>↵
where:
Variable Field Type Valid Values Description

<sourcePath> String 1 to 255 characters This parameter specifies the

source path of the logs on the
local machine. This source path
can contain wildcards.

9.6 Tools
This level is used to view and modify the tools entries.

9.6.1 backupdb
This command is used to back-up the content of the BroadWorks datastore to the specified file. '''NOTE
1''': Since the Application Sever uses a BroadWorks user ID, it cannot write an output file to a location for
which it does not have write permission. For example, when using the "bwadmin" user ID, the bwadmin
home directory cannot be used to write an output file. '''NOTE 2''': If no directory path is specified with the
target file name, the default path''/usr/local/broadworks/bw_base''is used.
1) Ensure you are at the /AS_CLI/Maintenance/Tools> level.
2) Enter:
backupdb <binary file where to backup the data>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 534
 Variable Field Type Valid Values Description

<binary file String 1 to 255 characters Indicates the target file name
where to (output file) where the data is
backup the backed up. Note that you can
data> also enter a directory path.
However, if no path is specified
the default path is used, which is /
usr/local/broadworks/bw_base.

9.6.2 healthmon
This command is used to report the status.
1) Ensure you are at the /AS_CLI/Maintenance/Tools> level.
2) Enter:
healthmon↵

9.6.3 importdb
This command is used to import the content of a remote Times Ten database in the current datastore. The
remote server must have replication enabled.
1) Ensure you are at the /AS_CLI/Maintenance/Tools> level.
2) Enter:
importdb <remote server hostname>↵
where:
Variable Field Type Valid Values Description

<remote server String 1 to 255 characters This is the remote server's host
hostname> address, which can be a host
name or IP address.

9.6.4 restoredb
This command is used to restore the content of the BroadWorks Times Ten datastore from the specified
file. The content must have previously been backed up with the backupdb command.
1) Ensure you are at the /AS_CLI/Maintenance/Tools> level.
2) Enter:
restoredb <file from which to restore the data>↵
where:
Variable Field Type Valid Values Description

<file from which String 1 to 255 characters The binary file from which the
to restore the data is restored.
data>

9.6.5 tech-support
This command is used to capture the status of the system.
1) Ensure you are at the /AS_CLI/Maintenance/Tools> level.
2) Enter:
tech-support [<attribute>]↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 535
 where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice day The name of an attribute to

modify. Tech-support includes
some information extracted from
log files on disk. Use the ''day''
option to get this information for a
specific day in the month.

<day> Integer 1 through 31 This parameter specifies the date

of a day in the month.

9.6.6 upgradeCheck
This command is used to perform a software activation dry run during which a system validation is
performed to determine if the upgrade will be successful.
1) Ensure you are at the /AS_CLI/Maintenance/Tools> level.
2) Enter:
upgradeCheck <version to switch to>↵
where:
Variable Field Type Valid Values Description

<version to String 1 to 255 characters Specifies the version to which the

switch to> system is upgraded.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 536
10 Interface

This level is used to configure and view the system-wide interfaces available from the Application Server
such as accounting, Internet mail facility, Media Control Protocol, Media Gateway Control Protocol, Media
Server Selection, Network Server Synchronization, Session Initiation Protocol, and Simple Network
Management Protocol.

10.1 ASR
This level is used to view and modify the Application Server Registration (ASR)-related parameters.
The ASR works in conjunction with the redundancy functionality for primary and backup servers in a
cluster to ensure on-going service during a primary Application Server failure condition. Each subscriber's
active Application Server is known throughout the network so that in the event that a subscriber's primary
Application Server is unavailable, a backup Application Server can take over the ownership of the
subscribers' directory number. Once the primary Application Server is available again, the subscriber's
directory number ownership reverts to its primary Application Server. The ASR protocol ensures that the
Application Server's active status is synchronized with the other Application Servers and the Network
Servers on the network.

10.1.1 get
This command is used to view Application Server Registration (ASR)-related attributes, such as the
listening port, the maximum number of retries, and the retransmission timer.
1) Ensure you are at the /AS_CLI/Interface/ASR> level.
2) Enter:
get↵

10.1.2 set
This command is used to modify Application Server Registration (ASR)-related attributes, such as the
listening port, the maximum number of retries, and the retransmission timer.
1) Ensure you are at the /AS_CLI/Interface/ASR> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice maximumNumberOfRetry, The name of an attribute to

retransmissionTimer, listening modify.
Port

<maximum Integer 0 through 9 The number of times the

NumberOf Application Server sends an
Retry> active indicator to the other
servers (usually the primary
Network Server) on the network.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 537
 Variable Field Type Valid Values Description

<retransmission Integer 100 through 2000 The time (seconds) the

Timer> Application Server waits to re-
send an active indicator to the
other servers (usually the primary
Network Server) on the network
when the sending Application
Server has not received a
response.

<listeningPort> Integer 1025 through 65535 The port upon which the
Application Server receives a
response. This value must be
aligned with the Network Server
setting for ASR listeningPort to
work properly.

10.2 Accounting
This level is used to manage billing information that is delivered to the service provider's billing system by
a third party. This billing information pertains to the use of all chargeable services that are configured for
groups. Billing files are located in the/var/broadworks/billingdirectory.

10.2.1 BroadWorksCDRInterface
The BroadWorks call detail record (CDR) interface is a billing format implemented to meet the
requirements of VoIP systems. The CDR format provides the same information that is currently provided in
the PacketCable event messages in a single CDR.

10.2.1.1 get
This command is used to view Call Detail Record (CDR) configuration information.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface> level.
2) Enter:
get↵

10.2.1.2 set
This command is used to modify Call Detail Record (CDR) configuration information.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 538
 Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, longCallDurationRecord The name of an attribute to

Control, longCallDurationTimer modify.
Minutes, enableCDRCodec
Changes, enableCDRInternal
Conference, enableCDRLocation
Change, enableCDRStartEnd,
enableCDRInterimAoC, enable
FailoverInfo, enableIntraGroupCD
R, enableModuleCentrex, enable
ModuleIP, enableModule3GP
P, enableTerminatingCDR,
use3xxAsRouteConfirmation
ForAccounting, customSchema
Version, enableAVPQuotes,
setAnswerIndicatorToYesFor
UnconfirmedAnswer

<enabled> Choice true, false Controls if the accounting

interface shall be on or off.

<longCall Choice disabled, enabled, controlledBy Specifies the status of the Long
DurationRecord DiameterServer Call Duration Record Control
Control> feature.

<longCall Integer 1 through 1440 In minutes, how long a call is up

DurationTimer before a Long Duration billing
Minutes> event is generated.

<enableCDR Choice true, false When set to "false", Call Codec

Codec Changes are off. When set to
Changes> "true", Call Codec changes are
on.

<enableCDR Choice true, false Controls if CDR Internal

Internal Conference is on or off.
Conference>

<enableCDR Choice true, false If enabled, interim CDRs are

Location generated for location changes.
Change>

<enableCDR Choice true, false Controls if Call detail record start

StartEnd> and end are on or off.

<enableCDR Choice true, false This parameter controls whether

InterimAoC> an interim Call Detail Record
is generated at each Advice
of Charge During call (AoC-D)
interval.

<enable Choice true, false Controls if Failover call detail

FailoverInfo> record generation is on or off.

<enableIntra Choice true, false Controls if Intra-group call detail

GroupCDR> records are on or off.

<enableModule Choice true, false Controls if Centrex module is on

Centrex> or off.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 539
 Variable Field Type Valid Values Description

<enable Choice true, false Controls if IP module is on or off.

ModuleIP>

<enable Choice true, false Controls if Module 3GPP is on or

Module3GPP> off.

<enable Choice true, false Controls if Terminating call detail

TerminatingCDR> record is on or off.

<use3xx Choice true, false When set to "false", instructs

AsRoute the system not to use the 3xx as
Confirmation route confirmation for accounting.
ForAccounting> When set to "true", instructs the
system to use the 3xx as route
confirmation for accounting.

<custom String 1 to 255 characters A string that appears in the

Schema CDR for allowing a configurable
Version> accounting schema version.

<enableAVP Choice true, false Controls if the double quotes(")

Quotes> are to be stripped off from the
AVP "IMS-Charging-Identifier"
and AVP "BWAS-Charging-
Vector-Key" parameters.

<setAnswer Choice true, false This parameter controls how

Indicator the answerIndicator CDR field is
ToYesFor populated in Answer Confirmation
Unconfirmed scenarios. When set to "true", the
Answer> answerIndicator field is modified
to output the value "Yes" and the
answerTime field is set to the
answerConfirmationInvocationTime
for unconfirmed answered
originating calls. When set
to "false" (default value), the
answerIndicator field is set to
"Yes" only if the call is confirmed.

10.2.1.3 clear
This command is used to clear (set to no value) BroadWorks Call Detail Record (CDR) interface attributes.
A Custom Schema Version change does not take effect until a restart is performed.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice customSchemaVersion The name of the attribute(s) to

clear.

10.2.1.4 Diameter
This level is used to manage Diameter attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 540
10.2.1.4.1 get
This command is used to view Diameter-related attributes.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/
Diameter> level.
2) Enter:
get↵
10.2.1.4.2 set
This command is used to modify Diameter-related attributes.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/
Diameter> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice defaultDestinationRealm, The name of an attribute to

useRealmFromCapabilities modify.
Exchange, callingPartyAddress
StrictCompliance, calledParty
AddressStrictCompliance

<default Domain/Host 1 to 80 characters Sets the default destination

Destination realm.
Realm>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 541
 Variable Field Type Valid Values Description

<useRealm Choice true, false When true: On the Rf interface,

From when rfRoutingMode is "direct" or
Capabilities "dynamic", all ACRs sent by the
Exchange> AS have the Destination-Realm
AVP set to the one obtained
from the peer on the latest
Capabilities-Exchange. Note:
this comes from the "Origin-
Realm" AVP in the CER or CEA
received by the AS from the
billing system. This does NOT
apply when rfRoutingMode is
"realm". Similarly, on the Ro
interface, when roRoutingMode
is "direct" or "dynamic", all
CCRs sent by the AS have the
Destination-Realm AVP set
to the one obtained from the
peer on the latest Capabilities-
Exchange. Note: this comes
from the "Origin-Realm" AVP
in the CER or CEA received by
the AS from the billing system.
This does NOT apply when
roRoutingMode is "realm". When
false: the Destination-Realm AVP
is taken along RFC3588, that is,
from the host part of the User-
Name AVP, where the User-
Name itself is taken from the
primaryDeviceLinePort CDR field.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 542
 Variable Field Type Valid Values Description

<callingParty Choice true, false This parameter determines how

AddressStrict the Calling-Party-Address 3GPP
Compliance> vendor specific AVP (code 831,
vendor-id 10415) in Diameter
messages is populated. When set
to "true", BroadWorks populates
the Calling-Party-Address
3GPP vendor specific Attribute
Value Pair (AVP) (code 831,
vendor-id 10415) in Diameter
messages with the value from the
BroadWorks Call Detail Record
(CDR) field callingPartyAddress
of the 3GPP module. If the
callingPartyAddress field contains
multiple entries, each is encoded
as a separate Calling-Party-
Address AVP in the Diameter
messages, as specified in the
3GPP specification TS 32.299.
When set to "false", BroadWorks
populates the Calling-Party-
Address 3GPP vendor specific
AVP (code 831, vendor-id
10415) in Diameter messages
with the value derived from
the content of BroadWorks
CDR fields callingNumber,
callingNumberContext and
callingPresentationIndicator.

<calledParty Choice true, false This parameter determines how

AddressStrict the Called-Party-Address 3GPP
Compliance> vendor specific AVP (code 832,
vendor-id 10415) in Diameter
messages is populated. When set
to "true", BroadWorks populates
the Called-Party-Address 3GPP
AVP (code 832, vendor-id 10415)
in Diameter messages with the
value from the BroadWorks
Call Detail Record (CDR) field
calledPartyAddress of the 3GPP
module. When set to "false",
BroadWorks populates the
Called-Party-Address 3GPP AVP
(code 832, vendor-id 10415) in
Diameter messages with the
value derived from the contents
of BroadWorks CDR fields
networkTranslatedNumber,
networkTranslatedNumberContext,
calledNumber, and
calledNumberContext.

10.2.1.4.3 clear
This command is used to clear (set to no value) Diameter-related attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 543
 1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/
Diameter> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice defaultDestinationRealm The name of the attribute(s) to

clear.

10.2.1.4.4 ChargingFunctionElement
BroadWorks uses the system configured default charging servers when the charging server address is
not received in time from the SIP signaling or when the system is not in IMS mode. This level is used to
manage default charging servers information.
10.2.1.4.4.1 get
This command is used to view charging servers-related attributes.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/
Diameter/ChargingFunctionElement> level.
2) Enter:
get↵
10.2.1.4.4.2 add
This command is used to add new charging servers to the system.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/
Diameter/ChargingFunctionElement> level.
2) Enter:
add <address> <isNetAddressExtended> <type> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<address> String 1 to 256 characters The address of a default charging

server.

<isNetAddress Choice true, false Indicates if the charging server

Extended> address is a network address
(that is, "192.1.1.1") or a free-form
string that may contain ports,
protocols, and transports (that is,
"aaa://192.1.1.4:6666").

<type> Choice CCF, ECF Specifies the type of the charging

function: Charging Collection
Function (CCF) signifies off-line
charging, for example postpaid
account charging.Event Charging
Function (ECF) signifies on-line
charging, for example pre-paid
account charging.

<attribute> MultipleChoice description Additional attributes to include

through the add command.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 544
 Variable Field Type Valid Values Description

<description> String 1 to 80 characters Specifies the description of the

Charging Function Element.

10.2.1.4.4.3 set
This command is used to modify online attributes.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/
Diameter/ChargingFunctionElement> level.
2) Enter:
set <address> <attribute>↵
where:
Variable Field Type Valid Values Description

<address> String 1 to 256 characters The address of a default charging

server.

<attribute> MultipleChoice type, description The name of an attribute to

modify.

<type> Choice CCF, ECF Specifies the type of the charging

function: Charging Collection
Function (CCF) specifies off-line
charging, for example postpaid
account charging.Event Charging
Function (ECF) specifies on-line
charging, for example pre-paid
account charging.

<description> String 1 to 80 characters Specifies the description of the

Charging Function Element.

10.2.1.4.4.4 delete
This command is used to delete a charging server.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/
Diameter/ChargingFunctionElement> level.
2) Enter:
delete <address>↵
where:
Variable Field Type Valid Values Description

<address> String 1 to 256 characters The IP address of the charging

server.

10.2.1.4.4.5 clear
This command is used to clear (set to no value) charging server attributes.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/
Diameter/ChargingFunctionElement> level.
2) Enter:
clear <address> <attribute>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 545
 where:
Variable Field Type Valid Values Description

<address> String 1 to 256 characters The IP address of the charging

server.

<attribute> MultipleChoice description The name of the attribute(s) to

clear.

10.2.1.4.4.6 reorder
This command is used to reorder the charging servers. The charging server entries are either ordered in
ascending or descending order, or by their Internet Protocol (IP) address.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/
Diameter/ChargingFunctionElement> level.
2) Enter:
reorder <address> <action>↵
where:
Variable Field Type Valid Values Description

<address> String 1 to 256 characters The IP address of the charging

server.

<action> Choice up, down Specifies whether the charging

server's entries should be ordered
in ascending or descending order
by their IP address.

10.2.1.4.5 InhibitedAVPCodeList
This level is used to view, add or delete Inhibited AVP codes.
10.2.1.4.5.1 get
This command is used to view the list of disabled elements.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/
Diameter/InhibitedAVPCodeList> level.
2) Enter:
get↵
10.2.1.4.5.2 add
This command is used to add an Attribute Value Pair (AVP) combination to disable. The AVP combination
includes a diameter AVP and a vendor ID.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/
Diameter/InhibitedAVPCodeList> level.
2) Enter:
add <avpCode> <vendorId>↵
where:
Variable Field Type Valid Values Description

<avpCode> Integer 0 through 2147483647 This parameter specifies the

diameter Attribute Value Pair
(AVP) code.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 546
 Variable Field Type Valid Values Description

<vendorId> Integer 0 through 2147483647 This parameter specifies the

vendor ID.

10.2.1.4.5.3 delete
This command is used to delete an AVP combination to disable. The AVP combination includes a vendor
ID and a diameter Attribute Value Pair (AVP).
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/
Diameter/InhibitedAVPCodeList> level.
2) Enter:
delete <avpCode> <vendorId>↵
where:
Variable Field Type Valid Values Description

<avpCode> Integer 0 through 2147483647 This parameter specifies the

diameter Attribute Value Pair
(AVP) code.

<vendorId> Integer 0 through 2147483647 This parameter specifies the

vendor ID.

10.2.1.4.6 Offline
This level is used to view and modify Diameter offline attributes.
10.2.1.4.6.1 get
This command is used to view Offline-related attributes.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/
Diameter/Offline> level.
2) Enter:
get↵
10.2.1.4.6.2 set
This command is used to modify Offline-related attributes.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/
Diameter/Offline> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, sendBroadWorks The name of an attribute to

Info, send3GPPInfo, enableFile modify.
Queuing, fileRetentionHours,
routingMode, pollingInterval
Seconds, backlogMaxParallel
Transactions

<enabled> Choice true, false Specifies whether sending offline

charging information to the billing
servers is enabled or disabled.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 547
 Variable Field Type Valid Values Description

<sendBroad Choice true, false Specifies whether BroadWorks

WorksInfo> information should be sent.

<send3GPP Choice true, false Specifies whether 3GPP

Info> information should be sent.

<enableFile Choice true, false Specifies whether file queuing is

Queuing> enabled.

<fileRetention Integer 1 through 168 Specifies how long the file will be
Hours> kept.

<routingMode> Choice direct, dynamic, realm When set to "direct", indicates

that the Execution Server shall
have a direct connection to the
CDFs specified in the P-CFA
header. For a given Rf accounting
session, the CDFs are tried
in the order received in the P-
CFA; if no Diameter connection
exists for a given CDF, the next
CDF from the P-CFA is tried.
When set to "dynamic", this is
similar to "direct", except that if
no direct connection exists to a
given CDF, the Execution Server
tries to dynamically establish a
diameter connection to the CDF
using the information available
in the P-CFA. This results in a
dynamic entry to be created in
the Peer Table (this does not
impact the Realm Routing Table).
Note that the entry is added even
if the connection fails. In such
cases, the procedures related
to Incoming Peer Connections
are applied. When set to "realm",
this indicates that Realm Routing
procedures are applied in case
the Execution Server does not
have direct connections to the
CDF. The realm is extracted from
the User-Name AVP present
in the ACR. Note that using
Realm Routing for Rf implies
that the Destination-Host AVP is
present in the ACRs, which is not
compliant with the ACR ABNF
as defined in 3GPP TS 32.299.
The Destination-Host MUST be
inserted in Realm-based Routing
for a request to reach a specific
server, in this case a given CCF.

<pollingInterval Integer 60 through 86400 The CDF server is polled at

Seconds> the interval specified by this
parameter to re-establish the
connection while unreachable.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 548
 Variable Field Type Valid Values Description

<backlog Integer 1 through 300 This parameter specifies the

MaxParallel maximum number of backlog
Transactions> Accounting Requests (ACRs) to
simultaneously send to the Offline
server for processing. The default
value is "1".

10.2.1.4.7 Online
This level is used to view and modify Online-related attributes.
10.2.1.4.7.1 get
This command is used to view Online-related attributes.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/
Diameter/Online> level.
2) Enter:
get↵
10.2.1.4.7.2 set
This command is used to modify Online attributes.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/
Diameter/Online> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, simultaneousOnline The name of an attribute to

OfflineBilling, defaultTimeQuota modify.
ThresholdSeconds, defaultCredit
ControlFailureHandling, unit
Determination, timeSliceSeconds,
warningToneThresholdSeconds,
enableBroadsoftAvps, routing
Mode, txTimerSeconds, service
ContextID, serviceContextIDAoC

<enabled> Choice true, false Enable or disable the Ro online

interface.

<simultaneous Choice true, false Enable or disable having only the

OnlineOffline Ro billing or both the Ro and Rf
Billing> billing (false).

<default Integer 1 through 300 Time margin at which the

TimeQuota Application Server requests new
Threshold credits before the current credits
Seconds> are exhausted or the validity is
reached(30).

<defaultCredit Choice continue, terminate, retryAnd Control the behavior of

ControlFailure Terminate Credit Failure handling
Handling> (retryAndTerminate).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 549
 Variable Field Type Valid Values Description

<unit Choice centralized, decentralized Specifies the method of credits

Determination> (seconds) to allocate(centralized).

<timeSlice Integer 1 through 3600 When unitDetermination is

Seconds> set to "decentralized", this
specifies the number of credits to
allocate(300).

<warningTone Integer 5 through 60 The number of seconds before

Threshold credits run out at which the
Seconds> Application Server plays the
insufficient credits warning
tone(30).

<enable Choice true, false Enable or disable the inclusion of

BroadsoftAvps> BroadSoft vendor-specific AVPs
(true).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 550
 Variable Field Type Valid Values Description

<routingMode> Choice direct, dynamic, realm When set to "direct", indicates

that the Execution Server shall
have a direct connection to the
CDFs specified in the P-CFA
header. For a given Rf accounting
session, the CDFs are tried
in the order received in the P-
CFA; if no Diameter connection
exists for a given CDF, the next
CDF from the P-CFA is tried.
When set to "dynamic", this is
similar to "direct", except that if
no direct connection exists to a
given CDF, the Execution Server
tries to dynamically establish a
diameter connection to the CDF
using the information available
in the P-CFA. This results in a
dynamic entry to be created in
the Peer Table (this does not
impact the Realm Routing Table).
Note that the entry is added even
if the connection fails. In such
cases, the procedures related
to Incoming Peer Connections
are applied. When set to "realm",
this indicates that Realm Routing
procedures are applied in case
the Execution Server does not
have direct connections to the
CDF. The realm is extracted from
the User-Name AVP present
in the ACR. Note that using
Realm Routing for Rf implies
that the Destination-Host AVP is
present in the ACRs, which is not
compliant with the ACR ABNF
as defined in 3GPP TS 32.299.
The Destination-Host MUST be
inserted in Realm-based Routing
for a request to reach a specific
server, in this case a given CCF.

<txTimer Integer 1 through 300 The Tx Timer controls the time

Seconds> call setup is suspended, and not
the actual time allocated to the
OCS to answer to CCRs.

<service String 1 to 161 characters This parameter specifies the

ContextID> Service-Context-Id value to set
(AVP 461) for an online (Ro)
request. The default value is
"8.32260@3gpp.org".

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 551
 Variable Field Type Valid Values Description

<service String 1 to 161 characters This parameter specifies

ContextIDAoC> the Service-Context-Id
value to set (AVP 461) for
an online (Ro) request for
Advice of Charge (AoC) tariff
information. The default value is
"11.32280@3gpp.org".

10.2.1.5 File
This level is used to determine the creation parameters of a billing file.
10.2.1.5.1 get
This command is used to view the BroadWorks CDR file-specific interface configuration.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/File>
level.
2) Enter:
get↵
10.2.1.5.2 set
This command is used to modify the configuration for the BroadWorks CDR interface.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/File>
level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice billingHoldTime, billingRotation The name of an attribute to

Hour, billingRotationMinutes, modify.
billingRotationsPerDay, enabled,
outputFormat, bufferSize

<billingHold Integer 0 through 120 The amount of time the billing file
Time> is stored on the system (in days).

<billingRotation Integer 0 through 23 The time (hour) at which the

Hour> accounting files are rotated
(for example, 2 indicates
2:00 AM while 15 indicates
3:00 PM). (Combines with
billingRotationMinutes to form the
exact time, for example, 2:15).

<billingRotation Integer 0 through 59 The time (minutes) at which the

Minutes> accounting files are rotated; for
example, 15 indicates 15 minutes
after the hour. (Combines with
billingRotationHour to form the
exact time, for example, 2:15).

<billing Choice 1, 2, 3, 4, 6, 12, 24, 48, 96, 144, The number of rotations per day
RotationsPer 288 for the billing file; defaults to one.
Day>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 552
 Variable Field Type Valid Values Description

<enabled> Choice true, false Controls if the billing configuration

is on or off.

<output Choice csv, xml When set to csv, output format

Format> for accounting record is .csv
(comma separated values file).
When set to xml, output format
for the accounting record is in
the extensible markup language
(xml).

<bufferSize> Integer 1 through 100 This attribute specifies the

number of buffered call detail
records. As call detail records are
generated, they are buffered in
RAM before being written to disk.
The number of buffered call detail
records ranges from 1 to 100, and
is set to 10 by default.

10.2.1.5.3 FTP
A single mode of transmission is supported: batch-mode FTP. In this mode, the call detail records are
written to a file and transferred periodically to the system provider's billing system or mediation device. The
call detail records are written to disk before being sent by FTP. They have the option of being archived for
a configurable number of days. This level of the CLI provides options for determining the location of the
billing file sent by FTP.
10.2.1.5.3.1 get
This command is used to view the BroadWorks Call Detail Record (CDR) File Transfer Protocol (FTP)-
specific interface configuration.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/File/
FTP> level.
2) Enter:
get↵
10.2.1.5.3.2 set
This command is used to modify the BroadWorks Call Detail Record (CDR) File Transfer Protocol (FTP)-
specific interface configuration.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/File/
FTP> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, remoteDirectory, remote The name of an attribute to

HostName, remoteUserId, remote modify.
Password, usePassiveMode

<enabled> Choice true, false Controls if the billing file FTP

delivery feature is on or off.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 553
 Variable Field Type Valid Values Description

<remote String 0 to 255 characters The name of the remote directory

Directory> to which the billing files will be
copied; if not empty, should be
terminated with a '/' character (or
a '\' character, depending on the
target platform).

<remoteHost String 0 to 255 characters The host name of the machine to

Name> which the billing files are copied.

<remoteUser String 0 to 20 characters The user ID with which to

Id> authenticate to the remote FTP
server. The CLI prompts you to
provide the password for this
user when you execute the set
command.

<usePassive Choice true, false When set to "true", the passive

Mode> mode is set to on. This parameter
is used when the Application
Server is behind a firewall
that blocks normal FTP data
connections with the billing or
mediation device. When set to
"false", the passive mode is set to
off. This parameter is used when
the Application Server is behind
a firewall that blocks normal FTP
data connections with the billing
or mediation device.

10.2.1.6 Radius
This level is used to view and modify the Radius accounting attributes.
10.2.1.6.1 get
This command is used to view all Radius accounting attributes.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/Radius>
level.
2) Enter:
get↵
10.2.1.6.2 set
This command is used to modify the Radius accounting attributes.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/Radius>
level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, sendCallStartCDR, send The name of an attribute to

CallAnswerCDR, sharedSecret, modify.
retransmissionDelayMilliseconds,
maxTransmissions

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 554
 Variable Field Type Valid Values Description

<enabled> Choice true, false Enables or disables the sending

of CDRs in real time.

<sendCall Choice true, false Specifies whether or not a CDR

StartCDR> is to be sent upon originations or
terminations.

<sendCall Choice true, false Specifies whether or not a CDR is

AnswerCDR> to be sent upon answer.

<shared String 0 to 80 characters The secret used for computing/

Secret> validating the authenticator in
accounting request/responses.
This field is case sensitive. It
must match the configuration
of the Radius Servers. If the
two Radius servers are used,
both servers MUST use the
same sharedSecret attribute with
respect to this Application Server.

<retransmission Integer 200 through 5000 Specifies the delay in

Delay milliseconds before the
Milliseconds> Application Server considers
a CDR request failed, and
retransmits the message to the
next Radius server in the pool.

<max Integer 1 through 100000 This attribute indicates

Transmissions> the maximum number of
transmissions for the same
accounting request to any
Radius server. At this point, new
accounting requests are kept in a
holding queue.

10.2.1.6.3 Device
This level is used to view and add new Radius servers to the system. You can also modify or remove
attributes related to the Radius servers.
10.2.1.6.3.1 get
This command is used to view Radius server-related attributes.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/Radius/
Device> level.
2) Enter:
get↵
10.2.1.6.3.2 add
This command is used to add a new Radius server.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/Radius/
Device> level.
2) Enter:
add <ipAddress> <port> [<attribute>]↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 555
 Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The IP address of the Radius

server.

<port> Integer 1025 through 65535 The Radius server's port.

<attribute> MultipleChoice description Additional attributes to include

through the add command.

<description> String 1 to 80 characters Specifies the description of the

Radius server.

10.2.1.6.3.3 set
This command is used to modify Radius server-related attributes.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/Radius/
Device> level.
2) Enter:
set <ipAddress> <port> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The IP address of the Radius

server.

<port> Integer 1025 through 65535 The Radius server's port.

<attribute> MultipleChoice description The name of an attribute to

modify.

<description> String 1 to 80 characters Specifies the description of the

Radius server.

10.2.1.6.3.4 delete
This command is used to delete an existing Radius server.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/Radius/
Device> level.
2) Enter:
delete <ipAddress> <port>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The IP address of the Radius

server.

<port> Integer 1025 through 65535 The Radius server's port.

10.2.1.6.3.5 clear
This command is used to clear (set to no value) specific attributes from an existing Radius server.
1) Ensure you are at the /AS_CLI/Interface/Accounting/BroadWorksCDRInterface/Radius/
Device> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 556
 2) Enter:
clear <ipAddress> <port> <attribute>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The IP address of the Radius

server.

<port> Integer 1025 through 65535 The Radius server's port.

<attribute> MultipleChoice description The name of the attribute(s) to

clear.

10.2.2 Browser
This level is used to browse billing files stored on the Application Server.

10.2.2.1 get
This command lists accounting files from one of the accounting holding directories.
1) Ensure you are at the /AS_CLI/Interface/Accounting/Browser> level.
2) Enter:
get <directory>↵
where:
Variable Field Type Valid Values Description

<directory> Choice active, latest, archive, not_sent When set to active, stores the
active CDR file (the file being
updated). When set to latest
stores the latest complete
CDR file. When an active file
is completed, it is closed and
moved from the active to the
latest subdirectory. It is then
automatically sent by FTP to the
billing system, if so configured.
When set to archive if the
billingHoldPeriod is set to a
value greater than 0, CDR files
are moved from the latest to
the archive subdirectory upon
file rotation (otherwise, the old
file is deleted from the latest
subdirectory). CDR files are
deleted from this subdirectory
once the billingHoldPeriod has
ended. When set to not_sent if
automatic FTP upload is enabled
but a failure occurs, an alarm is
generated and the CDR file is
copied to this subdirectory (and
never automatically deleted).

10.2.2.2 browse
This command is used to search BroadWorks accounting files. Search criteria can be specified to extract
billing records.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 557
 1) Ensure you are at the /AS_CLI/Interface/Accounting/Browser> level.
2) Enter:
browse <directory> <command> <criteria> <value> [<fileId>]↵
where:
Variable Field Type Valid Values Description

<directory> Choice active, latest, archive, not_sent When set to active, stores the
active CDR file (the file being
updated). When set to latest
stores the latest complete
CDR file. When an active file
is completed, it is closed and
moved from the active to the
latest subdirectory. It is then
automatically sent by FTP to the
billing system, if so configured.
When set to archive if the
billingHoldPeriod is set to a
value greater than 0, CDR files
are moved from the latest to
the archive subdirectory upon
file rotation (otherwise, the old
file is deleted from the latest
subdirectory). CDR files are
deleted from this subdirectory
once the billingHoldPeriod has
ended. When set to not_sent if
automatic FTP upload is enabled
but a failure occurs, an alarm is
generated and the CDR file is
copied to this subdirectory (and
never automatically deleted).

<command> Choice list, detail Lists the records (headers only),

that match the searching criteria.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 558
 Variable Field Type Valid Values Description

<criteria> Choice acbActivation.facResult, acb Refer to the BroadWorks Call

Activation.invocationTime, acb Detail Record (CDR) Interface
Deactivation.facResult, acb Specification document for more
Deactivation.invocationTime, information on each criterion.
accessCallID, accessDevice
Address, accessNetworkInfo,
accountCode, accountCode
PerCall.facResult, account
CodePerCall.invocationTime,
acrActivation.facResult, acr
Activation.invocationTime, acr
Deactivation.facResult, acr
Deactivation.invocationTime,
acrInterrogation.facResult, acr
Interrogation.invocationTime,
adviceOfCharge.aocType, advice
OfCharge.charge, adviceOf
Charge.currency, adviceOf
Charge.invocationTime, adviceOf
Charge.result, adviceOfCharge
.sum, adviceOfCharge.time,
answerConfirmationInvocation
Time, answerConfirmationTime,
answerIndicator, answerTime,
asCallType, authorizationCode,
automaticHoldRetrieve.action,
automaticHoldRetrieve.invocation
Time, bodyContentDisposition,
bodyContentLength, body
ContentType, bodyOriginator,
broadworksAnywhere.related
CallId, broadworksMobility
.mobilityNumber, broadworks
Mobility.mobilityRoutingNumber,
btluExceeded, callBridge.call
BridgeResult, callCategory,
callCenter.forcedForwarding
ActivationResult, callCenter
.forcedForwardingDeactivation
Result, callCenter.nightService
ActivationMOResult, callCenter
.nightServiceDeactivationMO
Result, callCenter.outgoing
CallCenterCallFACResult, call
Center.outgoingCallCenterGroup
Number, callCenter.outgoingCall
CenterPhoneNumber, callCenter
.outgoingCallCenterUserId, call
Center.outgoingPersonalCallFAC
Result, callMeNow.relatedCall
Id, callMeNow.transactionId,
callMeNow.type, callPark.fac
Result, callPark.invocationTime,
callParkRetrieve.facResult,
callParkRetrieve.invocation
Time, callParked.invocation
Time, callPickup.facResult,
callPickup.invocationTime,
callRecording.facResult, call
Recording.invocationTime, call

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 559
 Variable Field Type Valid Values Description
Recording.recordingDestination,
callRecording.recordingResult,
callRecording.recordingTrigger,
callRecordingPause.facResult,
callRecordingPause.invocation
Time, callRecordingResume
.facResult, callRecording
Resume.invocationTime, call
RecordingStart.facResult, call
RecordingStart.invocationTime,
callRecordingStop.facResult,
callRecordingStop.invocation
Time, callRetrieve.callRetrieve
Result, callWaitingActivation
.facResult, callWaitingActivation
.invocationTime, callWaiting
Deactivation.facResult, call
WaitingDeactivation.invocation
Time, calledAssertedIdentity,
calledAssertedPresentation
Indicator, calledNumber, called
NumberContext, calledParty
Address, callingAssertedNumber,
callingAssertedNumberContext,
callingNumber, callingNumber
Context, callingPartyAddress,
callingPartyCategory, calling
PresentationIndicator, calling
PresentationNumber, calling
PresentationNumberContext,
cancelCWTperCall.facResult,
cancelCWTperCall.invocation
Time, carrierIdentification
Code, cbActivation.facResult,
cbActivation.invocationTime,
cbDeactivation.facResult, cb
Deactivation.invocationTime,
cbQuery.facResult, cbQuery
.invocationTime, cbfAuthorization
Code, ccDispositionCode
Tagging.invocationTime, cc
DispositionCodeTagging.result,
ccEmergencyCall.invocationTime,
ccEscalatedCall.facResult, cc
EscalatedCall.invocationTime,
ccMonitoringBI.facResult, cc
MonitoringBI.invocationTime, cfa
Activation.facResult, cfaActivation
.invocationTime, cfaDeactivation
.facResult, cfaDeactivation
.invocationTime, cfaInterrogation
.facResult, cfaInterrogation
.invocationTime, cfbActivation.fac
Result, cfbActivation.invocation
Time, cfbDeactivation.facResult,
cfbDeactivation.invocationTime,
cfbInterrogation.facResult, cfb
Interrogation.invocationTime,
cfnaActivation.facResult, cfna
Activation.invocationTime, cfna

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 560
 Variable Field Type Valid Values Description
Deactivation.facResult, cfna
Deactivation.invocationTime,
cfnaInterrogation.facResult, cfna
Interrogation.invocationTime,
cfnrcActivation.facResult, cfnrc
Activation.invocationTime, cfnrc
Deactivation.facResult, cfnrc
Deactivation.invocationTime,
cfnrcInterrogation.facResult,
cfnrcInterrogation.invocation
Time, chargeIndicator, charge
Number, chargingFunction
Addresses, cicInsertedAsCac,
clearMWI.facResult, clearMW
I.invocationTime, clidBlocking
Activation.facResult, clidBlocking
Activation.invocationTime,
clidBlockingDeactivation.fac
Result, clidBlockingDeactivation
.invocationTime, clidBlocking
Interrogation.facResult, clid
BlockingInterrogation.invocation
Time, clidBlockingPerCall.fac
Result, clidBlockingPerCall
.invocationTime, clidDelivery
PerCall.facResult, clidDelivery
PerCall.invocationTime, clid
Permitted, codec, codecUsage,
collaborate.bridge, collaborate
.invocationTime, collaborate
.owner, collaborate.ownerDN,
collaborate.role, collaborate
.roomID, collaborate.roomName,
collaborate.roomType, colr
Interrogation.facResult, colr
Interrogation.invocationTime,
conference.confId, conference
.startTime, conference.stopTime,
conference.type, configurableCLI
D, creator, customRingback
.invocationTime, customRingback
.mediaSelection, customSchema
Version, customerOriginated
Trace.facResult, customer
OriginatedTrace.invocationTime,
cwInterrogation.facResult, cw
Interrogation.invocationTime,
date, department, dialableCalling
Number, dialedDigits, dialed
DigitsContext, directVMTransfer
.facResult, directVMTransfer
.invocationTime, directedCPU
BargeIn.facResult, directedCPU
BargeIn.invocationTime, directed
CallPickup.facResult, directedCall
Pickup.invocationTime, direction,
diversionInhibitor.facResult,
diversionInhibitor.invocation
Time, dndActivation.facResult,
dndActivation.invocationTime,

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 561
 Variable Field Type Valid Values Description
dndDeactivation.facResult,
dndDeactivation.invocation
Time, earlyMediaInitiatorFlag,
earlyMediaSdp, enterprise
TrunkCapacityExceeded, event
Counter, executiveAssistant
CallPush.facResult, executive
AssistantCallPush.invocation
Time, executiveAssistantInitiate
Call.facResult, executiveAssistant
InitiateCall.invocationTime,
executiveAssistantOptIn.fac
Result, executiveAssistantOpt
In.invocationTime, executive
AssistantOptOut.facResult,
executiveAssistantOptOut
.invocationTime, executiveCall
FilteringActivation.facResult,
executiveCallFilteringActivation
.invocationTime, executiveCall
FilteringDeactivation.facResult,
executiveCallFilteringDeactivation
.invocationTime, extTracking
Id, failoverCorrelationId, fax
Messaging, flashCallHold.fac
Result, flashCallHold.invocation
Time, flexibleSeatingGuest.host
Group, flexibleSeatingGuest.host
GroupNumber, flexibleSeating
Guest.hostUserId, flexibleSeating
Guest.hostUserNumber, flexible
SeatingGuest.invocationTime,
fmfmCallPush.facResult, fmfm
CallPush.invocationTime, gets,
group, groupNumber, group
Paging.invocationTime, group
Paging.relatedCallId, hoteling
.group, hoteling.groupNumber,
hoteling.invocationTime, hoteling
.userId, hoteling.userNumber,
huntGroupBusyActivation.fac
Result, huntGroupBusyActivation
.invocationTime, huntGroupBusy
Activation.targetHuntGroupId,
huntGroupBusyDeactivation
.facResult, huntGroupBusy
Deactivation.invocationTime,
huntGroupBusyDeactivation
.targetHuntGroupId, huntGroup
BusyInterrogation.facResult,
huntGroupBusyInterrogation
.invocationTime, huntGroupBusy
Interrogation.targetHuntGroup
Id, instantGroupCall.invocation
Time, instantGroupCall.pushTo
Talk, instantGroupCall.related
CallId, interceptGroup.routing
Number, interceptUser.routing
Number, key, lastNumberRedial
.facResult, lastNumberRedial

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 562
 Variable Field Type Valid Values Description
.invocationTime, legacyAcb
Activation.facResult, legacy
AcbActivation.invocationTime,
legacyAcbDeactivation.facResult,
legacyAcbDeactivation.invocation
Time, localCallId, location,
locationControl.locationActivation
Result, locationControl.location
DeactivationResult, locationType,
locationUsage, mediaInitiator
Flag, meetmeConference.bridge,
meetmeConference.conference
Id, meetmeConference.invocation
Time, meetmeConference.owner,
meetmeConference.ownerDN,
meetmeConference.projectCode,
meetmeConference.recording
Duration, meetmeConference
.role, meetmeConference.title,
midCallCustomerOriginatedTrace
.invocationTime, mobilityCall
AnchoringActivation.facResult,
mobilityCallAnchoringActivation
.invocationTime, mobilityCall
AnchoringActivationPerCall.fac
Result, mobilityCallAnchoring
ActivationPerCall.invocation
Time, mobilityCallAnchoring
Deactivation.facResult, mobility
CallAnchoringDeactivation
.invocationTime, mobilityCalling
LineIDActivation.facResult,
mobilityCallingLineIDActivation
.invocationTime, mobilityCalling
LineIDActivationPerCall.fac
Result, mobilityCallingLineID
ActivationPerCall.invocation
Time, mobilityCallingLineID
Deactivation.facResult, mobility
CallingLineIDDeactivation
.invocationTime, mobilityCalling
LineIDDeactivationPerCall.fac
Result, mobilityCallingLineID
DeactivationPerCall.invocation
Time, monitoringNextCall.fac
Result, monitoringNextCall
.invocationTime, musicOnHold
PerCallDeactivation.facResult,
musicOnHoldPerCallDeactivation
.invocationTime, namePermitted,
networkCallID, networkCall
Type, networkTranslatedGroup,
networkTranslatedNumber,
networkTranslatedNumber
Context, noAnswerTimerSet
.facResult, noAnswerTimer
Set.invocationTime, number
Portability.npdi, numberPortability
.rn, numberPortability.status,
numberPortabilityAnnouncement

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 563
 Variable Field Type Valid Values Description
Activation.facResult, number
PortabilityAnnouncement
Activation.invocationTime,
numberPortabilityAnnouncement
Deactivation.facResult, number
PortabilityAnnouncement
Deactivation.invocation
Time, officeZone, original
CalledNumber, originalCalled
NumberContext, originalCalled
PresentationIndicator, original
CalledReason, originationMethod,
originatorNetwork, otherInfoInPC
V, otherPartyName, otherParty
NamePresentationIndicator,
outsideAccessCode, pCamel
CellIDorLAI, pCamelLocInfo, p
CamelMscAddress, personal
Assistant.presence, preAlerting
Announcement.preAlerting
Duration, prepaidStatus, primary
DeviceLinePort, primaryZone,
pushtoTalk.facResult, pushtoTalk
.invocationTime, q850Cause,
recallType, receivedCalling
Number, redirectingNumber,
redirectingNumberContext,
redirectingPresentationIndicator,
redirectingReason, relatedCall
Id, relatedCallIdReason, release
Time, releasingParty, remote
CallId, returnCall.facResult,
returnCall.invocationTime, return
CallNumDel.facResult, return
CallNumberDeletion.invocation
Time, roamingMscAddress,
route, routeList.routeListNumber,
routingNumber, sacLocking.fac
Result, sacLocking.invocation
Time, sacUnlocking.facResult,
sacUnlocking.invocationTime,
scc.invocationTime, scc.scc
CallId, scc.sccCause, scc.scc
Number, scfActivation.facResult,
scfActivation.invocationTime,
scfDeactivation.facResult, scf
Deactivation.invocationTime,
scrInterrogation.facResult, scr
Interrogation.invocationTime,
sd100Programming.facResult,
sd100Programming.invocation
Time, sd8Programming.fac
Result, sd8Programming
.invocationTime, sdp, sdpAnswer
Timestamp, sdpOfferTimestamp,
serviceProvider, sipErrorCode,
startTime, systemId, system
TimeZone, terminationCause,
terminatorNetwork, transfer
.invocationTime, transfer.related

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 564
 Variable Field Type Valid Values Description
CallId, transfer.result, transfer
.type, trunkGroupInfo, trunk
GroupName, twoStageDialing
Digits, type, typeOfNetwork,
userAgent, userId, userNumber,
userTimeZone, virtualOnNet
Type, vmAlwaysActivation.fac
Result, vmAlwaysActivation
.invocationTime, vmAlways
Deactivation.facResult, vmAlways
Deactivation.invocationTime, vm
BusyActivation.facResult, vm
BusyActivation.invocationTime,
vmBusyDeactivation.facResult,
vmBusyDeactivation.invocation
Time, vmNoAnswerActivation.fac
Result, vmNoAnswerActivation
.invocationTime, vmNoAnswer
Deactivation.facResult, vmNo
AnswerDeactivation.invocation
Time, vmrDialing.facResult, vmr
Dialing.invocationTime, voice
PortalCalling.invocationTime,
vpDialing.facResult, vpDialing
.invocationTime

<value> String 1 to 256 characters The value associated with the

search criteria. The criteria list
the records that match both the
criteria and the value.

<fileId> Integer 1 through 2147483647 Search a specific file in the

accounting directory. Valid fields
are obtained by first running the
Get command on the accounting
directory.

10.2.3 FieldIdMapping
This level is used to view and modify the internal accounting field ID to external accounting field ID
mappings.

10.2.3.1 get
This command is used to view the internal accounting field ID to external accounting field ID mappings.
1) Ensure you are at the /AS_CLI/Interface/Accounting/FieldIdMapping> level.
2) Enter:
get [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice internalId, externalId Mapping criteria.

<internalId> Integer 4 through 1000 Internal accounting field Id to filter

on.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 565
 Variable Field Type Valid Values Description

<externalId> Integer 4 through 1000 External accounting field Id to

filter on.

10.2.3.2 set
This command is used to modify the account external field Id mapping attributes. A restart is required for
the change to take effect.
1) Ensure you are at the /AS_CLI/Interface/Accounting/FieldIdMapping> level.
2) Enter:
set <internalId> <attribute>↵
where:
Variable Field Type Valid Values Description

<internalId> Integer 4 through 1000 Internal accounting field Id.

<attribute> MultipleChoice externalId The name of an attribute to

modify.

<externalId> Integer 4 through 1000 External accounting field Id. This

is the Id output to accounting
records.

10.2.3.3 clear
This command is used to clear (set to no value) the account external field ID mapping attributes. A restart
is required for the change to take effect.
1) Ensure you are at the /AS_CLI/Interface/Accounting/FieldIdMapping> level.
2) Enter:
clear <internalId> <attribute>↵
where:
Variable Field Type Valid Values Description

<internalId> Integer 4 through 1000 Internal accounting field Id.

<attribute> MultipleChoice externalId The name of an attribute to clear.

10.3 CAP
This level is used to view and modify Client Application Protocol (CAP)-related attributes.

10.3.1 get
This command is used to view the Client Application Protocol (CAP)-related attributes.
1) Ensure you are at the /AS_CLI/Interface/CAP> level.
2) Enter:
get↵

10.3.2 set
This command is used to modify the Client Application Protocol (CAP)-related attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 566
 1) Ensure you are at the /AS_CLI/Interface/CAP> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice serverPort, numClient The name of an attribute to

Connections, enableConnection modify.
Ping, connectionPingInterval
Minutes, ccc2ServerPort, ccc2
NumClientConnections

<serverPort> Integer 1025 through 65535 The server port number.

<numClient Integer 0 through 10 The maximum number of client

Connections> connections allowed.

<enable Choice true, false Specify if the connection ping

Connection function is enabled. This is
Ping> used to keep or verify that the
connection is still active.

<connection Integer 0 through 1440 Set the connection ping time

PingInterval interval (in minutes).
Minutes>

<ccc2Server Integer 1025 through 65535 The port that the BroadWorks
Port> CAP for Client Call Control II
Server listens on.

<ccc2 Integer 0 through 10 The number of TCP/IP

NumClient connections allowed for the
Connections> ccc2ServerPort.

10.4 CallLogs
This level is used to view and modify the Call Log attributes.

10.4.1 get
This command is used to view Call Log attributes.
1) Ensure you are at the /AS_CLI/Interface/CallLogs> level.
2) Enter:
get↵

10.4.2 set
This command is used to modify the Call Log attributes.
1) Ensure you are at the /AS_CLI/Interface/CallLogs> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 567
 Variable Field Type Valid Values Description

<attribute> MultipleChoice enableSend, callLogServer1 The name of an attribute to

Address, callLogServer1Send modify.
Port, callLogServer1RetrievePort,
callLogServer2Address, callLog
Server2SendPort, callLogServer2
RetrievePort, sharedSecret,
retransmissionDelayMilliseconds,
maxTransmissions, soapTimeout
Seconds

<enableSend> Choice true, false This variable allows you to enable

or disable the sending of call logs.
Does not affect retrieval.

<callLog String 1 to 80 characters Specifies the address (IP or

Server1 FQDN) of the primary Call Detail
Address> Server.

<callLog Integer 1025 through 65535 Specifies the port that is used to
Server1Send send call logs for the primary Call
Port> Detail Server. The default port is
1813.

<callLog Integer 1 through 65535 Specifies the port through which

Server1 the call logs are retrieved using
RetrievePort> the primary Call Detail Server.
The default port is 8080.

<callLog String 1 to 80 characters Specifies the address (IP or

Server2 FQDN) of the alternate Call Detail
Address> Server. The address should be
left blank if the server is not in
use.

<callLog Integer 1025 through 65535 Specifies the port through which
Server2Send the call logs are sent using the
Port> alternate Call Detail Server. The
default port is 1813.

<callLog Integer 1 through 65535 Specifies the port through which

Server2 the call logs are retrieved using
RetrievePort> the alternate Call Detail server.
The default port is 8080.

<shared String 1 to 80 characters The sharedSecret variable is

Secret> used for computing/validating
the Authenticator in call logs
requests/responses. This field is
case sensitive. It MUST match
the configuration of the Call Detail
Servers. If both the primary and
alternate Call Detail Servers are
used, both servers MUST use the
same sharedSecret variable.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 568
 Variable Field Type Valid Values Description

<retransmission Integer 200 through 5000 Indicates the interval in

Delay milliseconds that the call log is
Milliseconds> re-sent after a response has not
been received.

<max Integer 1 through 5 Specifies the maximum

Transmissions> number of transmissions (initial
transmission included) of the
same call log request to the Call
Detail Server, before attempting
to connect to the alternate
server, or dropping the request
if the alternate server has been
attempted previously.

<soapTimeout Integer 1 through 120 When the PS asks the CDS over
Seconds> soap for the call logs of a user,
it must get a response within
soapTimeoutSeconds else it
gives up.

10.4.3 clear
This command is used to clear (set to no value) the Call Log attributes.
1) Ensure you are at the /AS_CLI/Interface/CallLogs> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice callLogServer1Address, callLog The name of the attribute(s) to

Server2Address, sharedSecret clear.

10.5 CommonCommunicationTransport
This level is used to configure the BroadWorks Common Communication Transport. The Common
Communication Transport protocol is a TCP-based transport method that is protocol-independent, that is
it can be used to send and receive messages concurrently using multiple protocols using a generic set
of message wrappers. It increases performance and security by reducing the need for open ports on the
network, supporting Secure Sockets Layer (SSL) security, and supporting per-protocol access control lists.

10.5.1 get
This command is used to view the BroadWorks Common Communication Transport attributes.
1) Ensure you are at the /AS_CLI/Interface/CommonCommunicationTransport> level.
2) Enter:
get↵

10.5.2 set
This command is used to modify the BroadWorks Common Communication Transport attributes.
1) Ensure you are at the /AS_CLI/Interface/CommonCommunicationTransport> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 569
 2) Enter:
set <attribute> <false> <false>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice XSUnlimitedConnections, PS The name of an attribute to

UnlimitedConnections, XS modify.
ListeningPort, PSListeningPort,
XSSecureListeningPort, PS
SecureListeningPort

<XSUnlimited Choice true, false Determines whether to allow

Connections> unlimited connections to the
execution server process on
the current host. If you choose
false, you must also specify the
maximum number of connections
(integer from 1 to 65535).

<false> Additional options are required

in case the connections are
unlimited.

<PSUnlimited Choice true, false Determines whether to allow

Connections> unlimited connections to the
provisioning server process on
the current host. If you choose
false, you must also specify the
maximum number of connections
(integer from 1 to 65535).

<false> Additional options are required

in case the connections are
unlimited.

<XSListening Integer 1025 through 65535 Determines the port used by

Port> the Common Communication
Transport for communication with
the execution server process on
the current host.

<PSListening Integer 1025 through 65535 Determines the port used by

Port> the Common Communication
Transport for communication with
the provisioning server process
on the current host.

<XSSecure Integer 1025 through 65535 Determines the port used by

ListeningPort> the Common Communication
Transport for secure
communication with the execution
server process on the current
host.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 570
 Variable Field Type Valid Values Description

<PSSecure Integer 1025 through 65535 Determines the port used by

ListeningPort> the Common Communication
Transport for secure
communication with the
provisioning server on the current
host.

10.5.3 OCI
This level is used to configure Open Client Interface (OCI)-related attributes of the BroadWorks Common
Communication Transport.

10.5.3.1 CallControl
This level is used to manage BroadWorks Common Communication Transport - OCI Call Control
attributes.
10.5.3.1.1 get
This command is used to view BroadWorks Common Communication Transport - OCI Call Control
attributes.
1) Ensure you are at the /AS_CLI/Interface/CommonCommunicationTransport/OCI/
CallControl> level.
2) Enter:
get↵
10.5.3.1.2 set
This command is used to modify BroadWorks Common Communication Transport - OCI Call Control
attributes-related attributes.
1) Ensure you are at the /AS_CLI/Interface/CommonCommunicationTransport/OCI/
CallControl> level.
2) Enter:
set <attribute> <false>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice unlimitedConnections, restrict The name of an attribute to

Interfaces modify.

<unlimited Choice true, false Determines whether to allow

Connections> unlimited connections on the
current host. If you choose
false, you must also specify the
maximum number of connections
(integer from 1 through 65535).

<false> Additional options are required

in case the connections are
unlimited.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 571
 Variable Field Type Valid Values Description

<restrict Choice true, false Determines whether to restrict

Interfaces> the local IP interfaces allowed to
receive messages using the OCI
protocol. If set to "true", configure
the list of remote hosts allowed to
use OSS.

10.5.3.1.3 Interfaces
This level is used to configure the list of local IP interfaces allowed to receive messages using the OCI
protocol over the BroadWorks Common Communications Transport.
10.5.3.1.3.1 get
This command is used to display the list of local IP interfaces allowed to receive messages using the OCI
protocol.
1) Ensure you are at the /AS_CLI/Interface/CommonCommunicationTransport/OCI/
CallControl/Interfaces> level.
2) Enter:
get↵
10.5.3.1.3.2 add
This command is used to add an interface address to the list of local IP interfaces allowed to receive
messages using the OCI protocol.
1) Ensure you are at the /AS_CLI/Interface/CommonCommunicationTransport/OCI/
CallControl/Interfaces> level.
2) Enter:
add <interfaceAddress>↵
where:
Variable Field Type Valid Values Description

<interface String 1 to 39 characters The interface IP address.

Address>

10.5.3.1.3.3 delete
This command is used to remove an interface address from the list of local IP interfaces allowed to receive
messages using the OCI protocol.
1) Ensure you are at the /AS_CLI/Interface/CommonCommunicationTransport/OCI/
CallControl/Interfaces> level.
2) Enter:
delete <interfaceAddress>↵
where:
Variable Field Type Valid Values Description

<interface String 1 to 39 characters The interface IP address.

Address>

10.5.3.2 Provisioning
This level is used to view and modify the Open Client Interface-Provisioning (OCI-P) attributes of the
BroadWorks Common Communication Transport.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 572
10.5.3.2.1 get
This command is used to view the Open Client Interface-Provisioning (OCI-P) attributes of the BroadWorks
Common Communication Transport.
1) Ensure you are at the /AS_CLI/Interface/CommonCommunicationTransport/OCI/
Provisioning> level.
2) Enter:
get↵
10.5.3.2.2 set
This command is used to modify the Open Client Interface-Provisioning (OCI-P) attributes of the
BroadWorks Common Communication Transport.
1) Ensure you are at the /AS_CLI/Interface/CommonCommunicationTransport/OCI/
Provisioning> level.
2) Enter:
set <attribute> <false>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice unlimitedConnections, restrict The name of an attribute to

Interfaces modify.

<unlimited Choice true, false Determines whether to allow

Connections> unlimited connections on the
current host. If you choose
false, you must also specify the
maximum number of connections
(integer from 1 to 65535).

<false> Additional options are required

in case the connections are
unlimited.

<restrict Choice true, false Determines whether to restrict

Interfaces> the local IP interfaces allowed to
receive messages using the OCI
protocol. If set to "true", configure
the list of remote hosts allowed to
use OSS.

10.5.3.2.3 Interfaces
This level is used to manage BroadWorks Common Communication Transport - OCI Provisioning
Supported Interfaces-related attributes.
10.5.3.2.3.1 get
This command is used to view BroadWorks Common Communication Transport - OCI Provisioning
Supported Interfaces-related attributes.
1) Ensure you are at the /AS_CLI/Interface/CommonCommunicationTransport/OCI/
Provisioning/Interfaces> level.
2) Enter:
get↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 573
10.5.3.2.3.2 add
This command is used to add a new BroadWorks Common Communication Transport - OCI Provisioning
Supported Interfaces.
1) Ensure you are at the /AS_CLI/Interface/CommonCommunicationTransport/OCI/
Provisioning/Interfaces> level.
2) Enter:
add <interfaceAddress>↵
where:
Variable Field Type Valid Values Description

<interface String 1 to 39 characters The interface IP address.

Address>

10.5.3.2.3.3 delete
This command is used to delete an existing BroadWorks Common Communication Transport - OCI
Provisioning Supported Interfaces from the system.
1) Ensure you are at the /AS_CLI/Interface/CommonCommunicationTransport/OCI/
Provisioning/Interfaces> level.
2) Enter:
delete <interfaceAddress>↵
where:
Variable Field Type Valid Values Description

<interface String 1 to 39 characters The interface IP address.

Address>

10.6 Cr
This level is used to display and modify the system level Cr Interface attributes.

10.6.1 get
This command is used to view the system level Cr Interface attributes.
1) Ensure you are at the /AS_CLI/Interface/Cr> level.
2) Enter:
get↵

10.6.2 set
This command is used to modify the system level Cr Interface attributes for detecting Media Cr Interface
communication failures.
1) Ensure you are at the /AS_CLI/Interface/Cr> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 574
 Variable Field Type Valid Values Description

<attribute> MultipleChoice crAuditEnabled, crAuditInterval The name of an attribute to

Milliseconds, crAuditTimeout modify.
Milliseconds, crConnection
Enabled, crConnectionTimeout
Milliseconds

<crAudit Choice true, false Controls if the Media Cr Audit is

Enabled> enabled/disabled.

<crAuditInterval Integer 500 through 60000 The value in milliseconds

Milliseconds> specifying how often the Media Cr
K-ALIVE request is sent.

<crAudit Integer 500 through 10000 The value in milliseconds

Timeout specifying how long to wait for
Milliseconds> Media Cr K-ALIVE response.

<crConnection Choice true, false Controls if the Media Server Cr

Enabled> Control Channel Connection
setup wait period is enabled/
disabled.

<crConnection Integer 1000 through 32000 The value in milliseconds

Timeout specifying how long to wait for
Milliseconds> the SIP INVITE to the Media
Server, that sets up the Cr control
connection to respond.

10.7 Diameter
This level is used to view and modify Diameter-related attributes.

10.7.1 get
This command is used to view Diameter-related attributes.
1) Ensure you are at the /AS_CLI/Interface/Diameter> level.
2) Enter:
get↵

10.7.2 set
This command is used to modify Diameter-related attributes.
1) Ensure you are at the /AS_CLI/Interface/Diameter> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 575
 Variable Field Type Valid Values Description

<attribute> MultipleChoice xsRealm, xsListeningPort, ps The name of an attribute to

Realm, psListeningPort, ps modify.
RelayThroughXs, xsRelay
ListeningPort, tcTimerSeconds,
twTimerSeconds, requestTimer
Seconds, busyPeerDetection
OutstandingTxnCount, busyPeer
RestoreOutstandingTxnCount,
dynamicEntryInactivityTimer
Hours, advertisedOfflineBilling
Application, advertisedOnline
BillingApplication

<xsRealm> Domain/Host 1 to 80 characters The Diameter Realm associated

with the XS external Diameter
Interface. Changing this value
while the XS external Diameter
interface is enabled causes a
restart of the interface.

<xsListening Integer 1025 through 65535 The TCP port on which the XS
Port> external Diameter interface is
listening for incoming Diameter
connections. Changing this value
while the XS external Diameter
interface is enabled causes a
restart of the interface.

<psRealm> Domain/Host 1 to 80 characters The Diameter Realm

associated with the PS
Diameter interface. Used only
when XS relay is disabled
(psRelayThroughXs=false).
Changing this value while the PS
Diameter interface is enabled and
XS relay is not used causes a
restart of the interface.

<psListening Integer 1025 through 65535 The TCP port on which the PS
Port> Diameter interface is listening for
incoming Diameter connections.
The same port value is used
no matter if the PS interface is
using XS relay or not. Changing
this value while the PS Diameter
interface is enabled and XS relay
is not used causes a restart of the
interface.

<psRelay Choice true, false Enable/Disable Relayed Diameter

ThroughXs> Interfaces.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 576
 Variable Field Type Valid Values Description

<xsRelay Integer 1025 through 65535 The TCP port on which the XS
ListeningPort> internal Diameter interface is
listening for incoming connections
from the PS. The XS internal
Diameter interface is always
listening on the localhost
interface.

<tcTimer Integer 1 through 3600 The TC timer value. The TC timer

Seconds> controls the delay after which
the Diameter stack attempts
to reconnect to a peer after
detecting a connection failure.

<twTimer Integer 6 through 60 The TW timer value. The TW

Seconds> timer controls the frequency of
Device-Watchdog messages
(when no other messages
are exchanged on the peer
connection) and is used in
connection failure detection
algorithm.

<requestTimer Integer 1 through 600 The default request timer after

Seconds> which the Diameter stack reports
a timeout to applications and
removes the request from its
requests queue.

<busyPeer Integer 1 through 1000000 The maximum number of

Detection concurrent outstanding
OutstandingTxn transactions allowed on a single
Count> peer connection, after which
the Diameter stack reports
busy peer to applications.
The Diameter Stack no longer
sends requests to the peer
until the number of concurrent
outstanding transactions has
been lowered below the Busy
Peer Restore Outstanding Txn
Count parameter.

<busyPeer Integer 1 through 1000000 The number of concurrent

Restore outstanding transactions at which
OutstandingTxn the Diameter Stack starts sending
Count> requests again after having
detected a busy peer condition.

<dynamicEntry Integer 1 through 168 Idle time allowed for a dynamic

InactivityTimer entry (either Realm Routing Table
Hours> entry or Peer Table entry) before
it is removed. Dynamic Peer
Table entries aren't removed if
referenced by at least one Realm
Routing Table entry.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 577
 Variable Field Type Valid Values Description

<advertised Choice base, 3gpp The application Id advertised for

OfflineBilling offline billing during the Diameter
Application> Capability Exchange. When base
is selected, Acct-Application-
Id=3 is advertised. When 3gpp
is selected, Vendor-Specific-
Application-Id(Acct-Application-
Id=3; Vendor-Id=10415) is
advertised.

<advertised Choice base, 3gpp The application Id advertised for

OnlineBilling online billing during the Diameter
Application> Capability Exchange. When base
is selected, Auth-Application-
Id=4 is advertised. When 3gpp
is selected, Vendor-Specific-
Application-Id(Auth-Application-
Id=4; Vendor-Id=10415) is
advertised.

10.7.3 clear
This command is used to clear a Diameter-related attribute.
1) Ensure you are at the /AS_CLI/Interface/Diameter> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice xsRealm, psRealm The name of the attribute(s) to

clear.

10.7.4 Peers
This level is used to manage the Peer Table's static entries for Diameter. Aggregated view of static and
dynamic entries along with actual connection statuses is available under the AS_CLI/ASDiagnostic/
Diameter context.

10.7.4.1 get
This command is used to view Diameter Peers-related entries.
1) Ensure you are at the /AS_CLI/Interface/Diameter/Peers> level.
2) Enter:
get↵

10.7.4.2 add
This command is used to add Diameter Peers-related entries.
1) Ensure you are at the /AS_CLI/Interface/Diameter/Peers> level.
2) Enter:
add <instance> <identity> <port> <enabled> [<attribute>]↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 578
 Variable Field Type Valid Values Description

<instance> Choice ps, xs The process for which the Peer

Table is displayed.

<identity> Domain/Host 1 to 80 characters The Diameter Identity of the peer.

<port> Integer 1025 through 65535 The TCP port on which the
peer is listening for Diameter
connections.

<enabled> Choice true, false Indicates if connection to the

peer shall be established. If set
to false, the Diameter Stack
won't attempt to connect to the
peer and will reject incoming
connection attempts from the
peer.

<attribute> MultipleChoice ipAddress Additional attributes to include

through the add command.

<ipAddress> String 1 to 39 characters The IP address or the peer.

This parameter is optional; if not
specified the actual IP address is
resolved on the DNS.

10.7.4.3 set
This command is used to modify Diameter Peers-related entries.
1) Ensure you are at the /AS_CLI/Interface/Diameter/Peers> level.
2) Enter:
set <instance> <identity> <attribute>↵
where:
Variable Field Type Valid Values Description

<instance> Choice ps, xs The process for which the Peer

Table is displayed.

<identity> Domain/Host 1 to 80 characters The Diameter Identity of the peer.

<attribute> MultipleChoice ipAddress, port, enabled The name of an attribute to

modify.

<ipAddress> String 1 to 39 characters The IP address or the peer.

This parameter is optional; if not
specified the actual IP address is
resolved on the DNS.

<port> Integer 1025 through 65535 The TCP port on which the
peer is listening for Diameter
connections.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 579
 Variable Field Type Valid Values Description

<enabled> Choice true, false Indicates if connection to the

peer shall be established. If set
to false, the Diameter Stack
won't attempt to connect to the
peer and will reject incoming
connection attempts from the
peer.

10.7.4.4 delete
This command is used to remove Diameter Peers-related entries.
1) Ensure you are at the /AS_CLI/Interface/Diameter/Peers> level.
2) Enter:
delete <instance> <identity>↵
where:
Variable Field Type Valid Values Description

<instance> Choice ps, xs The process for which the Peer

Table is displayed.

<identity> Domain/Host 1 to 80 characters The Diameter Identity of the peer.

10.7.4.5 clear
Use this command is clear (set to no value) or view Diameter Peers-related entries attributes.
1) Ensure you are at the /AS_CLI/Interface/Diameter/Peers> level.
2) Enter:
clear <instance> <identity> <attribute>↵
where:
Variable Field Type Valid Values Description

<instance> Choice ps, xs The process for which the Peer

Table is displayed.

<identity> Domain/Host 1 to 80 characters The Diameter Identity of the peer.

<attribute> MultipleChoice ipAddress The name of the attribute(s) to

clear.

10.7.5 Realms
This level is used to manage Realm Routing Table's static for the Diameter interface.

10.7.5.1 get
This command is used to view Realm Routing Table's static entries.
1) Ensure you are at the /AS_CLI/Interface/Diameter/Realms> level.
2) Enter:
get↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 580
10.7.5.2 add
This command is used to add Realm Routing Table's static entries.
1) Ensure you are at the /AS_CLI/Interface/Diameter/Realms> level.
2) Enter:
add <instance> <realm> <applicationId> <default>↵
where:
Variable Field Type Valid Values Description

<instance> Choice ps, xs The process for which the Realm

Routing Table is displayed.

<realm> Domain/Host 1 to 80 characters The Realm Name.

<applicationId> Choice Rf, Ro, Sh, All The application associated with
the Realm Routing Table entry.
All is a wildcard indicating the
entry applies for all supported
Diameter applications.

<default> Choice true, false Indicates if the entry is also used

as a default Realm Routing
Table entry for the specified
applicationId. There can be
at most one default entry per
applicationId.

10.7.5.3 set
This command is used to modify Realm Routing Table's static entries.
1) Ensure you are at the /AS_CLI/Interface/Diameter/Realms> level.
2) Enter:
set <instance> <realm> <applicationId> <attribute>↵
where:
Variable Field Type Valid Values Description

<instance> Choice ps, xs The process for which the Realm

Routing Table is displayed.

<realm> Domain/Host 1 to 80 characters The Realm Name.

<applicationId> Choice Rf, Ro, Sh, All The application associated with
the Realm Routing Table entry.
All is a wildcard indicating the
entry applies for all supported
Diameter applications.

<attribute> MultipleChoice default The name of an attribute to

modify.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 581
 Variable Field Type Valid Values Description

<default> Choice true, false Indicates if the entry is also used

as a default Realm Routing
Table entry for the specified
applicationId. There can be
at most one default entry per
applicationId.

10.7.5.4 delete
This command is used to delete Realm Routing Table's static entries.
1) Ensure you are at the /AS_CLI/Interface/Diameter/Realms> level.
2) Enter:
delete <instance> <realm> <applicationId>↵
where:
Variable Field Type Valid Values Description

<instance> Choice ps, xs The process for which the Realm

Routing Table is displayed.

<realm> Domain/Host 1 to 80 characters The Realm Name.

<applicationId> Choice Rf, Ro, Sh, All The application associated with
the Realm Routing Table entry.
All is a wildcard indicating the
entry applies for all supported
Diameter applications.

10.7.5.5 RoutingPeers
This level is used to manage Routing Peers associated to a static Realm Routing Table entry.
10.7.5.5.1 get
This command is used to view all Routing Peers associated to a static Realm Routing Table entry.
1) Ensure you are at the /AS_CLI/Interface/Diameter/Realms/RoutingPeers> level.
2) Enter:
get↵
10.7.5.5.2 add
This command is used to add a Routing Peer associated to a static Realm Routing Table entry. The
Routing Peer's instance and identity must correspond to a Static Peer with the same instance and identity.
1) Ensure you are at the /AS_CLI/Interface/Diameter/Realms/RoutingPeers> level.
2) Enter:
add <instance> <realm> <applicationId> <identity> <priority> <weight>↵
where:
Variable Field Type Valid Values Description

<instance> Choice ps, xs The process for which the Realm

Routing Peer is displayed.

<realm> Domain/Host 1 to 80 characters The Realm Name.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 582
 Variable Field Type Valid Values Description

<applicationId> Choice Rf, Ro, Sh, All The application associated with
the Realm Routing Table entry.
All is a wildcard indicating the
entry applies for all supported
Diameter applications.

<identity> Domain/Host 1 to 80 characters The Peer Identity. Must

correspond to a Static Peer of
the same instance and identity.
A Routing Peer may correspond
to only one Realm Routing Table
entry.

<priority> Integer 0 through 65535 The priority of this peer against

other routing peers associated to
the same Realm Routing Table
entry.

<weight> Integer 0 through 65535 The weight used for ordering

peers having the same priority.

10.7.5.5.3 set
This command is used to modify a Routing Peer associated to a static Realm Routing Table entry. The
Routing Peer's instance and identity must correspond to a Static Peer with the same instance and identity.
1) Ensure you are at the /AS_CLI/Interface/Diameter/Realms/RoutingPeers> level.
2) Enter:
set <instance> <realm> <applicationId> <identity> <attribute>↵
where:
Variable Field Type Valid Values Description

<instance> Choice ps, xs The process for which the Realm

Routing Peer is displayed.

<realm> Domain/Host 1 to 80 characters The Realm Name.

<applicationId> Choice Rf, Ro, Sh, All The application associated with
the Realm Routing Table entry.
All is a wildcard indicating the
entry applies for all supported
Diameter applications.

<identity> Domain/Host 1 to 80 characters The Peer Identity. Must

correspond to a Static Peer of
the same instance and identity.
A Routing Peer may correspond
to only one Realm Routing Table
entry.

<attribute> MultipleChoice priority, weight The name of an attribute to

modify.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 583
 Variable Field Type Valid Values Description

<priority> Integer 0 through 65535 The priority of this peer against

other routing peers associated to
the same Realm Routing Table
entry.

<weight> Integer 0 through 65535 The weight used for ordering

peers having the same priority.

10.7.5.5.4 delete
This command is used to delete a Routing Peer associated to a static Realm Routing Table entry. The
Routing Peer's instance and identity must correspond to a Static Peer with the same instance and identity.
1) Ensure you are at the /AS_CLI/Interface/Diameter/Realms/RoutingPeers> level.
2) Enter:
delete <instance> <realm> <applicationId> <identity>↵
where:
Variable Field Type Valid Values Description

<instance> Choice ps, xs The process for which the Realm

Routing Peer is displayed.

<realm> Domain/Host 1 to 80 characters The Realm Name.

<applicationId> Choice Rf, Ro, Sh, All The application associated with
the Realm Routing Table entry.
All is a wildcard indicating the
entry applies for all supported
Diameter applications.

<identity> Domain/Host 1 to 80 characters The Peer Identity. Must

correspond to a Static Peer of
the same instance and identity.
A Routing Peer may correspond
to only one Realm Routing Table
entry.

10.8 FTP
This level is used to manage general FTP system level attributes.

10.8.1 get
This command is used to view the File Transfer Protocol (FTP) -related attributes.
1) Ensure you are at the /AS_CLI/Interface/FTP> level.
2) Enter:
get↵

10.8.2 set
This command is used to modify the File Transfer Protocol (FTP) -related attributes.
1) Ensure you are at the /AS_CLI/Interface/FTP> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 584
 set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice ftpConnectionTimeoutSeconds, The name of an attribute to

ftpMaxTransferDurationSeconds modify.

<ftpConnection Integer 0 through 300 Determines the amount of time to

Timeout try to establish a connection.
Seconds>

<ftpMax Integer 0 through 86400 Determines the amount of time to

Transfer allow a connection to stay open.
Duration
Seconds>

10.9 Http
This level is used to view, modify, add, and delete the Hypertext Transfer Protocol (HTTP) settings.

10.9.1 ClientAuthentication
This level is used to view and modify the Hypertext Transfer Protocol (HTTP) client authentication
properties.

10.9.1.1 get
This command is used to view the Client Authentication properties.
1) Ensure you are at the /AS_CLI/Interface/Http/ClientAuthentication> level.
2) Enter:
get↵

10.9.1.2 set
This command is used to modify the Client Authentication properties.
1) Ensure you are at the /AS_CLI/Interface/Http/ClientAuthentication> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice chainDepth The name of an attribute to

modify.

<chainDepth> Integer 0 through 256 This parameter specifies the

maximum depth of the client
Certification Authority (CA)
certificates. The depth is the
maximum number of intermediate
client certificate issuers.

10.9.1.3 Trusts
This level is used to generate Secure Sockets Layer (SSL) trust anchors.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 585
10.9.1.3.1 get
This command is used to view the list of Trust Anchors.
1) Ensure you are at the /AS_CLI/Interface/Http/ClientAuthentication/Trusts> level.
2) Enter:
get [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> Choice hideChain You may specify hideChain to

prevent the chain of certificate
authorities from being listed.

10.9.1.3.2 createTrust
This command is used to generate a Secure Sockets Layer (SSL) key and a trust anchor for a secure
Hypertext Transfer Protocol (HTTPS) interface.
1) Ensure you are at the /AS_CLI/Interface/Http/ClientAuthentication/Trusts> level.
2) Enter:
createTrust <alias> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<alias> String 1 to 64 characters This parameter describes a name

specified by the administrator to
identify uniquely a trust anchor.

<attribute> MultipleChoice keyLength, country, stateOr This parameter describes an

Province, city, organisationName, optional attribute to be set.
organisationUnit, emailAddress,
challengePassword, common
Name

<keyLength> Integer 512 through 16384 This parameter specifies the key
length or key size. (default value
2048 when not specified).

<country> String 2 to 2 characters This parameter describes the

country code international
abbreviation code.

<stateOr String 1 to 50 characters This parameter describes the

Province> state or province.

<city> String 1 to 50 characters This parameter describes the

name of the city.

<organisation String 1 to 50 characters This parameter describes the

Name> organization name.

<organisation String 1 to 50 characters This parameter describes the

Unit> organization unit.

<email String 1 to 50 characters This parameter describes the e-

Address> mail address.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 586
 Variable Field Type Valid Values Description

<challenge String 1 to 40 characters This parameter describes the

Password> challenge password.

<common String 1 to 255 characters This parameter describes the

Name> common name. Generally,
the common name on a client
certificate is the proper name
of the organization requesting
a certificate. Alternatively,
it may follow any standard
already determined within
the organization owning the
certificate.

10.9.1.3.3 deleteTrust
This command is used to delete a trust anchor identified by its alias name.
1) Ensure you are at the /AS_CLI/Interface/Http/ClientAuthentication/Trusts> level.
2) Enter:
deleteTrust <alias>↵
where:
Variable Field Type Valid Values Description

<alias> String 1 to 64 characters This parameter is used to identify

which trust anchor to delete.

10.9.1.3.4 exportTrust
This command is used to export a file related to Secure Sockets Layer (SSL). The SSL file is extracted
from the BroadWorks trust store and copied to the /var/broadworks/tmp directory.
1) Ensure you are at the /AS_CLI/Interface/Http/ClientAuthentication/Trusts> level.
2) Enter:
exportTrust <alias> <attribute>↵
where:
Variable Field Type Valid Values Description

<alias> String 1 to 64 characters This parameter is used to identify

which trust anchor to export.

<attribute> MultipleChoice certificateFile, keyFile, pkcs12File This parameter is used to select

which file type to export.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 587
 Variable Field Type Valid Values Description

Variable: pkcs12File

pkcs12File This parameter indicates to

export the certificate and key
in a Public-Key Cryptography
Standards (PKCS#12) formatted
keystore.

<pkcs12 Password 5 to 255 characters This parameter is used to specify

Password> (prompted) the password used to secure
the Public-Key Cryptography
Standards (PKCS#12) formatted
keystore.

10.9.1.3.5 showTrust
This command is used to view the details of the X.509 certificate associated with the trust anchor of the
provided interface.
1) Ensure you are at the /AS_CLI/Interface/Http/ClientAuthentication/Trusts> level.
2) Enter:
showTrust <alias>↵
where:
Variable Field Type Valid Values Description

<alias> String 1 to 64 characters This parameter is used to identify

which trust anchor to display.

10.9.1.3.6 updateTrust
This command is used to load and update a trust anchor file. The certificate is taken from the specified
path and copied to the proper location. If a trust anchor chain is provided, it is used for determining the
certificate hierarchy when storing the trust anchor.
1) Ensure you are at the /AS_CLI/Interface/Http/ClientAuthentication/Trusts> level.
2) Enter:
updateTrust <alias> <trustAnchorFile> [<trustAnchorChain>]↵
where:
Variable Field Type Valid Values Description

<alias> String 1 to 64 characters This parameter is used to identify

which trust anchor to update.

<trustAnchor String 1 to 255 characters This parameter is used to identify

File> the file name for the trust anchor
file.

<trustAnchor String 1 to 255 characters This parameter is used to identify

Chain> the file name for the trust anchor
chain.

10.9.1.4 WebApps
This level is used to view, add, and delete webapp entries.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 588
10.9.1.4.1 get
This command is used to view the list of Web Applications where the Client Authentication applies.
1) Ensure you are at the /AS_CLI/Interface/Http/ClientAuthentication/WebApps> level.
2) Enter:
get↵
10.9.1.4.2 add
This command is used to add a Web Application where the Client Authentication applies.
1) Ensure you are at the /AS_CLI/Interface/Http/ClientAuthentication/WebApps> level.
2) Enter:
add <interface> <port> <applicationName> <clientAuthReq>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface IP address.

<port> Integer 0 through 65535 This parameter specifies the port

number.

<application Choice CommPilot, DeviceManagement This parameter specifies the

Name> Files, JWSFiles, MediaFiles, OCI name of the web application
Files, OCIOverSoap accepting Hypertext Transfer
Protocol (HTTP) requests on this
interface.

<clientAuth Choice true, false This parameter determines if

Req> the web application requests the
client identity. When the value is
set to "true", the web application
requests the client identity. When
the value is set to "false", the
web application does not request
the client identity. When a client
receives a request for identity, it
shall send its certificate.

10.9.1.4.3 set
This command is used to modify a Web Application where the Client Authentication applies.
1) Ensure you are at the /AS_CLI/Interface/Http/ClientAuthentication/WebApps> level.
2) Enter:
set <interface> <port> <applicationName> <attribute>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface IP address.

<port> Integer 0 through 65535 This parameter specifies the port

number.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 589
 Variable Field Type Valid Values Description

<application Choice CommPilot, DeviceManagement This parameter specifies the

Name> Files, JWSFiles, MediaFiles, OCI name of the web application
Files, OCIOverSoap accepting Hypertext Transfer
Protocol (HTTP) requests on this
interface.

<attribute> MultipleChoice clientAuthReq The name of an attribute to

modify.

<clientAuth Choice true, false This parameter determines if

Req> the web application requests the
client identity. When the value is
set to "true", the web application
requests the client identity. When
the value is set to "false", the
web application does not request
the client identity. When a client
receives a request for identity, it
shall send its certificate.

10.9.1.4.4 delete
This command is used to remove a Web Application where the Client Authentication applies.
1) Ensure you are at the /AS_CLI/Interface/Http/ClientAuthentication/WebApps> level.
2) Enter:
delete <interface> <port> <applicationName>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface IP address.

<port> Integer 0 through 65535 This parameter specifies the port

number.

<application Choice CommPilot, DeviceManagement This parameter specifies the

Name> Files, JWSFiles, MediaFiles, OCI name of the web application
Files, OCIOverSoap accepting Hypertext Transfer
Protocol (HTTP) requests on this
interface.

10.9.1.4.5 Resources
This level is used to view, add, and delete resource entries.
10.9.1.4.5.1 get
This command is used to view the list of resources for the Web Application where the Client Authentication
applies.
1) Ensure you are at the /AS_CLI/Interface/Http/ClientAuthentication/WebApps/
Resources> level.
2) Enter:
get <interface> <port> <applicationName>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 590
 Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface IP address.

<port> Integer 0 through 65535 This parameter specifies the port

number.

<application Choice CommPilot, DeviceManagement This parameter specifies the

Name> Files, JWSFiles, MediaFiles, OCI name of the web application
Files, OCIOverSoap accepting Hypertext Transfer
Protocol (HTTP) requests on this
interface.

10.9.1.4.5.2 add
This command is used to add a restriction to the scope of the Client Authentication.
1) Ensure you are at the /AS_CLI/Interface/Http/ClientAuthentication/WebApps/
Resources> level.
2) Enter:
add <interface> <port> <applicationName> <relativeUrl> <clientAuthReq>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface IP address.

<port> Integer 0 through 65535 This parameter specifies the port

number.

<application Choice CommPilot, DeviceManagement This parameter specifies the

Name> Files, JWSFiles, MediaFiles, OCI name of the web application
Files, OCIOverSoap accepting Hypertext Transfer
Protocol (HTTP) requests on this
interface.

<relativeUrl> String 1 to 256 characters This parameter specifies the

relative URL of the targeted
resources.

<clientAuth Choice true, false This parameter determines if

Req> the web application requests the
client identity. When the value is
set to 'true', the web application
requests the client identity. When
the value is set to 'false', the web
application does not request
the client identity. When a client
receives a request for identity, it
shall send its certificate.

10.9.1.4.5.3 set
This command is used to modify a restriction to the scope of the Client Authentication.
1) Ensure you are at the /AS_CLI/Interface/Http/ClientAuthentication/WebApps/
Resources> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 591
 2) Enter:
set <interface> <port> <applicationName> <relativeUrl> <attribute>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface IP address.

<port> Integer 0 through 65535 This parameter specifies the port

number.

<application Choice CommPilot, DeviceManagement This parameter specifies the

Name> Files, JWSFiles, MediaFiles, OCI name of the web application
Files, OCIOverSoap accepting Hypertext Transfer
Protocol (HTTP) requests on this
interface.

<relativeUrl> String 1 to 256 characters This parameter specifies the

relative URL of the targeted
resources.

<attribute> MultipleChoice clientAuthReq The name of an attribute to

modify.

<clientAuth Choice true, false This parameter determines if

Req> the web application requests the
client identity. When the value is
set to 'true', the web application
requests the client identity. When
the value is set to 'false', the web
application does not request
the client identity. When a client
receives a request for identity, it
shall send its certificate.

10.9.1.4.5.4 delete
This command is used to remove a restriction to the scope of Client Authentication.
1) Ensure you are at the /AS_CLI/Interface/Http/ClientAuthentication/WebApps/
Resources> level.
2) Enter:
delete <interface> <port> <applicationName> <relativeUrl>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface IP address.

<port> Integer 0 through 65535 This parameter specifies the port

number.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 592
 Variable Field Type Valid Values Description

<application Choice CommPilot, DeviceManagement This parameter specifies the

Name> Files, JWSFiles, MediaFiles, OCI name of the web application
Files, OCIOverSoap accepting Hypertext Transfer
Protocol (HTTP) requests on this
interface.

<relativeUrl> String 1 to 256 characters This parameter specifies the

relative URL of the targeted
resources.

10.9.2 GeneralSettings
This level is used to view and modify the Hypertext Transfer Protocol (HTTP) general settings.

10.9.2.1 get
This command is used to view the Hypertext Transfer Protocol (HTTP) general settings.
1) Ensure you are at the /AS_CLI/Interface/Http/GeneralSettings> level.
2) Enter:
get↵

10.9.2.2 set
The command is used to modify the Hypertext Transfer Protocol (HTTP) general settings.
1) Ensure you are at the /AS_CLI/Interface/Http/GeneralSettings> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice keepAliveTimeout, clientIO The name of an attribute to

Timeout modify.

<keepAlive Integer 1 through 86400 This parameter specifies the

Timeout> timeout for HTTP keep alive
(required for profile tuning).

<clientIO Integer 1 through 300 This parameter specifies the

Timeout> maximum length of time allowed
for a client connection to be
inactive. When the time elapsed
since the last received or
transmitted Transmission Control
Protocol (TCP) packet reaches
the timeout value, the connection
is severed. The timeout value
applies to cases where either the
client or the server is not emitting
packets.

10.9.3 HttpAlias
This level is used to view, add, modify, or delete the Hypertext Transfer Protocol (HTTP) server (Web
Server) aliases. Whenever a web page is accessed, the web address in the URL that appears in the user's
browser is replaced by the public address configured on this sever. If the server can be reached using

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 593
 alternate host names (and you do not want the address in the user's browser to be rewritten, when the web
server is reached using those host names), you can add the host name to the list of recognized aliases.

10.9.3.1 get
This command is used to retrieve the list of Hypertext Transfer Protocol (HTTP) aliases.
1) Ensure you are at the /AS_CLI/Interface/Http/HttpAlias> level.
2) Enter:
get↵

10.9.3.2 add
This command is used to add a Hypertext Transfer Protocol (HTTP) alias for a physical interface.
1) Ensure you are at the /AS_CLI/Interface/Http/HttpAlias> level.
2) Enter:
add <interface> <alias> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface Internet Protocol (IP)
address.

<alias> String 1 to 80 characters This parameter specifies the

name of the Hypertext Transfer
Protocol (HTTP) server.

<attribute> MultipleChoice clusterFQDN Additional attributes to include

through the add command.

<clusterFQDN> String 1 to 80 characters This parameter specifies the Fully

Qualified Domain Name (FQDN)
of the cluster (for example,
xsp1.mtl.broadsoft.com).

10.9.3.3 set
This command is used to modify the Hypertext Transfer Protocol (HTTP) aliases-related attributes for a
given interface.
1) Ensure you are at the /AS_CLI/Interface/Http/HttpAlias> level.
2) Enter:
set <interface> <alias> <attribute>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface Internet Protocol (IP)
address.

<alias> String 1 to 80 characters This parameter specifies the

name of the Hypertext Transfer
Protocol (HTTP) server.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 594
 Variable Field Type Valid Values Description

<attribute> MultipleChoice clusterFQDN The name of an attribute to

modify.

<clusterFQDN> String 1 to 80 characters This parameter specifies the Fully

Qualified Domain Name (FQDN)
of the cluster (for example,
xsp1.mtl.broadsoft.com).

10.9.3.4 delete
This command is used to delete a Hypertext Transfer Protocol (HTTP) alias for an interface.
1) Ensure you are at the /AS_CLI/Interface/Http/HttpAlias> level.
2) Enter:
delete <interface> <alias>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface Internet Protocol (IP)
address.

<alias> String 1 to 80 characters This parameter specifies the

name of the Hypertext Transfer
Protocol (HTTP) server.

10.9.3.5 clear
This command is used to clear a (set to know value) Hypertext Transfer Protocol (HTTP) aliases-related
attributes for an interface.
1) Ensure you are at the /AS_CLI/Interface/Http/HttpAlias> level.
2) Enter:
clear <interface> <alias> <attribute>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface Internet Protocol (IP)
address.

<alias> String 1 to 80 characters This parameter specifies the

name of the Hypertext Transfer
Protocol (HTTP) server.

<attribute> MultipleChoice clusterFQDN The name of an attribute to

modify.

10.9.4 HttpBinding
This level is used to view, add, modify, or delete the Hypertext Transfer Protocol (HTTP) bindings. Bindings
associate an application to a specific server through an address and port combination.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 595
10.9.4.1 get
This command is used to retrieve the list of Hypertext Transfer Protocol (HTTP) bindings.
1) Ensure you are at the /AS_CLI/Interface/Http/HttpBinding> level.
2) Enter:
get↵

10.9.4.2 add
This command is used to add a Hypertext Transfer Protocol (HTTP) bindings.
1) Ensure you are at the /AS_CLI/Interface/Http/HttpBinding> level.
2) Enter:
add <interface> <port> <applicationName>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. Internet Protocol (IP) address of
the interface.

<port> Integer 0 through 65535 This parameter specifies the port

number.

<application Choice CommPilot, DeviceManagement This parameter specifies the

Name> Files, JWSFiles, MediaFiles, OCI name of the web application
Files, OCIOverSoap accepting Hypertext Transfer
Protocol (HTTP) requests on this
interface.

10.9.4.3 delete
This command is used to delete an Hypertext Transfer Protocol (HTTP) binding.
1) Ensure you are at the /AS_CLI/Interface/Http/HttpBinding> level.
2) Enter:
delete <interface> <port> <applicationName>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. Internet Protocol (IP) address of
the interface.

<port> Integer 0 through 65535 This parameter specifies the port

number.

<application Choice CommPilot, DeviceManagement This parameter specifies the

Name> Files, JWSFiles, MediaFiles, OCI name of the web application
Files, OCIOverSoap accepting Hypertext Transfer
Protocol (HTTP) requests on this
interface.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 596
10.9.5 HttpServer
This level is used to view, modify, add, and delete the Hypertext Transfer Protocol (HTTP) server settings.
This level is also used to generate a Secure Sockets Layer (SSL) key for a secure HTTP server and to
load and update a new SSL certificate file.

10.9.5.1 get
This command is used to view the Hypertext Transfer Protocol (HTTP) servers.
1) Ensure you are at the /AS_CLI/Interface/Http/HttpServer> level.
2) Enter:
get↵

10.9.5.2 add
This command is used to add a Hypertext Transfer Protocol (HTTP) server.
1) Ensure you are at the /AS_CLI/Interface/Http/HttpServer> level.
2) Enter:
add <interface> <port> <name> <secure> <clientAuthReq> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface Internet Protocol (IP)
address.

<port> Integer 0 through 65535 This parameter specifies the port

number.

<name> String 1 to 80 characters This parameter specifies the

name of the Hypertext Transfer
Protocol (HTTP) server.

<secure> Choice true, false This parameter controls server

security.

<clientAuth Choice true, false This parameter determines if

Req> the server requests the client
identity. When the value is set
to "true", the server requests the
client identity. When the value
is set to "false", the server does
not request the client identity.
When a client receives a request
for identity, it shall send its
certificate.

<attribute> MultipleChoice clusterFQDN Additional attributes to include

through the add command.

<clusterFQDN> String 1 to 80 characters This parameter specifies the Fully

Qualified Domain Name (FQDN)
of the cluster (for example,
xsp1.mtl.broadsoft.com).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 597
10.9.5.3 set
This command is used to modify the Hypertext Transfer Protocol (HTTP) server properties.
1) Ensure you are at the /AS_CLI/Interface/Http/HttpServer> level.
2) Enter:
set <interface> <port> <attribute>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface Internet Protocol (IP)
address.

<port> Integer 0 through 65535 This parameter specifies the port

number.

<attribute> MultipleChoice name, secure, clientAuthReq, The name of an attribute to

clusterFQDN modify.

<name> String 1 to 80 characters This parameter specifies the

name of the Hypertext Transfer
Protocol (HTTP) server.

<secure> Choice true, false This parameter controls server

security.

<clientAuth Choice true, false This parameter determines if

Req> the server requests the client
identity. When the value is set
to "true", the server requests the
client identity. When the value
is set to "false", the server does
not request the client identity.
When a client receives a request
for identity, it shall send its
certificate.

<clusterFQDN> String 1 to 80 characters This parameter specifies the Fully

Qualified Domain Name (FQDN)
of the cluster (for example,
xsp1.mtl.broadsoft.com).

10.9.5.4 delete
This command is used to delete an existing Hypertext Transfer Protocol (HTTP) server.
1) Ensure you are at the /AS_CLI/Interface/Http/HttpServer> level.
2) Enter:
delete <interface> <port>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface Internet Protocol (IP)
address.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 598
 Variable Field Type Valid Values Description

<port> Integer 0 through 65535 This parameter specifies the port

number.

10.9.5.5 clear
This command is used to clear Hypertext Transfer Protocol (HTTP) server attributes.
1) Ensure you are at the /AS_CLI/Interface/Http/HttpServer> level.
2) Enter:
clear <interface> <port> <attribute>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface Internet Protocol (IP)
address.

<port> Integer 0 through 65535 This parameter specifies the port

number.

<attribute> MultipleChoice clusterFQDN Name of the attribute to clear.

10.9.5.6 sslExport
This command is used to export Secure Sockets Layer (SSL) files (certificate, key, or chain file). The SSL
file is taken from its location and copied to the /var/broadworks/tmp/ directory.
1) Ensure you are at the /AS_CLI/Interface/Http/HttpServer> level.
2) Enter:
sslExport <interface> <port> <attribute>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This is the Hypertext Transfer

defined on the server. Protocol (HTTP) interface.

<port> Integer 0 through 65535 The port number.

<attribute> MultipleChoice certificateFile, keyFile, chainFile Used to select which file to

export.

10.9.5.7 sslGenkey
This command is used to generate a Secure Sockets Layer (SSL) key for a secure HTTP server. A
generated ''.csr''(Certificate Signing Request) file is written to the ''/tmp'' directory under the name
''name.csr'', where name is the interface IP address.
1) Ensure you are at the /AS_CLI/Interface/Http/HttpServer> level.
2) Enter:
sslGenkey <interface> <port> [<attribute>]↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 599
 Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This is the Hypertext Transfer

defined on the server. Protocol (HTTP) interface.

<port> Integer 0 through 65535 The port number.

<attribute> MultipleChoice keyLength, country, stateOr Optional attribute to be set.

Province, city, organisationName,
organisationUnit, emailAddress,
challengePassword, common
Name

<keyLength> Integer 512 through 16384 The SSL key length or key size,
default value (when not specified)
is "1024".

<country> String 2 to 2 characters The country code international

abbreviation code.

<stateOr String 1 to 50 characters The state or province.

Province>

<city> String 1 to 50 characters The name of the city.

<organisation String 1 to 50 characters The organization name.

Name>

<organisation String 1 to 50 characters The organization unit.

Unit>

<email String 1 to 50 characters The e-mail address.

Address>

<challenge String 1 to 40 characters The challenge password.

Password>

<common String 1 to 255 characters The common name. It must

Name> correspond to the host name of
this Hypertext Transfer Protocol
(HTTP) server. A "*" wildcard
character may be present in
the left-most name component
of the host if the certificate is
to be used on multiple servers
having the same domain. For
example, the common name
for host xsp1.broadsoft.com
could be *.broadsoft.com or
xsp*.broadsoft.com.

10.9.5.8 sslRemove
This command is used to remove the Secure Sockets Layer (SSL) file (chain file).
1) Ensure you are at the /AS_CLI/Interface/Http/HttpServer> level.
2) Enter:
sslRemove <interface> <port> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 600
 Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently The Hypertext Transfer Protocol

defined on the server. (HTTP) interface.

<port> Integer 0 through 65535 The port number.

<attribute> MultipleChoice chainFile The type of file to be removed.

10.9.5.9 sslShow
This command is used to view the details of the X.509 certificate and certificate chain associated with the
provided interface. This command reflects the information as it is sent by the server to the client software.
1) Ensure you are at the /AS_CLI/Interface/Http/HttpServer> level.
2) Enter:
sslShow <interface> <port>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently This parameter specifies the

defined on the server. interface IP address.

<port> Integer 0 through 65535 This parameter specifies the port

number.

10.9.5.10 sslUpdate
This command is used to load and update a Secure Sockets Layer (SSL) certificate file. The certificate is
taken from the specified path and copied to the proper location.
1) Ensure you are at the /AS_CLI/Interface/Http/HttpServer> level.
2) Enter:
sslUpdate <interface> <port> <attribute>↵
where:
Variable Field Type Valid Values Description

<interface> Choice An IP interface that is currently Enter a specific IP address or

defined on the server. select "ALL".

<port> Integer 0 through 65535 The port number.

<attribute> MultipleChoice certificateFile, keyFile, chainFile The name of an Secure Sockets

Layer (SSL) configuration
attribute to update.

<certificateFile> String 1 to 255 characters The file name of the certificate

file.

<keyFile> String 1 to 255 characters The file name of the certificate

chain file.

<chainFile> String 1 to 255 characters The file name of the key file.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 601
10.10 INServiceControl
This level is used to display or modify Intelligent Network (IN) Service Control-related attributes.

10.10.1 get
This command is used to display IN Service Control-related attributes.
1) Ensure you are at the /AS_CLI/Interface/INServiceControl> level.
2) Enter:
get↵

10.10.2 set
This command is used to modify IN Service Control-related attributes. Note that the system must be
restarted for changes to be implemented.
1) Ensure you are at the /AS_CLI/Interface/INServiceControl> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice serverPort, numClient The name of an attribute to

Connections modify.

<serverPort> Integer 1025 through 65535 The server port number.

<numClient Integer 0 through 10 The maximum number of client

Connections> connections allowed.

10.11 LDAP
This level is used to view and modify attributes related to the Lightweight Directory Access Protocol
(LDAP).

10.11.1 Client
This level is used to view and modify attributes related to the Lightweight Directory Access Protocol (LDAP)
client.

10.11.1.1 get
This command is used to view the Lightweight Directory Access Protocol (LDAP) client options.
1) Ensure you are at the /AS_CLI/Interface/LDAP/Client> level.
2) Enter:
get↵

10.11.1.2 set
This command is used to modify the Lightweight Directory Access Protocol (LDAP) client options.
1) Ensure you are at the /AS_CLI/Interface/LDAP/Client> level.
2) Enter:
set <attribute>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 602
 where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice baseDistinguishedName, bind The name of an attribute to

Password, enabled modify.

<base String 1 to 80 characters This parameter specifies the

Distinguished distinguished name of the
Name> search base(for example,
dc=broadsoft,dc=com).

<bind Password 1 to 40 characters This parameter specifies the

Password> (prompted) credentials to bind to the
Lightweight Directory Access
Protocol (LDAP) server.

<enabled> Choice true, false This parameter specifies whether

the BroadWorks Lightweight
Directory Access Protocol (LDAP)
client is enabled.

10.11.1.3 clear
This command is used to clear the Lightweight Directory Access Protocol (LDAP) client options.
1) Ensure you are at the /AS_CLI/Interface/LDAP/Client> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice baseDistinguishedName The name of an attribute to

modify.

10.11.1.4 LocalUsers
This level is used to view and modify Lightweight Directory Access Protocol (LDAP) local users.
10.11.1.4.1 get
This command is used to view local users.
1) Ensure you are at the /AS_CLI/Interface/LDAP/Client/LocalUsers> level.
2) Enter:
get↵
10.11.1.4.2 add
This command is used to add local user.
1) Ensure you are at the /AS_CLI/Interface/LDAP/Client/LocalUsers> level.
2) Enter:
add <name>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 603
 Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the

local user name for which the
group membership lookups are
not performed to the Lightweight
Directory Access Protocol (LDAP)
server. This can be useful in case
of unavailability of the LDAP
server.

10.11.1.4.3 delete
This command is used to delete local user.
1) Ensure you are at the /AS_CLI/Interface/LDAP/Client/LocalUsers> level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the

local user name for which the
group membership lookups are
not performed to the Lightweight
Directory Access Protocol (LDAP)
server. This can be useful in case
of unavailability of the LDAP
server.

10.11.1.5 Servers
This level is used to view and modify Lightweight Directory Access Protocol (LDAP) servers.
10.11.1.5.1 get
This command is used to view the Lightweight Directory Access Protocol (LDAP) servers.
1) Ensure you are at the /AS_CLI/Interface/LDAP/Client/Servers> level.
2) Enter:
get↵
10.11.1.5.2 add
This command is used to add a Lightweight Directory Access Protocol (LDAP) server.
1) Ensure you are at the /AS_CLI/Interface/LDAP/Client/Servers> level.
2) Enter:
add <name> <port> <secured>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the fully

qualified domain name (FQDN) of
the Lightweight Directory Access
Protocol (LDAP) server.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 604
 Variable Field Type Valid Values Description

<port> Integer 0 through 65535 This parameter specifies the port

number.

<secured> Choice true, false This parameter specifies if secure

communication is enabled.

10.11.1.5.3 set
This command is used to modify the Lightweight Directory Access Protocol (LDAP) server options.
1) Ensure you are at the /AS_CLI/Interface/LDAP/Client/Servers> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the fully

qualified domain name (FQDN) of
the Lightweight Directory Access
Protocol (LDAP) server.

<attribute> MultipleChoice port, secured The name of an attribute to

modify.

<port> Integer 0 through 65535 This parameter specifies the port

number.

<secured> Choice true, false This parameter specifies if secure

communication is enabled.

10.11.1.5.4 delete
This command is used to delete a Lightweight Directory Access Protocol (LDAP) server.
1) Ensure you are at the /AS_CLI/Interface/LDAP/Client/Servers> level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the fully

qualified domain name (FQDN) of
the Lightweight Directory Access
Protocol (LDAP) server.

10.12 LDAPDirectory
This level is used to configure an enterprise Lightweight Directory Access Protocol (LDAP) directory,
which can be accessed by users to make calls through the CommPilot Call Manager. This is useful
for an enterprise that stores user information in a LDAP directory. This feature has been enhanced to
provide increased security and more flexibility. To provide greater security, the LDAP connection now
supports the use of an SSL connection to bind with the LDAP server. To provide more flexibility, the
search filter can now be specified, as well as which field is filterable. Also there are up to four configurable

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 605
 columns of information that can be returned from an LDAP query. All of these enhancements are
provided at the system, enterprise, and group levels. This section describes the system level. Previously,
when BroadWorks queried an LDAP server, the information returned was the cn (common name) and
the telephone number. The information returned can now be configurable with up to four columns of
information returned. (The labels for these columns are also configurable for localization.) The last three
columns are treated as phone numbers in the Call Manager. This means that if the text is clicked and
the text is determined to be a phone number, then it will appear in the number to be dialed text box.
The first column is always the sorted column. The search filter string used by BroadWorks is (cn=*)
(telephoneNumber=*) which returns entities from the LDAP server search base that have a cn and a
telephone number. The search filter string can be configured. When a user types text into the search
box on the CommPilot Call Manager LDAP tab, the text is set in the search filter string as (cn=text*)
(telephoneNumber=*). The searchable field can be specified separately. For example, if a system has a
search filter string of (objectClass=User) (objectCategory=Person) and a searchable field of displayName,
the search filter string that is sent for the LDAP query will be (objectClass=User)(objectCategory=Person)
(displayName=Smith*).This level of commands allows display, modification, and clearing of the LDAP
directory interface.

10.12.1 get
This command displays the configuration to use to access a group's private LDAP directory.
1) Ensure you are at the /AS_CLI/Interface/LDAPDirectory> level.
2) Enter:
get↵

10.12.2 set
This command is used to set the configuration used to access the group's private LDAP directory.
1) Ensure you are at the /AS_CLI/Interface/LDAPDirectory> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice address, port, searchBase, The name of an attribute to

useSSL, requireAuthentication, modify.
authenticatedDN, authenticated
Password, sortControl, paged
ResultControl, searchFilter,
alwaysInclSearchAttr, colAttr
Name1, colAttrName2, colAttr
Name3, colAttrName4, searchAttr
Col

<address> String 1 to 80 characters The IP address of the LDAP

server.

<port> Integer 1 through 65535 The port of the LDAP server.

<searchBase> String 1 to 256 characters The search base of the LDAP

server, which is the root suffix of
the search. The root suffix should
reflect the domain name of the
site being searched.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 606
 Variable Field Type Valid Values Description

<useSSL> Choice true, false When set to "false", the LDAP

connection will not support the
use of an SSL connection to bind
with the LDAP server. When set
to "true", the LDAP connection
will support the use of an SSL
connection to bind with the LDAP
server.

<require Choice true, false When set to "false", the

Authentication> LDAP server does not require
authentication. When set to
"true", the LDAP server requires
authentication.

<authenticatedDN> String 1 to 256 characters If the LDAP server requires

authentication, the authenticated
directory number is required. This
should be a unique identifier for
the user.

<authenticated String 1 to 40 characters If the LDAP server requires

Password> authentication, the authenticated
password for the user is required.

<sortControl> Choice true, false When set to "false", sort controls

are not supported. When set
to "true", sort controls are
supported.

<pagedResult Choice true, false When set to "false", paged result

Control> controls are not supported. When
set to "true", paged result controls
are supported.

<searchFilter> String 1 to 256 characters Specify a search filter to include

in all directory server searches.
By default, the suggested search
filter is "(telephoneNumber=*)",
which will restrict all directory
server searches made using
the CommPilot Call Manager,
to directory users with the
telephoneNumber attribute
specified.

<alwaysIncl Choice true, false When set to "false", the search

SearchAttr> attribute is not included. When
set to "true", the search attribute
is always included. This forces
the current search attribute to be
included in all directory server
searches, even when the user
leaves search parameters blank.
By default, a search with blank
parameters uses only the value
of the search filter, for example,
"(telephoneNumber=*)".

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 607
 Variable Field Type Valid Values Description

<colAttr String 1 to 80 characters The first column attribute name,

Name1> for example, CN.

<colAttr String 1 to 80 characters The second column

Name2> attribute name, for example,
telephoneNumber.

<colAttr String 1 to 80 characters The third column attribute name.

Name3>

<colAttr String 1 to 80 characters The fourth column attribute name.

Name4>

<searchAttr Choice column1, column2, column3, Specifies which columns to

Col> column4 search.

10.12.3 clear
This command is used to clear a configuration attribute for a group's private LDAP directory.
1) Ensure you are at the /AS_CLI/Interface/LDAPDirectory> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice address, searchBase, The name of the attribute(s) to

authenticatedDN, authenticated clear.
Password, searchFilter, colAttr
Name2, colAttrName3, colAttr
Name4

10.13 MGCP
This level is used to view and modify Media Gateway Control Protocol (MGCP)- related attributes.
The MGCP is used as a location for users when their profiles are set up (for example, mgcp:aaln/S1/
SU0/1@broadsoft.com) and permits call completion. A proxy address allows BroadWorks to work with
MGCP Proxy Server.

10.13.1 get
MGCP-related attributes, such as the timer values, are viewed using this command.
1) Ensure you are at the /AS_CLI/Interface/MGCP> level.
2) Enter:
get↵

10.13.2 set
MGCP-related attributes, such as the timer values and MGCP Proxy Address, are changed using this
command.
1) Ensure you are at the /AS_CLI/Interface/MGCP> level.
2) Enter:
set <attribute>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 608
 where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice t1, t2, listeningPort, access The name of an attribute to

Control, sendNotifiedEntity, modify.
notifiedEntity, suspiciousAddress
Threshold, maxAddressesPer
Hostname, proxyAddress, embed
DigitCollection, use3264Hold

<t1> Choice 500, 1000, 2000, 5000, 7000, The t1 timeout for MGCP in
9000 milliseconds.

<t2> Choice 4000, 6000, 8000, 10000 The t2 timeout for MGCP in
milliseconds.

<listeningPort> Integer 1025 through 65355 The port upon which the
messages are received.

<access Choice true, false When set to "false", process any

Control> incoming MGCP message without
verifying its source. When set to
"true", process incoming MGCP
messages after verifying source.

<sendNotified Choice true, false When set to "false", BroadWorks

Entity> does not send notifiedEntity value
with MGCP requests. When set
to "true", BroadWorks sends the
notifiedEntity value with MGCP
requests.

<notifiedEntity> String 1 to 80 characters The hostname portion of the

NotifiedEntity parameter sent
within MGCP requests when
sendNotifyEntity is true.

<suspicious Integer 0 through 11 Sets the maximum number of

Address unacknowledged transmissions
Threshold> to a given IP address when DNS
returns multiple IP addresses for
a fully qualified domain name
(FQDN). Once the maximum
number is reached, another IP
address that is associated with
the FQDN is tried.

<max Integer 1 through 50 The maximum number of

AddressesPer addresses from a DNS query that
Hostname> shall be tried when attempting to
send a request to an endpoint.

<proxy String 1 to 80 characters To allow BroadWorks to work with

Address> MGCP Proxy Server.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 609
 Variable Field Type Valid Values Description

<embedDigit Choice true, false When set to "false", the

Collection> digit collection feature is not
embedded in this protocol. When
set to "true", the digit collection
feature is embedded in this
protocol.

<use3264Hold> Choice true, false Enable or disable RFC 3264

hold Session Description
Protocol (SDP) sending support.
This serves to control how
BroadWorks sends hold SDP
on the network and access-side
interfaces.

10.13.3 clear
This command is used to clear MGCP-related attributes.
1) Ensure you are at the /AS_CLI/Interface/MGCP> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice notifiedEntity, proxyAddress The name of the attribute(s) to

clear.

10.14 Mail
The Internet Mail Facility is an interface that permits users to receive e-mail messages via the system.

10.14.1 get
This command is used to view mail-related attributes, such as the default From address, default Subject
heading, and the primary and secondary Simple Mail Transfer Protocol (SMTP) servers.
1) Ensure you are at the /AS_CLI/Interface/Mail> level.
2) Enter:
get↵

10.14.2 set
This command is used to modify mail-related attributes, such as the default From address, default Subject
heading, and the primary and secondary Simple Mail Transfer Protocol (SMTP) servers.
1) Ensure you are at the /AS_CLI/Interface/Mail> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 610
 Variable Field Type Valid Values Description

<attribute> MultipleChoice primarySMTPServer, The name of an attribute to

secondarySMTPServer, default modify.
FromAddress, defaultSubject,
supportDnsSrvForMailServer
Access

<primarySMTP String 1 to 80 characters The primary SMTP server

Server> address to provide e-mail to
users.

<secondarySMTP String 1 to 80 characters The secondary SMTP server

Server> address to provide e-mail to
users.

<defaultFrom String 1 to 80 characters The default From address to be

Address> used when BroadWorks sends
an e-mail for CPE configuration
errors, service pack migration
messages and web password
lockout messages. Note that for
services that generate e-mails,
such as Call Center, Emergency
Zones, Inventory Report, Voice
Messaging, and Call Notify, the
defaultFromAddress is defined
under the Service CLI level.

<default String 1 to 80 characters The default Subject heading to

Subject> be used when the sender's e-
mail subject is not available, for
example, "Subject Not Available".

<supportDns Choice true, false When set to "true", SRV DNS

SrvForMail record types are supported by the
ServerAccess> mail server.

10.14.3 clear
This command is used to clear (set to no value) mail-related attributes, such as the default From address,
default Subject heading, and the primary and secondary Simple Mail Transfer Protocol (SMTP) servers.
1) Ensure you are at the /AS_CLI/Interface/Mail> level.
2) Enter:
clear <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<clearAttribute> MultipleChoice primarySMTPServer, The name of the attribute(s) to

secondarySMTPServer, default clear.
Subject

10.15 MediaFileSize
This level is used to view, add, modify, and delete MediaFileSize entries.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 611
10.15.1 get
This command is used to view the settings of the MediaFileSize attribute.
1) Ensure you are at the /AS_CLI/Interface/MediaFileSize> level.
2) Enter:
get↵

10.15.2 set
This command is used to modify the settings of the MediaFileSize attribute. NOTE: Changing
MediaFileSize-related settings is effective immediately, without server restart. However a web portal user
needs to log out and log in again to see these changes.
1) Ensure you are at the /AS_CLI/Interface/MediaFileSize> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice voiceMessageGreetingMaxAudio The name of an attribute to

FileSizeKilobytes, voiceMessage modify.
GreetingMaxVideoFileSize
Kilobytes, autoAttendantGreeting
MaxAudioFileSizeKilobytes, auto
AttendantGreetingMaxVideo
FileSizeKilobytes, personalized
NameMaxAudioFileSizeKilobytes,
answerConfirmationMaxAudio
FileSizeKilobytes, musicOnHold
MaxAudioFileSizeKilobytes,
videoOnHoldMaxVideoFileSize
Kilobytes, ringbackMaxAudio
FileSizeKilobytes, ringbackMax
VideoFileSizeKilobytes, intercept
MaxAudioFileSizeKilobytes,
interceptMaxVideoFileSize
Kilobytes, callCenterMaxAudio
FileSizeKilobytes, callCenter
MaxVideoFileSizeKilobytes,
preAlertingMaxAudioFileSize
Kilobytes, preAlertingMaxVideo
FileSizeKilobytes, conference
GreetingMaxAudioFileSize
Kilobytes, securityClassification
AnncMaxAudioFileSizeKilobytes,
announcementRepository
AudioFileMaxSizeKilobytes,
announcementRepositoryVideo
FileMaxSizeKilobytes

<voiceMessage Integer 500 through 10000 This parameter specifies the

GreetingMax maximum audio file size for voice
AudioFileSize messaging greetings.
Kilobytes>

<voiceMessage Integer 1000 through 24000 This parameter specifies the

GreetingMax maximum video file size for voice
VideoFileSize messaging greetings.
Kilobytes>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 612
 Variable Field Type Valid Values Description

<autoAttendant Integer 500 through 10000 This parameter specifies the

GreetingMax maximum audio file size for auto
AudioFileSize attendant greetings.
Kilobytes>

<autoAttendant Integer 1000 through 24000 This parameter specifies the

GreetingMax maximum video file size for auto
VideoFileSize attendant greetings.
Kilobytes>

<personalized Integer 50 through 500 This parameter specifies the

NameMax maximum audio file size for
AudioFileSize personalized name recordings.
Kilobytes>

<answer Integer 500 through 10000 This parameter specifies the

Confirmation maximum audio file size for
MaxAudioFile answer confirmation messages.
SizeKilobytes>

<musicOnHold Integer 1000 through 10000 This parameter specifies the

MaxAudioFile maximum audio file size for music
SizeKilobytes> on hold media files.

<videoOnHold Integer 1000 through 24000 This parameter specifies the

MaxVideoFile maximum video file size for video
SizeKilobytes> on hold media files.

<ringbackMax Integer 500 through 10000 This parameter specifies the

AudioFileSize maximum audio file size for
Kilobytes> custom ringback media files.

<ringbackMax Integer 1000 through 24000 This parameter specifies the

VideoFileSize maximum video file size for
Kilobytes> custom ringback media files.

<interceptMax Integer 500 through 10000 This parameter specifies the

AudioFileSize maximum audio file size for
Kilobytes> intercept greetings.

<interceptMax Integer 1000 through 24000 This parameter specifies the

VideoFileSize maximum video file size for
Kilobytes> intercept greetings.

<callCenterMax Integer 500 through 10000 This parameter specifies the

AudioFileSize maximum audio file size for call
Kilobytes> center announcements.

<callCenterMax Integer 1000 through 24000 This parameter specifies the

VideoFileSize maximum video file size for call
Kilobytes> center announcements.

<preAlerting Integer 500 through 10000 This parameter specifies

MaxAudioFile the maximum audio file size
SizeKilobytes> for the pre alerting service
announcements.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 613
 Variable Field Type Valid Values Description

<preAlerting Integer 1000 through 24000 This parameter specifies

MaxVideoFile the maximum video file size
SizeKilobytes> for the pre alerting service
announcements.

<conference Integer 500 through 10000 This parameter specifies the

GreetingMax maximum audio file size for
AudioFileSize conference greetings.
Kilobytes>

<security Integer 50 through 500 This parameter specifies

Classification the maximum audio file size
AnncMax for security classification
AudioFileSize announcements.
Kilobytes>

<announcement Integer 50 through 10000 This parameter specifies the

Repository maximum size of an audio file in
AudioFileMax the announcement repository.
SizeKilobytes>

<announcement Integer 1000 through 24000 This parameter specifies the

Repository maximum size of a video file in
VideoFileMax the nnouncement repository.
SizeKilobytes>

10.16 Messaging
This level is used to view, modify, and clear Messaging Server-related attributes.

10.16.1 get
This command is used to view Messaging Server-related system interface attributes.
1) Ensure you are at the /AS_CLI/Interface/Messaging> level.
2) Enter:
get↵

10.16.2 set
This command is used to modify Messaging Server-related system interface attributes.
1) Ensure you are at the /AS_CLI/Interface/Messaging> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice provisioningUrl, provisioningUser The name of an attribute to

Id, provisioningPassword, enable modify.
Synchronization

<provisioning String 1 to 256 characters The address/domain of the

Url> Messaging Server provisioning
adapter.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 614
 Variable Field Type Valid Values Description

<provisioning String 1 to 80 characters The user id used to log on the

UserId> Messaging Server provisioning
adapter.

<enable Choice true, false Controls if flow-thru provisioning

Synchronization> into Messaging Server is on or
off.

10.16.3 clear
This command is used to clear Messaging Server-related system interface attributes.
1) Ensure you are at the /AS_CLI/Interface/Messaging> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice provisioningUrl, provisioningUser The name of an attribute to clear.

Id, provisioningPassword

10.17 NetServSync
The Network Server synchronization interface provides the synchronization between the Application Server
and the Network Server, and specifically the trusted key. The trusted key is necessary for the Network
Server to accept connections from the Application Server.

10.17.1 get
Network Server synchronization interface-related attributes, such as the name of the interface and the
Network Server synchronization key, are viewed using this command.
1) Ensure you are at the /AS_CLI/Interface/NetServSync> level.
2) Enter:
get↵

10.17.2 set
Network Server synchronization interface-related attributes, such as the Network Server synchronization
key, are changed using this command.
1) Ensure you are at the /AS_CLI/Interface/NetServSync> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice syncFlag, syncLinePorts, sync The name of an attribute to

DeviceManagementInfo, sync modify.
TrunkGroups

<syncFlag> Choice true, false Controls if the Network Server

synchronization is on or off.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 615
 Variable Field Type Valid Values Description

<syncLine Choice true, false When this attribute is set to true,

Ports> the Application Server shares
line/ports data with the Network
Server, allowing the Network
Server to be used for access
side network call routing (or
registrations).

<syncDevice Choice true, false When this attribute is set to true,

Management the Application Server shares
Info> device file information, MAC
address and device usernames
with the Network Server, allowing
the Network Server to be used for
a AS location engine for device
management.

<syncTrunk Choice true, false When this attribute is set to

Groups> true, the Application Server
shares trunk groups data with
the Network Server, allowing the
Network Server to be used for
access side network call routing
based on originating trunk group
identifier.

10.18 OCI
The Open Client Interface (OCI) reporting interface provides a reporting interface for the Application
Server. The Application Server relays successfully executed OCI modification requests to external systems
over the OCI Reporting Interface so that these systems have an up-to-date view of configuration data.
The external systems can include, but are not limited to, third-party services platforms, customer care
platforms, and data mining applications. The OCI modification requests and associated data are relayed
over TCP/IP to all connected external systems. Associated data consists of:A user ID and login type for
the account that enacted the modificationAn indicator that indicates whether or not the OCI modification
request relayed to an external system is the same as that received over the Open Client InterfaceAccess
Control ListAn access control list is used to indicate which external systems can connect to the Application
Server for notifications. The system administrator configures an access control list for OCI reporting using
one of the following methods:Adds the address for the external system to the access control list using
the AS_CLI/System/NetworkAccessLists/OCIReporting context. The address can be an IP address or
a fully qualified host name. For more information, refer to section 12.14.5 OCI.Configures the access
control list by submitting OCI requests. For more information on this method, refer to the BroadWorks
Application Server Provisioning Interface Specification Guide.External systems whose addresses are in
the access control list are permitted to connect to the Application Server. One connection is permitted
per IP address. The Application Server sends OCIReportingReportNotifications to all connections. The
Application Server writes successfully executed OCI requests to a single file, which is rotated based on
the file size and number of files. The level of information written to the audit log file can be configured.
(Note that the Application Server audit logs that existed prior to this feature are now obsolete; therefore the
AuditTrail context under the AS_CLI/Monitoring level has been removed).

10.18.1 CallControl
The Application Server collects users that share the same provisioning characteristics and places them into
a group. For example, a group can be a company or an organization. Members are defined for each group
and include the members' phone numbers. Group administrators responsible for entering members into the
system for that group are also defined. Valid access points for each group are specified. As well, a range of

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 616
 phone numbers can be reserved for each group. Additionally, the following are configured: group services,
group extension lists, group calling ID, and password management for group members.

10.18.1.1 get
This command is used to view OCI Call Control Application definition attributes.
1) Ensure you are at the /AS_CLI/Interface/OCI/CallControl> level.
2) Enter:
get↵

10.18.1.2 add
This command is used to add an OCI Call Control Application definition to the system. Disabling system-
wide means the application is enabled per user.
1) Ensure you are at the /AS_CLI/Interface/OCI/CallControl> level.
2) Enter:
add <applicationId> <enableSystemWide> <notificationTimeoutInSeconds>
<maxEventChannelsPerSet> [<description>]↵
where:
Variable Field Type Valid Values Description

<applicationId> String 1 to 80 characters Identifies the application.

<enableSystem Choice true, false When set to "true", the application

Wide> is enabled system-wide;
otherwise, it is enabled on a per-
user basis.

<notification Integer 2 through 30 The timeout value for an OCI-C

TimeoutIn application's notifications.
Seconds>

<maxEvent Integer 1 through 100 The maximum number of Event

ChannelsPer Channels allowed per set.
Set>

<description> String 1 to 80 characters A description of the application

being added.

10.18.1.3 set
This command is used to modify an OCI Call Control Application definition attributes. Disabling system-
wide means the application is enabled per user. If an application is enabled per user then switched to
being enabled system-wide, the switch to enabling system-wide will require confirmation as the application
settings per user will be lost for this application.
1) Ensure you are at the /AS_CLI/Interface/OCI/CallControl> level.
2) Enter:
set <applicationId> <attribute>↵
where:
Variable Field Type Valid Values Description

<applicationId> String 1 to 80 characters Identifies the application.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 617
 Variable Field Type Valid Values Description

<attribute> MultipleChoice enableSystemWide, notification The name of an attribute to

TimeoutInSeconds, maxEvent modify.
ChannelsPerSet, description

<enableSystem Choice true, false When set to "true", the application

Wide> is enable system-wide; otherwise,
it is enabled on a per-user basis.

<notification Integer 2 through 30 The timeout value for an OCI-C

TimeoutIn application's notifications.
Seconds>

<maxEvent Integer 1 through 100 The maximum number of Event

ChannelsPer Channels allowed per set.
Set>

<description> String 1 to 80 characters A description of the application

being added.

10.18.1.4 delete
This command is used to delete an OCI Call Control Application definition from the system. Confirmation is
required since deleting the application will remove it from all users that have enabled it.
1) Ensure you are at the /AS_CLI/Interface/OCI/CallControl> level.
2) Enter:
delete <applicationId>↵
where:
Variable Field Type Valid Values Description

<applicationId> String 1 to 80 characters Identifies the application.

10.18.1.5 clear
This command is used to clear OCI Call Control Application attributes.
1) Ensure you are at the /AS_CLI/Interface/OCI/CallControl> level.
2) Enter:
clear <applicationId> <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<applicationId> String 1 to 80 characters The application identifier.

<clearAttribute> MultipleChoice description The name of the attribute(s) to

clear.

10.18.2 Reporting
This level is used to view and modify OCI Reporting-related attributes.

10.18.2.1 get
This command is used to view OCI Reporting-related attributes.
1) Ensure you are at the /AS_CLI/Interface/OCI/Reporting> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 618
 2) Enter:
get↵

10.18.2.2 set
This command is used to modify OCI Reporting-related attributes. Note that a restart of the Application
Server is required for the modification to any these attributes to take effect.
1) Ensure you are at the /AS_CLI/Interface/OCI/Reporting> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice serverPort, enableConnection The name of an attribute to

Ping, connectionPingInterval modify.
Seconds, alterPasswords, enable
PublicIdentityReporting

<serverPort> Integer 1025 through 65535 This value allows the system
administrator to configure the
server port that connects to all
external systems. The default is
8025.

<enable Choice true, false When set to "false", the

Connection Application Server does not
Ping> send out the OCI Reporting
Server Status Notification. When
set to "true", the Application
Server periodically sends out
an OCI Reporting Server Status
Notification to all connections.
This indicates to external systems
that the connection is still active.

<connection Integer 1 through 86400 Specifies the interval in seconds

PingInterval to which the Application Server
Seconds> periodically sends out an
OCI Reporting Server Status
Notification to all connections.

<alter Choice true, false When set to "false", this is a

Passwords> system-wide setting used to
indicate that passwords are
not altered in OCI modification
requests. When set to "true",
this is a system-wide setting
used to indicate that passwords
are altered to "XXXXX" in OCI
modification requests. The default
setting is to alter passwords.
If passwords are altered, the
isAltered element is included in
the OCI Reporting Server Status
Notification to indicate that the
OCI modification request has
been altered.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 619
 Variable Field Type Valid Values Description

<enable Choice true, false Enables or disables reporting for

PublicIdentity public identity feature. NOTE:
Reporting> When this setting is modified, a
restart is required.

10.19 ProvisioningValidation
The provisioning validation framework is used to validate forwarding numbers provisioned against the
Outgoing Calling Plan. It also provides network translation support, thus enabling complete validation
of the destination numbers. When the destination number is determined to be a network destination,
the Network Server is queried. The number is then validated by AAC and OCP, taking into account the
Network Server results. Note that for network destinations, the Network Server is queried even if the
validity of the destination could be determined without the network translations. A trivial example of this is
a user who has neither AAC nor OCP services. Adding Network Server queries allows proper resolution of
City Wide Centrex and toll calls.

10.19.1 get
This command is used to view Provisioning Validation-related attributes.
1) Ensure you are at the /AS_CLI/Interface/ProvisioningValidation> level.
2) Enter:
get↵

10.19.2 set
This command is used to modify Provisioning Validation-related attributes.
1) Ensure you are at the /AS_CLI/Interface/ProvisioningValidation> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enablePVInterface, enablePV The name of an attribute to

NetworkServerQuery, pvTimeout modify.
Seconds

<enablePV Choice true, false Specifies whether the

Interface> Provisioning Verification interface
is enabled.

<enablePV Choice true, false When set to "true", provisioning

NetworkServer validation queries the Network
Query> Server for all network destinations
and is able to fully validate the
destination number. When set to
"false", the Execution Server does
not query the Network Server
and is unable to completely
screen out invalid destination
addresses for City Wide Centrex
users, or when the toll status
is available only in the Network
Server results.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 620
 Variable Field Type Valid Values Description

<pvTimeout Integer 1 through 30 When this delay expires, the

Seconds> provisioning transaction fails and
an error is returned to the user.

10.20 SIP
This level is used to view and modify the Session Initiation Protocol (SIP) attributes.
Session Initiation Protocol (SIP) information is required to establish communication between the network
elements (NEs). The SIP interface supports call completion. The Application Server supports two SIP timer
values:
t1: the initial SIP message retransmission time interval to wait before re-transmitting messages.
t2: the maximum time interval between retransmission of non-INVITE requests retry interval.
If the initial attempt to transmit a SIP request fails, the system will retry after the interval specified by t1.
This interval will then double for each subsequent retransmission attempt unless restricted by t2. If the
maximum interval specified by t2 is exceeded, then each subsequent transmission will occur at the t2
interval instead. Note that only non-INVITE requests can be restricted by t2. These timers correspond to
the T1 and T2 timers described in RFC 3261.
Retransmission attempts continue until one of the following conditions is met:Interval exceeds 64*t1. For
access-side INVITEs, the interval exceeds the terminationAttemptTimeoutSeconds value specified under
the AS_CLI/System/CallP/AccessRouting> context and the terminationAttemptTimeoutActive parameter is
set to true. For network-side INVITEs, the interval exceeds the routeTimerLength value specified under the
AS_CLI/System/CallP/Routing/RouteParms> context.
This level is also used to configure an Application Server to interwork with a Call Session Control Function
(CSCF). In particular, BroadWorks interfaces with the Serving CSCF (S-CSCF).
To configure the Application Server, the following parameters are used:
* 100rel, useDomainForSubscriberAddress
* parameters of the AS_CLI/Interface/IMS> context (available in IMS mode only).

10.20.1 get
This command is used to view Session Initiation Protocol (SIP)-related attributes, including the default port,
the t1 timer, and the t2 timer.
1) Ensure you are at the /AS_CLI/Interface/SIP> level.
2) Enter:
get↵

10.20.2 set
This command is used to modify Session Initiation Protocol (SIP)-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SIP> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 621
 Variable Field Type Valid Values Description

<attribute> MultipleChoice t1, t2, maxForwardingHops, The name of an attribute to

inviteAuthenticationRatio, modify.
encryptFromHeader, 100rel, use
DomainForSubscriberAddress,
accessControl, sendE164,
suspiciousAddressThreshold,
privacyVersion, privacyEnforce
Screening, listeningPort, network
ProxyHost, networkProxyPort,
networkProxyTransport, access
ProxyHost, accessProxyPort,
accessProxyTransport, support
DnsSrv, maxAddressesPer
Hostname, maxAddressesPer
HostnameInDialog, useDomain
ForRealm, includeT38Capability
Info, reInviteAuthentication,
supportAnswerAfter, network
SupportGtd, privateDialPlan
OriginatorUsesExtension,
disallowHoldingEmergency
Call, enableHoldNormalization,
callingPartyCategoryFormat,
networkSupportInviteWithout
Sdp, symmetricSignaling, support
Tcp, supportDnsNaptr, send
CarrierSelection, sendDialedCA
C, originatingTrunkGroupFormat,
destinationTrunkGroupFormat,
supportRFC3398, restricted
DisplayName, maxNumber
TcpSocketsPerSystem, max
NumberTcpSocketsPerPeer,
autoDiscardStaleConnections,
staleConnectionTimerInMinutes,
treatDTMFPoundAsFlash,
supportPEarlyMediaHeader,
sendDiversionInhibitor, network
SupportVideo, callingPartyE164
Normalization, supportRFC3966
PhoneContext, includePrivacy
User, broadworksHoldingSDP
Method, broadworksHoldingSDP
NetAddress, broadworks
HoldingSDPIPv6NetAddress,
useStrictRFC3264Compliance,
disableSDPChangesForAnswer
Responses, accessForking
Support, networkForkingSupport,
proxyInfoInAllowHeader, proxy
UpdateInAllowHeader, use
SessionCompletionTimer,
sessionCompletionTimer, use
HistoryInfoHeaderOnNetwork
Side, requiresBroadWorksDigit
Collection, supportXFeature
Control, chargeHeaderFormat,
noaValue, forceAnswerSDP
OnAnswer, sendXBroad
WorksDNCHeader, encryptX

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 622
 Variable Field Type Valid Values Description
BroadWorksDNCHeader, x
BroadWorksDNCHeaderKey,
allowBroadWorksConference
Info, sendCallerNameInfoFor
NetworkCalls, includeClassmark,
send181Response, routeTo
TrunkingDomainByDefault,
clusterAddress, disabledCLID
NumberValue, suppressImplicit
ReferSubscription, networkSend
IdentityInUpdateAndReInvite,
networkReceiveIdentityInUpdate
AndReInvite, enableTS29163
Compliance, redirectingAsserted
IdentityPolicy, useAsserted
IdentityForPrivateCLID, transfer
NetworkCauseID, sipIpVersion,
networkHoldNormalization,
supportPrivacyNone, reportAltc
Supported, suppressUnreliable
AlertingForIVR, sendCall
CorrelationIDAccess, sendCall
CorrelationIDNetwork, redirection
HeaderPriority, disableCOLP
ForRFC3323, viaBranchToken,
enforceDeviceFeatureSyncPolicy
ForSingleUserMode, enableDelay
QuickReInvite, delayQuickRe
InviteMilliseconds, treatUnknown
DisplayNameAsUnavailable,
enableRFC6044, supportCause
Parameter, includeHistoryInfoIn
Response

<t1> Choice 500, 1000, 2000, 5000, 7000, This parameter specifies the SIP
9000 t1 timer (in milliseconds).

<t2> Choice 4000, 6000, 8000, 10000 This parameter specifies the SIP
t2 timer (in milliseconds).

<max Integer 0 through 2147483647 This parameter specifies the

Forwarding maximum number of hops before
Hops> a call is rejected because of too
many forwards.

<invite String 1 to 7 characters 0, 1, 0.000000001 to

Authentication 0.999999999; this is the ratio,
Ratio> expressed in decimals, of SIP
INVITE messages that will be
challenged for authentication out
of those sent to the AS from a
BroadWorks user's originating
device when this user has the
Authentication service assigned.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 623
 Variable Field Type Valid Values Description

<encryptFrom Choice true, false When set to "true", the From

Header> header is encrypted in the
INVITEs sent to network devices
when the caller requests privacy.
When set to false, the From
header is not encrypted in
INVITEs sent to network devices
irrespective of whether or not
caller requests privacy.

<100rel> Choice true, false Allows delivery of provisional

responses per RFC 3262 to
be activated or deactivated.
True indicates that 100rel is
supported by BroadWorks. False
indicates 100rel is not supported
by BroadWorks. Setting 100rel
to false can improve capacity by
preventing the PRACK message
flow during call setup. However
this can degrade the user
experience during UPD packet
loss situations, when provisional
responses such as 180 Ringing
are not successfully delivered.
The default value is true.

<useDomain Choice true, false This parameter is used to control

ForSubscriber whether the Application Server
Address> uses the subscriber's domain for
subscriber addressing. When
set to "true", BroadWorks uses
the subscriber's domain for
subscriber addressing (the host
portion of the FROM header
when the subscriber originates
a call). In terminating scenarios,
the host part of the FROM URI is
also changed to the user domain
if the remote address is a phone
number. When set to "false",
BroadWorks uses the Application
Server address for subscriber
addressing. The default value for
this parameter is "false". Note that
this parameter should be set to
true when cscfApplication is set to
"true".

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 624
 Variable Field Type Valid Values Description

<access Choice true, false When set to "false", BroadWorks

Control> will accept an INVITE event if the
domain name of the originator's
location does not resolve to the
same IP address of the UDP
socket on which the message
was received. When set to "true",
BroadWorks will reject an INVITE
event if the domain name of the
originator's location does not
resolve to the same IP address
of the UDP socket on which the
message was received.

<sendE164> Choice true, false When set to "false", BroadWorks

will use all digits in the user
portion of SIP URLs when
sending INVITE messages for
digit-dialed calls. When set to
"true", BroadWorks will use E.164
formatted strings digits in the
user portion of SIP URLs when
sending INVITE messages for
digit-dialed calls.

<suspicious Integer 0 through 11 Defines the number of

Address unacknowledged tries when
Threshold> sending to a given IP address
associated with a fully qualified
domain name (FQDN) before
another IP address associated
with the FQDN is tried. A value
of 0 indicates that only one IP
address from the DNS query
shall be tried. During call setup
when the routing tables are
involved, /System/CallP/Routing/
RouteParms/ routeTimerLength
shall be used instead of
suspicious AddressThreshold
to advance among hostnames
multiple IP addresses.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 625
 Variable Field Type Valid Values Description

<privacy Choice RFC3323, RFC3323-Japan, When set to RFC3323,

Version> privacy-03, privacy-00, none BroadWorks supports the
P-ASSERT-IDENTITY and
PRIVACY headers described
in RFC3325 and RFC3323.
When set to RFC3323-Japan,
BroadWorks adds two P-Assert-
Identity headers to INVITEs
transmitted to a trusted network.
One P-Assert-Identity header
with a SIP-URL and the other
with a TEL-URL. When set
to privacy-03, BroadWorks
supports the calling-line privacy
using the methods described
in draft-ietf-sip-privacy-03. This
is the default value and should
be used unless the network
devices in your deployment do
not support this. When set to
privacy-00, BroadWorks supports
calling line privacy using the
methods described in draft-
ietf-sip-privacy-00. When set to
none, BroadWorks will not use
any SIP headers that are used
to require or support privacy.
"encryptFrom Header" may be
configured independently to block
the calling line ID by setting its
value to "true".

<privacy Choice true, false When set to "false", indicates

Enforce that the Remote-Party-ID header
Screening> is to be used to determine the
originating party information
regardless of the value of the
screen parameter. When set to
"true", if the message indicates
that the originator's identity was
not screened, then the originator
is considered unscreened, PSTN,
and identity unavailable.

<listeningPort> Integer 1025 through 65355 The port upon which the
messages are received.

<networkProxy String 1 to 80 characters Indicates that network-bound

Host> SIP INVITE messages leaving
BroadWorks should be sent to the
specified location if its value is not
an empty string.

<networkProxy Integer 1025 through 65355 Indicates that network-bound

Port> SIP INVITE messages leaving
BroadWorks should be sent to the
specified location if its value is not
an empty string.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 626
 Variable Field Type Valid Values Description

<networkProxy Choice udp, tcp, unspecified Indicates the transport to use for
Transport> sending to the specified location
network-bound SIP INVITE
messages leaving BroadWorks.

<accessProxy String 1 to 80 characters Defines the host/IP address. SIP

Host> Access Proxy is only used to
indicate an alternate source from
which it is acceptable to receive
messages from an access device
when ACL is enabled. Its use has
no impact on how BroadWorks
processes outbound messages.

<accessProxy Integer 1025 through 65355 Defines the port associated with
Port> the accessProxyHost. SIP Access
Proxy is only used to indicate an
alternate source from which it is
acceptable to receive messages
from an access device when ACL
is enabled. Its use has no impact
on how BroadWorks processes
outbound messages.

<accessProxy Choice udp, tcp, unspecified Defines the transport associated

Transport> with the accessProxyHost.

<supportDns Choice true, false When set to "false", deactivates

Srv> performing DNS SIP SRV
queries. If BroadWorks is
deployed in a network that has
been provisioned without DNS
SIP SRV records, setting the
value to false avoids useless
DNS SIP SRV queries. When set
to "true", activates performing
DNS SIP SRV queries.

<max Integer 1 through 50 Indicates the maximum number of

AddressesPer addresses from a DNS query that
Hostname> shall be tried. The value includes
both SRV queries and A record
queries. Thus if a SRV host
name query results in multiple
host names, the address count
crosses multiple host names.

<max Integer 1 through 50 Indicates the maximum number

AddressesPer of addresses from a DNS query
HostnameIn that shall be tried once a dialog
Dialog> has been established. The value
includes both SRV queries
and A record queries. Thus if a
SRV host name query results in
multiple host names, the address
count crosses multiple host
names.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 627
 Variable Field Type Valid Values Description

<useDomain Choice true, false When set to "false", the SIP

ForRealm> authentication realm defaults to
"BroadWorks" for all users. This
is the default value. When set to
"true", the user's domain is used
for the SIP authentication realm
for all users.

<includeT38 Choice true, false When set to "false", T38

CapabilityInfo> capability information is not
included for SIP devices. When
set to "true". T38 capability
information is included for SIP
devices.

<reInvite Choice true, false When set to "false", indicates

Authentication> that Re-INVITES will not be
authenticated. When set to
"true", SIP Re-INVITES will be
authenticated.

<support Choice true, false When set to "false", an answer-

AnswerAfter> after parameter is not sent. When
set to "true", CAP initiated SIP
INVITES will be sent out with an
answer-after=0 parameter.

<network Choice true, false When set to "false", GTD

SupportGtd> signaling is not used on SIP
messages. When set to "true",
indicates that the network
supports GTD signaling on the
appropriate SIP messages.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 628
 Variable Field Type Valid Values Description

<private Choice true, false When set to "false", any SIP

DialPlan INVITES received with the private
OriginatorUses dialing plan context set (and it
Extension> is not an intra-group call) will
have the originating identification
normalized to an E.164 number.
Any 302 responses received with
the private dialing plan context
set will cause the resulting SIP
INVITE to be sent out with an
extension phone number or E.164
number. When set to "true", any
SIP INVITES received with the
private dialing plan context set
will use an extension for the
originator identification instead
of normalizing the originator
identification to an E.164 number
if the originator identification
is a phone number. Any 302
responses received with the
private dialing plan context set
will cause the resulting SIP
INVITE to be sent out with an
extension instead of a phone
number or E.164 number.

<disallow Choice true, false Indicates if users can place

Holding emergency calls on hold.
Emergency
Call>

<enableHold Choice true, false Enable or disable RFC 3264

Normalization> hold Session Description
Protocol (SDP) sending support.
This serves to control how
BroadWorks sends hold SDP
on the network and access-side
interfaces.

<callingParty Choice none, cpc, isup-oli, cpc-gtd This parameter selects the format
Category used to send the calling party
Format> category parameter associated
with a user. When set to "none",
the calling party category (cpc)
parameter is not sent. When set
to "cpc", the CPC parameter is
included in the From header,
under the cpc field. When set to
"isup-oli", the CPC parameter
is included in the From header,
under the isup-oli field. When set
to "cpc-gtd" the CPC parameter
is included in the GTD header,
under the CPC field.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 629
 Variable Field Type Valid Values Description

<network Choice true, false When this parameter is set to

SupportInvite true, the network side supports
WithoutSdp> INVITE requests without SDP
and the Application Server allows
INVITE requests to terminate
to the network side without an
SDP. When this parameter is set
to false, the network side does
not support INVITE requests
without SDP and the Application
Server includes the fake SDP
in INVITE requests that do not
have an SDP. In this case, the
Application Server re-INVITEs
the network endpoint immediately
upon receiving the 200 OK
response, to ensure that the
network endpoint provides a valid
offer SDP.

<symmetric Choice true, false When this parameter is set to

Signaling> true, BroadWorks is configured
to send SIP messages on the
same source tuple (protocol,
IP address, port) as it uses to
receive. Note that the system
must be restarted for this change
to be implemented.

<supportTcp> Choice true, false When this parameter is set to

true, support to transport SIP
signaling via TCP is enabled.

<supportDns Choice true, false When this parameter is set

Naptr> to true, support for the use of
DNS Naming Authority Pointer
(NAPTR) records is enabled.

<sendCarrier Choice true, false When this parameter is set to

Selection> true, the Application Server sends
in outgoing Invite messages
to the caller's preferred carrier
identification codes (CICs) for
intra-LATA (cic2), inter-LATA
(cic1), and international calls
(cic3). It also selects the carrier to
be used (cic) based on the type of
the call.

<send Choice true, false Controls whether the AS sends

DialedCAC> the dialed casual dial prefix and
carrier code in the SIP INVITE
requests to the NS.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 630
 Variable Field Type Valid Values Description

<originating Choice otg, x-nortel-profile When set to "otg", the Application

TrunkGroup Server sends the originating trunk
Format> group in the From header as a
SIP URI parameter. When set to
"x-nortel-profile", the Application
Server sends the originating
trunk group in the X-Nortel-Profile
header.

<destination Choice dtg, tgrpInContact, tgrpInRequest When set to "dtg", the Application
TrunkGroup Uri, x-nortel-profile Server sends the destination
Format> trunk group information in the
outgoing INVITE as the dtg
parameter of the request-URI.
When set to "tgrpInContact",
the destination trunk group
information is passed in the
outgoing INVITE as the tgrp
and trunk-context parameters
in the user portion of the
Contact header URI. When
set to "tgrpInRequestURI",
the destination trunk group
information is passed in the
outgoing INVITE as the tgrp and
trunk-context parameters in the
user portion of the request-URI.
When set to "x-nortel-profile", an
X-Nortel-Profile header is added
to carry the destination trunk
group information in the outgoing
SIP INVITE sent towards the
network.

<supportRF Choice true, false When this parameter is set to

C3398> false, the Application Server
allows remote to local ringback
transitions. When this parameter
is set to true, the Application
Server does not allow remote to
local ringback transitions unless it
determines that the remote side is
another BroadWorks server. The
default value is false.

<restricted String 1 to 80 characters Sets the system-wide SIP

DisplayName> restricted display name. The
default value is "Anonymous".

<maxNumber Integer 1 through 65355 The maximum number of TCP

TcpSocketsPer sockets per system.
System>

<maxNumber Integer 1 through 65355 The maximum number of TCP

TcpSocketsPer sockets per peer.
Peer>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 631
 Variable Field Type Valid Values Description

<auto Choice true, false Specifies whether stale

DiscardStale connections should be
Connections> automatically discarded.

<stale Integer 1 through 15000 Specifies how long a stale

Connection connection should be kept before
TimerIn being discarded.
Minutes>

<treatDTMF Choice true, false Specifies whether DTMF pound

PoundAsFlash> should be treated as flash.

<supportPEarly Choice true, false Specifies whether the Application

MediaHeader> Server proxies and generates the
P-Early-Media header.

<sendDiversion Choice true, false Specifies whether a diversion

Inhibitor> inhibitor should be sent.

<network Choice true, false When this parameter is set to

SupportVideo> true, the network side supports
video.

<calling Choice none, systemCountryCode, called This parameter configures

PartyE164 CountryCode how the Application Server
Normalization> normalizes the calling party's
CLID (Calling Line Identity) for
network originatorsWhen set
to "none", the calling party's
CLID for a network originator
is never normalized to the
E.164 format. When set to
"systemCountryCode", the
calling party's CLID for a network
originator is normalized to E.164
using the system country code.
When set to "calledCountryCode",
the calling party's CLID for a
network originator is normalized
to E.164 using the called country
code for the INVITE when the
CLID is considered a phone
number but is not already in
E.164 format. The called country
code is the country code for the
called address.

<supportRF Choice true, false When the

C3966Phone supportRFC3966PhoneContext
Context> parameter is set to "true",
the phone-context (if any) is
used as specified in the IMS
Interoperability Enhancements
FS.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 632
 Variable Field Type Valid Values Description

<includePrivacy Choice true, false This system parameter

User> determines whether the
Application Server includes the
"user" value in the Privacy header
when privacy is restricted.

<broadworks Choice holdSDP, modifiedAddressSDP Specifies the holding Session

HoldingSDP Description Protocol (SDP)
Method> method system wide. The
default value for a new
installation is "holdSDP". The
default value for an upgrade is
"modifiedAddressSDP".

<broadworks String 1 to 39 characters A dummy Ipv4 address to be

HoldingSDPNet used when building modified
Address> address SDPs.

<broadworks String 1 to 39 characters A dummy Ipv6 address to be

HoldingSDPI used when building modified
Pv6Net address SDPs.
Address>

<useStrictRF Choice true, false When set to "true", it forces strict

C3264 compliance to RFC 3264 for SDP
Compliance> offer/answer.

<disableSDP Choice true, false When set to "true", it disables

Changes SDP changes for answer
ForAnswer responses.
Responses>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 633
 Variable Field Type Valid Values Description

<accessForking Choice singleDialog, singleDialog This parameter selects the forking

Support> WithUPDATE, multipleDialogs
WithErrorCorrection, multiple
Dialogs
support type for the access-side
of the SIP interface. When set to
"multipleDialogsWithErrorCorrection" (default
setting), the AS is generally
transparent to the creation of SIP
dialogs. In the case where the
media session is updated within
a given dialog on a subsequent
18x/2xx response, then the
AS forces the creation of a
new SIP dialog. When set to
"singleDialog", all responses
are mapped to the same dialog.
In some cases, this means
that the media session may be
updated within the dialog on a
subsequent 18x response or
on the 2xx response. When set
to "singleDialogWithUPDATE",
all responses are mapped to
the same dialog. Also, media
session updates on subsequent
18x responses are converted to
the UPDATE method. When set
to "multipleDialogs", the AS is
transparent to the creation of SIP
dialogs.

<network Choice singleDialog, singleDialog This parameter selects the forking

Forking WithUPDATE, multipleDialogs support type for the network-side
Support> WithErrorCorrection, multiple of the SIP interface. When set to
Dialogs "multipleDialogsWithErrorCorrection" (default
setting), the AS is generally
transparent to the creation of SIP
dialogs. In the case where the
media session is updated within
a given dialog on a subsequent
18x/2xx response, then the
AS forces the creation of a
new SIP dialog. When set to
"singleDialog", all responses
are mapped to the same dialog.
In some cases, this means
that the media session may be
updated within the dialog on a
subsequent 18x response or
on the 2xx response. When set
to "singleDialogWithUPDATE",
all responses are mapped to
the same dialog. Also, media
session updates on subsequent
18x responses are converted to
the UPDATE method. When set
to "multipleDialogs", the AS is
transparent to the creation of SIP
dialogs.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 634
 Variable Field Type Valid Values Description

<proxyInfoIn Choice true, false Specifies whether Allow header

AllowHeader> proxying for the INFO method is
enabled.

<proxyUpdateIn Choice true, false Specifies whether Allow header

AllowHeader> proxying for the UPDATE method
is enabled.

<useSession Choice true, false When set to "true", the

Completion Application Server uses the SIP
Timer> Session Completion timer set
by the administrator via the CLI
interface (sessionCompletion
TimerMillis). Otherwise the SIP
Session Completion timer from t2
is used.

<session Integer 5000 through 100000 The value of the Session

Completion Completion timer in milliseconds.
Timer>

<useHistory Choice true, false Specifies whether History Info

InfoHeaderOn Header should be used on the
NetworkSide> network side.

<requiresBroad Choice true, false Determines whether BroadWorks

WorksDigit is going to perform digit
Collection> collection.

<supportX Choice true, false Determines whether the

Feature Application Server sends
Control> the X-FeatureControl header
in SIP INVITE messages.
When set to "to true", the X-
FeatureControl header is inserted
if the FAC programming result
is known. If set to "false" the X-
FeatureControl header is never
inserted.

<chargeHeader Choice chargeHeaderSip, chargeHeader Determines whether

Format> Tel, pChargeInfoSip, pChargeInfo
Tel, paiTelURI, diversionSip
the ChargeHeaderSip,
ChargeHeaderTel,
PChargeInfoSip, PChargeInfoTel,
paiTelURI, or diversionSip header
is used for the Charge Number
service.

<noaValue> String 1 to 80 characters Indicates to the PSTN the nature

of address.

<force Choice true, false Controls sending the SDP in

AnswerSDPOn the generated 200 OK message
Answer> when no SDP is received in the
200 OK final response by the
Application Server. The default
value is true.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 635
 Variable Field Type Valid Values Description

<sendXBroad Choice true, false This system parameter controls

WorksDNC whether or not the X-BroadWorks
Header> -DNC header is allowed to be
included in SIP messages.

<encryptX Choice true, false This system parameter controls

Broad whether or not the X-BroadWorks
WorksDNC -DNC header is encrypted when
Header> included in SIP messages.

<xBroad String 8 to 80 characters This system parameter contains

WorksDNC the private encryption key that
HeaderKey> is used for encrypting the X-
BroadWorks-DNC header in SIP
messages.

<allow Choice true, false This system parameter controls

BroadWorks whether SIP INFO messages
Conference with an application/x-broadworks-
Info> conference-info+xml body are
allowed.

<sendCaller Choice true, false Controls whether Caller Name

NameInfoFor Information is sent or not in
NetworkCalls> network calls.

<include Choice true, false Controls the ability to proxy a

Classmark> classmark received over the SIP
interface.

<send181 Choice true, false Controls proxying and generating

Response> a SIP "181 Call is being
forwarded" reponse.

<routeTo Choice true, false This parameter is used to decide

Trunking whether the trunking domain of a
DomainBy given trunk group should be used
Default> in outgoing requests.

<cluster String 1 to 80 characters The value for this parameter

Address> is used to populate the host
part of BroadWorks user when
identified by a phone number.
If not set, and publicIPAddress
is set, publicIPAddress shall be
used. Otherwise the ipAddress
from resolving "localhost" shall be
used.

<disabledCLID String 1 to 80 characters Stores the user portion of the

NumberValue> calling line identity when no
calling line identity is enabled for
a user.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 636
 Variable Field Type Valid Values Description

<suppress Choice withoutNOTIFY, perRFC3515 When set to withoutNOTIFY,

ImplicitRefer Application Server suppresses
Subscription> the implicit REFER subscription
without sending NOTIFY. When
set to perRFC3515, Application
Server sends NOTIFY per RFC
3515 to suppress the implicit
REFER subscription.

<network Choice true, false When set to "true", indicates that

SendIdentityIn the application server updates
UpdateAndRe the network subscriber with the
Invite> updated identity information in an
UPDATE/Re-INVITE message.
When set to "false", application
server does not send the updated
identity information. Default is
false.

<network Choice true, false When set to "true", indicates that

ReceiveIdentity the application server accepts
InUpdateAnd the identity information sent from
ReInvite> the network in an UPDATE/Re-
INVITE message. When set to
"false", application server ignores
the identity information. Default is
false.

<enableT Choice true, false When set to "true", support is

S29163 provided for multiple Calling Line
Compliance> Identities to comply with the rules
defined in 3GPP TS 29.163.

<redirecting Choice assertedIdentity, redirecting When set to "redirectingIdentity",

Asserted Identity, includeRedirecting the Application Server will use the
IdentityPolicy> IdentityWhenAssertedNot asserted identity for redirection.
Available When set to "useAssertedIdentity"
the asserted identity received
will be proxied. When set to
"includeRedirectingIdentityWhenAssertedNotAva
the asserted identity received
will be proxied, and will include
the redirecting party's asserted
identity when the asserted identity
is not present.

<useAsserted Choice true, false When set to "true", the

IdentityFor Application Server uses the
PrivateCLID> asserted number when privacy is
requested. When set to "false",
the asserted number is not used.

<transfer Choice true, false This parameter enables the

Network transfer of the Network Asserted
CauseID> Identity received from the network
to the outbound device.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 637
 Variable Field Type Valid Values Description

<sipIpVersion> Choice ipv4, ipv6, both This parameter specifies the IP

version used for SIP.

<networkHold Choice useUnspecifiedAddress, use Specifies how the Application

Normalization> Inactive, useRfc3264 Server will perform SDP
normalization on the network
side when attempting to hold the
device media.

<support Choice true, false This parameter specifies whether

PrivacyNone> the Application Server respects
the "none" value in the Privacy
header for a user origination.
When set to "true" and the user
origination is received with the
Privacy header set to "none", the
user's CLID Delivery Blocking
service setting is ignored.
However, if the user dials the
CLID Delivery Blocking per Call
Feature Access Code (FAC), the
privacy restrictions are enabled
since the user explicitly requested
privacy in the origination. When
set to "false" and the user
origination is received with the
Privacy header set to "none", the
user's CLID Delivery Blocking
service setting is applied, privacy
restrictions are enabled, and the
user has the service enabled. The
default value is "false".

<reportAltc Choice true, false This system parameter allows

Supported> you to specify whether the
Application Server supports the
SIP alternate connection header
or not.

<suppress Choice true, false When set to "true", the application

Unreliable server will suppress the 18x
Alerting message for IVR calls.
ForIVR>

<sendCall Choice true, false When set to true, the Call

CorrelationID Correlation Identifier is included
Access> in SIP messages to Access-side
devices.

<sendCall Choice true, false When set to true, the Call

CorrelationID Correlation Identifier is included in
Network> SIP messages within the network.

<redirection Choice historyInfo, diversion This parameter determines which

HeaderPriority> redirection header is prioritized
when both headers (History-Info
header and Diversion header) are
present.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 638
 Variable Field Type Valid Values Description

<disableCOLP Choice true, false When set to true, the P-Asserted-

ForRFC3323> Identity header will not be part of
the connected identity messages
when the privacy version is set to
RFC3323.

<viaBranch String 1 to 7 characters This parameter defines a custom

Token> branch token to recognize call
terminations across different
clusters. Note that the system
must be restarted for this change
to be implemented.

<enforceDevice Choice true, false When set to true, the Device

FeatureSync Feature Synchronization policy
PolicyForSingle is considered for users in single
UserMode> user mode. When set to false,
the policy is not enforced for call
processing purposes.

<enableDelay Choice true, false When set to true, the SIP Invite is
QuickReInvite> resent with a delay.

<delayQuick Integer 100 through 10000 This parameter defines the delay
ReInvite to wait in milliseconds before
Milliseconds> resending a SIP Invite.

<treatUnknown Choice true, false This parameter determines

DisplayName whether to treat as Unavailable
AsUnavailable> the presentation identiy when the
FROM header's display name of
a SIP invite is set to "Unknown".

<enableRF Choice true, false This parameter enforces the

C6044> mapping between the History-
Info and Diversion redirection
headers.

<supportCause Choice true, false This parameter specifies that the

Parameter> cause URI parameter is accepted
in incoming INVITE and applied
to History-Info entries in outgoing
INVITE.

<include Choice true, false This parameter specifies that the

HistoryInfoIn History-Info header is included
Response> in the SIP response to the
originating endpoint.

10.20.3 clear
This command is used to clear (set to no value) Session Initiation Protocol (SIP)-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SIP> level.
2) Enter:
clear <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 639
 Variable Field Type Valid Values Description

<attribute> MultipleChoice networkProxyHost, network The name of the attribute(s) to

ProxyPort, accessProxyHost, clear.
accessProxyPort, broadworks
HoldingSDPNetAddress,
broadworksHoldingSDPIPv6
NetAddress, clusterAddress,
disabledCLIDNumberValue, via
BranchToken

10.20.4 ContentType
This level is used to view, modify, add, and delete content types supported by the BroadWorks Application
Server SIP interface.

10.20.4.1 get
This command is used to view Content Type-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SIP/ContentType> level.
2) Enter:
get↵

10.20.4.2 set
This command is used to modify Content Type-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SIP/ContentType> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enableAcceptHeader The name of an attribute to

Transparency modify.

<enable Choice true, false This parameter controls the

AcceptHeader Accept header proxying
Transparency> capability. When it is set to
"true", the Accept header in
SIP messages provides a list
of content-type values that are
understood and supported by the
sender. When this parameter is
set to "false", the Accept header
always contains the full list of
configured content-type entries.

10.20.4.3 Content
This level is used to manage Content-related attributes.
10.20.4.3.1 get
This command is used to view Content-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SIP/ContentType/Content> level.
2) Enter:
get↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 640
10.20.4.3.2 add
This command is used to add a new Content entry.
1) Ensure you are at the /AS_CLI/Interface/SIP/ContentType/Content> level.
2) Enter:
add <contentType> <supportedInterface>↵
where:
Variable Field Type Valid Values Description

<contentType> String 2 to 80 characters The name of the content type.

<supported Choice access, network, both Indicates whether the content

Interface> type entry should be allowed
from the access, network, or
both access and network side
interfaces.

10.20.4.3.3 set
This command is used to change the supported Interface attribute for a supported Content type list entry.
1) Ensure you are at the /AS_CLI/Interface/SIP/ContentType/Content> level.
2) Enter:
set <contentType> <attribute>↵
where:
Variable Field Type Valid Values Description

<contentType> String 2 to 80 characters The name of the content type.

<attribute> MultipleChoice supportedInterface The name of an attribute to

modify.

<supported Choice access, network, both Indicates whether the content

Interface> type entry should be allowed
from the access, network, or
both access and network side
interfaces.

10.20.4.3.4 delete
This command is used to delete an existing Content entry.
1) Ensure you are at the /AS_CLI/Interface/SIP/ContentType/Content> level.
2) Enter:
delete <contentType>↵
where:
Variable Field Type Valid Values Description

<contentType> String 2 to 80 characters The name of the content type.

10.20.5 DiversionReasonMap
This level is used to view and modify Diversion Reason attributes supported by the BroadWorks
Application Server SIP interface.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 641
10.20.5.1 get
This command is used to view Session Initiation Protocol (SIP) Diversion Reason-related attributes,
including the cause value mappings.
1) Ensure you are at the /AS_CLI/Interface/SIP/DiversionReasonMap> level.
2) Enter:
get↵

10.20.5.2 set
This command is used to modify Session Initiation Protocol (SIP) Diversion Reason-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SIP/DiversionReasonMap> level.
2) Enter:
set <diversionReason> <causeValue>↵
where:
Variable Field Type Valid Values Description

<diversion Choice unknown, user-busy, no-answer, This parameter identifies the

Reason> unavailable, unconditional, diversion reason.
deflection, time-of-day, do-not-
disturb, follow-me, out-of-service,
away, transfer, voicemail, hunt-
group, call-center, route-point, B
W-ImplicitID, BW-ExplicitID

<causeValue> String 3 to 3 characters This parameter specifies the

cause value to use with the
specified diversion reason.

10.20.6 ProxyPolicy
This level is used to control proxy headers or option tags considered Unknown based on new SIP header
proxy policies (known SIP headers and SIP option tags).

10.20.6.1 HeaderPolicy
This level is used to view, modify, add, delete, and clear HeaderPolicy entries.
10.20.6.1.1 get
This command is used to view Header Policy definition attributes.
1) Ensure you are at the /AS_CLI/Interface/SIP/ProxyPolicy/HeaderPolicy> level.
2) Enter:
get↵
10.20.6.1.2 add
This command is used to add a Header Policy definition.
1) Ensure you are at the /AS_CLI/Interface/SIP/ProxyPolicy/HeaderPolicy> level.
2) Enter:
add <headerName> <ruleName> [<shortHeaderName>]↵
where:
Variable Field Type Valid Values Description

<headerName> String 1 to 128 characters The name of SIP header to be

handled.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 642
 Variable Field Type Valid Values Description

<ruleName> String 1 to 30 characters The name of the SIP proxy rule.

<shortHeader String 1 to 1 characters The short header name for the

Name> SIP header to be handled.

10.20.6.1.3 set
This command is used to modify HeaderPolicy definition attributes.
1) Ensure you are at the /AS_CLI/Interface/SIP/ProxyPolicy/HeaderPolicy> level.
2) Enter:
set <headerName> <attribute>↵
where:
Variable Field Type Valid Values Description

<headerName> String 1 to 128 characters The name of SIP header to be

handled.

<attribute> MultipleChoice ruleName, shortHeaderName The name of an attribute to

modify.

<ruleName> String 1 to 30 characters The name of the SIP proxy rule.

<shortHeader String 1 to 1 characters The short header name for the

Name> SIP header to be handled.

10.20.6.1.4 delete
This command is used to delete a Header Policy.
1) Ensure you are at the /AS_CLI/Interface/SIP/ProxyPolicy/HeaderPolicy> level.
2) Enter:
delete <headerName>↵
where:
Variable Field Type Valid Values Description

<headerName> String 1 to 128 characters The name of SIP header to be

deleted.

10.20.6.1.5 clear
This command is used to clear (set to no value) a Header Policy definition attribute.
1) Ensure you are at the /AS_CLI/Interface/SIP/ProxyPolicy/HeaderPolicy> level.
2) Enter:
clear <headerName> <attribute>↵
where:
Variable Field Type Valid Values Description

<headerName> String 1 to 128 characters SIP header to be handled.

<attribute> MultipleChoice shortHeaderName The name of the attribute(s) to

clear.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 643
10.20.6.2 OptionTagPolicy
This level is used to view, modify, add, and delete OptionTagPolicy entries.
10.20.6.2.1 get
This command is used to view Option Tag Policy entries.
1) Ensure you are at the /AS_CLI/Interface/SIP/ProxyPolicy/OptionTagPolicy> level.
2) Enter:
get↵
10.20.6.2.2 add
This command is used to add a new Option Tag Policy entry.
1) Ensure you are at the /AS_CLI/Interface/SIP/ProxyPolicy/OptionTagPolicy> level.
2) Enter:
add <optionTag> <ruleName>↵
where:
Variable Field Type Valid Values Description

<optionTag> String 1 to 128 characters The SIP option tag to be handled.

<ruleName> String 1 to 30 characters The name of the SIP proxy rule.

10.20.6.2.3 set
This command is used to modify Option Tag Policy entry attributes.
1) Ensure you are at the /AS_CLI/Interface/SIP/ProxyPolicy/OptionTagPolicy> level.
2) Enter:
set <optionTag> <attribute>↵
where:
Variable Field Type Valid Values Description

<optionTag> String 1 to 128 characters The SIP option tag to be handled.

<attribute> MultipleChoice ruleName The name of an attribute to

modify.

<ruleName> String 1 to 30 characters The name of the SIP proxy rule.

10.20.6.2.4 delete
This command is used to delete an Option Tag Policy entry.
1) Ensure you are at the /AS_CLI/Interface/SIP/ProxyPolicy/OptionTagPolicy> level.
2) Enter:
delete <optionTag>↵
where:
Variable Field Type Valid Values Description

<optionTag> String 1 to 128 characters Identifies the SIP option tag to be

deleted.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 644
10.20.6.3 Rule
This level is used to view and add Rule entries.
10.20.6.3.1 get
This command is used to view SIP proxy rule-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SIP/ProxyPolicy/Rule> level.
2) Enter:
get↵
10.20.6.3.2 add
This command is used to add a SIP proxy rule.
1) Ensure you are at the /AS_CLI/Interface/SIP/ProxyPolicy/Rule> level.
2) Enter:
add <ruleName> <keepOnRedirection> <keepOnEgressAccess>
<keepOnEgressNetworkOnNet> <keepOnEgressNetworkOffNet>
<keepOnEgressAccessSharedCallAppearance>
<keepOnEgressNetworkBroadWorksAnywhereOnNet>
<keepOnEgressNetworkBroadWorksAnywhereOffNet> <acceptFromRedirectToURI>↵
where:
Variable Field Type Valid Values Description

<ruleName> String 1 to 30 characters This is the name of the rule to

add.

<keepOn Choice true, false This parameter determines

Redirection> whether the header is kept in the
case of a redirection.

<keepOn Choice true, false This parameter determines

EgressAccess> whether the header is kept
for outgoing messages to the
access-side.

<keepOn Choice true, false This parameter determines

EgressNetwork whether the header is propagated
OnNet> for outgoing on-net messages
bound to the network.

<keepOn Choice true, false This parameter determines

EgressNetwork whether the header is propagated
OffNet> for outgoing off-net messages
bound to the network.

<keepOn Choice true, false This parameter determines

EgressAccess whether the header is kept for
SharedCall outgoing messages to a Shared
Appearance> Call Appearance secondary
location.

<keepOn Choice true, false This parameter determines

EgressNetwork whether the header is kept for
BroadWorks outgoing on-net messages to a
AnywhereOn BroadWorks Anywhere location.
Net>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 645
 Variable Field Type Valid Values Description

<keepOn Choice true, false This parameter determines

EgressNetwork whether the header is kept for
BroadWorks outgoing off-net messages to a
AnywhereOff BroadWorks Anywhere location.
Net>

<acceptFrom Choice true, false This parameter determines if an

Redirect unknown header embedded in
ToURI> a redirect destination URI may
be accepted for insertion into an
outbound message.

10.20.6.3.3 set
This command is used to modify a SIP proxy rule.
1) Ensure you are at the /AS_CLI/Interface/SIP/ProxyPolicy/Rule> level.
2) Enter:
set <ruleName> <attribute>↵
where:
Variable Field Type Valid Values Description

<ruleName> String 1 to 30 characters This is the name of the rule to

modify.

<attribute> MultipleChoice keepOnRedirection, keepOn The name of an attribute to

EgressAccess, keepOnEgress modify.
NetworkOnNet, keepOnEgress
NetworkOffNet, keepOnEgress
AccessSharedCallAppearance,
keepOnEgressNetworkBroad
WorksAnywhereOnNet, keep
OnEgressNetworkBroadWorks
AnywhereOffNet, acceptFrom
RedirectToURI

<keepOn Choice true, false This parameter determines

Redirection> whether the header is kept in the
case of a redirection.

<keepOn Choice true, false This parameter determines

EgressAccess> whether the header is kept
for outgoing messages to the
access-side.

<keepOn Choice true, false This parameter determines

EgressNetwork whether the header is propagated
OnNet> for outgoing on-net messages
bound to the network.

<keepOn Choice true, false This parameter determines

EgressNetwork whether the header is propagated
OffNet> for outgoing off-net messages
bound to the network.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 646
 Variable Field Type Valid Values Description

<keepOn Choice true, false This parameter determines

EgressAccess whether the header is kept for
SharedCall outgoing messages to a Shared
Appearance> Call Appearance secondary
location.

<keepOn Choice true, false This parameter determines

EgressNetwork whether the header is kept for
BroadWorks outgoing on-net messages to a
AnywhereOn BroadWorks Anywhere location.
Net>

<keepOn Choice true, false This parameter determines

EgressNetwork whether the header is kept for
BroadWorks outgoing off-net messages to a
AnywhereOff BroadWorks Anywhere location.
Net>

<acceptFrom Choice true, false This parameter determines if an

Redirect unknown header embedded in
ToURI> a redirect destination URI may
be accepted for insertion into an
outbound message.

10.20.6.3.4 delete
This command is used to delete a SIP proxy rule.
1) Ensure you are at the /AS_CLI/Interface/SIP/ProxyPolicy/Rule> level.
2) Enter:
delete <ruleName>↵
where:
Variable Field Type Valid Values Description

<ruleName> String 1 to 30 characters This is the name of the rule to

delete.

10.20.6.4 UnmatchedHeaderPolicy
This level is used to view, modify, and clear the Unmatched Header Policy attributes.
10.20.6.4.1 get
This command is used to view the Unmatched Header Policy attributes.
1) Ensure you are at the /AS_CLI/Interface/SIP/ProxyPolicy/UnmatchedHeaderPolicy>
level.
2) Enter:
get↵
10.20.6.4.2 set
This command is used to modify UnmatchedHeaderPolicy attributes.
1) Ensure you are at the /AS_CLI/Interface/SIP/ProxyPolicy/UnmatchedHeaderPolicy>
level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 647
 Variable Field Type Valid Values Description

<attribute> MultipleChoice ruleName The name of an attribute to

modify.

<ruleName> String 1 to 30 characters The name of the SIP proxy rule.

10.20.6.4.3 clear
This command is used to clear (set to no value) Unmatched Header Policy attributes.
1) Ensure you are at the /AS_CLI/Interface/SIP/ProxyPolicy/UnmatchedHeaderPolicy>
level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice ruleName The name of the attribute(s) to

clear.

10.20.6.5 UnmatchedOptionTagPolicy
This level is used to view, modify, and clear Unmatched Option Tag Policy attributes.
10.20.6.5.1 get
This command is used to view the Unmatched Option Tag Policy attributes.
1) Ensure you are at the /AS_CLI/Interface/SIP/ProxyPolicy/UnmatchedOptionTagPolicy>
level.
2) Enter:
get↵
10.20.6.5.2 set
This command is used to modify Unmatched Option Tag Policy attributes.
1) Ensure you are at the /AS_CLI/Interface/SIP/ProxyPolicy/UnmatchedOptionTagPolicy>
level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice ruleName The name of an attribute to

modify.

<ruleName> String 1 to 30 characters The name of the SIP proxy rule.

10.20.6.5.3 clear
This command is used to clear (set to no value) Unmatched Option Tag Policy attributes.
1) Ensure you are at the /AS_CLI/Interface/SIP/ProxyPolicy/UnmatchedOptionTagPolicy>
level.
2) Enter:
clear <attribute>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 648
 where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice ruleName The name of the attribute(s) to

clear.

10.21 SMDI
This level is used to view, modify, add, and delete system parameters related to the SMDI interface.

10.21.1 get
This command is used to view SMDI Interface-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SMDI> level.
2) Enter:
get↵

10.21.2 set
This command is used to modify SMDI Interface-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SMDI> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, maxNbOfConnections, The name of an attribute to

listeningPort modify.

<enabled> Choice true, false Enable or disable the SMDI

Interface.

<maxNbOf Integer 0 through 64 The maximum number of terminal

Connections> server sessions that can be
simultaneously connected to
the Application Server SMDI
Interface.

<listeningPort> Integer 1025 through 65535 The Application Server SMDI

Interface Server listening port.

10.22 SMPP
This level is used to view, modify, or clear SMPP (Short Message Peer-to-Peer Protocol)-related attributes.

10.22.1 get
This command is used to view the current Short Message Peer-to-Peer Protocol (SMPP)-related
configuration.
1) Ensure you are at the /AS_CLI/Interface/SMPP> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 649
 get↵

10.22.2 set
This command is used to modify Short Message Peer-to-Peer Protocol (SMPP)-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SMPP> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice primaryServer, primaryPort, The name of an attribute to

secondaryServer, secondary modify.
Port, systemId, password,
version, systemType, enableMWI
CustomizedMessage, support
MessagePayload, maxShort
MessageLength, useGsmMwi
Ucs2Encoding

<primary String 1 to 80 characters This parameter specifies the

Server> primary server's address.

<primaryPort> Integer 1 through 65535 This parameter specifies the

primary server's port.

<secondary String 1 to 80 characters This parameter specifies the

Server> secondary server's address.

<secondary Integer 1 through 65535 This parameter specifies the

Port> secondary server's port.

<systemId> String 1 to 16 characters This parameter specifies the

server's login.

<password> String 1 to 8 characters This parameter specifies the

server's password.

<version> Choice 3.3, 3.4, 5.0 This parameter specifies the

version that the system supports.

<systemType> String 1 to 12 characters This parameter specifies

the system type of the Short
Message Peer-to-Peer Protocol
(SMPP) protocol. the value
"VMS", indicating the voice mail
system, is the default value.

<enableMWI Choice true, false This parameter determines

Customized whether the customized
Message> templates will be used to build
the text message to be included
in the Short Message Peer-
to-Peer Protocol (SMPP)
Message Waiting Indicator (MWI)
notifications messages.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 650
 Variable Field Type Valid Values Description

<support Choice true, false This parameter determines

Message whether the system supports
Payload> customized messages that are
larger than 70 characters.

<maxShort Integer 1 through 70 This parameter specifies

Message the maximum length of the
Length> short_message field included
in the Short Message Peer-
to-Peer Protocol (SMPP)
Message Waiting Indicator (MWI)
messages in character.

<useGsmMwi Choice true, false This parameter determines

Ucs2Encoding> whether the system supports
the Global System for Mobile
Communications (GSM) Message
Waiting Indicator (MWI) encoding
for sending 2-byte Universal
Character Set (UCS-2) encoded
payloads. If the value is set to
"false" and a text message is
included in the Short Message
Service (SMS) message, then
the encoding will be set to UCS2
with no support for GSM MWI
encoding.

10.22.3 clear
This command is used to clear (set to no value) Short Message Peer-to-Peer Protocol (SMPP) attributes
that do not have default settings.
1) Ensure you are at the /AS_CLI/Interface/SMPP> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice primaryServer, secondaryServer, The name of the attribute(s) to

systemId, password, systemType clear.

10.23 SNMP
This level is used to view and modify the Simple Network Management Protocol (SNMP) agent.

10.23.1 AccessList
This level is used to view and modify the list of entries in the Simple Network Management Protocol
(SNMP) access list.

10.23.1.1 get
This command is used to view the nodes that currently can access the Simple Network Management
Protocol (SNMP) agent.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 651
 1) Ensure you are at the /AS_CLI/Interface/SNMP/AccessList> level.
2) Enter:
get↵

10.23.1.2 add
This command is used to add a node to the Simple Network Management Protocol (SNMP) access list. To
obtain performance measurements, the SNMP manager must have access to the individual nodes in the
network. The SNMP manager Internet Protocol (IP) address is used by the agent to identify managers that
are granted access.
1) Ensure you are at the /AS_CLI/Interface/SNMP/AccessList> level.
2) Enter:
add <ipAddress>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters This parameter specifies the

Internet Protocol (IP) address
of an external Simple Network
Management Protocol (SNMP)
manager.

10.23.1.3 delete
This command is used to remove a node from the Simple Network Management Protocol (SNMP) access
list. When the node is removed from the access list, it is longer able to obtain performance measurements
from the SNMP Agent. The node's IP address is used to identify the manager.
1) Ensure you are at the /AS_CLI/Interface/SNMP/AccessList> level.
2) Enter:
delete <ipAddress>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 39 characters This parameter specifies the

Internet Protocol (IP) address
of an external Simple Network
Management Protocol (SNMP)
manager.

10.23.2 Agent
This level is used to view and modify the current Simple Network Management Protocol (SNMP) Agent
settings, modify the listening port, modify the read community string, or modify the write community string.
You can set the source address that is used to send traps, which supports configurations whereby a server
can have multiple network interfaces, including a dedicated maintenance/management interface.

10.23.2.1 get
This command is used to view the current Simple Network Management Protocol (SNMP) Agent-related
attributes.
1) Ensure you are at the /AS_CLI/Interface/SNMP/Agent> level.
2) Enter:
get↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 652
10.23.2.2 set
This command is used to modify Simple Network Management Protocol (SNMP) Agent-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SNMP/Agent> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice port, encoding, readCommunity, The name of an attribute to

writeCommunity, trapCommunity, modify.
trapSourceAddress, disableV2

<port> Integer 1024 through 65535 This parameter specifies the

port used to communicate to the
Simple Network Management
Protocol (SNMP) Agent.

<encoding> Choice UTF-8, ISO-8859-1 This parameter controls whether

ISO-8859-1 or UTF-8 (Unicode)
encoding is used by the Simple
Network Management Protocol
(SNMP) Agent to send traps.

<read String 1 to 255 characters This parameter specifies the read

Community> community string used to access
the Simple Network Management
Protocol (SNMP) Agent.

<write String 1 to 255 characters This parameter specifies the write

Community> community string used to access
the Simple Network Management
Protocol (SNMP) Agent.

<trap String 1 to 255 characters This parameter specifies the trap

Community> community string used by the
Simple Network Management
Protocol (SNMP) Agent when
sending SNMP Traps.

<trapSource Choice An IP interface that is currently This parameter specifies the trap
Address> defined on the server. source for the Simple Network
Management Protocol (SNMP)
Agent.

<disableV2> Choice true, false This parameter is used to disable

Simple Network Management
Protocol (SNMP) v2.

10.23.3 Logging
This level is used to view and modify logging for the Simple Network Management Protocol (SNMP) Agent.

10.23.3.1 get
This command is used to view logging-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SNMP/Logging> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 653
 get↵

10.23.3.2 set
This command is used to modify logging-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SNMP/Logging> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, severity, priority, max This parameter specifies the
QueueSize, showThreadName attribute to be modified.

<enabled> Choice true, false This parameter turns the logging

on and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn default logging severity level.

<priority> Integer 1 through 5 This parameter specifies the

priority of the logging thread. The
value "1" indicates the lowest
priority and "5" indicates the
highest.

<maxQueue Integer 0 through 2147483647 This parameter specifies the

Size> maximum size of the logging
queue.

<showThread Choice true, false This parameter enables thread

Name> name logging.

10.23.3.3 InputChannels
This level is used to view, modify, or clear input channels entries.
10.23.3.3.1 get
This command is used to view input channels-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SNMP/Logging/InputChannels> level.
2) Enter:
get↵
10.23.3.3.2 set
This command is used to modify input channels-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SNMP/Logging/InputChannels> level.
2) Enter:
set <name> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 654
 Variable Field Type Valid Values Description

<name> Choice Generic, BroadsoftCommon This parameter specifies the

CommunicationTransport, name of the logging input
BroadsoftCommon channel.
CommunicationTransportKeep
Alive, SMAP, SNMP

<attribute> MultipleChoice enabled, severity The name of an attribute to

modify.

<enabled> Choice true, false This parameter turns the logging

to the logging input channel on
and off.

<severity> Choice Debug, FieldDebug, Info, Notice, This parameter specifies the
Warn severity level of the logging input
channel.

10.23.3.3.3 clear
This command is used to clear input channels-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SNMP/Logging/InputChannels> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> Choice Generic, BroadsoftCommon This parameter specifies the

CommunicationTransport, name of the logging input
BroadsoftCommon channel.
CommunicationTransportKeep
Alive, SMAP, SNMP

<attribute> MultipleChoice severity The name of an attribute to clear.

10.23.3.4 OutputChannels
This level is used to view, modify, or clear output channels.
10.23.3.4.1 get
This command is used to view output channels-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SNMP/Logging/OutputChannels> level.
2) Enter:
get↵
10.23.3.4.2 set
This command is used to modify output channels-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SNMP/Logging/OutputChannels> level.
2) Enter:
set <name> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 655
 Variable Field Type Valid Values Description

<name> Choice Stdout, File This parameter specifies the

name of the logging output
channel.

<attribute> MultipleChoice enabled, directory, filePrefix, file The name of an attribute to

SizeInMB, numberOfFiles modify.

<enabled> Choice true, false This parameter turns the logging

to the logging output channel on
and off.

<directory> String 1 to 256 characters This parameter specifies the

directory where the log files are
located.

<filePrefix> String 1 to 256 characters This parameter specifies the

prefix of the log files.

<fileSizeInMB> Integer 1 through 2000 This parameter specifies the

maximum size of a log file.

<numberOf Integer 1 through 65535 This parameter specifies the

Files> maximum number of log files that
exist before the old log files are
deleted.

10.23.4 Reporting
This level is used to view and configure the attributes related to the automated performance measurement
(PM) reporting over the SNMP feature.

10.23.4.1 get
This command is used to view Performance Measurement (PM) reporting-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SNMP/Reporting> level.
2) Enter:
get↵

10.23.4.2 set
This command is used to modify Performance Measurement (PM) reporting attributes.
1) Ensure you are at the /AS_CLI/Interface/SNMP/Reporting> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice active, intervalMin, reset The name of an attribute to

Counters, reportEnterprise, report modify.
ServiceProvider, reportDevice

<active> Choice true, false If true, enables automated PM

reporting.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 656
 Variable Field Type Valid Values Description

<intervalMin> Integer 5 through 45000 PM reporting frequency in

minutes.

<reset Choice true, false If true, automatically resets all

Counters> counters after generating a
report.

<report Choice true, false If true, include Enterprise service

Enterprise> counters in the report.

<reportService Choice true, false If true, include Service Provider

Provider> service counters in the report.

<reportDevice> Choice true, false If true, include device counters in

the report.

10.23.4.3 generateReport
This command is used to generate a Performance Measurement (PM) report and send it to remote File
Transfer Protocol (FTP) servers. This command does not reset counters (even when resetCounters is
enabled).
1) Ensure you are at the /AS_CLI/Interface/SNMP/Reporting> level.
2) Enter:
generateReport↵

10.23.4.4 FTP
The File Transfer Protocol (FTP) level is used to view and modify the target FTP servers for Performance
Measurement (PM) reporting.
10.23.4.4.1 get
Use this command to view File Transfer Protocol (FTP) server-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SNMP/Reporting/FTP> level.
2) Enter:
get↵
10.23.4.4.2 add
Use this command to add a File Transfer Protocol (FTP) server.
1) Ensure you are at the /AS_CLI/Interface/SNMP/Reporting/FTP> level.
2) Enter:
add <hostname> <userid> [<usePassiveMode>]↵
where:
Variable Field Type Valid Values Description

<hostname> String 1 to 80 characters The IP address, host name, or

domain of a target FTP server to
be deleted.

<userid> String 1 to 30 characters User ID to use when logging in to

the target FTP server.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 657
 Variable Field Type Valid Values Description

<usePassive Choice true, false Use FTP passive mode when

Mode> connecting to the remote FTP
server.

10.23.4.4.3 set
Use this command to modify the information associated with the File Transfer Protocol (FTP) server.
1) Ensure you are at the /AS_CLI/Interface/SNMP/Reporting/FTP> level.
2) Enter:
set <hostname> <attribute>↵
where:
Variable Field Type Valid Values Description

<hostname> String 1 to 80 characters The IP address, host name, or

domain of a target FTP server to
be deleted.

<attribute> MultipleChoice usePassiveMode The name of an attribute to

modify.

<usePassive Choice true, false Use FTP passive mode when

Mode> connecting to the remote FTP
server.

10.23.4.4.4 delete
Use this command to delete an existing File Transfer Protocol (FTP) serve.
1) Ensure you are at the /AS_CLI/Interface/SNMP/Reporting/FTP> level.
2) Enter:
delete <hostname>↵
where:
Variable Field Type Valid Values Description

<hostname> String 1 to 80 characters The IP address, host name, or

domain of a target FTP server to
be deleted.

10.23.5 SMAP
This level is used to view, add, modify, and delete Software Management Application Protocol (SMAP)-
related attributes.

10.23.5.1 get
This command is used to view the Software Management Application Protocol (SMAP)-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SNMP/SMAP> level.
2) Enter:
get↵

10.23.5.2 set
This command is used to modify the Software Management Application Protocol (SMAP)-related attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 658
 1) Ensure you are at the /AS_CLI/Interface/SNMP/SMAP> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice timeout The name of an attribute to

modify.

<timeout> Integer 1 through 60 This parameter specifies the

length of time that the agent waits
for a server's response to its
requests (in seconds).

10.23.5.3 BCCT
This level is used to view and modify the Software Management Application Protocol (SMAP) BroadWorks
Common Communication Transport (BCCT)-related attributes.
10.23.5.3.1 get
This command is used to view the Software Management Application Protocol (SMAP) BroadWorks
Common Communication Transport (BCCT)-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SNMP/SMAP/BCCT> level.
2) Enter:
get↵
10.23.5.3.2 set
This command is used to modify the Software Management Application Protocol (SMAP) BroadWorks
Common Communication Transport (BCCT)-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SNMP/SMAP/BCCT> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice port The name of an attribute to

modify.

<port> Integer 1024 through 65535 This parameter specifies the

port number for the Software
Management Application Protocol
(SMAP) BroadWorks Common
Communication Transport
(BCCT) Channel.

10.23.6 TrapTable
This level is used to view and modify entries in the Simple Network Management Protocol (SNMP) trap
table.

10.23.6.1 get
This command is used to view information in the current Simple Network Management Protocol (SNMP)
trap table, such as the IP address of the machine the BroadWorks server is sending traps to and the
corresponding port.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 659
 1) Ensure you are at the /AS_CLI/Interface/SNMP/TrapTable> level.
2) Enter:
get↵

10.23.6.2 add
This command is used to add a node to the Simple Network Management Protocol (SNMP) trap table. To
send traps, the BroadWorks server must be able to identify the node where traps are sent. This is usually a
machine designated as the central point for monitoring. The node's IP address and port are used to identify
the node.
1) Ensure you are at the /AS_CLI/Interface/SNMP/TrapTable> level.
2) Enter:
add <ipAddress> <port> <model> <useAlarms>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters This parameter specifies the

Internet Protocol (IP) address of
the node.

<port> Integer 0 through 65535 This parameter specifies the port

of the node.

<model> Choice shared, unique This parameter determines how

Simple Network Management
Protocol (SNMP) traps are sent.
When the value is set to "shared",
the SNMP Agent wraps every
trap in an envelope with the same
name. The recipient can receive
three different types of envelopes:
a notification, an alarm, or a
software error. The content
of the envelope provides an
explanation of the source of the
problem. When the value is set to
"unique", the SNMP Agent sends
every instance of a notification
in a different envelope. Each
of these uniquely identifies the
problem without having to open
the envelope.

<useAlarms> Choice true, false This parameter determines

if the system sends pairs of
notifications or alarms. This is a
backward-compatibility flag.

10.23.6.3 set
This command is used to modify an entry in the Simple Network Management Protocol (SNMP) trap table.
1) Ensure you are at the /AS_CLI/Interface/SNMP/TrapTable> level.
2) Enter:
set <ipAddress> <port> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 660
 Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters This parameter specifies the

Internet Protocol (IP) address of
the node.

<port> Integer 0 through 65535 This parameter specifies the port

of the node.

<attribute> MultipleChoice model, useAlarms This parameter specifies the

name of an attribute to modify.

<model> Choice shared, unique This parameter determines how

Simple Network Management
Protocol (SNMP) traps are sent.
When the value is set to "shared",
the SNMP Agent wraps every
trap in an envelope with the same
name. The recipient can receive
three different types of envelopes:
a notification, an alarm, or a
software error. The content
of the envelope provides an
explanation of the source of the
problem. When the value is set to
"unique", the SNMP Agent sends
every instance of a notification
in a different envelope. Each
of these uniquely identifies the
problem without having to open
the envelope.

<useAlarms> Choice true, false This parameter determines

if the system sends pairs of
notifications or alarms. This is a
backward-compatibility flag.

10.23.6.4 delete
This command is used to remove a node from the Simple Network Management Protocol (SNMP) trap
table. Nodes removed from the SNMP trap table are no longer sent traps. The node's IP address and port
are used to identify the node.
1) Ensure you are at the /AS_CLI/Interface/SNMP/TrapTable> level.
2) Enter:
delete <ipAddress> <port>↵
where:
Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters This parameter specifies the

Internet Protocol (IP) address of
the node.

<port> Integer 0 through 65535 This parameter specifies the port

of the node.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 661
10.23.7 V3AccessControl
This level is used to view and modify the Simple Network Management Protocol (SNMP) V3 Access
Control level.

10.23.7.1 Groups
This level is used to view and modify Simple Network Management Protocol (SNMP) V3 groups.
10.23.7.1.1 get
This command is used to view Simple Network Management Protocol (SNMP) V3 groups-related
attributes.
1) Ensure you are at the /AS_CLI/Interface/SNMP/V3AccessControl/Groups> level.
2) Enter:
get↵
10.23.7.1.2 add
This command is used to add a Simple Network Management Protocol (SNMP) V3 groups.
1) Ensure you are at the /AS_CLI/Interface/SNMP/V3AccessControl/Groups> level.
2) Enter:
add <name>↵
where:
Variable Field Type Valid Values Description

<name> String 2 to 30 characters This parameter specifies the

name of the group.

10.23.7.1.3 delete
This command is used to delete an existing Simple Network Management Protocol (SNMP) v3 group.
1) Ensure you are at the /AS_CLI/Interface/SNMP/V3AccessControl/Groups> level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> String 2 to 30 characters This parameter specifies the

name of the group.

10.23.7.1.4 AccessLevels
This level is used to view and modify levels of access for the group.
10.23.7.1.4.1 get
This command is used to view Simple Network Management Protocol (SNMP) V3 group access levels.
1) Ensure you are at the /AS_CLI/Interface/SNMP/V3AccessControl/Groups/AccessLevels>
level.
2) Enter:
get <name>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 662
 Variable Field Type Valid Values Description

<name> String 2 to 30 characters This parameter specifies the

name of the group.

10.23.7.1.4.2 add
This command is used to add Simple Network Management Protocol (SNMP) V3 access levels to a group.
1) Ensure you are at the /AS_CLI/Interface/SNMP/V3AccessControl/Groups/AccessLevels>
level.
2) Enter:
add <name> <level>↵
where:
Variable Field Type Valid Values Description

<name> String 2 to 30 characters This parameter specifies the

name of the group.

<level> Choice all, management, performance This parameter specifies a level

of access for the group. When
the value is set to "all", complete
access is provided; when the
value is set to "management",
access to the managed objects
is provided; when the value is set
to "performance", access to the
performance measurements is
provided.

10.23.7.1.4.3 delete
This command is used to remove Simple Network Management Protocol (SNMP) V3 access levels from a
group.
1) Ensure you are at the /AS_CLI/Interface/SNMP/V3AccessControl/Groups/AccessLevels>
level.
2) Enter:
delete <name> <level>↵
where:
Variable Field Type Valid Values Description

<name> String 2 to 30 characters This parameter specifies the

name of the group.

<level> Choice all, management, performance This parameter specifies a level

of access for the group. When
the value is set to "all", complete
access is provided; when the
value is set to "management",
access to the managed objects
is provided; when the value is set
to "performance", access to the
performance measurements is
provided.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 663
10.23.8 V3Users
This level is used to view, add, modify, delete and clear the V3 User level attributes. The V3 User level
provides support for the Simple Network Management Protocol (SNMP) version 3 (SNMPv3). The primary
feature of SNMPv3 is additional security. The only security feature in SNMPv2 is the support of community
strings (that can be viewed as a simple password with no user name). SNMPv3 supports multiple user
name/password pairs, as well as encryption. System administrators are able to configure the version of
SNMP that BroadWorks should support (v2 or v3), as well as parameters specific to each version. Note
that some SNMPv3 features, such as View-based Access Control Model (VACM), are not supported. In
fact, BroadWorks is configured with a single view that gives access to all performance measurements. The
only supported view name is "default".

10.23.8.1 get
This command is used to view Simple Network Management Protocol (SNMP) V3 user-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SNMP/V3Users> level.
2) Enter:
get↵

10.23.8.2 add
This command is used to add a Simple Network Management Protocol (SNMP) V3 user.
1) Ensure you are at the /AS_CLI/Interface/SNMP/V3Users> level.
2) Enter:
add <user> <read> <write> <security> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<user> String 1 to 80 characters This parameter specifies the

SNMP v3 user ID. It is required to
perform SNMP v3 access to the
server.

<read> Choice true, false This parameter determines

whether this user is authorized for
read access.

<write> Choice true, false This parameter determines

whether this user is authorized for
write access.

<security> Choice NoAuthNoPriv, AuthNoPriv, Auth This parameter specifies the

Priv security implemented for this
Simple Network Management
Protocol (SNMP) v3 user.

<attribute> MultipleChoice authenticationKey, privacyKey, Additional attributes to include

group through the add command.

<authentication Password 8 to 40 characters This parameter specifies the user

Key> (prompted) authentication key.

<privacyKey> Password 8 to 40 characters This parameter specifies the

(prompted) privacy key used for encryption.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 664
 Variable Field Type Valid Values Description

<group> String 2 to 30 characters This parameter specifies the user

Simple Network Management
Protocol (SNMP) v3 group name.

10.23.8.3 set
This command is used to modify Simple Network Management Protocol (SNMP) V3 user-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SNMP/V3Users> level.
2) Enter:
set <user> <attribute>↵
where:
Variable Field Type Valid Values Description

<user> String 1 to 80 characters This parameter specifies the

SNMP v3 user ID. It is required to
perform SNMP v3 access to the
server.

<attribute> MultipleChoice read, write, security, The name of an attribute to

authenticationKey, privacyKey, modify.
group

<read> Choice true, false This parameter determines

whether this user is authorized for
read access.

<write> Choice true, false This parameter determines

whether this user is authorized for
write access.

<security> Choice NoAuthNoPriv, AuthNoPriv, Auth This parameter specifies the

Priv security implemented for this
Simple Network Management
Protocol (SNMP) v3 user.

<authentication Password 8 to 40 characters This parameter specifies the user

Key> (prompted) authentication key.

<privacyKey> Password 8 to 40 characters This parameter specifies the

(prompted) privacy key used for encryption.

<group> String 2 to 30 characters This parameter specifies the user

Simple Network Management
Protocol (SNMP) v3 group name.

10.23.8.4 delete
This command is used to delete an existing Simple Network Management Protocol (SNMP) v3 user.
1) Ensure you are at the /AS_CLI/Interface/SNMP/V3Users> level.
2) Enter:
delete <user>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 665
 Variable Field Type Valid Values Description

<user> String 1 to 80 characters This parameter specifies the

SNMP v3 user ID. It is required to
perform SNMP v3 access to the
server.

10.23.8.5 clear
This command is used to clear Simple Network Management Protocol (SNMP) V3 user-related attributes.
1) Ensure you are at the /AS_CLI/Interface/SNMP/V3Users> level.
2) Enter:
clear <user> <attribute>↵
where:
Variable Field Type Valid Values Description

<user> String 1 to 80 characters This parameter specifies the

SNMP v3 user ID. It is required to
perform SNMP v3 access to the
server.

<attribute> MultipleChoice authenticationKey, privacyKey, The name of the attribute to clear.

group

10.24 Sh
This level is used to manage Sh interface-related attributes.

10.24.1 get
This command is used to view Sh Interface-related attributes.
1) Ensure you are at the /AS_CLI/Interface/Sh> level.
2) Enter:
get↵

10.24.2 set
This command is used to modify Sh Interface-related attributes in the system.
1) Ensure you are at the /AS_CLI/Interface/Sh> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice hssRealm, publicIdentityRefresh The name of an attribute to

DelayInSeconds modify.

<publicIdentity Integer 0 through 30 Sets the public identity refresh

RefreshDelayIn delay (in seconds).
Seconds>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 666
 Variable Field Type Valid Values Description

<hssRealm> String 1 to 80 characters Identifies the Home Subscriber

Server (HSS) realm.

10.24.3 clear
This command is used to clear Sh Interface-related attributes.
1) Ensure you are at the /AS_CLI/Interface/Sh> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice hssRealm The name of the attribute(s) to

clear.

10.24.4 NonTransparentData
This level is used to view, modify, delete, clear, and refresh NonTransparentData entries.

10.24.4.1 get
This command is used to view Sh Non-Transparent Data-related attributes.
1) Ensure you are at the /AS_CLI/Interface/Sh/NonTransparentData> level.
2) Enter:
get <publicUserIdentity>↵
where:
Variable Field Type Valid Values Description

<publicUser String 1 to 161 characters The user's public identity.

Identity>

10.24.4.2 set
This command is used to modify Sh Non-Transparent Data-related attributes.
1) Ensure you are at the /AS_CLI/Interface/Sh/NonTransparentData> level.
2) Enter:
set <publicUserIdentity> <attribute>↵
where:
Variable Field Type Valid Values Description

<publicUser String 1 to 161 characters The user public identity.

Identity>

<attribute> MultipleChoice s-CSCFName, imsUserState The name of an attribute to

modify.

<s-CSCF String 1 to 161 characters The serving CallSession Control

Name> Function (CSCF) name.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 667
 Variable Field Type Valid Values Description

<imsUser Choice registered, notRegistered, The user IMS registration state.

State> authenticationPending, registered
UnregServices

10.24.4.3 clear
This command is used to clear Sh Non Transparent Data-related attributes.
1) Ensure you are at the /AS_CLI/Interface/Sh/NonTransparentData> level.
2) Enter:
clear <publicUserIdentity> <attribute>↵
where:
Variable Field Type Valid Values Description

<publicUser String 1 to 161 characters The user public identity.

Identity>

<attribute> MultipleChoice s-CSCFName The name of the attribute(s) to

clear.

10.24.4.4 refresh
This command is used to refresh the Sh Non Transparent Data for a single Public User Identity.
1) Ensure you are at the /AS_CLI/Interface/Sh/NonTransparentData> level.
2) Enter:
refresh <publicUserIdentity>↵
where:
Variable Field Type Valid Values Description

<publicUser String 1 to 161 characters The user public identity.

Identity>

10.24.4.5 SystemRefresh
This level is used to view, add, modify, and delete SystemRefresh entries.
10.24.4.5.1 query
This command is used to query the status of the system refresh task.
1) Ensure you are at the /AS_CLI/Interface/Sh/NonTransparentData/SystemRefresh> level.
2) Enter:
query↵
10.24.4.5.2 start
This command starts the system refresh task which refreshes all public identities for all users.
1) Ensure you are at the /AS_CLI/Interface/Sh/NonTransparentData/SystemRefresh> level.
2) Enter:
start↵
10.24.4.5.3 terminate
This command terminates the system refresh task.
1) Ensure you are at the /AS_CLI/Interface/Sh/NonTransparentData/SystemRefresh> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 668
 2) Enter:
terminate↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 669
11 SubscriberMgmt

This level is used to manage all user types including system, service provider, group, and user.

11.1 Administrator
This level is used to configure access and security issues for administrative users, including system
providers and provisioning administrators.

11.1.1 get
Administrator-related attributes, such as the administrator user ID and corresponding name and access
level, are viewed using this command. A user ID can be in the form of an e-mail address.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Administrator> level.
2) Enter:
get [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice userId, lastName, firstName, The name of an attribute to filter

type, readOnly, language on.

<userId> String 2 to 80 characters The user ID for the administrator.

<lastName> String 1 to 30 characters The user's last name.

<firstName> String 1 to 30 characters The user's first name.

<type> Choice system, prov when set to "system", allows

for complete access to the
Application Server CLI and its
functions. When set to "prov",
allows only limited access to
the Application Server CLI,
specifically functions in the
network level only.

<readOnly> Choice true, false Cannot configure the system.

<language> String 1 to 40 characters Indicates the language for the

administrator.

11.1.2 add
When adding a new administrator to the system, you set the administrator user ID, access level, first and
last names, and password.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Administrator> level.
2) Enter:
add <userId> <type> <readOnly> [<attribute>]↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 670
 Variable Field Type Valid Values Description

<userId> String 2 to 80 characters The user ID for the administrator.

<type> Choice system, prov when set to "system", allows

for complete access to the
Application Server CLI and its
functions. When set to "prov",
allows only limited access to
the Application Server CLI,
specifically functions in the
network level only.

<readOnly> Choice true, false Cannot configure the system.

<attribute> MultipleChoice lastName, firstName, language Additional attributes to include

through the add command.

<lastName> String 1 to 30 characters The user's last name.

<firstName> String 1 to 30 characters The user's first name.

<language> String 1 to 40 characters Indicates the language to be used

for the administrator.

11.1.3 set
Administrator-related attributes, such as the administrator user ID, first and last names, password, and
access level are changed using this command.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Administrator> level.
2) Enter:
set <userId> <attribute>↵
where:
Variable Field Type Valid Values Description

<userId> String 2 to 80 characters The user ID for the administrator.

<attribute> MultipleChoice lastName, firstName, password, The name of an attribute to

language modify.

<lastName> String 1 to 30 characters The user's last name.

<firstName> String 1 to 30 characters The user's first name.

<language> String 1 to 40 characters Indicates the language to be used

for the administrator.

11.1.4 delete
Administrators can be deleted from the system. The user ID for the administrator is used to identify the
record.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Administrator> level.
2) Enter:
delete <userId>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 671
 where:
Variable Field Type Valid Values Description

<userId> String 2 to 80 characters The user ID for the administrator.

11.1.5 clear
Group administrator-related attributes, such as the group administrator's user ID, and first and last names,
are changed using this command.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Administrator> level.
2) Enter:
clear <userId> <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<userId> String 2 to 80 characters The system administrator user ID.

<clearAttribute> MultipleChoice lastName, firstName The name of the attribute(s) to

clear.

11.2 AnnouncementRepository
This level is used to view and modify the settings for the announcement repository.

11.2.1 get
This command is used to view the settings of the announcement repository.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AnnouncementRepository> level.
2) Enter:
get↵

11.2.2 set
This command is used to modify the settings of the announcement repository.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AnnouncementRepository> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice groupAnnouncementTotal The name of an attribute to

FileMaxSizeMegabytes, user modify.
AnnouncementTotalFileMax
SizeMegabytes, autoAttendant
AnnouncementTotalFileMax
SizeMegabytes, callCenter
AnnouncementTotalFileMaxSize
Megabytes

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 672
 Variable Field Type Valid Values Description

<group Integer 1 through 999999 This parameter specifies the size

Announcement of the announcement repository
TotalFile for a group.
MaxSize
Megabytes>

<user Integer 1 through 999999 This parameter specifies the size

Announcement of the announcement repository
TotalFile for an user.
MaxSize
Megabytes>

<autoAttendant Integer 1 through 999999 This parameter specifies the size

Announcement of the announcement repository
TotalFile for an Auto Attendant instance.
MaxSize
Megabytes>

<callCenter Integer 1 through 999999 This parameter specifies the size

Announcement of the announcement repository
TotalFile for a Call Center or Route Point
MaxSize instance.
Megabytes>

11.3 AppServerSet
This level allows for the adding, modifying, or removal of group and service provider Application Server
Set.

11.3.1 Group
This level is used to view, modify, and clear group Application Server Set.

11.3.1.1 get
This command is used to view group Application Server Set-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AppServerSet/Group> level.
2) Enter:
get <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The name of the service provider.

Id>

<groupId> String 1 to 30 characters The name of the group.

11.3.1.2 set
This command is used to modify group Application Server Set-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AppServerSet/Group> level.
2) Enter:
set <svcProviderId> <groupId> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 673
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The name of the service provider.

Id>

<groupId> String 1 to 30 characters The name of the group.

<attribute> MultipleChoice applicationServerSetName The name of an attribute to

modify.

<application String 1 to 80 characters The name of the Application

ServerSet Server Set.
Name>

11.3.1.3 clear
This command is used to clear group Application Server Set-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AppServerSet/Group> level.
2) Enter:
clear <svcProviderId> <groupId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The name of the service provider.

Id>

<groupId> String 1 to 30 characters The name of the group.

<attribute> MultipleChoice applicationServerSetName The name of an attribute to

modify.

11.3.2 ServiceProvider
This level is used to view, modify, and clear service provider Application Server Set.

11.3.2.1 get
This command is used to view service provider Application Server Set-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AppServerSet/ServiceProvider> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The name of the service provider.

Id>

11.3.2.2 set
This command is used to modify service provider Application Server Set-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AppServerSet/ServiceProvider> level.
2) Enter:
set <svcProviderId> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 674
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The name of the service provider.

Id>

<attribute> MultipleChoice applicationServerSetName The name of an attribute to

modify.

<application String 1 to 80 characters The name of the Application

ServerSet Server Set.
Name>

11.3.2.3 clear
This command is used to clear service provider Application Server Set-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AppServerSet/ServiceProvider> level.
2) Enter:
clear <svcProviderId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The name of the service provider.

Id>

<attribute> MultipleChoice applicationServerSetName The name of an attribute to

modify.

11.4 AuthenticationLockout
This level is used to view and modify authentication lockouts.

11.4.1 get
This command is used to modify authentication lockout-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AuthenticationLockout> level.
2) Enter:
get↵

11.4.2 set
This command is used to modify authentication lockout-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AuthenticationLockout> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice counterResetIntervalDays, The name of the attribute to

counterResetHour, counterReset modify.
Minute, emergencySIPBypass
Allowed

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 675
 Variable Field Type Valid Values Description

<counterReset Integer 1 through 10 The number of days to wait to

IntervalDays> clear lockouts.

<counterReset Integer 0 through 23 The time of day (hour) that

Hour> all authentication lockouts
are automatically cleared (for
example, "2" indicates 2:00
A.M. and "15" indicates 3:00
P.M.). The value combines
with''counterResetIntervalMinute''to
form the exact time. (for example,
2:15).

<counterReset Integer 0 through 59 The time of day (minutes) that

Minute> all authentication lockouts
are automatically cleared.
(for example, "15" indicates
15 minutes after the hour).
The value combines with
''counterResetIntervalHour' 'to
form the exact time. (for example,
2:15).

<emergencySIP Choice true, false When set to "true", emergency

Bypass calls are allowed when locked
Allowed> out.

11.4.3 dump
This command is used to create a comma separated file (''.csv'') containing all locked out device profiles,
Session Initiation Protocol (SIP) endpoints, and SIP trunk groups.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AuthenticationLockout> level.
2) Enter:
dump <fileName>↵
where:
Variable Field Type Valid Values Description

<fileName> String 1 to 300 characters The name of the dump file. The
''.csv'' file extension is added
to the filename automatically.
If no path is supplied with the
filename, the file is created in the
application directory.

11.4.4 DeviceProfile
This level is used to view and modify the device profile authentication lockouts.

11.4.4.1 get
This command is used display the locked out device profiles. If the command is used with a specified
variable, only records matching that criterion are displayed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AuthenticationLockout/DeviceProfile>
level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 676
 get <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice deviceNameStarts, deviceName The name of the attribute to view.

Contains, deviceNameEqualTo,
deviceTypeEqualTo, groupId
Starts, groupIdContains, groupId
EqualTo, organizationIdEqualTo,
organizationTypeEqualTo

<deviceName String 0 to 40 characters Displays only devices whose

Starts> names start with the specified
string.

<deviceName String 0 to 40 characters Displays only devices whose

Contains> names contain the specified
string.

<deviceName String 1 to 40 characters Displays only devices whose

EqualTo> names match the specified string.

<deviceType String 1 to 40 characters Displays only devices whose

EqualTo> types match the specified string.

<groupId String 0 to 30 characters Displays only users whose group

Starts> ID starts with the specified string.

<groupId String 0 to 30 characters Displays only users whose group

Contains> ID contains the specified string.

<groupIdEqual String 1 to 30 characters Displays only users whose group

To> ID matches the specified string.

<organizationId String 1 to 30 characters Displays only devices in

EqualTo> organizations whose names
match the specified string.

<organization Choice enterprise, serviceProvider Displays only devices in

TypeEqualTo> organization types whose names
match the specified string.

11.4.4.2 clear
This command is used to clear locked out device profiles.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AuthenticationLockout/DeviceProfile>
level.
2) Enter:
clear <level> <deviceProfileName>↵
where:
Variable Field Type Valid Values Description

<level> Choice group, serviceProvider, system The device profile level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 677
 Variable Field Type Valid Values Description

Variable: group

group Group device profile level.

<svcProvider String 1 to 30 characters The service provider id.

Id>

<groupId> String 1 to 30 characters The group id.

Variable: serviceProvider

serviceProvider Service Provider device profile

level.

<svcProvider String 1 to 30 characters The service provider id.

Id>

<system> System device profile level.

<deviceProfile String 1 to 40 characters The device profile name.

Name>

11.4.4.3 clearAll
This command is used clear the locked out device profiles.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AuthenticationLockout/DeviceProfile>
level.
2) Enter:
clearAll↵

11.4.5 SIP
This level is used to manage the Session Initiation Protocol (SIP) endpoint authentication lockouts.

11.4.5.1 clearAll
This command is used clear all locked out SIP endpoints and trunk groups.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AuthenticationLockout/SIP> level.
2) Enter:
clearAll↵

11.4.5.2 Endpoint
This level is used to manage the Session Initiation Protocol (SIP) endpoint authentication lockouts.
11.4.5.2.1 get
This command is used display locked out Session Initiation Protocol (SIP) endpoints. If the command is
used with a specified variable, only records matching that criterion are displayed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AuthenticationLockout/SIP/Endpoint>
level.
2) Enter:
get <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 678
 Variable Field Type Valid Values Description

<attribute> MultipleChoice linePortUserPartStarts, linePort The name of the attribute to view.

UserPartContains, linePortUser
PartEqualTo, linePortDomain
Starts, linePortDomainContains,
linePortDomainEqualTo, userId
Starts, userIdContains, userId
EqualTo, lastNameStarts, last
NameContains, lastNameEqual
To, firstNameStarts, firstName
Contains, firstNameEqualTo,
groupIdStarts, groupIdContains,
groupIdEqualTo, organizationId
EqualTo, organizationTypeEqual
To

<linePortUser String 0 to 80 characters Displays only users whose line

PartStarts> port starts with the specified
string.

<linePortUser String 0 to 80 characters Displays only users whose line

PartContains> port contains the specified string.

<linePortUser String 1 to 80 characters Displays only users whose line

PartEqualTo> port matches the specified string.

<linePort String 0 to 80 characters Displays only users whose

DomainStarts> line port domain starts with the
specified string.

<linePort String 0 to 80 characters Displays only users whose

Domain line port domain contains the
Contains> specified string.

<linePort String 1 to 80 characters Displays only users whose

DomainEqual line port domain matches the
To> specified string.

<userIdStarts> String 0 to 161 characters Displays only users whose user

ID starts with the specified string.

<userId String 0 to 161 characters Displays only users whose user

Contains> ID contains the specified string.

<userIdEqual String 1 to 161 characters Displays only users whose user

To> ID matches the specified string.

<lastName String 0 to 30 characters Displays only users whose last

Starts> name starts with the specified
string.

<lastName String 0 to 30 characters Displays only users whose last

Contains> name contains the specified
string.

<lastName String 1 to 30 characters Displays only users whose last

EqualTo> name matches the specified
string.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 679
 Variable Field Type Valid Values Description

<firstName String 0 to 30 characters Displays only users whose first

Starts> name starts with the specified
string.

<firstName String 0 to 30 characters Displays only users whose first

Contains> name contains the specified
string.

<firstName String 1 to 30 characters Displays only users whose first

EqualTo> name matches the specified
string.

<groupId String 0 to 30 characters Displays only users whose group

Starts> ID starts with the specified string.

<groupId String 0 to 30 characters Displays only users whose group

Contains> ID contains the specified string.

<groupIdEqual String 1 to 30 characters Displays only users whose group

To> ID matches the specified string.

<organizationId String 1 to 30 characters Displays only devices in

EqualTo> organizations whose names
match the specified string.

<organization Choice enterprise, serviceProvider Displays only devices in

TypeEqualTo> organization types whose names
match the specified string.

11.4.5.2.2 clear
This command is used clear the locked out Session Initiation Protocol (SIP) endpoints.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AuthenticationLockout/SIP/Endpoint>
level.
2) Enter:
clear <userId> <linePort>↵
where:
Variable Field Type Valid Values Description

<userId> String 1 to 30 characters The user Id.

<linePort> String 1 to 161 characters The line/port of the endpoint.

11.4.5.3 TrunkGroup
This level is used to manage Session Initiation Protocol (SIP) Trunk Group authentication lockouts.
11.4.5.3.1 get
This command is used to display locked out Session Initiation Protocol (SIP) Trunk Groups. If the
command is used with a specified variable, only records matching that criterion are displayed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AuthenticationLockout/SIP/
TrunkGroup> level.
2) Enter:
get <attribute>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 680
 where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice trunkGroupNameStarts, trunk The name of the attribute to view.

GroupNameContains, trunk
GroupNameEqualTo, groupId
Starts, groupIdContains, groupId
EqualTo, organizationIdEqualTo,
organizationTypeEqualTo

<trunkGroup String 0 to 161 characters Displays only trunk groups whose

NameStarts> names start with the specified
string.

<trunk String 0 to 161 characters Displays only trunk groups whose

GroupName names contain the specified
Contains> string.

<trunkGroup String 1 to 161 characters Displays only trunk groups whose

NameEqualTo> names contain the specified
string.

<groupId String 0 to 30 characters Displays only users whose group

Starts> ID starts with the specified string.

<groupId String 0 to 30 characters Displays only users whose group

Contains> ID contains the specified string.

<groupIdEqual String 1 to 30 characters Displays only users whose group

To> ID matches the specified string.

<organizationId String 1 to 30 characters Displays only devices in

EqualTo> organizations whose names
match the specified string.

<organization Choice enterprise, serviceProvider Displays only devices in

TypeEqualTo> organization types whose names
match the specified string.

11.4.5.3.2 clear
This command is used to clear the locked out Trunk Groups.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AuthenticationLockout/SIP/
TrunkGroup> level.
2) Enter:
clear <groupId> <svcProviderId> <trunkGroupName>↵
where:
Variable Field Type Valid Values Description

<groupId> String 1 to 30 characters The group Id.

<svcProvider String 1 to 30 characters The service provider Id.

Id>

<trunkGroup String 1 to 40 characters The trunk group name.

Name>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 681
11.5 AuthenticationPasswordRules
This level is used to manage authentication password rules.

11.5.1 DeviceProfile
This level is used to manage device profile authentication password rules.

11.5.1.1 get
This command is used to view the device profile authentication password-related attributes for system
administrators, such as the allowable login failures, minimum password length, whether the authentication
name can be used as a password, and whether passwords can contain numbers or symbols, and so on.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AuthenticationPasswordRules/
DeviceProfile> level.
2) Enter:
get↵

11.5.1.2 set
This command is used to modify the device profile authentication password-related attributes for system
administrators, such as the allowable authentication failures, minimum password length, whether the user
name can also be the password, and whether passwords can contain numbers or symbols, and so on.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AuthenticationPasswordRules/
DeviceProfile> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice containNonAlphaNumChars, The name of the attribute to

containNonAlphaNum, contain modify.
LowerAlphaChars, contain
LowerAlpha, containUpperAlpha
Chars, containUpperAlpha,
containNumberChars, contain
Number, notReverseOfOld
Password, notOldPassword, not
AuthenticationName, minimum
Length, sendPermanentLockout
Notification, permanentLockout
NotifyEmailAddress, deviceProfile
AuthenticationLockoutType,
deviceProfileTemporaryLockout
Threshold, deviceProfileWait
Algorithm, deviceProfileLockout
FixedMinutes, deviceProfile
PermanentLockoutThreshold

<containNon Integer 1 through 10 The number of non-alphanumeric

AlphaNum characters that must be present
Chars> in the password.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 682
 Variable Field Type Valid Values Description

<containNon Choice true, false When set to "false", the password

AlphaNum> does not have to contain non-
alphanumeric characters. When
set to "true", the password
must contain non-alphanumeric
characters.

<containLower Integer 1 through 10 The number of lower case

AlphaChars> alphabetic characters the
password must contain.

<containLower Choice true, false When set to "false", the password

Alpha> does not have to contain lower-
case alphabetic characters. When
set to "true", the password must
contain lower-case alphabetic
characters.

<containUpper Integer 1 through 10 The number of upper-case

AlphaChars> alphabetic characters the
password must contain.

<containUpper Choice true, false When set to "false", the password

Alpha> does not have to contain upper-
case alphabetic characters. When
set to "true", the password must
contain upper-case alphabetic
characters.

<contain Integer 1 through 10 The number of numeric

NumberChars> characters the password must
contain.

<contain Choice true, false When set to "false", the password

Number> does not have to contain numeric
characters. When set to "true",
the password must contain
numeric characters.

<not Choice true, false When set to "false", the password

Authentication can be the same as the
Name> authentication name. When set
to "true", the password must be
different from the authentication
name.

<notOld Choice true, false When set to "false", the password

Password> is allowed to be the previous
password. When set to "true", the
password cannot be the previous
password.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 683
 Variable Field Type Valid Values Description

<notReverseOf Choice true, false When set to "false", the password

OldPassword> is allowed to be the reverse
characters of the previous
password. When set to "true", the
password cannot be the reverse
characters of the previous
password.

<minimum Integer 3 through 40 The minimum length allowed for

Length> passwords.

<send Choice true, false When set to "false", do not

Permanent send notice of a permanent
Lockout authentication lockout. When
Notification> set to "true", send notice that a
permanent authentication lockout
has occurred.

<permanent String 1 to 80 characters E-mail address to which

LockoutNotify notification is sent when a
EmailAddress> permanent authentication lockout
occurs.

<deviceProfile Choice never, temporary, permanent The method of authentication

Authentication disabling to use. When set to
LockoutType> never, authentication is not
disabled. When set to temporary,
only temporary lockouts are
used. When set to permanent,
both temporary and permanent
lockouts are used.

<deviceProfile Integer 1 through 10 The number of authentication

Temporary failures allowed before temporary
Lockout lockout occurs.
Threshold>

<deviceProfile Choice double, fixed The method of timeout to

WaitAlgorithm> use for lockouts. When
set to Fixed, the lockout
duration is specified by the
deviceProfileLockoutFixedMinutes
setting. When set to Double,
the lockout timeout starts at 5
minutes and doubles with each
successive invalid authentication.

<deviceProfile Choice 5, 10, 20, 40, 60 When authentication is

LockoutFixed temporarily locked out, the
Minutes> time in minutes to wait after
each additional authentication
attempt. Applies only when
deviceProfileWaitAlgorithm is set
to Fixed.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 684
 Variable Field Type Valid Values Description

<deviceProfile Integer 2 through 10 When authentication is

Permanent temporarily locked out, the
Lockout number of additional temporary
Threshold> lockouts to allow before
permanent lockout.

11.5.1.3 clear
This command is used to clear (set to no value) the device profile authentication password-related
attributes for system administrators, such as the e-mail address to notify when the number of failed
authentication attempts is exceeded.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AuthenticationPasswordRules/
DeviceProfile> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice permanentLockoutNotifyEmail The name of the attribute(s) to

Address clear.

11.5.2 SIP
This level is used to manage the Session Initiation Protocol (SIP) authentication password rules.

11.5.2.1 get
This command is used to view the Session Initiation Protocol (SIP) authentication password rules-related
attributes for system administrators, such as the allowable login failures, minimum password length,
whether the authentication name can be used as a password, and whether passwords can contain
numbers or symbols, and so on.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AuthenticationPasswordRules/SIP> level.
2) Enter:
get↵

11.5.2.2 set
This command is used to modify the Session Initiation Protocol (SIP) authentication password rules-related
attributes for system administrators, such as the allowable authentication failures, minimum password
length, whether the authentication name can also be the password, and whether passwords can contain
numbers or symbols, and so on.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AuthenticationPasswordRules/SIP> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 685
 Variable Field Type Valid Values Description

<attribute> MultipleChoice containNonAlphaNumChars, The name of the attribute to

containNonAlphaNum, contain modify.
LowerAlphaChars, containLower
Alpha, containUpperAlphaChars,
containUpperAlpha, contain
NumberChars, containNumber,
notReverseOfOldPassword, not
OldPassword, notAuthentication
Name, minimumLength, send
PermanentLockoutNotification,
permanentLockoutNotifyEmail
Address, endpointAuthentication
LockoutType, endpointTemporary
LockoutThreshold, endpointWait
Algorithm, endpointLockoutFixed
Minutes, endpointPermanent
LockoutThreshold, trunkGroup
AuthenticationLockoutType,
trunkGroupTemporaryLockout
Threshold, trunkGroupWait
Algorithm, trunkGroupLockout
FixedMinutes, trunkGroup
PermanentLockoutThreshold

<containNon Integer 1 through 10 The number of non-alphanumeric

AlphaNum characters that must be present
Chars> in the password.

<containNon Choice true, false When set to "false", the password

AlphaNum> does not have to contain non-
alphanumeric characters. When
set to "true", the password
must contain non-alphanumeric
characters.

<containLower Integer 1 through 10 The number of lower case

AlphaChars> alphabetic characters the
password must contain.

<containLower Choice true, false When set to "false", the password

Alpha> does not have to contain lower-
case alphabetic characters. When
set to "true", the password must
contain lower-case alphabetic
characters.

<containUpper Integer 1 through 10 The number of upper-case

AlphaChars> alphabetic characters the
password must contain.

<containUpper Choice true, false When set to "false", the password

Alpha> does not have to contain upper-
case alphabetic characters. When
set to "true", the password must
contain upper-case alphabetic
characters.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 686
 Variable Field Type Valid Values Description

<contain Integer 1 through 10 The number of numeric

NumberChars> characters the password must
contain.

<contain Choice true, false When set to "false", the password

Number> does not have to contain numeric
characters. When set to "true",
the password must contain
numeric characters.

<not Choice true, false When set to "false", the password

Authentication can be the same as the
Name> authentication name. When set
to "true", the password must be
different from the authentication
name.

<notOld Choice true, false When set to "false", the password

Password> is allowed to be the previous
password. When set to "true", the
password cannot be the previous
password.

<notReverseOf Choice true, false When set to "false", the password

OldPassword> is allowed to be the reverse
characters of the previous
password. When set to "true", the
password cannot be the reverse
characters of the previous
password.

<minimum Integer 3 through 40 The minimum length allowed for

Length> passwords.

<send Choice true, false When set to "false", do not

Permanent send notice of a permanent
Lockout authentication lockout. When
Notification> set to "true", send notice that a
permanent authentication lockout
has occurred.

<permanent String 1 to 80 characters E-mail address to which

LockoutNotify notification is sent when a
EmailAddress> permanent authentication lockout
occurs.

<endpoint Choice never, temporary, permanent The method of authentication

Authentication disabling to use. When set to
LockoutType> never, authentication is not
disabled. When set to temporary,
only temporary lockouts are
used. When set to permanent,
both temporary and permanent
lockouts are used.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 687
 Variable Field Type Valid Values Description

<endpoint Integer 1 through 10 The number of authentication

Temporary failures allowed before temporary
Lockout lockout occurs.
Threshold>

<endpointWait Choice double, fixed The method of timeout to use for

Algorithm> lockouts. When set to Fixed, the
lockout duration is specified by
the endpointLockoutFixedMinutes
setting. When set to Double,
the lockout timeout starts at 5
minutes and doubles with each
successive invalid authentication.

<endpoint Choice 5, 10, 20, 40, 60 When authentication is

LockoutFixed temporarily locked out, the
Minutes> time in minutes to wait after
each additional authentication
attempt. Applies only when
endpointWaitAlgorithm is set to
Fixed.

<endpoint Integer 2 through 10 When authentication is

Permanent temporarily locked out, the
Lockout number of additional temporary
Threshold> lockouts to allow before
permanent lockout.

<trunkGroup Choice never, temporary, permanent The method of authentication

Authentication disabling to use. When set to
LockoutType> never, authentication is not
disabled. When set to temporary,
only temporary lockouts are
used. When set to permanent,
both temporary and permanent
lockouts are used.

<trunkGroup Integer 1 through 10 The number of authentication

Temporary failures allowed before temporary
Lockout lockout occurs.
Threshold>

<trunkGroup Choice double, fixed The method of timeout to

WaitAlgorithm> use for lockouts. When
set to Fixed, the lockout
duration is specified by the
trunkGroupLockoutFixedMinutes
setting. When set to Double,
the lockout timeout starts at 5
minutes and doubles with each
successive invalid authentication.

<trunkGroup Choice 5, 10, 20, 40, 60 When authentication is

LockoutFixed temporarily locked out, the
Minutes> time in minutes to wait after
each additional authentication
attempt. Applies only when
trunkGroupWaitAlgorithm is set to
Fixed.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 688
 Variable Field Type Valid Values Description

<trunkGroup Integer 2 through 10 When authentication is

Permanent temporarily locked out, the
Lockout number of additional temporary
Threshold> lockouts to allow before
permanent lockout.

11.5.2.3 clear
This command is used to clear (set to no value) Session Initiation Protocol (SIP) authentication password
rules-related attributes for system administrators, such as the e-mail address to notify when the number of
failed authentication attempts is exceeded.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/AuthenticationPasswordRules/SIP> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice permanentLockoutNotifyEmail The name of the attribute(s) to

Address clear.

11.6 ClientApplicationLaunchProfiles
This level is used to view and modify the Client Application Launch Profiles at the system level.

11.6.1 get
This command is used to view Client Application Launch Profile-related attributes at the system level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ClientApplicationLaunchProfiles> level.
2) Enter:
get↵

11.6.2 set
This command is used to modify Client Application Launch Profile-related attributes at the system level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ClientApplicationLaunchProfiles> level.
2) Enter:
set <clientApplication> <attribute>↵
where:
Variable Field Type Valid Values Description

<client Choice callcenter, receptionist The Client Application.

Application>

<attribute> MultipleChoice enabled, useVersion The attribute to modify.

<enabled> Choice true, false Whether the client application is

enabled.

<useVersion> Choice current, custom The version to launch for the

given application.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 689
 Variable Field Type Valid Values Description

<current> The version matching the current

BroadWorks release.

Variable: custom

custom A custom version.

<version> String 1 to 20 characters When a custom version is used,

the string representing that
version.

11.7 Device
This level allows for the adding, modifying, or removal of system access devices.

11.7.1 get
This command is used to view System Access Device-related attributes. At least one of the parameters
defined in the multiple choice attribute needs to be specified to search all access devices in the group.
Device's name, type, IP address, and MAC address can be used as search criteria. If the search produces
over 1,000 entries, an error message will be displayed and user should refine the search criteria to narrow
the search.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Device> level.
2) Enter:
get <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice deviceNameStarts, deviceName The name of an attribute to filter

Contains, deviceNameEqualTo, on.
deviceTypeEqualTo, ipAddress
Starts, ipAddressContains, ip
AddressEqualTo, macAddress
Starts, macAddressContains,
macAddressEqualTo

<deviceName String 0 to 40 characters Displays only devices whose

Starts> names start with the specified
string.

<deviceName String 0 to 40 characters Displays only devices whose

Contains> names contain the specified
string.

<deviceName String 1 to 40 characters Displays only devices whose

EqualTo> names match the specified string.

<deviceType String 1 to 40 characters Displays only devices whose

EqualTo> types match the specified string.

<ipAddress String 0 to 80 characters Displays only devices whose IP

Starts> addresses start with the specified
string.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 690
 Variable Field Type Valid Values Description

<ipAddress String 0 to 80 characters Displays only devices whose IP

Contains> addresses contain the specified
string.

<ipAddress String 1 to 80 characters Displays only devices whose IP

EqualTo> addresses match the specified
string.

<macAddress String 0 to 12 characters Displays only devices whose mac

Starts> addresses start with the specified
string.

<macAddress String 0 to 12 characters Displays only devices whose mac

Contains> addresses contain the specified
string.

<macAddress String 12 to 12 characters Displays only devices whose

EqualTo> names match the specified string.

11.7.2 detail
This command is used to view System Access Device detail attributes, such as IP address, port, mac
address, and so on.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Device> level.
2) Enter:
detail <deviceName>↵
where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device for which

you want to view details.

11.7.3 add
This command allows you to add a new System Access device to the system.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Device> level.
2) Enter:
add <deviceName> <deviceType> [<attribute>] <true> <true>↵
where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device.

<deviceType> String 1 to 40 characters The device type.

<attribute> MultipleChoice ipAddress, port, protocol, Additional attributes to include

transportType, macAddress, through the add command.
serialNumber, description,
outboundProxyServer, stun
Server, physicalLocation, isMM
Device, useCustomUserName
Password

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 691
 Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The corresponding IP address,

host name, or domain for the
device.

<port> Integer 1025 through 65535 The port of the device.

<protocol> String 1 to 41 characters Protocol configured for this device

to use.

<transport Choice udp, tcp, unspecified The type of transport protocol to

Type> use when communicating with the
device.

<macAddress> MAC Address 12 characters The MAC address of the device.

<serial String 1 to 80 characters The serial number of the device.

Number>

<description> String 1 to 80 characters Description of the device.

<outbound String 1 to 80 characters Allows the group administrator to

ProxyServer> set IP address for the Outbound
Proxy Server.

<stunServer> String 1 to 80 characters Allows the group administrator to

set an IP address for the STUN
Server.

<physical String 1 to 1024 characters Specifies the physical location of

Location> the originating device.

<isMMDevice> Choice true, false Specifies that this is or is not a

Mobility Manager device.

<true>

<useCustom Choice true, false Specifies that a custom password

UserName is or is not used for the user.
Password>

<true>

11.7.4 set
This command is used to modify System Access Device-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Device> level.
2) Enter:
set <deviceName> <attribute>↵
where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 692
 Variable Field Type Valid Values Description

<attribute> MultipleChoice ipAddress, port, protocol, The name of an attribute to

transportType, macAddress, modify.
serialNumber, description,
outboundProxyServer, stun
Server, physicalLocation, mobility
ManagerProvisioningURL,
mobilityManagerProvisioning
UserName, mobilityManager
ProvisioningPassword, mobility
ManagerDefaultOriginating
ServiceKey, mobilityManager
DefaultTerminatingServiceKey,
useCustomUserNamePassword,
userName

<ipAddress> String 1 to 80 characters The corresponding IP address,

host name, or domain for the
device.

<port> Integer 1025 through 65535 The port of the device.

<protocol> String 1 to 41 characters Protocol configured for this device

to use.

<transport Choice udp, tcp, unspecified The type of transport to be used

Type> for the device.

<macAddress> MAC Address 12 characters MAC address of the device.

<serial String 1 to 80 characters Serial number of the device.

Number>

<description> String 1 to 80 characters Description of the device.

<outbound String 1 to 80 characters Allows the group administrator to

ProxyServer> set IP address for the Outbound
Proxy Server.

<stunServer> String 1 to 80 characters Allows the group administrator

to set IP address for the STUN
Server.

<physical String 1 to 1024 characters Specifies the physical location of

Location> the originating device.

<mobility String 1 to 256 characters The Mobility Manager device

Manager provisioning UTL.
ProvisioningURL>

<mobility String 1 to 15 characters The Mobility Manager

Manager provisioning user name.
Provisioning
UserName>

<mobility Integer 0 through 999 The Mobility Manager default

Manager originating service key.
Default
Originating
ServiceKey>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 693
 Variable Field Type Valid Values Description

<mobility Integer 0 through 999 The Mobility Manager default

Manager terminating service key.
Default
Terminating
ServiceKey>

<useCustom Choice true, false Specifies that a custom password

UserName is or is not used for the user.
Password>

<userName> String 1 to 161 characters The name of the user for whom a
custom password is required.

11.7.5 delete
This command is used to delete an existing system access device from the system.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Device> level.
2) Enter:
delete <deviceName>↵
where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device.

11.7.6 clear
This command is used to clear System Access Device-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Device> level.
2) Enter:
clear <deviceName> <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device.

<clearAttribute> MultipleChoice ipAddress, port, macAddress, The name of the attribute(s) to

serialNumber, description, clear.
outboundProxyServer, stun
Server, physicalLocation, mobility
ManagerDefaultOriginating
ServiceKey, mobilityManager
DefaultTerminatingServiceKey,
userName

11.7.7 lineOrder
Line order is used when an IP Phone is sharing lines and you want to change the order of lines by moving
a subscriber's line up or down.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Device> level.
2) Enter:
lineOrder <deviceName> <linePort> <action> [<attribute>]↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 694
 where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters Device name.

<linePort> String 0 to 161 characters Line port to line is moved.

<action> Choice up, down Direction to move the line.

<attribute> MultipleChoice rebuildFileNow The name of an attribute to filter

on.

<rebuildFile Choice true, false Indicates if the device

Now> configuration file should be built.
This gives you control of when
the file is built. If you do not set
this attribute to true, the file is not
built. This is to prevent the file
from being built and transmitted
every time a line/port is moved.
If you moved a line/port up five
spaces, the file would be built five
times. The default is false.

11.7.8 rebuildDefaultFile
This command is used to rebuild each file of the device using the subscribers profile parameter.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Device> level.
2) Enter:
rebuildDefaultFile <deviceName>↵
where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device.

<force> Choice force When specified, the templates

are uploaded to the repository
even if the content hasn't
changed since the last rebuilt was
performed.

11.7.9 CustomTags
This level is used to view, add, modify, and delete CustomTags entries.

11.7.9.1 get
This command is used to view Custom Tag-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Device/CustomTags> level.
2) Enter:
get <deviceName>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 695
 Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device.

11.7.9.2 add
This command is used to add a new Custom Tag.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Device/CustomTags> level.
2) Enter:
add <deviceName> <tagName> [<tagValue>]↵
where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device name to

be added.

<tagName> String 1 to 64 characters The tag name.

<tagValue> String 1 to 256 characters The tag value.

11.7.9.3 set
This command is used to modify Custom Tag-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Device/CustomTags> level.
2) Enter:
set <deviceName> <tagName> <attribute>↵
where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device.

<tagName> String 1 to 64 characters The tag name.

<attribute> MultipleChoice tagValue The name of an attribute to

modify.

<tagValue> String 1 to 256 characters The tag value.

11.7.9.4 delete
This command is used to delete an existing Custom Tag from the system.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Device/CustomTags> level.
2) Enter:
delete <deviceName> <tagName>↵
where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device.

<tagName> String 1 to 64 characters The tag name.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 696
11.7.9.5 clear
This command is used to clear Custom Tag-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Device/CustomTags> level.
2) Enter:
clear <deviceName> <tagName> <attribute>↵
where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device.

<tagName> String 1 to 64 characters The tag name.

<attribute> MultipleChoice tagValue The name of the attribute(s) to

clear.

11.7.10 Files
This level is used to view, add, modify, and delete Files entries.

11.7.10.1 get
This command is used to view Device Profile File-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Device/Files> level.
2) Enter:
get <deviceName>↵
where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device.

11.7.10.2 detail
This command is used to view Device Profile File detail attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Device/Files> level.
2) Enter:
detail <deviceName> <fileFormat>↵
where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The device name.

<fileFormat> String 1 to 128 characters The file format.

11.7.10.3 set
This command is used to modify Device Profile File-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Device/Files> level.
2) Enter:
set <deviceName> <fileFormat> <attribute>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 697
 where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The device name.

<fileFormat> String 1 to 128 characters The file format.

<attribute> MultipleChoice fileSource, configurationFile The name of an attribute to

Name, extCaptureOnUpload modify.

<fileSource> Choice manual, default, custom The Provisioning Server does

not generate a file for this device
profile. The file must be manually
generated and saved in the file
repository.

<configuration String 1 to 256 characters The configuration file name.

FileName>

<extCaptureOn Choice true, false This parameter enables or

Upload> disables the extended file capture
on upload from a device. When
enabled, new files uploaded from
a device are kept in the extended
capture file repository until a
configurable number of them is
reached. At this point, the oldest
is deleted. When disabled, new
files uploaded from a device
overwrite the previous version
in the file repository. NOTE: The
association between devices and
file repositories is made under the
FileServer context.

11.7.11 User
This level is used to view the users associated with a system access device.

11.7.11.1 get
This command is used to view Device User-related attributes. At least one of the parameters defined in the
multiple choice attribute needs to be specified to search all users for a device. If the search produces over
1,000 entries, an error message appears and you should refine your search criteria to narrow the search.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Device/User> level.
2) Enter:
get <deviceName> <attribute>↵
where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 698
 Variable Field Type Valid Values Description

<attribute> MultipleChoice linePortUserPartStarts, linePort The name of an attribute to filter

UserPartContains, linePortUser on.
PartEqualTo, linePortDomain
Starts, linePortDomainContains,
linePortDomainEqualTo, userId
Starts, userIdContains, userId
EqualTo, lastNameStarts, last
NameContains, lastNameEqual
To, firstNameStarts, firstName
Contains, firstNameEqualTo,
phoneStarts, phoneContains,
phoneEqualTo, extensionStarts,
extensionContains, extension
EqualTo, svcProviderIdEqualTo,
groupIdStarts, groupIdContains,
groupIdEqualTo, userTypeEqual
To

<linePortUser String 0 to 80 characters Displays only users whose line

PartStarts> port starts with the specified
string.

<linePortUser String 0 to 80 characters Displays only users whose line

PartContains> port contains the specified string.

<linePortUser String 1 to 80 characters Displays only users whose line

PartEqualTo> port matches the specified string.

<linePort String 0 to 80 characters Displays only users whose

DomainStarts> line port domain starts with the
specified string.

<linePort String 0 to 80 characters Displays only users whose

Domain line port domain contains the
Contains> specified string.

<linePort String 1 to 80 characters Displays only users whose

DomainEqual line port domain matches the
To> specified string.

<userIdStarts> String 0 to 161 characters Displays only users whose user

ID starts with the specified string.

<userId String 0 to 161 characters Displays only users whose user

Contains> ID contains the specified string.

<userIdEqual String 1 to 161 characters Displays only users whose user

To> ID matches the specified string.

<lastName String 0 to 30 characters Displays only users whose last

Starts> name starts with the specified
string.

<lastName String 0 to 30 characters Displays only users whose last

Contains> name contains the specified
string.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 699
 Variable Field Type Valid Values Description

<lastName String 1 to 30 characters Displays only users whose last

EqualTo> name matches the specified
string.

<firstName String 0 to 30 characters Displays only users whose first

Starts> name starts with the specified
string.

<firstName String 0 to 30 characters Displays only users whose first

Contains> name contains the specified
string.

<firstName String 1 to 30 characters Displays only users whose first

EqualTo> name matches the specified
string.

<phoneStarts> String 0 to 23 characters Displays only users whose phone

number starts with the specified
string.

<phone String 0 to 23 characters Displays only users whose phone

Contains> number contains the specified
string.

<phoneEqual String 1 to 23 characters Displays only users whose phone

To> number matches the specified
string.

<extension String 0 to 20 characters Displays only users whose

Starts> extension starts with the specified
string.

<extension String 0 to 20 characters Displays only users whose

Contains> extension contains the specified
string.

<extension String 2 to 20 characters Displays only users whose

EqualTo> extension matches the specified
string.

<svcProviderId String 1 to 30 characters Displays only users whose

EqualTo> service provider ID matches the
specified string.

<groupId String 0 to 30 characters Displays only users whose group

Starts> ID starts with the specified string.

<groupId String 0 to 30 characters Displays only users whose group

Contains> ID contains the specified string.

<groupIdEqual String 1 to 30 characters Displays only users whose group

To> ID matches the specified string.

<userType Choice normal, autoAttendant, call Specifies the type of user.

EqualTo> Center, huntGroup, instantGroup
Call, routePoint, voiceMessaging

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 700
11.7.11.2 set
This command is used to modify Service Provider Device Profile User-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Device/User> level.
2) Enter:
set <deviceName> <linePort> <attribute>↵
where:
Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device for which

you want to set attributes.

<linePort> String 1 to 161 characters The line/port number.

<attribute> MultipleChoice primaryLinePort The name of an attribute to

modify.

<primaryLine Choice true, false Specifies whether this is the

Port> primary line/port.

11.8 DeviceInventory
This level is used to view the configured devices on the system.

11.8.1 get
Device inventory-related attributes, such as the device name and address, are viewed using this
command. If you use the command with a specified variable, only records matching that criterion are
displayed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/DeviceInventory> level.
2) Enter:
get <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice deviceNameStarts, deviceName The name of an attribute to filter

Contains, deviceNameEqualTo, on.
deviceTypeEqualTo, ipAddress
Starts, ipAddressContains, ip
AddressEqualTo, macAddress
Starts, macAddressContains,
macAddressEqualTo, groupId
Starts, groupIdContains, groupId
EqualTo, svcProviderIdEqualTo

<deviceName String 0 to 40 characters Displays only devices whose

Starts> names start with the specified
string.

<deviceName String 0 to 40 characters Displays only devices whose

Contains> names contain the specified
string.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 701
 Variable Field Type Valid Values Description

<deviceName String 1 to 40 characters Displays only devices whose

EqualTo> names match the specified string.

<deviceType String 1 to 40 characters Displays only devices whose

EqualTo> types match the specified string.

<ipAddress String 0 to 80 characters Displays only devices whose IP

Starts> addresses start with the specified
string.

<ipAddress String 0 to 80 characters Displays only devices whose IP

Contains> addresses contain the specified
string.

<ipAddress String 1 to 80 characters Displays only devices whose IP

EqualTo> addresses match the specified
string.

<macAddress String 0 to 80 characters Displays only devices whose

Starts> MAC addresses start with the
specified string.

<macAddress String 0 to 80 characters Displays only devices whose

Contains> MAC addresses contain the
specified string.

<macAddress String 1 to 80 characters Displays only devices whose

EqualTo> names match the specified string.

<groupId String 0 to 30 characters Displays only devices in groups

Starts> whose names start with the
specified string.

<groupId String 0 to 30 characters Displays only devices in groups

Contains> whose names contain the
specified string.

<groupIdEqual String 1 to 30 characters Displays only devices in groups

To> whose names match the specified
string.

<svcProviderId String 1 to 30 characters Displays only devices in service

EqualTo> providers whose names match
the specified string.

11.9 Domain
This level is used to view configured domain names, which are used for subscriber identification on
BroadWorks that include authentication and SIP subscriber identification.

11.9.1 get
This command is used to view all service provider-configured domain-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Domain> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 702
 get↵

11.9.2 detail
This command is used to view system domain detail-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Domain> level.
2) Enter:
detail <domainName>↵
where:
Variable Field Type Valid Values Description

<domain String 2 to 80 characters The name of the domain.

Name>

11.9.3 add
This command is used to add a new domain to the system.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Domain> level.
2) Enter:
add <domainName>↵
where:
Variable Field Type Valid Values Description

<domain String 2 to 80 characters The name of the domain.

Name>

11.9.4 delete
This command deletes an existing domain from the system.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Domain> level.
2) Enter:
delete <domainName>↵
where:
Variable Field Type Valid Values Description

<domain String 2 to 80 characters The name of the domain.

Name>

11.10 EnterpriseTrunkNumberRanges
This level is used to view the enterprise trunk number ranges.

11.10.1 get
This command is used to view the enterprise trunk number ranges.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/EnterpriseTrunkNumberRanges> level.
2) Enter:
get [<attribute>]↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 703
 Variable Field Type Valid Values Description

<attribute> MultipleChoice svcProviderId The name of an attribute to filter

on.

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider for whom enterprise
trunk number ranges should be
displayed.

11.11 Extensions
This level allows for the configuration of extensions of group members and group services.

11.11.1 get
Group extension list-related attributes, such as the group name, user name, phone number, and
corresponding extension, are viewed using this command. The unique group name is used to identify the
record to be viewed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Extensions> level.
2) Enter:
get↵

11.11.2 set
The length of extension numbers is changed using this command.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Extensions> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice extMinLength, extMaxLength The name of an attribute to

modify.

<extMin Integer 2 through 20 The minimum number of

Length> extension digits allowed in the
group.

<extMax Integer 2 through 20 The maximum number of

Length> extension digits allowed in the
group.

11.12 FeatureAccessCodes
This level is used to view, add, modify, and delete system-wide attributes related to FeatureAccessCodes.

11.12.1 get
This command is used to view the system-level Feature Access Codes (FACs) configured.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/FeatureAccessCodes> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 704
 get↵

11.12.2 set
This command is used to modify the system-level Feature Access Codes (FACs) configured.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/FeatureAccessCodes> level.
2) Enter:
set <functionName> <attribute>↵
where:
Variable Field Type Valid Values Description

<function String 1 to 80 characters This parameter specifies the

Name> name of Feature Access Code
(FAC) to set.

<attribute> MultipleChoice mainCode, alternateCode, The name of an attribute to

enabled modify.

<mainCode> String 2 to 5 characters The main code used for the

feature access code.

<alternate String 2 to 5 characters The alternate code used for the

Code> feature access code.

<enabled> Choice true, false Default value of flag to enable or

disable feature access code.

11.12.3 clear
This command is used to clear Default Feature Access Codes-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/FeatureAccessCodes> level.
2) Enter:
clear <functionName> <attribute>↵
where:
Variable Field Type Valid Values Description

<function String 1 to 80 characters The function performed by the

Name> feature access code.

<attribute> MultipleChoice alternateCode The name of the attribute(s) to

clear.

11.13 Group
The Application Server collects users that share the same provisioning characteristics and places them into
a group. For example, a group can be a company or an organization. Members are defined for each group
and include the members' phone numbers. Group administrators responsible for entering members into the
system for that group are also defined. Valid access points for each group are specified. As well, a range of
phone numbers can be reserved for each group. Additionally, the following are configured: group services,
group extension lists, group calling ID, and password management for group members.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 705
11.13.1 get
Group-related attributes, such as the corresponding service provider, the group name used by the system
and the company name, are viewed using this command. If you use this command alone, all records are
displayed. If you use this command with a specified variable, only records matching that criterion are
displayed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group> level.
2) Enter:
get <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice groupIdStarts, groupIdContains, The name of an attribute to filter

groupIdEqualTo, groupName on.
Starts, groupNameContains,
groupNameEqualTo, svcProvider
IdEqualTo

<groupId String 0 to 30 characters Displays only groups with IDs that

Starts> start with the specified string.

<groupId String 0 to 30 characters Displays only groups with IDs that

Contains> contain the specified string.

<groupIdEqual String 1 to 30 characters Displays only groups with IDs that

To> match the specified string.

<groupName String 0 to 80 characters Displays only groups with names

Starts> that start with the specified string.

<groupName String 0 to 80 characters Displays only groups with names

Contains> that contain the specified string.

<groupName String 0 to 80 characters Displays only groups with names

EqualTo> that match the specified string.

<svcProviderId String 1 to 30 characters Displays only groups within the

EqualTo> service provider with IDs that
match the specified string.

11.13.2 detail
This command is used to view details of a configured group.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group> level.
2) Enter:
detail <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider or enterprise

Id> ID.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 706
 Variable Field Type Valid Values Description

<groupId> String 1 to 30 characters The group belonging to the

service provider or enterprise
specified.

11.13.3 add
When adding a new group to the system, the group name used by the system, the company name, the
contact information, and other relevant group information are set.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group> level.
2) Enter:
add <svcProviderId> <groupId> <defaultDomainName> <userLimit> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

<groupId> String 1 to 30 characters The ID of the new group.

<defaultDomain String 2 to 80 characters The domain name of the group.

Name>

<userLimit> Integer 1 through 999999 The number of users this group is

limited to having.

<attribute> MultipleChoice groupName, callingLineIdName, Additional attributes to include

contactName, contactNumber, through the add command.
contactEmail, locationCode, time
Zone, addressLine1, address
Line2, city, stateOrProvince, zip
OrPostalCode, country

<groupName> String 0 to 80 characters The company name, for example,

BroadSoft.

<callingLineId String 0 to 80 characters The name of the company to

Name> appear in the calling line ID to
called parties.

<contactName> String 0 to 30 characters The name of the contact person

for this group.

<contact String 0 to 30 characters The phone number of the contact

Number> person for this group.

<contactEmail> String 0 to 80 characters The e-mail address of the contact

person for this group.

<locationCode> Digit String 1 to 15 digits The code used to indicate the

group location.

<timeZone> String 1 to 127 characters The time zone for this group.

<address String 1 to 80 characters The service provider address: line

Line1> 1.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 707
 Variable Field Type Valid Values Description

<address String 1 to 80 characters The service provider address: line

Line2> 2.

<city> String 1 to 50 characters The service provider address:

city.

<stateOr String 1 to 50 characters The service provider address:

Province> state or province.

<zipOrPostal String 1 to 50 characters The service provider address: zip

Code> or postal code.

<country> String 1 to 50 characters The service provider address:

country.

11.13.4 set
Group-related attributes, such as the corresponding service provider, the group name used by the system,
the company name, the contact's name, phone number, e-mail address, the mailing address, and the
appropriate time zone are changed using this command. The group name is used to identify the record to
be changed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group> level.
2) Enter:
set <svcProviderId> <groupId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider.

Id>

<groupId> String 1 to 30 characters The name of the group to be used

by the system.

<attribute> MultipleChoice groupName, defaultDomain The name of an attribute to

Name, callingLineIdName, calling modify.
LineIdNumber, contactName,
contactNumber, contactEmail,
locationCode, timeZone, user
Limit, addressLine1, address
Line2, city, stateOrProvince, zip
OrPostalCode, country

<groupName> String 0 to 80 characters The company name, for example,

BroadSoft.

<defaultDomain String 2 to 80 characters The domain name of the group.

Name>

<callingLineId String 0 to 80 characters The name for the company to

Name> appear in the calling line ID to
called parties.

<callingLineId String 1 to 23 characters The calling line identity number.

Number>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 708
 Variable Field Type Valid Values Description

<contactName> String 0 to 30 characters The name of the contact person

for this group.

<contact String 0 to 30 characters The phone number of the contact

Number> person for this group.

<contactEmail> String 0 to 80 characters The e-mail address of the contact

person for this group.

<locationCode> Digit String 1 to 15 digits The code used to indicate the

group location.

<timeZone> String 1 to 127 characters The time zone for this group.

<userLimit> Integer 1 through 999999 The number of users this group is

limited to having.

<address String 1 to 80 characters The service provider address: line

Line1> 1.

<address String 1 to 80 characters The service provider address: line

Line2> 2.

<city> String 1 to 50 characters The service provider address:

city.

<stateOr String 1 to 50 characters The service provider address:

Province> state or province.

<zipOrPostal String 1 to 50 characters The service provider address: zip

Code> or postal code.

<country> String 1 to 50 characters The service provider address:

country.

11.13.5 delete
Groups can be deleted using this command. The unique service provider ID and group name combination
are used to delete the associated record.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group> level.
2) Enter:
delete <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider to

Id> whom the group belongs.

<groupId> String 1 to 30 characters The ID of the group.

11.13.6 clear
This command is used to clear the group's location code.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 709
 1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group> level.
2) Enter:
clear <svcProviderId> <groupId> <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider to

Id> whom the group belongs.

<groupId> String 1 to 30 characters The ID of the group.

<clearAttribute> MultipleChoice locationCode, groupName, The name of the attribute(s) to

contactName, contactNumber, clear.
callingLineIdName, callingLineId
Number, contactEmail, address
Line1, addressLine2, city, state
OrProvince, zipOrPostalCode,
country

11.13.7 Administrator
This level allows for the display, modification, addition, or deletion of administrators for groups.

11.13.7.1 get
Group administrator-related attributes, such as the corresponding service provider, the group name,
and the group administrator's user ID, first name, and last name are viewed using this command. Group
administrators have access to information related to their own groups.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Administrator> level.
2) Enter:
get <svcProviderId> <groupId> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider

Id> to whom the group and group
administrator belongs.

<groupId> String 1 to 30 characters The ID of the group to which the

administrator belongs.

<attribute> MultipleChoice userId, lastName, firstName, The name of an attribute to filter

language on.

<userId> String 2 to 161 characters The user ID for the group

administrator.

<lastName> String 1 to 30 characters The group administrator's last

name.

<firstName> String 1 to 30 characters The group administrator's first

name.

<language> String 1 to 40 characters The supported language for the

group administrator.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 710
11.13.7.2 add
When adding a new group administrator to the system, the corresponding group name and service
provider, and the group administrator's user ID, first name, and last name are set.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Administrator> level.
2) Enter:
add <svcProviderId> <groupId> <userId> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider

Id> to whom the group and group
administrator belong.

<groupId> String 1 to 30 characters The ID of the group to which the

administrator belongs.

<userId> String 2 to 161 characters The user ID for the group

administrator.

<attribute> MultipleChoice lastName, firstName, language Additional attributes to include

through the add command.

<lastName> String 1 to 30 characters The group administrator's last

name.

<firstName> String 1 to 30 characters The group administrator's first

name.

<language> String 1 to 40 characters The supported language for the

group administrator.

11.13.7.3 set
Group administrator-related attributes, such as the group administrator's user ID, and first and last names,
are changed using this command.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Administrator> level.
2) Enter:
set <userId> <attribute>↵
where:
Variable Field Type Valid Values Description

<userId> String 2 to 161 characters The user ID for the group

administrator.

<attribute> MultipleChoice lastName, firstName, password, The name of an attribute to

language modify.

<lastName> String 1 to 30 characters The group administrator's last

name.

<firstName> String 1 to 30 characters The group administrator's first

name.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 711
 Variable Field Type Valid Values Description

<language> String 1 to 40 characters The supported language for the

group administrator.

11.13.7.4 delete
Group administrators can be deleted using this command. The unique user ID is used to delete the
associated record.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Administrator> level.
2) Enter:
delete <userId>↵
where:
Variable Field Type Valid Values Description

<userId> String 2 to 161 characters The user ID for the group

administrator.

11.13.7.5 clear
Group administrator-related attributes, such as the group administrator's user ID, and first and last names,
are changed using this command.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Administrator> level.
2) Enter:
clear <userId> <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<userId> String 2 to 161 characters The user ID for the group

administrator.

<clearAttribute> MultipleChoice lastName, firstName The name of the attribute(s) to

clear.

11.13.7.6 Policy
This level is used to view, add, modify, and delete Policy entries.
11.13.7.6.1 get
This command is used to view the policy attributes for users in the group.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Administrator/Policy> level.
2) Enter:
get <userId>↵
where:
Variable Field Type Valid Values Description

<userId> String 2 to 161 characters The user for whom you need
policy details.

11.13.7.6.2 set
This command is used to modify the policy attributes for users in the group.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 712
 1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Administrator/Policy> level.
2) Enter:
set <userId> <attribute>↵
where:
Variable Field Type Valid Values Description

<userId> String 2 to 161 characters The user ID of the group member

for whom you are setting the
policies.

<attribute> MultipleChoice profileAccess, userAccess, admin The name of an attribute to

Access, deptAccess, device modify.
Access, enhancedServiceAccess,
featureAccessCodeAccess,
numberExtensionAccess, calling
LineIdNumberAccess, service
Access, trunkGroupAccess, office
ZoneAccess, sessionAdmission
ControlAccess, numberActivation
Access, dialableCallerIDAccess,
verifyTranslationAndRouting
Access, communicationBarring
UserProfileAccess

<profile Choice Full, Restricted, None A policy that allows full, read-only
Access> or no access to user profiles.

<userAccess> Choice Full, Restricted-FullProfile, A policy that allows full, read-

Restricted-ReadProfile, only, or no access to users in the
Restricted-NoProfile, None group.

<admin Choice Full, Restricted, None A policy that allows full, read-
Access> only, or no access to group admin
profiles.

<deptAccess> Choice Full, Restricted, None A policy that allows full, read-
only, or no access to department
profiles.

<device Choice Full, Restricted, Restricted-No A policy that allows full, read-only,
Access> UserAssociation or no access to group profiles.

<enhanced Choice Full, Restricted A policy that allows or restricts

Service the group administrator from
Access> assigning enhanced services.
Restricted access still allows an
administrator to modify service
instances.

<featureAccess Choice Full, Restricted A policy that allows or restricts

CodeAccess> the group administrator from
assigning feature access codes.

<number Choice Full, Restricted A policy that allows or restricts

Extension the group administrator from
Access> assigning numbers to groups or
users.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 713
 Variable Field Type Valid Values Description

<callingLine Choice Full, Restricted A policy that allows or restricts

IdNumber the group administrator from
Access> configuring Calling Line Id
Number configuration.

<service Choice Full, Restricted A policy that allows or restricts

Access> the group administrator from
assigning services.

<trunkGroup Choice Full, Restricted-FullResource, A policy that allows or restricts

Access> Restricted-ReadResource, None the group administrator from
assigning trunk group access.

<officeZone Choice Full, Restricted A policy that allows or restricts

Access> the group administrator from
configuring office zones at the
user level.

<session Choice Full, Restricted, None A policy that allows or restricts

Admission the group administrator from
ControlAccess> configuring session admission
control configuration.

<number Choice Full, Restricted, None A policy that allows or restricts

Activation the group administrator from
Access> activating phone numbers.

<dialable Choice Full, Restricted, None Policy that allows or restricts

CallerID the group administrator full,
Access> restricted, or no access to
dialable caller id.

<verify Choice Full, None A policy that allows or restricts

Translation the group administrator
AndRouting from accessing the web
Access> verify translation and routing
functionality.

<communication Choice Full, None This parameter controls the policy

BarringUser that allows or restricts the group
ProfileAccess> administrator from accessing
communication barring settings at
the user level.

11.13.8 ClientApplicationLaunchProfiles
This level is used to view and modify the Client Application Launch Profiles at the group level.

11.13.8.1 get
This command is used to view Client Application Launch Profile-related attributes at the group level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/
ClientApplicationLaunchProfiles> level.
2) Enter:
get <svcProviderId> <groupId>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 714
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The Service Provider.

Id>

<groupId> String 1 to 30 characters The Group.

11.13.8.2 add
This command is used to add a new Client Application Launch Profile at the group level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/
ClientApplicationLaunchProfiles> level.
2) Enter:
add <svcProviderId> <groupId> <clientApplication> <enabled> <useVersion>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The Service Provider.

Id>

<groupId> String 1 to 30 characters The Group.

<client Choice callcenter, receptionist The Client Application.

Application>

<enabled> Choice true, false Whether the client application is

enabled.

<useVersion> Choice current, custom The version to launch for the

given application.

<current> The version matching the current

BroadWorks release.

Variable: custom

custom A custom version.

<version> String 1 to 20 characters When a custom version is used,

the string representing that
version.

11.13.8.3 set
This command is used to modify Client Application Launch Profile-related attributes at the group level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/
ClientApplicationLaunchProfiles> level.
2) Enter:
set <svcProviderId> <groupId> <clientApplication> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The Service Provider.

Id>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 715
 Variable Field Type Valid Values Description

<groupId> String 1 to 30 characters The Group.

<client Choice callcenter, receptionist The Client Application.

Application>

<attribute> MultipleChoice enabled, useVersion The attribute to modify.

<enabled> Choice true, false Whether the client application is

enabled.

<useVersion> Choice current, custom The version to launch for the

given application.

<current> The version matching the current

BroadWorks release.

Variable: custom

custom A custom version.

<version> String 1 to 20 characters When a custom version is used,

the string representing that
version.

11.13.8.4 delete
This command is used to delete a Client Application Launch Profile at the group level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/
ClientApplicationLaunchProfiles> level.
2) Enter:
delete <svcProviderId> <groupId> <clientApplication>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The Service Provider.

Id>

<groupId> String 1 to 30 characters The Group.

<client Choice callcenter, receptionist The Client Application.

Application>

11.13.9 Department
This level is used to add departments to a group. Departments can be used to group users into areas such
as "sales" or "engineering". Incoming and outgoing calling restrictions can be assigned by department, but
other services are still assigned to the entire group or to individual users.

11.13.9.1 get
This command displays a list of all departments for a group as well as the number of users in each
department.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Department> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 716
 get <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider who is part of the group
(receiving the new department).

<groupId> String 1 to 30 characters The group to which the new

department belongs.

11.13.9.2 add
This command adds a department to a group.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Department> level.
2) Enter:
add <svcProviderId> <groupId> <department> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider who is part of the group
(receiving the new department).

<groupId> String 1 to 30 characters The group to which the new

department belongs.

<department> String 1 to 50 characters The name of the department.

<attribute> MultipleChoice parentDepartment, callingLine Additional attributes to include

IdName, callingLineIdPhone through the add command.
Number

<parent Choice enterpriseDept, groupDept Can either be an enterprise or a

Department> group department.

<enterprise String 1 to 50 characters Specifies the name of an

Dept> enterprise department that is
a level above the one you are
modifying, if there is one.

<groupDept> String 1 to 50 characters Specifies the name of a group

department that is a level above
the one you are adding, if there is
one.

<callingLineId String 1 to 80 characters The calling line Id name to use for

Name> a department.

<callingLineId String 1 to 23 characters The calling line Id phone number

PhoneNumber> to use for a department.

11.13.9.3 set
This command changes the name of a department.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 717
 1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Department> level.
2) Enter:
set <svcProviderId> <groupId> <department> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider to whom the group and
department belong.

<groupId> String 1 to 30 characters The group to which the

department belongs.

<department> String 1 to 50 characters The existing name of the

department.

<attribute> MultipleChoice newDepartment, parent The attribute to modify.

Department, callingLineIdName,
callingLineIdPhoneNumber

<new String 1 to 50 characters The new name of the department.

Department>

<parent Choice enterpriseDept, groupDept Can either be an enterprise or a

Department> group department.

<enterprise String 1 to 50 characters Specifies the name of an

Dept> enterprise department that is
a level above the one you are
modifying, if there is one.

<groupDept> String 1 to 50 characters Specifies the name of a group

department that is a level above
the one you are adding, if there is
one.

<callingLineId String 1 to 80 characters The calling line Id name to use for

Name> a department.

<callingLineId String 1 to 23 characters The calling line Id phone number

PhoneNumber> to use for a department.

11.13.9.4 delete
This command removes a department from a group. NOTE: All users must be unassigned from the
department before it can be deleted.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Department> level.
2) Enter:
delete <svcProviderId> <groupId> <department>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider to whom the group and
department belong.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 718
 Variable Field Type Valid Values Description

<groupId> String 1 to 30 characters The group to which the

department belongs.

<department> String 1 to 50 characters The existing name of the

department.

11.13.9.5 clear
This command clears the parent of a department, effectively moving the department to the top-level of the
group department hierarchy.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Department> level.
2) Enter:
clear <svcProviderId> <groupId> <department> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider to whom the group and
department belong.

<groupId> String 1 to 30 characters The group to which the

department belongs.

<department> String 1 to 50 characters The existing name of the

department.

<attribute> MultipleChoice parentDepartment, callingLine The name of the attribute(s) to

IdName, callingLineIdPhone clear.
Number

11.13.9.6 Administrator
This section allows your department to be assigned an administrator. You can view, add, modify, and
delete administrators for groups.
11.13.9.6.1 get
This command displays a list of administrators for a department.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Department/Administrator> level.
2) Enter:
get <svcProviderId> <groupId> <department> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider to whom the group and
department belong.

<groupId> String 1 to 30 characters The group to which the

department belongs.

<department> String 1 to 50 characters The existing name of the

department.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 719
 Variable Field Type Valid Values Description

<attribute> MultipleChoice userId, lastName, firstName, The name of an attribute to filter

language on.

<userId> String 6 to 161 characters The user ID of the department

administrator.

<lastName> String 0 to 30 characters The last name of the department

administrator.

<firstName> String 0 to 30 characters The first name of the department

administrator.

<language> String 1 to 40 characters The language used by the

department administrator.

11.13.9.6.2 add
This command adds an administrator to a specific department.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Department/Administrator> level.
2) Enter:
add <svcProviderId> <groupId> <department> <userId> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider to whom the group and
department belong.

<groupId> String 1 to 30 characters The group to which the

department belongs.

<department> String 1 to 50 characters The existing name of the

department.

<userId> String 6 to 161 characters The user ID of the department

administrator.

<attribute> MultipleChoice lastName, firstName, language Additional attributes to include

through the add command.

<lastName> String 0 to 30 characters The last name of the department

administrator.

<firstName> String 0 to 30 characters The first name of the department

administrator.

<language> String 1 to 40 characters The language used by the

department administrator.

11.13.9.6.3 set
This command is used to modify information associated with a department administrator.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Department/Administrator> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 720
 set <userId> <attribute>↵
where:
Variable Field Type Valid Values Description

<userId> String 6 to 161 characters The user ID of the department

administrator.

<attribute> MultipleChoice lastName, firstName, password, The name of an attribute to

language modify.

<lastName> String 0 to 30 characters The last name of the department

administrator.

<firstName> String 0 to 30 characters The first name of the department

administrator.

<language> String 1 to 40 characters The supported language for the

department administrator.

11.13.9.6.4 delete
This command is used to delete an administrator from a group.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Department/Administrator> level.
2) Enter:
delete <userId>↵
where:
Variable Field Type Valid Values Description

<userId> String 6 to 161 characters The user ID of the department

administrator.

11.13.10 Device
This level allows for the adding, modifying, or removal of devices used by a group.

11.13.10.1 get
Device inventory-related attributes, such as the corresponding service provider and group, as well as the
device name, are viewed using this command. If you use the command with a specified variable, only
records matching that criterion will be displayed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Device> level.
2) Enter:
get <svcProviderId> <groupId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider for

Id> whom you want to view devices.

<groupId> String 1 to 30 characters The ID of the group from which

you want to view device detail.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 721
 Variable Field Type Valid Values Description

<attribute> MultipleChoice deviceNameStarts, deviceName The name of an attribute to filter

Contains, deviceNameEqualTo, on.
deviceTypeEqualTo, ipAddress
Starts, ipAddressContains, ip
AddressEqualTo, macAddress
Starts, macAddressContains,
macAddressEqualTo

<deviceName String 0 to 40 characters Displays only devices whose

Starts> names start with the specified
string.

<deviceName String 0 to 40 characters Displays only devices whose

Contains> names contain the specified
string.

<deviceName String 1 to 40 characters Displays only devices whose

EqualTo> names match the specified string.

<deviceType String 1 to 40 characters Displays only devices whose

EqualTo> types match the specified string.

<ipAddress String 0 to 80 characters Displays only devices whose IP

Starts> addresses start with the specified
string.

<ipAddress String 0 to 80 characters Displays only devices whose IP

Contains> addresses contain the specified
string.

<ipAddress String 1 to 80 characters Displays only devices whose IP

EqualTo> addresses match the specified
string.

<macAddress String 0 to 12 characters Displays only devices whose

Starts> MAC addresses start with the
specified string.

<macAddress String 0 to 12 characters Displays only devices whose

Contains> MAC addresses contain the
specified string.

<macAddress String 12 to 12 characters Displays only devices whose

EqualTo> names match the specified string.

11.13.10.2 detail
This command is used to view the device details, such as IP address, port, software load, and so on.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Device> level.
2) Enter:
detail <svcProviderId> <groupId> <deviceName>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 722
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider for

Id> whom you want to view device
details.

<groupId> String 1 to 30 characters The ID of the group from which

you want to view device details.

<deviceName> String 1 to 40 characters The name of the device for which

you want to view details.

11.13.10.3 add
When adding a new device inventory to the system, the device inventory's corresponding service provider,
group, and device name and type are set.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Device> level.
2) Enter:
add <svcProviderId> <groupId> <deviceName> <deviceType> [<attribute>] <true> <true>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of service provider.

Id>

<groupId> String 1 to 30 characters The system ID of the group.

<deviceName> String 1 to 40 characters The name of the device to add.

<deviceType> String 1 to 40 characters The device type.

<attribute> MultipleChoice ipAddress, port, protocol, Additional attributes to include

transportType, macAddress, through the add command.
serialNumber, description,
outboundProxyServer, stun
Server, physicalLocation, isMM
Device, useCustomUserName
Password

<ipAddress> String 1 to 80 characters The corresponding IP address,

host name, or domain for the
device.

<port> Integer 1025 through 65535 The port of the device.

<protocol> String 1 to 41 characters Protocol configured for this device

to use.

<transport Choice udp, tcp, unspecified The type of transport for the
Type> device.

<macAddress> MAC Address 12 characters The MAC address of the device.

<serial String 1 to 80 characters The serial number of the device.

Number>

<description> String 1 to 80 characters Description of the device.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 723
 Variable Field Type Valid Values Description

<stunServer> String 1 to 80 characters Allows the group administrator to

set an IP address for the STUN
Server.

<physical String 1 to 1024 characters Specifies the physical location

Location> of the originating device. Valid
characters for a physical location
are: alphanumeric - . ! % * _ + ` '
~. The access-type portion of the
PANI header cannot contain any
spaces, but the parameters can
be a quoted string with spaces.

<outbound String 1 to 80 characters Allows the group administrator to

ProxyServer> set IP address for the outbound
proxy server.

<isMMDevice> Choice true, false When set to "false", specifies

that this device is not a
Mobility Manager. When set to
"true",:specifies that this device is
a Mobility Manager.

<true>

<useCustom Choice true, false Specifies that a custom password

UserName is not used or not.
Password>

<true>

11.13.10.4 set
Device inventory-related attributes, such as the protocol being used, IP address, and port, are changed
using this command. The service provider/group/device name combination is used to identify the record to
be changed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Device> level.
2) Enter:
set <svcProviderId> <groupId> <deviceName> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<deviceName> String 1 to 40 characters Device name to retrieve.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 724
 Variable Field Type Valid Values Description

<attribute> MultipleChoice ipAddress, port, protocol, The name of an attribute to

transportType, macAddress, modify.
serialNumber, description,
outboundProxyServer, stun
Server, physicalLocation,
configMode, mobilityManager
ProvisioningURL, mobility
ManagerProvisioningUserName,
mobilityManagerProvisioning
Password, mobilityManager
DefaultOriginatingService
Key, mobilityManagerDefault
TerminatingServiceKey, use
CustomUserNamePassword,
userName

<ipAddress> String 1 to 80 characters The corresponding IP address,

host name, or domain for the
device.

<port> Integer 1025 through 65535 The port of the device.

<protocol> String 1 to 41 characters Protocol configured for this device

to use.

<transport Choice udp, tcp, unspecified The type of transport for the
Type> device.

<macAddress> MAC Address 12 characters MAC address of the device.

<serial String 1 to 80 characters Serial number of the device.

Number>

<description> String 1 to 80 characters Description of the device.

<stunServer> String 1 to 80 characters Allows the group administrator

to set IP address for the STUN
Server.

<physical String 1 to 1024 characters Specifies the physical location

Location> of the originating device. Valid
characters for a physical location
are: alphanumeric - . ! % * _ + ` '
~. The access-type portion of the
PANI header cannot contain any
spaces, but the parameters can
be a quoted string with spaces.

<outbound String 1 to 80 characters Allows the group administrator to

ProxyServer> set IP address for the Outbound
Proxy Server.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 725
 Variable Field Type Valid Values Description

<configMode> Choice default, manual, custom When set to default, the

device profile does not use a
custom template. Instead, the
Provisioning Server uses the
corresponding file/template
defined at the device-type level
(or a device-type customization
at the group level) to build the
resulting file for the device
profile. When set to manual, the
Provisioning Server does not
generate a file for this device
profile. The file must be manually
generated and saved in the file
repository. When set to custom,
the device profile has its own file/
template.

<custom> String 1 to 256 characters The name custom file/template.

<mobility String 1 to 256 characters The Mobility Manager device

Manager provisioning URL.
ProvisioningURL>

<mobility String 1 to 15 characters The Mobility Manager

Manager provisioning user name.
Provisioning
UserName>

<mobility Integer 0 through 999 The Mobility Manager default

Manager originating service key.
Default
Originating
ServiceKey>

<mobility Integer 0 through 999 The Mobility Manager default

Manager terminating service key.
Default
Terminating
ServiceKey>

<useCustom Choice true, false Specifies whether a custom

UserName password is to be used.
Password>

<userName> String 1 to 161 characters The name of the user for whom a
custom password is to be used.

11.13.10.5 delete
A device inventory can be deleted from the system using this command. The unique service provider/
group/device name combination is used to identify the record to be deleted.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Device> level.
2) Enter:
delete <svcProviderId> <groupId> <deviceName>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 726
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of service provider.

Id>

<groupId> String 1 to 30 characters The ID of the group.

<deviceName> String 1 to 40 characters The name of the device.

11.13.10.6 clear
This command is used to clear attributes related to the Group Access Device.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Device> level.
2) Enter:
clear <svcProviderId> <groupId> <deviceName> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The system ID of the group.

<deviceName> String 1 to 40 characters The device name to retrieve.

<attribute> MultipleChoice ipAddress, port, macAddress, The name of the attribute(s) to

serialNumber, description, clear.
outboundProxyServer, stun
Server, physicalLocation, mobility
ManagerDefaultOriginating
ServiceKey, mobilityManager
DefaultTerminatingServiceKey,
userName

11.13.10.7 lineOrder
Line order is used when an IP Phone is sharing lines and you want to change the order of lines by moving
a subscriber's line up or down.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Device> level.
2) Enter:
lineOrder <svcProviderId> <groupId> <deviceName> <linePort> <action> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<deviceName> String 1 to 40 characters Device name.

<linePort> String 0 to 161 characters Line port to line is moved.

<action> Choice up, down Direction to move the line.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 727
 Variable Field Type Valid Values Description

<attribute> MultipleChoice rebuildFileNow The name of an attribute to filter

on.

<rebuildFile Choice true, false Indicates if the device

Now> configuration file should be built.
This gives you control of when
the file is built. If you do not set
this attribute to true, the file is not
built. This is to prevent the file
from being built and transmitted
every time a line/port is moved.
If you moved a line/port up five
spaces, the file would be built five
times. The default is false.

11.13.10.8 rebuildDefaultFile
This command is used to rebuild each file of the device using the subscribers profile parameter.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Device> level.
2) Enter:
rebuildDefaultFile <svcProviderId> <groupId> <deviceName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider to

Id> whom the group belongs.

<groupId> String 1 to 30 characters The ID of the group.

<deviceName> String 1 to 40 characters The name of the device.

<force> Choice force When specified, the templates

are uploaded to the repository
even if the content hasn't
changed since the last rebuilt was
performed.

11.13.10.9 CustomTags
This level is used to view, add, modify, and delete Files entries.
11.13.10.9.1 get
This command is used to view Custom Tag-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Device/CustomTags> level.
2) Enter:
get <svcProviderId> <groupId> <deviceName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters Service provider.

Id>

<groupId> String 1 to 30 characters The system ID of the group.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 728
 Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device.

11.13.10.9.2 add
This command is used to add a new Custom Tag.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Device/CustomTags> level.
2) Enter:
add <svcProviderId> <groupId> <deviceName> <tagName> [<tagValue>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider or enterprise

Id> ID.

<groupId> String 1 to 30 characters The group belonging to the

service provider or enterprise
specified.

<deviceName> String 1 to 40 characters The name of the device.

<tagName> String 1 to 64 characters The name of the tag.

<tagValue> String 1 to 256 characters The value of the tag.

11.13.10.9.3 set
This command is used to modify Custom Tag-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Device/CustomTags> level.
2) Enter:
set <svcProviderId> <groupId> <deviceName> <tagName> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider or enterprise

Id> ID.

<groupId> String 1 to 30 characters The group belonging to the

service provider or enterprise
specified.

<deviceName> String 1 to 40 characters The name of the device.

<tagName> String 1 to 64 characters The name of the tag.

<attribute> MultipleChoice tagValue The name of an attribute to

modify.

<tagValue> String 1 to 256 characters The value of the tag.

11.13.10.9.4 delete
This command is used to delete an existing Custom Tag from the system.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 729
 1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Device/CustomTags> level.
2) Enter:
delete <svcProviderId> <groupId> <deviceName> <tagName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider to

Id> whom the group belongs.

<groupId> String 1 to 30 characters The ID of the group.

<deviceName> String 1 to 40 characters The name of the device.

<tagName> String 1 to 64 characters The name of the tag.

11.13.10.9.5 clear
This command is used to clear Custom Tag-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Device/CustomTags> level.
2) Enter:
clear <svcProviderId> <groupId> <deviceName> <tagName> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider to

Id> whom the group belongs.

<groupId> String 1 to 30 characters The ID of the group.

<deviceName> String 1 to 40 characters The name of the device.

<tagName> String 1 to 64 characters The name of the tag.

<attribute> MultipleChoice tagValue The name of the attribute(s) to

clear.

11.13.10.10 Files
This level is used to view, add, modify, and delete Files entries.
11.13.10.10.1 get
This command is used to view Device Profile File-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Device/Files> level.
2) Enter:
get <svcProviderId> <groupId> <deviceName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider to

Id> whom the group belongs.

<groupId> String 1 to 30 characters The ID of the group.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 730
 Variable Field Type Valid Values Description

<deviceName> String 1 to 40 characters The name of the device.

11.13.10.10.2 detail
This command is used to view Device Profile File detail attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Device/Files> level.
2) Enter:
detail <svcProviderId> <groupId> <deviceName> <fileFormat>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider to

Id> whom the group belongs.

<groupId> String 1 to 30 characters The ID of the group.

<deviceName> String 1 to 40 characters The name of the device.

<fileFormat> String 1 to 128 characters The type of the device profile file.

11.13.10.10.3 set
This command is used to modify Device Profile File-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Device/Files> level.
2) Enter:
set <svcProviderId> <groupId> <deviceName> <fileFormat> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider to

Id> whom the group belongs.

<groupId> String 1 to 30 characters The ID of the group.

<deviceName> String 1 to 40 characters The name of the device.

<fileFormat> String 1 to 128 characters The type of the device profile file.

<attribute> MultipleChoice fileSource, configurationFile The name of an attribute to

Name, extCaptureOnUpload modify.

<fileSource> Choice manual, default, custom The file source.

<configuration String 1 to 256 characters The name of the configuration

FileName> file.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 731
 Variable Field Type Valid Values Description

<extCaptureOn Choice true, false This parameter enables or

Upload> disables the extended file capture
on upload from a device. When
enabled, new files uploaded from
a device are kept in the extended
capture file repository until a
configurable number of them is
reached. At this point, the oldest
is deleted. When disabled, new
files uploaded from a device
overwrite the previous version
in the file repository. NOTE: The
association between devices and
file repositories is made under the
FileServer context.

11.13.10.11 User
This level is used to view the users associated with a Group Access Device.
11.13.10.11.1 get
User-related attributes, such as last name and phone number, are viewed using this command.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Device/User> level.
2) Enter:
get <svcProviderId> <groupId> <deviceName> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

<deviceName> String 1 to 40 characters The name of the device.

<attribute> MultipleChoice linePortUserPartStarts, linePort The name of an attribute to filter

UserPartContains, linePortUser on.
PartEqualTo, linePortDomain
Starts, linePortDomainContains,
linePortDomainEqualTo, userId
Starts, userIdContains, userId
EqualTo, lastNameStarts, last
NameContains, lastNameEqual
To, firstNameStarts, firstName
Contains, firstNameEqualTo,
phoneStarts, phoneContains,
phoneEqualTo, extensionStarts,
extensionContains, extension
EqualTo, userTypeEqualTo

<linePortUser String 0 to 80 characters Displays only users whose line

PartStarts> port starts with the specified
string.

<linePortUser String 0 to 80 characters Displays only users whose line

PartContains> port contains the specified string.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 732
 Variable Field Type Valid Values Description

<linePortUser String 1 to 80 characters Displays only users whose line

PartEqualTo> port matches the specified string.

<linePort String 0 to 80 characters Displays only users whose

DomainStarts> line port domain starts with the
specified string.

<linePort String 0 to 80 characters Displays only users whose

Domain line port domain contains the
Contains> specified string.

<linePort String 1 to 80 characters Displays only users whose

DomainEqual line port domain matches the
To> specified string.

<userIdStarts> String 0 to 161 characters Displays only users whose user

ID starts with the specified string.

<userId String 0 to 161 characters Displays only users whose user

Contains> ID contains the specified string.

<userIdEqual String 1 to 161 characters Displays only users whose user

To> ID matches the specified string.

<lastName String 0 to 30 characters Displays only users whose last

Starts> name starts with the specified
string.

<lastName String 0 to 30 characters Displays only users whose last

Contains> name contains the specified
string.

<lastName String 1 to 30 characters Displays only users whose last

EqualTo> name matches the specified
string.

<firstName String 0 to 30 characters Displays only users whose first

Starts> name starts with the specified
string.

<firstName String 0 to 30 characters Displays only users whose first

Contains> name contains the specified
string.

<firstName String 1 to 30 characters Displays only users whose first

EqualTo> name matches the specified
string.

<phoneStarts> String 0 to 23 characters Displays only users whose phone

number starts with the specified
string.

<phone String 0 to 23 characters Displays only users whose phone

Contains> number contains the specified
string.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 733
 Variable Field Type Valid Values Description

<phoneEqual String 1 to 23 characters Displays only users whose phone

To> number matches the specified
string.

<extension String 0 to 20 characters Displays only users whose

Starts> extension starts with the specified
string.

<extension String 0 to 20 characters Displays only users whose

Contains> extension contains the specified
string.

<extension String 2 to 20 characters Displays only users whose

EqualTo> extension matches the specified
string.

<userType Choice normal, autoAttendant, call Specifies the type of user.

EqualTo> Center, huntGroup, instantGroup
Call, routePoint, voiceMessaging

11.13.10.11.2 set
This command is used to modify Group Device Profile User-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Device/User> level.
2) Enter:
set <svcProviderId> <groupId> <deviceName> <linePort> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<deviceName> String 1 to 40 characters The name of the device.

<linePort> String 1 to 161 characters The line/port of the device.

<attribute> MultipleChoice primaryLinePort The name of an attribute to

modify.

<primaryLine Choice true, false Specifies whether this is a

Port> primary port.

11.13.11 DeviceFileReposUsers
This level allows for the adding, modifying, or removal of Device Files Repository Users.

11.13.11.1 get
This command is used to view File Repository Group User-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/DeviceFileReposUsers> level.
2) Enter:
get <svcProviderId> <groupId> <fileReposName>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 734
 where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<fileRepos String 1 to 40 characters The name of the device file

Name> repository.

11.13.11.2 add
This command is used to add a new File Repository Group User.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/DeviceFileReposUsers> level.
2) Enter:
add <svcProviderId> <groupId> <fileReposName> <userName> <accessPriv>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<fileRepos String 1 to 40 characters The name of the file repository.

Name>

<userName> String 1 to 30 characters The name of the user to be

added.

<accessPriv> MultipleChoice put, delete, get User access privileges.

11.13.11.3 set
This command is used to modify File Repository Group User-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/DeviceFileReposUsers> level.
2) Enter:
set <svcProviderId> <groupId> <fileReposName> <userName> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

<fileRepos String 1 to 40 characters The name of the file repository.

Name>

<userName> String 1 to 30 characters The file repository user name.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 735
 Variable Field Type Valid Values Description

<attribute> MultipleChoice accessPriv, password The name of an attribute to

modify.

<accessPriv> MultipleChoice put, delete, get User access privileges.

11.13.11.4 delete
This command is used to delete an existing File Repository Group User from the system.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/DeviceFileReposUsers> level.
2) Enter:
delete <svcProviderId> <groupId> <fileReposName> <userName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<fileRepos String 1 to 40 characters The name of the file repository.

Name>

<userName> String 1 to 30 characters The name of the user to be

removed.

11.13.12 Domain
This level is used to view, add, and delete the domains used by a group.

11.13.12.1 get
This command is used to view group domain-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Domain> level.
2) Enter:
get <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

11.13.12.2 detail
This command is used to view group domain detail attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Domain> level.
2) Enter:
detail <svcProviderId> <groupId> <domainName>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 736
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<domain String 2 to 80 characters The domain name used by this

Name> group.

11.13.12.3 add
This command is used to add a new group domain.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Domain> level.
2) Enter:
add <svcProviderId> <groupId> <domainName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<domain String 2 to 80 characters The domain name used by this

Name> group.

11.13.12.4 delete
This command is used to delete an existing group domain from the system.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Domain> level.
2) Enter:
delete <svcProviderId> <groupId> <domainName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<domain String 2 to 80 characters The domain name used by this

Name> group.

11.13.13 EnterpriseTrunkNumberRanges
This level is used to view, add, delete, activate and deactivate the enterprise trunk number ranges defined
in a group.

11.13.13.1 get
This command is used to view the enterprise trunk number ranges defined in a group.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 737
 1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/EnterpriseTrunkNumberRanges>
level.
2) Enter:
get <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters This parameter specifies the

Id> system ID of the service provider.

<groupId> String 1 to 30 characters This parameter specifies the

system ID of the group.

11.13.13.2 add
This command is used to assign an enterprise trunk number range to a group.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/EnterpriseTrunkNumberRanges>
level.
2) Enter:
add <svcProviderId> <groupId> <numberRangeStart>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters This parameter specifies the

Id> system ID of the service provider.

<groupId> String 1 to 30 characters This parameter specifies the

system ID of the group.

<numberRange String 1 to 23 characters This parameter specifies the

Start> starting number for a number
range.

11.13.13.3 delete
This command is used to unassign an enterprise trunk number range from a group.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/EnterpriseTrunkNumberRanges>
level.
2) Enter:
delete <svcProviderId> <groupId> <numberRangeStart>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters This parameter specifies the

Id> system ID of the service provider.

<groupId> String 1 to 30 characters This parameter specifies the

system ID of the group.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 738
 Variable Field Type Valid Values Description

<numberRange String 1 to 23 characters This parameter specifies the

Start> starting number for a number
range.

11.13.14 Extensions
This level allows for the configuration of extensions of group members and group services.

11.13.14.1 get
Group extension list-related attributes, such as the group name, user name, phone number, and
corresponding extension, are viewed using this command. The unique group name is used to identify the
record to be viewed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Extensions> level.
2) Enter:
get <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

11.13.14.2 set
The length of extension numbers is changed using this command.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Extensions> level.
2) Enter:
set <svcProviderId> <groupId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<attribute> MultipleChoice extMinLength, extMaxLength, ext The name of an attribute to

DefaultLength modify.

<extMin Integer 2 through 20 The minimum number of

Length> extension digits allowed in the
group.

<extMax Integer 2 through 20 The maximum number of

Length> extension digits allowed in the
group.

<extDefault Integer 2 through 20 The default length of extension

Length> numbers.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 739
11.13.15 GroupPagingTargetsCapacity
This level is used to view and modify the Group Paging targets capacity.

11.13.15.1 get
The maximum number of target users in paging groups for a particular group is viewed using this
command. The unique service provider name is used to identify the record to be viewed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/GroupPagingTargetsCapacity>
level.
2) Enter:
get <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider to

Id> whom the group belongs.

<groupId> String 1 to 30 characters The ID of the group.

11.13.15.2 set
The maximum number of target users in paging groups for a particular group is changed using this
command. The unique service provider ID and group ID are used to identify the record to be changed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/GroupPagingTargetsCapacity>
level.
2) Enter:
set <svcProviderId> <groupId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider to

Id> whom the group belongs.

<groupId> String 1 to 30 characters The ID of the group.

<attribute> MultipleChoice maximumTargets The name of an attribute to

modify.

<maximum Integer 1 through 294 Maximum number of target users

Targets> for groups.

11.13.16 GroupServices
This level is used to assign and authorize Group Services.

11.13.16.1 Assign
This level is used to display, add, and delete Group Service Assignment-related attributes.
11.13.16.1.1 get
This command is used to view Group Service Assignment-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/GroupServices/Assign> level.
2) Enter:
get <svcProviderId> <groupId> [<attribute>]↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 740
 where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<attribute> MultipleChoice assigned, serviceName The name of an attribute to filter

on.

<assigned> Choice true, false Lists only services assigned to

the specified group (true) or not
assigned to the specified group
(false).

<serviceName> String 1 to 80 characters Lists only services whose name

match the specified string.

11.13.16.1.2 add
This command is used to add a new Group Service Assignment.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/GroupServices/Assign> level.
2) Enter:
add <svcProviderId> <groupId> <serviceName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<serviceName> String 1 to 80 characters The name of the service to be

removed from the group.

11.13.16.1.3 delete
This command is used to delete an existing Group Service Assignment from the system.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/GroupServices/Assign> level.
2) Enter:
delete <svcProviderId> <groupId> <serviceName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<serviceName> String 1 to 80 characters The name of the service to be

assigned to the group.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 741
11.13.16.2 Authorize
This level is used to display and configure Group Service Authorization-related attributes.
11.13.16.2.1 get
This command is used to view Group Service Authorization-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/GroupServices/Authorize> level.
2) Enter:
get <svcProviderId> <groupId> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<attribute> MultipleChoice authorized, serviceName The name of an attribute to filter

on.

<authorized> Choice true, false Lists only services assigned to

the specified group (true) or not
assigned to the specified group
(false).

<serviceName> String 1 to 80 characters Lists only services whose name

match the specified string.

11.13.16.2.2 set
This command is used to modify Group Service Authorization-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/GroupServices/Authorize> level.
2) Enter:
set <svcProviderId> <groupId> <serviceName> <authorize>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<serviceName> String 1 to 80 characters The name of the service to be

authorized for the group.

<authorize> Choice false, true False removes authorization

from the specified group. True
authorizes the service for the
specified group. If you specify
true, you must indicate the
capacity of the service using the
"isUnlimited" variable described
below.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 742
 Variable Field Type Valid Values Description

Variable: true

true Authorized.

<unlimited> Choice false, true True sets the capacity for the
specified service to unlimited.
False limits the capacity to
a quantity specified by the
"quantity" variable.

Variable: false

false Limited.

<quantity> Integer 1 through 999999 The limit.

11.13.17 LDAPDirectory
This feature allows the administrators to configure an enterprise LDAP (Lightweight Directory Access
Protocol) directory that can be accessed by the users to make calls through the CommPilot Call Manager.
It is useful for an enterprise that stores user information in a LDAP directory. For more information, see
section 11.7 LDAP Directory.

11.13.17.1 get
This command displays the configuration to use to access the group's private LDAP directory.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/LDAPDirectory> level.
2) Enter:
get <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider to which the

Id> group using the LDAP directory
belongs.

<groupId> String 1 to 30 characters The group using the LDAP

directory.

11.13.17.2 set
This command is used to set the configuration used to access the group's private LDAP directory.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/LDAPDirectory> level.
2) Enter:
set <svcProviderId> <groupId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 743
 Variable Field Type Valid Values Description

<groupId> String 1 to 30 characters The group using the LDAP

directory.

<attribute> MultipleChoice useSetting, address, port, The name of an attribute to

searchBase, useSSL, require modify.
Authentication, authenticatedD
N, authenticatedPassword, sort
Control, pagedResultControl,
searchFilter, alwaysInclSearch
Attr, colAttrName1, colAttrName2,
colAttrName3, colAttrName4,
searchAttrCol

<useSetting> Choice system, serviceProvider, group Determines the administrative

level to use for this group's
directory access settings.

<address> String 1 to 80 characters The IP address of the LDAP

server.

<port> Integer 1 through 65535 The port of the LDAP server.

<searchBase> String 1 to 256 characters The search base of the LDAP

server, which is the root suffix of
the search. The root suffix should
reflect the domain name of the
site being searched.

<useSSL> Choice true, false When set to "false", the LDAP

connection does not support the
use of an SSL connection to bind
with the LDAP server. When set
to "true", the LDAP connection
does support the use of an SSL
connection to bind with the LDAP
server.

<require Choice true, false When set to "false", the

Authentication> LDAP server does not require
authentication. When set to
"true", the LDAP server requires
authentication.

<authenticatedDN> String 1 to 256 characters If the LDAP server requires

authentication, the authenticated
directory number is required. This
should be a unique identifier of
the user.

<authenticated String 1 to 40 characters If the LDAP server requires

Password> authentication, the authenticated
password for the user is required.

<sortControl> Choice true, false When set to "false", sort controls

are not supported. When set
to "true", sort controls are
supported.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 744
 Variable Field Type Valid Values Description

<pagedResult Choice true, false When set to "false", Paged result

Control> controls are not supported. When
set to "true", paged result controls
are supported.

<searchFilter> String 1 to 256 characters Specify a search filter to include

in all directory server searches.
By default, the suggested search
filter is "(telephoneNumber=*)",
which will restrict all directory
server searches made using
the CommPilot Call Manager
to directory users with the
telephoneNumber attribute
specified.

<alwaysIncl Choice true, false When set to "false", The search

SearchAttr> attribute is not included. When
set to "true", the search attribute
is always included. This forces
the current search attribute to be
included in all directory server
searches, even when the user
leaves search parameters blank.
By default, a search with blank
parameters uses only the value
of the search filter, for example,
"(telephoneNumber=*).

<colAttr String 1 to 80 characters The first column attribute name,

Name1> for example, CN.

<colAttr String 1 to 80 characters The second column

Name2> attribute name, for example,
telephoneNumber.

<colAttr String 1 to 80 characters The third column attribute name.

Name3>

<colAttr String 1 to 80 characters The fourth column attribute name.

Name4>

<searchAttr Choice column1, column2, column3, Specifies which columns to

Col> column4 search.

11.13.17.3 clear
This command is used to reset a configuration attribute for the group's private LDAP directory. Clearing the
port attribute resets it to its default value 389.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/LDAPDirectory> level.
2) Enter:
clear <svcProviderId> <groupId> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 745
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

<groupId> String 1 to 30 characters The group using the LDAP

directory.

<attribute> MultipleChoice address, searchBase, The name of the attribute(s) to

authenticatedDN, authenticated clear.
Password, searchFilter, colAttr
Name2, colAttrName3, colAttr
Name4

11.13.18 MeetMeConfPorts
This level is used to view and modify the group level port settings of the Meet-Me Conferencing.

11.13.18.1 get
This command is used to view the group level port settings of the Meet-Me Conferencing.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/MeetMeConfPorts> level.
2) Enter:
get <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters Service provider Id.

Id>

<groupId> String 1 to 30 characters Group Id.

11.13.18.2 set
This command is used to modify group level Meet-Me conference ports.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/MeetMeConfPorts> level.
2) Enter:
set <svcProviderId> <groupId> <unlimited> <false>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters Service provider Id.

Id>

<groupId> String 1 to 30 characters Group Id.

<unlimited> Choice true, false If set to true, unlimited ports will

be allocated to the group.

<false> If you choose false, you must also

specify the number of allocated
Meet-Me conference ports
(integer from 0 through 999999).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 746
11.13.19 Numbers
This level allows for the assignment of directory numbers to groups.

11.13.19.1 get
Group number-related attributes, such as the group name and the list of phone numbers in use or reserved
for that group, are viewed using this command. The unique service provider/group name combination is
used to identify the record to be viewed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Numbers> level.
2) Enter:
get <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

11.13.19.2 add
When adding a new phone number or range of phone numbers to the system, the corresponding service
provider and group IDs, and the phone number or range of phone numbers to be added, are entered.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Numbers> level.
2) Enter:
add <svcProviderId> <groupId> <startNumber> [<endNumber>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<startNumber> String 1 to 23 characters The starting phone number for a

range of phone numbers for the
group. To add a single number,
do not enter an endNumber.

<endNumber> String 1 to 23 characters The ending phone number for a

range of phone numbers for the
group. To add a single number,
do not enter an endNumber.

11.13.19.3 delete
When removing a phone number or range of phone numbers from the system, the corresponding service
provider and group IDs, and the phone number or range of phone numbers to be removed, are entered.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Numbers> level.
2) Enter:
delete <svcProviderId> <groupId> <startNumber> [<endNumber>]↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 747
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<startNumber> String 1 to 23 characters The starting phone number

for a range of phone numbers
for the group. To remove a
single number, do not enter an
endNumber.

<endNumber> String 1 to 23 characters The ending phone number

for a range of phone numbers
for the group. To remove a
single number, do not enter an
endNumber.

11.13.19.4 activate
This command is used activate a phone number or a range of phone numbers.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Numbers> level.
2) Enter:
activate <svcProviderId> <groupId> <startNumber> [<endNumber>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<startNumber> String 1 to 23 characters The starting phone number for a

range of phone numbers for the
group. To add a single number,
do not enter an endNumber.

<endNumber> String 1 to 23 characters The ending phone number for a

range of phone numbers for the
group. To add a single number,
do not enter an endNumber.

11.13.19.5 deactivate
This command is used deactivate a phone number or a range of phone numbers.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Numbers> level.
2) Enter:
deactivate <svcProviderId> <groupId> <startNumber> [<endNumber>]↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 748
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<startNumber> String 1 to 23 characters The starting phone number for a

range of phone numbers for the
group. To add a single number,
do not enter an endNumber.

<endNumber> String 1 to 23 characters The ending phone number for a

range of phone numbers for the
group. To add a single number,
do not enter an endNumber.

11.13.20 PasscodeRules
This level is used to view and modify the group-level passcode rule-related attributes. It applies to Voice
Portal and BroadWorks Anywhere portal passcodes.

11.13.20.1 get
This command is used to view the group-level passcode rule-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/PasscodeRules> level.
2) Enter:
get <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

11.13.20.2 set
This command is used to modify the group-level passcode rule-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/PasscodeRules> level.
2) Enter:
set <svcProviderId> <groupId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 749
 Variable Field Type Valid Values Description

<attribute> MultipleChoice useRuleLevel, notRepeated The name of an attribute to

Digits, numberOfRepeated modify.
Digits, notRepeatedPatterns, not
ContiguousSequences, number
OfAscendingDigits, number
OfDescendingDigits, notUser
Number, notReverseOfUser
Number, notPreviousPasscodes,
numberOfPreviousPasscodes,
notReverseOfOldPasscode,
minimumLength, maximum
Length, expirePasscode,
expirationDays, disableLogin,
allowableLoginFailures, send
Notification, notifyEmailAddress

<useRule Choice system, sp, group This attribute is used to control

Level> whether users' passcodes will
follow the rules set by the system
provider, by the service provider
or enterprise administrator, or by
the group administrator.

<notRepeated Choice true, false This attribute allows or disallows

Digits> the use of repeated digits in the
passcode (for example, 11111 or
22222).

<numberOf Integer 1 through 6 This attribute sets the number of

Repeated repeated digits allowed when the
Digits> notRepeatedDigits attribute is set
to true.

<notRepeated Choice true, false This attribute allows or disallows

Patterns> the use of repeated patterns
in the passcode (for example,
232323 or 1234512345).

<notContiguous Choice true, false This attribute allows or disallows

Sequences> the use of contiguous sequences
of digits in the passcode (for
example, 12345 or 54321).

<numberOf Integer 2 through 5 When the

Ascending notContiguousSequences
Digits> attribute is set to true, this value
of this attribute determines the
number of sequentially ascending
digits to allow.

<numberOf Integer 2 through 5 When the

Descending notContiguousSequences
Digits> attribute is set to true, this value
of this attribute determines
the number of sequentially
descending digits to allow.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 750
 Variable Field Type Valid Values Description

<notUser Choice true, false When enabled, passcodes cannot

Number> contain a user's own extension or
phone number.

<notReverseOf Choice true, false When enabled, passcodes cannot

UserNumber> contain a user's own extension or
phone number reversed.

<notPrevious Choice true, false When enabled, passcodes

Passcodes> cannot contain a user's previous
passcode.

<number Integer 1 through 10 When notPreviousPasscodes is

OfPrevious enabled, the value of this attribute
Passcodes> will determine the number of
previous passcodes to disallow.

<notReverseOf Choice true, false When enabled, passcodes

OldPasscode> cannot contain a user's previous
passcode reversed.

<minimum Integer 2 through 15 This attribute specifies the

Length> minimum length of the passcode.

<maximum Integer 3 through 30 This attribute specifies the

Length> maximum length of the passcode.

<expire Choice true, false With this attribute enabled, the

Passcode> passcode will expire according to
the expirationDays attribute.

<expiration Integer 15 through 180 This attribute specifies the

Days> number of days before a
passcode expires.

<disableLogin> Choice true, false When enabled, a user cannot log

in to their account.

<allowable Integer 2 through 10 This attribute specifies the

LoginFailures> number of times a user can log in
incorrectly before their account is
locked out.

<send Choice true, false With this attribute enabled, a

Notification> message is sent via e-mail to the
system administrator indicating
that the user's account has been
locked out.

<notifyEmail String 1 to 80 characters Specifies the e-mail address of

Address> the person to be notified when a
lockout has occurred.

11.13.20.3 clear
This command is used to the clear the portal passcode rules for a specific group.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/PasscodeRules> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 751
 2) Enter:
clear <svcProviderId> <groupId> <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

<clearAttribute> MultipleChoice notifyEmailAddress The name of the attribute(s) to

clear.

11.13.21 PasswordRules
This level is used to view Password Rules-related attributes.

11.13.21.1 get
This command is used to view the Password-related attributes for group administrators.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/PasswordRules> level.
2) Enter:
get <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

11.13.22 Policy
This level allows for the configuration of group policies.

11.13.22.1 get
Group service-related attributes, such as the authorization and assignment of services, are viewed using
this command. The unique service provider/group name combination is used to identify the record to be
viewed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy> level.
2) Enter:
get <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 752
11.13.22.2 set
Group services-related attributes, such as service authorization and assignment, are changed using
this command. The unique service provider/group name combination is used to identify the record to be
changed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy> level.
2) Enter:
set <svcProviderId> <groupId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<attribute> MultipleChoice groupCallingPlanAccess, group The name of an attribute to

ExtensionAccess, groupLDAP modify.
Access, groupVoiceMessaging
Access, groupDeptAdminUser
Access, groupDeptAdminTrunk
GroupAccess, groupDeptAdmin
PhoneNumberExtensionAccess,
groupDeptAdminCallingLine
IdNumberAccess, groupUser
AuthenticationAccess, group
UserProfileAccess, groupUser
GroupDirectoryAccess, group
UserEnhancedCallLogsAccess,
groupUserAutoAttendantName
DialingAccess

<groupCalling Choice Full, Restricted A group policy setting that

PlanAccess> hides the Calling Plans web
page, restricts the Incoming
Calling Plan page at the user
level to show only Collect Calls,
and restricts the Outgoing
Calling Plan page to show only
International, Operator-assisted,
700/900 and Casual call types.

<group Choice Full, Restricted, None A group policy setting will allow
Extension for hiding the extension dialing
Access> page, making the extension
dialing page read-only or allowing
full access.

<groupLDAP Choice Full, Restricted, None A group policy setting will allow
Access> for hiding the LDAP Directory
page, making the LDAP Directory
screen read-only or allowing full
access as today.

<groupVoice Choice Full, Restricted A group policy setting that allows

Messaging you to restrict users from setting
Access> their advanced Voice Messaging
configurations.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 753
 Variable Field Type Valid Values Description

<groupDept Choice Full, Restricted-ReadProfile, Full access to users in that

AdminUser Restricted-NoProfile, None department. Restricted from
Access> adding or removing users; read-
only user profile. Note that this
means that the user profile is
read-only and also that the
administrator will have the user
view of the alternate Numbers
and Shared Call Appearance
screen. Restricted from adding
or removing users; no access to
user profile. Note that this means
that the user profile is hidden
and also that the administrator
will have the user view of the
Alternate Numbers and Shared
Call Appearance pages. No
access to users.

<groupDept Choice Full, None When set to full, this policy allows
AdminTrunk department administrators full
GroupAccess> access to their Trunk Groups.
When set to none, Trunk Groups
are not visible to their department
administrators.

<groupDept Choice Full, Restricted Group Web Policy that

AdminPhone determines the access level for
Number Department administrator to
Extension Phone Number/Extensions.
Access>

<groupDept Choice Full, Restricted Group Web Policy that

AdminCalling determines the access level for
LineIdNumber Department administrator Calling
Access> Line Id Number.

<groupUser Choice Full, None The user will have a policy

Authentication that will allow control if the
Access> Authentication screen is available
to them as today (if assigned) or
to hide it completely.

<groupUser Choice Full, Restricted, None Full access to users. Restricted

ProfileAccess> from adding or removing users;
no access to user profile.
Restricted from adding or
removing users; read-only user
profile. Note that this means that
the user profile is read-only.

<groupUser Choice Full, None Group/enterprise directories are

GroupDirectory not shown in the menu for the
Access> end user. This means that when
the user clicks the Utilities link on
the web portal, there will be no
link to Group Directories.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 754
 Variable Field Type Valid Values Description

<groupUser Choice Full, Restricted Controls whether users have full

EnhancedCall access or read-only access to
LogsAccess> enhanced call logs.

<groupUser Choice Full, None This parameter controls access to

AutoAttendant the Auto Attendant name dialing
NameDialing properties.
Access>

11.13.22.3 CallProcessing
This level allows the administrator to view and modify the call processing policy attributes for the group
level.
11.13.22.3.1 CallLimits
This level is used to view, add, modify, and clear the Call Limits policy-related attributes at the group-level.
11.13.22.3.1.1 get
This command is used to view the Call Limits policy-related attributes at the group-level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/CallProcessing/
CallLimits> level.
2) Enter:
get <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

11.13.22.3.1.2 set
This command is used to modify the Call Limits policy-related attributes at the group-level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/CallProcessing/
CallLimits> level.
2) Enter:
set <svcProviderId> <groupId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 755
 Variable Field Type Valid Values Description

<attribute> MultipleChoice useGroupPolicy, groupMax The name of an attribute to

NumberSimultaneousCalls, group modify.
UseMaxNumberSimultaneous
Calls, groupMaxNumber
SimultaneousVideoCalls, group
UseMaxNumberSimultaneous
VideoCalls, groupMaxCallTime
ForAnsweredCallsInMinutes,
groupUseMaxCallTimeFor
AnsweredCalls, groupMaxCall
TimeForUnansweredCallsIn
Minutes, groupUseMaxCall
TimeForUnansweredCalls,
groupMaxNumberConcurrent
RedirectedCalls, groupUseMax
NumberConcurrentRedirected
Calls, groupMaxFindMeFollow
MeDepth, groupUseMaxFind
MeFollowMeDepth, groupMax
RedirectionDepth, groupMax
NumberConcurrentFindMeFollow
MeInvocations, groupUseMax
NumberConcurrentFindMeFollow
MeInvocations

<useGroup Choice true, false Indicates if the group policy is

Policy> used.

<groupMax Integer 1 through 999999 Specifies the maximum number

Number of simultaneous calls per user.
Simultaneous The default value is "10".
Calls>

<groupUse Choice true, false Enables or disables the Group

MaxNumber Max Number Simultaneous Calls
Simultaneous attribute.
Calls>

<groupMax Integer 1 through 999999 Determines whether the Group

Number Max Number Simultaneous Calls
Simultaneous parameter is used.
VideoCalls>

<groupUse Choice true, false Enables or disables the Group

MaxNumber Max Number SimultaneousVideo
Simultaneous Calls attribute.
VideoCalls>

<groupMax Integer 3 through 2880 Indicates in minutes the

CallTimeFor maximum call time for an
AnsweredCalls answered call. The default value
InMinutes> is 600 minutes.

<groupUse Choice true, false Enables or disables the Group

MaxCallTime Use Max Call Time For Answered
ForAnswered Calls attribute.
Calls>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 756
 Variable Field Type Valid Values Description

<groupMax Integer 1 through 2880 Enables or disables the Group

CallTimeFor Max Call Time For Unanswered
Unanswered Calls In Minutes attribute.
CallsIn
Minutes>

<groupUseMax Choice true, false Enables or disables the

CallTimeFor Group Use Max Call Time For
Unanswered Unanswered Calls.
Calls>

<groupUse Choice true, false When enabled, the administrator

MaxNumber can change the limit of
Concurrent simultaneous redirections at the
Redirected group level.
Calls>

<groupMax Integer 1 through 999999 Specifies the limit of simultaneous

Number redirections for each subscriber.
Concurrent
Redirected
Calls>

<groupUseMax Choice true, false When enabled, the administrator

FindMeFollow can change the cascading limit
MeDepth> of forking services at the group
level.

<groupMaxFind Integer 1 through 100 Specifies the cascading limit of

MeFollowMe forking services (Simultaneous
Depth> Ringing and Sequential Ringing).

<groupMax Integer 1 through 100 Specifies the maximum number

Redirection of cascaded redirections at the
Depth> group level.

<groupUse Choice true, false When enabled, the administrator

MaxNumber can limit the number of
ConcurrentFind simultaneous invocations of
MeFollowMe Find Me/Follow Me services at
Invocations> the group level. These services
include Simultaneous Ringing,
Sequential Ringing, and Remote
Office.

<groupMax Integer 1 through 999999 Specifies the limit of simultaneous

Number invocations of Find Me/Follow Me
ConcurrentFind services.
MeFollowMe
Invocations>

11.13.22.3.2 CallingLineId
This level is used to view and modify group level CallingLineId-related attributes.
11.13.22.3.2.1 get
This command is used to view Group Call Processing Calling Line ID Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/CallProcessing/
CallingLineId> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 757
 get <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

11.13.22.3.2.2 set
This command is used to modify Group Call Processing Calling Line ID Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/CallProcessing/
CallingLineId> level.
2) Enter:
set <svcProviderId> <groupId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

<attribute> MultipleChoice useGroupPolicy, groupCLID The name of an attribute to

Policy, groupEnterpriseCallsCLID modify.
Policy, groupGroupCallsCLID
Policy, groupEmergencyCLID
Policy, useGroupName, group
AllowAlternateNumbersFor
RedirectingIdentity, groupBlock
CallingNameForExternalCalls,
groupAllowConfigurableCLIDFor
RedirectingIdentity, groupAllow
DepartmentCLIDNameOverride

<useGroup Choice true, false Indicates that the group policy

Policy> should be used.

<groupCLID Choice useDN, useConfigurableCLID, Indicates which CLID should be

Policy> useGroupOrDepartmentCLID used for the group policy. This
can be the DN, a configurable
CLID, or the Department/
Group CLID. The department
is used if available otherwise
the group CLID is used if
useGroupOrDepartmentCLID
option is chosen.

<group Choice useExtension, useLocationCode Determines which Internal Call

Enterprise PlusExtension, useGroupCLID Calling Line ID (CLID) policy is
CallsCLID Policy used for inter-group calls within
Policy> an enterprise.This applies only
to groups within an enterprise
and not to groups within a service
provider.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 758
 Variable Field Type Valid Values Description

<groupGroup Choice useExtension, useLocationCode Determines which Internal Call

CallsCLID PlusExtension, useGroupCLID Calling Line ID (CLID) policy is
Policy> Policy used for intra-group calls.

<group Choice useDN, useConfigurableCLID, Indicates which emergency

EmergencyCLID useGroupOrDepartmentCLID CLID should be used for the
Policy> group policy. This can be the
DN, a configurable CLID, or the
Department/Group CLID. The
department is used if available
otherwise the group CLID is used
if useGroupOrDepartmentCLID
option is chosen.

<useGroup Choice true, false When set to "false", the party who
Name> receives the call does not see the
group name. When set to "true",
the party who receives the call
can see the group name.

<groupAllow Choice true, false Indicates for the group if alternate

Alternate numbers for redirecting identity
NumbersFor are allowed.
Redirecting
Identity>

<groupBlock Choice true, false Setting to "true" blocks calling

CallingName name for all external calls unless
ForExternal overridden at the User level.
Calls>

<groupAllow Choice true, false Indicates if the configurable

ConfigurableCLID calling line id can be used as
ForRedirecting identity for redirected calls.
Identity>

<groupAllow Choice true, false If set to true, the department

DepartmentCLID calling line id name is used for
NameOverride> the calling line Id if defined.
The useGroupName attribute
must also be set to true for the
department clid override to take
effect.

11.13.22.3.3 DialableCallerID
This level allows the group administrator to view and modify the DialableCallerID policy attributes for the
group level.
11.13.22.3.3.1 get
This command is used to view group DialableCallerID Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/CallProcessing/
DialableCallerID> level.
2) Enter:
get <svcProviderId> <groupId>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 759
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

11.13.22.3.3.2 set
This command is used to modifygroup DialableCallerID Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/CallProcessing/
DialableCallerID> level.
2) Enter:
set <svcProviderId> <groupId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

<attribute> MultipleChoice useGroupSetting, enabled The name of an attribute to

modify.

<useGroup Choice true, false Shows whether to use the Group

Setting> settings for Dialable Caller ID or
to inherit the settings from the
ServiceProvider/Enterprise level.

<enabled> Choice true, false Shows whether Dialable Caller ID

is enabled at the Group level.

11.13.22.3.4 Media
This level is used to view, modify, and clear Media Policy-related attributes.
11.13.22.3.4.1 get
This command is used to view Group Call Processing Media Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/CallProcessing/Media>
level.
2) Enter:
get <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

11.13.22.3.4.2 set
This command is used to modify Group Call Processing Media Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/CallProcessing/Media>
level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 760
 2) Enter:
set <svcProviderId> <groupId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

<attribute> MultipleChoice useGroupPolicy, groupMedia The name of an attribute to

Policy, groupSupportedMediaSet modify.

<useGroup Choice true, false Indicates that the group policy

Policy> should be used.

<groupMedia Choice forceUncompressedCodec, use Indicates which CLID should be

Policy> SupportedMedia, noRestriction used for the media policy.

<group String 1 to 80 characters Indicates the supported media set

Supported at the group level.
MediaSet>

11.13.22.3.4.3 clear
This command is used to clear Group Call Processing Media Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/CallProcessing/Media>
level.
2) Enter:
clear <svcProviderId> <groupId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

<attribute> MultipleChoice groupSupportedMediaSet The name of the attribute(s) to

clear.

11.13.22.3.5 RoutingXLA
This level is used to view and modify RoutingXLA-related attributes.
11.13.22.3.5.1 get
This command is used to view Group Call Processing Routing and Translation Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/CallProcessing/
RoutingXLA> level.
2) Enter:
get <svcProviderId> <groupId>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 761
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

11.13.22.3.5.2 set
This command is used to modify Group Call Processing Routing and Translation Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/CallProcessing/
RoutingXLA> level.
2) Enter:
set <svcProviderId> <groupId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

<attribute> MultipleChoice useGroupPolicy, groupNetwork The name of an attribute to

Usage, groupAllowEnterprise modify.
GroupCallTypingForPrivate
DialingPlan, groupAllow
EnterpriseGroupCallTyping
ForPublicDialingPlan, group
OverrideCLIDRestrictionFor
PrivateCallCategory, group
EnableEnterpriseExtension
Dialing, groupEnforceGroup
CallingLineIdentityRestriction,
groupUseEnterpriseCLIDFor
PrivateCallCategory

<useGroup Choice true, false Indicates that the group policy

Policy> should be used.

<groupNetwork Choice forceAllCalls, noForceEntGroup When set to "forceAllCalls",

Usage> Calls, noForceExtAndLoc this choice forces all calls
to use the network. When
set to "noForceExtAndLoc",
this choice forces all none-
location+extension calls to
use the network. When set to
"noForceEntGroupCalls", this
choice forces all non-extension
calls to use the network.

<groupAllow Choice true, false Specifies whether the Allow

Enterprise Enterprise Group Call Typing For
GroupCall Private Dialing Plan feature is
TypingFor enabled or disabled.
PrivateDialing
Plan>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 762
 Variable Field Type Valid Values Description

<groupAllow Choice true, false Specifies whether the Allow

Enterprise Enterprise Group Call Typing
GroupCall For Public Dialing Plan feature is
TypingFor enabled or disabled.
PublicDialing
Plan>

<group Choice true, false Specified whether the Override

OverrideCLID CLID Restriction For Private
RestrictionFor CallCategory feature is enabled
PrivateCall or disabled.
Category>

<groupEnable Choice true, false Specifies whether the Enable

Enterprise Enterprise Extension Dialing
Extension feature is enabled or disabled.
Dialing>

<groupEnforce Choice true, false When enabled, this attribute

GroupCalling enforces group calling line identity
LineIdentity restrictions.
Restriction>

<groupUse Choice true, false Specifies whether the Use

EnterpriseCLID Enterprise CLID For Private Call
ForPrivateCall Category feature is enabled or
Category> disabled.

11.13.22.4 DialPlan
The Dial Plan policy is implemented on the Application Server and replaces the Digit Collection policy.
The Application Server Dial Plan policy provides a complete outside access code (OAC) function, and this
enables the application of the Outgoing Calling Plan/Outgoing Digit Plan to be transparent with the OAC.
This level is used to manage group Dial Plan Policy-related attributes.
11.13.22.4.1 get
This command is used to view group Dial Plan Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/DialPlan> level.
2) Enter:
get <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

11.13.22.4.2 set
This command is used to modify group Dial Plan Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/DialPlan> level.
2) Enter:
set <svcProviderId> <groupId> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 763
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

<attribute> MultipleChoice useSetting, requiresAccessCode The name of an attribute to

ForPublicCalls, allowE164Public modify.
Calls, preferE164FormatFor
CallbackServices, publicDigitMap,
privateDigitMap

<useSetting> Choice system, serviceProvider, group Specifies which level setting to

use for the group.

<requires Choice true, false Determines whether dialing

AccessCode an access code is enforced
ForPublicCalls> to access the public dial plan.
Typically, this is enforced by
the Network Server Voice VPN
policy. However, this allows
the implementation of a non-
permissive private dial plan for
smaller enterprises without the
need to configure the Voice VPN
policy on the Network Server.

<preferE164 Choice true, false If set to "true", E.164 formatted

FormatFor callback numbers are not
Callback transformed into a national-
Services> prefixed number by the callback
services.

<allowE164 Choice true, false Determines whether E.164

PublicCalls> addresses are allowed as public
calls regardless of the non-
permissive option setting. This
option is only relevant when the
non-permissive option is set.

<publicDigit String 1 to 2048 characters Digit maps are sent by the

Map> Application Server in the context
of a call origination from an
MGCP device or a call origination
that involves the Media Server for
digit collection. This digit map is
mandatory.

<privateDigit String 1 to 2048 characters This digit map is optional, but

Map> must be configured if the Enabled
secondary dial tone option of an
access code is set.

11.13.22.4.3 clear
This command is used to clear group Dial Plan Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/DialPlan> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 764
 clear <svcProviderId> <groupId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

<attribute> MultipleChoice publicDigitMap, privateDigitMap The name of the attribute(s) to

clear.

11.13.22.4.4 AccessCodes
This level is used to manage group Dial Plan policy Access codes.
11.13.22.4.4.1 get
This command is used to view Dial Plan Policy Access Codes-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/DialPlan/AccessCodes>
level.
2) Enter:
get <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

11.13.22.4.4.2 detail
This command is used to view group Dial Plan Policy Access Codes detail attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/DialPlan/AccessCodes>
level.
2) Enter:
detail <svcProviderId> <groupId> <accessCode>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group identifier.

<accessCode> String 1 to 5 characters The group access code.

11.13.22.4.4.3 add
This command is used to add new group Dial Plan Policy Access Codes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/DialPlan/AccessCodes>
level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 765
 add <svcProviderId> <groupId> <accessCode>
<includeCodeForNetworkTranslationsAndRouting> <includeCodeForScreeningServices>
<enableSecondaryDialTone> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

<accessCode> String 1 to 5 characters The dial plan policy access code.

<includeCode Choice true, false Determines whether the access

ForNetwork code should be included as
Translations part of the dialed digits for the
AndRouting> purpose of network translations
and routing.

<includeCode Choice true, false Determines whether the access

ForScreening code should be included as part
Services> of the dialed digits for the purpose
of call screening (for example,
Outgoing Digit Plan and Outgoing
Calling Plan).

<enable Choice true, false Determines whether secondary

SecondaryDial dial tone is applicable for calls
Tone> initiated from an MGCP device
or for call originations that
involve the Media Server for
digit collection. If this attribute is
set, then the private digit map is
initially used for digit collection.
This attribute cannot be set
unless a private digit map is
configured.

<attribute> MultipleChoice description Additional attributes to include

through the add command.

<description> String 1 to 80 characters The access code description.

11.13.22.4.4.4 set
This command is used to modify group Dial Plan Policy Access Codes-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/DialPlan/AccessCodes>
level.
2) Enter:
set <svcProviderId> <groupId> <accessCode> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 766
 Variable Field Type Valid Values Description

<groupId> String 1 to 30 characters The group ID.

<accessCode> String 1 to 5 characters The dial plan policy access code.

<attribute> MultipleChoice includeCodeForNetwork The name of an attribute to

TranslationsAndRouting, include modify.
CodeForScreeningServices,
enableSecondaryDialTone,
description

<includeCode Choice true, false Determines whether the access

ForNetwork code should be included as
Translations part of the dialed digits for the
AndRouting> purpose of network translations
and routing.

<includeCode Choice true, false Determines whether the access

ForScreening code should be included as part
Services> of the dialed digits for the purpose
of call screening (for example,
Outgoing Digit Plan and Outgoing
Calling Plan).

<enable Choice true, false Determines whether secondary

SecondaryDial dial tone is applicable for calls
Tone> initiated from an MGCP device
or for call originations that
involve the Media Server for
digit collection. If this attribute is
set, then the private digit map is
initially used for digit collection.
This attribute cannot be set
unless a private digit map is
configured.

<description> String 1 to 80 characters The access code description.

11.13.22.4.4.5 delete
This command is used to delete an existing group Dial Plan access code from the system.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/DialPlan/AccessCodes>
level.
2) Enter:
delete <svcProviderId> <groupId> <accessCode>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

<accessCode> String 1 to 5 characters The dial plan policy access code.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 767
11.13.22.4.4.6 clear
This command is used to clear group Dial Plan access code attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/Policy/DialPlan/AccessCodes>
level.
2) Enter:
clear <svcProviderId> <groupId> <accessCode> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<groupId> String 1 to 30 characters The group ID.

<accessCode> String 1 to 5 characters The number representing the

country where the carrier is
located.

<attribute> MultipleChoice description The name of the attribute(s) to

clear.

11.13.23 TrunkingCallCapacity
This level is used to configure the maximum simultaneous calls for a group.

11.13.23.1 get
This command is used to display the maximum number of simultaneous calls available to a group.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/TrunkingCallCapacity> level.
2) Enter:
get <svcProviderId> <groupId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

11.13.23.2 set
This command is used to set the maximum number of simultaneous calls available to a group.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/TrunkingCallCapacity> level.
2) Enter:
set <svcProviderId> <groupId> <attribute> <limited>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 768
 Variable Field Type Valid Values Description

<groupId> String 1 to 30 characters The system ID of the group.

<attribute> MultipleChoice maxSimultaneousCalls, max The name of an attribute to

BurstingSimultaneousCalls modify.

<max Integer 0 through 999999 The maximum allowed number of

Simultaneous simultaneous calls for the group.
Calls>

<maxBursting Choice true, false When set to unlimited, allows

Simultaneous an unlimited amount of bursting
Calls> simultaneous calls for the
specified group. When set to
limited, restricts the maximum
number of bursting simultaneous
calls to the amount indicated
by the numberOfBurstingCalls
variable.

<limited> Options when

maxBurstingSimultaneousCalls is
set to "limited".

11.13.24 UserServices
This level is used to configure services for users.

11.13.24.1 Authorize
This level is used to display and configure User Service Authorization-related attributes.
11.13.24.1.1 get
This command is used to display User Service Authorization-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/UserServices/Authorize> level.
2) Enter:
get <svcProviderId> <groupId> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<attribute> MultipleChoice service, servicePack The name of an attribute to filter

on.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 769
 Variable Field Type Valid Values Description

Variable: service

service Authorize a service.

<attribute> MultipleChoice serviceName, authorized The name of an attribute to filter

on.

<serviceName> String 1 to 80 characters The name of the service to

authorize.

<authorized> Choice true, false authorizes the service to the user.

Variable: servicePack

servicePack Authorize a servicePack.

<attribute> MultipleChoice servicePackName, authorized The name of an attribute to filter

on.

<servicePack String 1 to 80 characters The name of the service pack to

Name> authorize.

<authorized> Choice true, false authorizes the service to the user.

11.13.24.1.2 set
This command is used to set User Service Authorization-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/UserServices/Authorize> level.
2) Enter:
set <svcProviderId> <groupId> <attribute> <authorize>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<attribute> Choice service, servicePack The name of an attribute to

modify.

Variable: service

service Authorize a service.

<serviceName> String 1 to 80 characters The name of the service to

authorize.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 770
 Variable Field Type Valid Values Description

Variable: servicePack

servicePack Authorize a servicePack.

<servicePack String 1 to 80 characters The name of the service pack to

Name> authorize.

<authorize> Choice false, true False removes authorization

from the specified user. True
authorizes the service for the
specified user. If you specify true,
you must indicate the capacity of
the service using the "isUnlimited"
variable described below.

Variable: true

true

<unlimited> Choice false, true True sets the capacity for the
specified service to unlimited.
False limits the capacity to
a quantity specified by the
"quantity" variable.

Variable: false

false

<quantity> Integer 1 through 999999 Quantity value is case of limited

authorization.

11.13.24.2 ExistingUser
This level is used to add or delete and existing user service assignment.
11.13.24.2.1 get
This command is used to view the Existing User Service Assignments.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/UserServices/ExistingUser> level.
2) Enter:
get <svcProviderId> <groupId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<attribute> Choice serviceName, servicePackName The name of an attribute to filter

on.

<serviceName> String 1 to 80 characters The name of the authorized

service.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 771
 Variable Field Type Valid Values Description

<servicePack String 1 to 80 characters The name of the authorized

Name> service pack.

11.13.24.2.2 add
This command is used to add a new Existing User Service Assignment.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/UserServices/ExistingUser> level.
2) Enter:
add <svcProviderId> <groupId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<attribute> Choice serviceName, servicePackName Additional attributes to include

through the add command.

<serviceName> String 1 to 80 characters The name of the service to

authorize.

<servicePack String 1 to 80 characters The name of the service pack to

Name> authorize.

11.13.24.2.3 delete
This command is used to delete an Existing User Service Assignment.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/UserServices/ExistingUser> level.
2) Enter:
delete <svcProviderId> <groupId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<attribute> Choice serviceName, servicePackName The name of an attribute to filter

on.

<serviceName> String 1 to 80 characters The name of the authorized

service.

<servicePack String 1 to 80 characters The name of the authorized

Name> service pack.

11.13.24.3 NewUser
Use this level to display, add, or delete New User Service Assignment-related attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 772
11.13.24.3.1 get
This command is used to display New User Service Assignment-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/UserServices/NewUser> level.
2) Enter:
get <svcProviderId> <groupId> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<attribute> MultipleChoice serviceName, servicePackName The name of an attribute to filter

on.

<serviceName> String 1 to 80 characters The name of the service to

authorize.

<servicePack String 1 to 80 characters The name of the service pack to

Name> authorize.

11.13.24.3.2 add
This command is used to add New User Service Assignment-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/UserServices/NewUser> level.
2) Enter:
add <svcProviderId> <groupId> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<attribute> Choice serviceName, servicePackName Additional attributes to include

through the add command.

<serviceName> String 1 to 80 characters The name of the service to

authorize.

<servicePack String 1 to 80 characters The name of the service pack to

Name> authorize.

11.13.24.3.3 delete
This command is used to delete New User Service Assignment-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Group/UserServices/NewUser> level.
2) Enter:
delete <svcProviderId> <groupId> [<attribute>]↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 773
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<groupId> String 1 to 30 characters The system ID of the group.

<attribute> Choice serviceName, servicePackName The name of an attribute to filter

on.

<serviceName> String 1 to 80 characters The name of the service to

authorize.

<servicePack String 1 to 80 characters The name of the service pack to

Name> authorize.

11.14 MobileSubscriberDirectoryNumbers
This level is used to search and display the mobile subscriber directory numbers.

11.14.1 get
This command is used to search and display the mobile subscriber directory numbers.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/MobileSubscriberDirectoryNumbers>
level.
2) Enter:
get <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice mobileNumberStarts, mobile The name of an attribute to filter

NumberContains, mobileNumber on.
EqualTo, mobileNetworkEqual
To, svcProviderIdStarts, svc
ProviderIdContains, svcProvider
IdEqualTo, groupIdStarts, group
IdContains, groupIdEqualTo, user
IdStarts, userIdContains, user
IdEqualTo, lastNameStarts, last
NameContains, lastNameEqual
To, firstNameStarts, firstName
Contains, firstNameEqualTo,
phoneStarts, phoneContains,
phoneEqualTo, extensionStarts,
extensionContains, extension
EqualTo

<mobileNumber String 1 to 23 characters This parameter displays mobile

Starts> numbers starting with the
specified string.

<mobileNumber String 1 to 23 characters This parameter displays mobile

Contains> numbers containing the specified
string.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 774
 Variable Field Type Valid Values Description

<mobileNumber String 1 to 23 characters This parameter displays mobile

EqualTo> numbers equal to the specified
string.

<mobile String 1 to 80 characters This parameter displays mobile

NetworkEqual numbers contained in the mobile
To> network of the specified string.

<svcProviderId String 0 to 30 characters This parameter displays mobile

Starts> numbers contained in the service
provider with ID's starting with the
specified string.

<svcProviderId String 0 to 30 characters This parameter displays mobile

Contains> numbers contained in the service
provider with ID's including in the
specified string.

<svcProviderId String 1 to 30 characters This parameter displays mobile

EqualTo> numbers contained in the service
provider with ID's equals to the
specified string.

<groupId String 0 to 30 characters This parameter displays mobile

Starts> numbers assigned to groups with
ID's starting with the specified
string.

<groupId String 0 to 30 characters This parameter displays mobile

Contains> numbers assigned to groups with
ID's including the specified string.

<groupIdEqual String 1 to 30 characters This parameter displays mobile

To> numbers assigned to groups with
ID's equal to the specified string.

<userIdStarts> String 0 to 161 characters This parameter displays mobile

numbers assigned to users with
ID's starting with the specified
string.

<userId String 0 to 161 characters This parameter displays mobile

Contains> numbers assigned to users with
ID's including the specified string.

<userIdEqual String 1 to 161 characters This parameter displays mobile

To> numbers assigned to users with
ID's equal to the specified string.

<lastName String 0 to 30 characters This parameter displays mobile

Starts> numbers assigned to users with
last names starting with the
specified string.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 775
 Variable Field Type Valid Values Description

<lastName String 0 to 30 characters This parameter displays mobile

Contains> numbers assigned to users with
last names including the specified
string.

<lastName String 1 to 30 characters This parameter displays mobile

EqualTo> numbers assigned to users with
last names equal to the specified
string.

<firstName String 0 to 30 characters This parameter displays mobile

Starts> numbers assigned to users with
first names starting with the
specified string.

<firstName String 0 to 30 characters This parameter displays mobile

Contains> numbers assigned to users with
first names including the specified
string.

<firstName String 1 to 30 characters This parameter displays mobile

EqualTo> numbers assigned to users with
first names equal to the specified
string.

<phoneStarts> String 0 to 23 characters This parameter displays mobile

numbers assigned to users with
phone numbers starting with the
specified string.

<phone String 0 to 23 characters This parameter displays mobile

Contains> numbers assigned to users with
phone numbers including the
specified string.

<phoneEqual String 1 to 23 characters This parameter displays mobile

To> numbers assigned to users with
phone numbers equal to the
specified string.

<extension String 0 to 20 characters This parameter displays mobile

Starts> numbers assigned to users with
extensions starting with the
specified string.

<extension String 0 to 20 characters This parameter displays mobile

Contains> numbers assigned to users with
extensions including the specified
string.

<extension String 2 to 20 characters This parameter displays mobile

EqualTo> numbers assigned to users with
extensions equal to the specified
string.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 776
11.15 NumberActivation
This level is used to view and modify Number Activation-related attributes.

11.15.1 get
This command is used to display Number Activation-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/NumberActivation> level.
2) Enter:
get↵

11.15.2 set
This command is used to modify Number Activation-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/NumberActivation> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice dnMode, enterpriseTrunkNumber The name of an attribute to

RangeMode modify.

<dnMode> Choice off, userActivationEnabled, group Specifies whether number

AndUserActivationEnabled activation is set to off,
userActivationEnabled or
groupAndUserActivationEnabled.

<enterprise Choice off, on This parameter determines

TrunkNumber whether the enterprise trunk
RangeMode> number range activation is
enabled or disabled.

11.16 Numbers
This level allows the configuration of Application Server phone numbers used by system providers.

11.16.1 get
Phone number-related attributes, such as the number, the service provider ID, the group ID, and whether
the number is assigned, are viewed using this command.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Numbers> level.
2) Enter:
get [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice svcProviderId The name of an attribute to filter

on.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 777
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider for whom phone
numbers should be displayed.

11.16.2 Utilization
Information about phone numbers being used is available at this level.

11.16.2.1 get
The command displays information about the phone numbers in use for service providers.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Numbers/Utilization> level.
2) Enter:
get [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice svcProviderId The name of an attribute to filter

on.

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider for whom phone number
utilization should be displayed.

11.17 PasscodeRules
This level is used to view and modify system-level passcode rules. It applies to Voice Portal and
BroadWorks Anywhere Portal passcodes.

11.17.1 get
This command is used to view system-level passcode rules.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/PasscodeRules> level.
2) Enter:
get↵

11.17.2 set
This command is used to modify system-level portal passcode rules.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/PasscodeRules> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 778
 Variable Field Type Valid Values Description

<attribute> MultipleChoice notRepeatedDigits, numberOf The name of an attribute to

RepeatedDigits, notRepeated modify.
Patterns, notContiguous
Sequences, numberOfAscending
Digits, numberOfDescending
Digits, notUserNumber, not
ReverseOfUserNumber, not
PreviousPasscodes, numberOf
PreviousPasscodes, notReverse
OfOldPasscode, minimum
Length, maximumLength, expire
Passcode, expirationDays,
disableLogin, allowableLogin
Failures, sendNotification, notify
EmailAddress, defaultPasscode

<notRepeated Choice true, false This attribute allows or disallows

Digits> the use of repeated digits in the
passcode (for example, 11111 or
22222).

<numberOf Integer 1 through 6 This attribute sets the number of

Repeated repeated digits allowed when the
Digits> notRepeatedDigits attribute is set
to true.

<notRepeated Choice true, false This attribute allows or disallows

Patterns> the use of repeated patterns
in the passcode (for example,
232323 or 1234512345).

<notContiguous Choice true, false This attribute allows or disallows

Sequences> the use of contiguous sequences
of digits in the passcode (for
example, 12345 or 54321).

<numberOf Integer 2 through 5 When the

Ascending notContiguousSequences
Digits> attribute is set to true, this value
of this attribute determines the
number of sequentially ascending
digits to allow.

<numberOf Integer 2 through 5 When the

Descending notContiguousSequences
Digits> attribute is set to true, this value
of this attribute determines
the number of sequentially
descending digits to allow.

<notUser Choice true, false When enabled, passcodes cannot

Number> contain a user's own extension or
phone number.

<notReverseOf Choice true, false When enabled, passcodes cannot

UserNumber> contain a user's own extension or
phone number reversed.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 779
 Variable Field Type Valid Values Description

<notPrevious Choice true, false When enabled, passcodes

Passcodes> cannot contain a user's previous
passcode.

<number Integer 1 through 10 When notPreviousPasscodes is

OfPrevious enabled, the value of this attribute
Passcodes> will determine the number of
previous passcodes to disallow.

<notReverseOf Choice true, false When enabled, passcodes

OldPasscode> cannot contain a user's previous
passcode reversed.

<minimum Integer 2 through 15 This attribute specifies the

Length> minimum length of the passcode.

<maximum Integer 3 through 30 This attribute specifies the

Length> maximum length of the passcode.

<expire Choice true, false With this attribute enabled, the

Passcode> passcode expires according to
the expirationDays attribute.

<expiration Integer 15 through 180 This attribute specifies the

Days> number of days before a
passcode expires.

<disableLogin> Choice true, false When enabled, a user cannot log

in to their account.

<allowable Integer 2 through 10 This attribute specifies the

LoginFailures> number of times a user can log in
incorrectly before his/her account
is locked out.

<send Choice true, false With this attribute enabled, a

Notification> message is sent via e-mail to the
system administrator, indicating
that a user's account has been
locked out.

<notifyEmail String 1 to 80 characters Specifies the e-mail address of

Address> the person to be notified when a
lockout has occurred.

<default String 1 to 30 characters The default passcode.

Passcode>

11.17.3 clear
This command is used to clear (set to no value) the portal passcode rules for a specific group.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/PasscodeRules> level.
2) Enter:
clear <clearAttribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 780
 Variable Field Type Valid Values Description

<clearAttribute> MultipleChoice notifyEmailAddress The name of the attribute(s) to

clear.

11.18 PasswordRules
Password rules for service provider administrators can be viewed and modified at this level. These rules
apply to all service provider administrators.

11.18.1 get
Password-related attributes for service provider administrators, such as the allowable login failures,
minimum password length, whether the user ID can be used as a password, days to the password
expiry date, and whether passwords can contain numbers or symbols, and so on, are viewed using this
command.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/PasswordRules> level.
2) Enter:
get↵

11.18.2 set
Password-related attributes for service provider administrators, such as the allowable login failures,
minimum password length, whether the user name can also be the password, days to the password
expiry date, and whether passwords can contain numbers or symbols, and so on, are changed using this
command.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/PasswordRules> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice rulesApplyTo, containNonAlpha The name of an attribute to

NumChars, containNonAlpha modify.
Num, containLowerAlphaChars,
containLowerAlpha, contain
UpperAlphaChars, contain
UpperAlpha, containNumber
Chars, containNumber, not
ReverseOfOldPassword, notOld
Password, notUserId, minimum
Length, expirationDays, allowable
LoginFailures, sendNotification,
notifyEmailAddress, allowWeb
AddExternalUsers, notRecent
Passwords, numberRecent
Passwords

<rulesApplyTo> Choice allAdminUsers, spAdminAbove Rules apply to all administrators.

Only, sysAdminsOnlyOthersUse
ExternalAuth

<containNon Integer 1 through 10 The number of non-alphanumeric

AlphaNum characters that must be present
Chars> in the password.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 781
 Variable Field Type Valid Values Description

<containNon Choice true, false When set to "false", the password

AlphaNum> does not have to contain non-
alphanumeric characters. When
set to "true", the password
must contain non-alphanumeric
characters.

<containLower Integer 1 through 10 The number of lower case

AlphaChars> alphabetic characters the
password must contain.

<containLower Choice true, false When set to "false", the password

Alpha> does not have to contain lower-
case alphabetic characters. When
set to "true", the password must
contain lower-case alphabetic
characters.

<containUpper Integer 1 through 10 The number of upper-case

AlphaChars> alphabetic characters the
password must contain.

<containUpper Choice true, false When set to "false", the password

Alpha> does not have to contain upper-
case alphabetic characters. When
set to "true", the password must
contain upper-case alphabetic
characters.

<contain Integer 1 through 10 The number of numeric

NumberChars> characters the password must
contain.

<contain Choice true, false When set to "false", the password

Number> does not have to contain numeric
characters. When set to "true",
the password must contain
numeric characters.

<notReverseOf Choice true, false When set to "false", the password

OldPassword> is allowed to be the reverse
characters of the previous
password. When set to "true", the
password cannot be the reverse
characters of the previous
password.

<notOld Choice true, false When set to "false", the password

Password> is allowed to be the previous
password. When set to "true", the
password cannot be the previous
password.

<notUserId> Choice true, false When set to "false", the password

can be the same as the user ID.
When set to "true", the password
must be different from the user
ID.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 782
 Variable Field Type Valid Values Description

<minimum Integer 3 through 40 The minimum length allowed for

Length> passwords.

<expiration Integer 0 through 199 The number of days after which

Days> the password expires and the
user is forced to change the
password.

<allowable Integer 0 through 10 The number of login failures

LoginFailures> allowed. After the specified
number of failures, the user
is blocked and must contact
an administrator for password
change.

<send Choice true, false When set to "false", do not

Notification> send notice of failed login
attempts after specified number
of attempts. When set to "true",
send notice of failed login
attempts after specified number
of attempts.

<notifyEmail String 1 to 80 characters E-mail address to which

Address> notification is sent of user failed
log in attempts.

<allowWebAdd Choice true, false This parameter allows a service

ExternalUsers> provider to enable or disable an
administrators' ability to create
new users without passwords.

<notRecent Choice true, false Rule setting to check whether the

Passwords> new password equals any of the
previous passwords for a user or
administrator.

<number Integer 1 through 10 The number of passwords

Recent to check when applying the
Passwords> notRecentPasswords rule.

11.18.3 clear
Password-related attributes for service provider administrators, such as the e-mail address to notify when
the number of failed login attempts is exceeded, are cleared (set to no value) using this command.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/PasswordRules> level.
2) Enter:
clear <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<clearAttribute> MultipleChoice notifyEmailAddress The name of the attribute(s) to

clear.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 783
11.19 Policy
This level is used to configure policies for groups and users.

11.19.1 get
This command is used to view the system policies for group administrators, department administrators, and
users.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy> level.
2) Enter:
get↵

11.19.2 set
This command is used to modify the system policies for group administrators, department administrators,
and users.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 784
 Variable Field Type Valid Values Description

<attribute> MultipleChoice defaultGroupCallingPlanAccess, The name of an attribute to

defaultGroupExtensionAccess, modify.
defaultGroupLDAPAccess,
defaultGroupVoiceMessaging
Access, defaultGroupDept
AdminUserAccess, defaultGroup
DeptAdminTrunkGroupAccess,
defaultGroupDeptAdminPhone
NumberExtensionAccess, default
GroupDeptAdminCallingLineId
NumberAccess, defaultGroup
UserAuthenticationAccess,
defaultGroupUserGroupDirectory
Access, defaultGroupUserAuto
AttendantNameDialingAccess,
defaultGroupUserProfileAccess,
defaultGroupUserEnhancedCall
LogsAccess, defaultGroupAdmin
ProfileAccess, defaultGroup
AdminUserAccess, defaultGroup
AdminAdminAccess, default
GroupAdminDeptAccess, default
GroupAdminDeviceAccess,
defaultGroupAdminEnhanced
ServiceAccess, defaultGroup
AdminFeatureAccessCode
Access, defaultGroupAdmin
NumberExtensionAccess, default
GroupAdminCallingLineIdNumber
Access, defaultGroupAdmin
ServiceAccess, defaultGroup
AdminTrunkGroupAccess, default
GroupAdminVerifyTranslation
AndRoutingAccess, default
GroupAdminSessionAdmission
ControlAccess, defaultGroup
AdminOfficeZoneAccess, default
GroupAdminNumberActivation
Access, defaultGroupAdmin
DialableCallerIDAccess, default
GroupAdminCommunication
BarringUserProfileAccess, default
SvcProvAdminProfileAccess,
defaultSvcProvAdminGroup
Access, defaultSvcProvAdmin
UserAccess, defaultSvcProv
AdminAdminAccess, defaultSvc
ProvAdminDeptAccess, default
SvcProvAdminDeviceAccess,
defaultSvcProvAdminNetwork
PolicyAccess, defaultSvcProv
AdminNumberExtensionAccess,
defaultSvcProvAdminCallingLine
IdNumberAccess, defaultSvcProv
AdminServiceAccess, defaultSvc
ProvAdminServicePackAccess,
defaultSvcProvAdminSession
AdmissionControlAccess, default
SvcProvAdminVerifyTranslation
AndRoutingAccess, defaultSvc

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 785
 Variable Field Type Valid Values Description
ProvAdminWebBrandingAccess,
defaultSvcProvAdminOfficeZone
Access, defaultEnterpriseAdmin
NumberActivationAccess, default
SvcProvAdminCommunication
BarringAccess, defaultSvcProv
AdminDialableCallerIDAccess

<defaultGroup Choice Full, Restricted A group policy that allows full or

CallingPlan no access to Calling Plan service
Access> configuration.

<defaultGroup Choice Full, Restricted, None A group policy setting will allow
Extension for hiding the extension dialing
Access> page, making the extension
dialing page read-only, or
allowing full access.

<default Choice Full, Restricted, None A group policy setting will allow
GroupLDAP for hiding the LDAP Directory
Access> screen, making the LDAP
Directory screen read-only, or
allowing full access as today.

<default Choice Full, Restricted A group policy that allows full or

GroupVoice no access to advanced Voice
Messaging Messaging service configuration.
Access>

<defaultGroup Choice Full, Restricted-ReadProfile, Full access to users in that

DeptAdminUser Restricted-NoProfile, None department.Restricted-
Access> ReadProfile: Restricted from
adding or removing users; read-
only user profile - Note that
this means that the user profile
is read-only and also that the
administrator will have the user
view of the alternate Numbers
and Shared Call Appearance
screen.Restricted-NoProfile:
Restricted from adding or
removing users; no access to
user profile - Note that this means
that the user profile is hidden
and also that the administrator
will have the user view of the
alternate Numbers and Shared
Call Appearance screen.None:
No access to users.

<defaultGroup Choice Full, None This policy allows or denies

DeptAdmin access to the Trunk Group.
TrunkGroup
Access>

<defaultGroup Choice Full, Restricted Group Web Policy that

DeptAdmin determines the access level for
PhoneNumber Department administrator to
Extension Phone Number/Extensions.
Access>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 786
 Variable Field Type Valid Values Description

<defaultGroup Choice Full, Restricted Group Web Policy that

DeptAdmin determines the access level for
CallingLine Department administrator Calling
IdNumber Line Id Number.
Access>

<default Choice Full, None The user will have a policy

GroupUser that will allow control if the
Authentication Authentication screen is available
Access> to them as today (if assigned) or
to hide it completely.

<defaultGroup Choice Full, None Full: Full access to users. None:

UserGroup Group/Enterprise directories will
Directory not be shown in the menu for the
Access> end user.

<defaultGroup Choice Full, None This parameter controls access to

UserAuto the Auto Attendant name dialing
AttendantName parameters. Valid values include
DialingAccess> "Full" and "None". When set to
"Full", name dialing fields are
displayed to the users. When set
to "None", name dialing fields are
hidden from the users.

<defaultGroup Choice Full, Restricted, None Full: Full access to

UserProfile users.Restricted: Restricted from
Access> adding or removing users; read-
only user profile - Note that this
means that the user profile is
read-only.None: No access to
users.

<defaultGroup Choice Full, Restricted The system default for the

UserEnhanced Group User Enhanced Call
CallLogs Logs Access. The Group User
Access> Enhanced Call Logs Access
controls whether users have full
access or read-only access to
enhanced call logs.

<defaultGroup Choice Full, Restricted, None Policy that allows control if the
AdminProfile group profile screen is available
Access> to them as today, read-only, or to
hide it completely.

<defaultGroup Choice Full, Restricted-FullProfile, Policy that allows the group

AdminUser Restricted-ReadProfile, administrator access to user
Access> Restricted-NoProfile, None profiles (Full, Read-Only, or No
access).

<defaultGroup Choice Full, Restricted, None Policy that allows the group
AdminAdmin administrator access to other
Access> group administrator profiles (Full,
Read-Only, or No access).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 787
 Variable Field Type Valid Values Description

<defaultGroup Choice Full, Restricted, None Policy that has the ability to hide
AdminDept the department screens (List/
Access> Add/Modify), to show only the
department list, or operate with
full access.

<defaultGroup Choice Full, Restricted, Restricted-No Policy that allows the group
AdminDevice UserAssociation administrator full access to
Access> devices, read-only access to
devices, or full access without the
ability to assign users to devices.

<default Choice Full, Restricted Policy that allows or restricts

GroupAdmin group administrator access to
Enhanced Enhanced Service configuration.
Service
Access>

<defaultGroup Choice Full, Restricted Policy that allows or restricts

AdminFeature group administrators from
AccessCode configuring feature access codes.
Access>

<defaultGroup Choice Full, Restricted Policy that allows or restricts

AdminNumber a group administrator from
Extension performing number extension
Access> assignment.

<defaultGroup Choice Full, Restricted Administrator Web Policy for

AdminCalling Group administrators that
LineIdNumber determines the access level for
Access> Calling Lined Id Number.

<defaultGroup Choice Full, Restricted Policy that can hide, make read-
AdminService only or allow full access to service
Access> configuration of the group and/or
users.

<defaultGroup Choice Full, Restricted-FullResource, Policy that allows the group

AdminTrunk Restricted-ReadResource, None administrator access to the
GroupAccess> Trunk Group (Full, Restricted-
FullResource, Restricted-
ReadResource, None).

<defaultGroup Choice Full, None Policy that allows or restricts the

AdminVerify group administrator to access
Translation the verify translation and routing
AndRouting functionality.
Access>

<defaultGroup Choice Full, Restricted, None The system default session

AdminSession admission control access for all
Admission new group administrators. The
ControlAccess> default value is Restricted.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 788
 Variable Field Type Valid Values Description

<defaultGroup Choice Full, Restricted Default Group Administrator

AdminOffice Office Zone access setting.
ZoneAccess> Controls whether a Group
administrator can configure office
zones at the user level.

<defaultGroup Choice Full, Restricted, None Policy that allows Group

AdminNumber administrator, Number Activation
Activation Access(Default).
Access>

<defaultGroup Choice Full, Restricted, None Policy that allows the Group
AdminDialable administrator access to Dialable
CallerID Caller ID (Full, Read-only, or No
Access> access).

<default Choice Full, None Default Group Administrator

GroupAdmin Communication Barring access
Communication setting. Controls whether a Group
BarringUser administrator can configure
ProfileAccess> communication barring control
settings at the user level.

<defaultSvc Choice Full, Restricted, None Policy that allows the service
ProvAdmin provider administrator access
ProfileAccess> to service provider profile (Full,
Read-only, or No access).

<defaultSvc Choice Full, Restricted, None Policy that allows the service
ProvAdmin provider administrator:Full:
GroupAccess> Full access to groups
(default).Restricted: Restricted
from adding or removing groups:
The add/add wizard button on
the Service Provider: Profile
- Groups page will not be
shown. The delete button on the
Group: Profile - Profile will not
be shownNone: No Access to
groups: The Service Provider:
Profile -Groups will not be shown
on the Profile menu.

<defaultSvc Choice Full, Restricted-FullProfile, Policy that allows the service

ProvAdminUser Restricted-ReadProfile, provider administrator:Full access
Access> Restricted-NoProfile, None to users (default).Restricted from
adding or removing users; full
access to user profile. Restricted
from adding or removing users;
read-only access to user profile.
Restricted from adding or
removing users; no access to
user profile. No Access to users.
The Service Provider: Profile -
Users will not be shown on the
Profile menu.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 789
 Variable Field Type Valid Values Description

<defaultSvc Choice Full, Restricted, None Policy that allows the service
ProvAdmin provider administrator access to
AdminAccess> service provider administrators
(Full, Read-only or no access).

<defaultSvc Choice Full, Restricted, None Policy that allows the service
ProvAdminDept provider administrator Full
Access> access to departments (default),
Restricted from adding or
removing departments, or No
Access to departments.

<defaultSvc Choice Full, Restricted, Restricted-No Policy that allows the service
ProvAdmin UserAssociation provider administrator Full access
DeviceAccess> to devices (default), Read-only
access to devices, or full access
without the ability to assign users
for devices.

<defaultSvc Choice Full, None Policy that allows the service

ProvAdmin provider administrator Full access
NetworkPolicy to setting network policies.
Access>

<defaultSvc Choice Full, Restricted-NoGroup, Policy that allows the service

ProvAdmin Restricted provider administrator Full access
Number to Numbers (default), or Read-
Extension only access to Numbers.
Access>

<defaultSvc Choice Full, Restricted Administrator Web Policy for

ProvAdmin Service Providers and Enterprise
CallingLine administrators that determines
IdNumber the access level for Calling Lined
Access> Id Number.

<defaultSvc Choice Full, Restricted-NoAuthorize, Policy that allows the service

ProvAdmin Restricted provider administrator Full access
Service to services (default), or Read-only
Access> access to services.

<defaultSvc Choice Full, None Policy that allows the service

ProvAdmin provider administrator Full access
ServicePack to service packs (default) or No
Access> access to service packs.

<defaultSvc Choice Full, Restricted, None The system default session

ProvAdmin admission control access
Session for all new service provider
Admission administrators. The default value
ControlAccess> is Restricted.

<default Choice Full, None Policy that allows or restricts the

SvcProv service provider administrator to
AdminVerify access the verify translation and
Translation routing functionality.
AndRouting
Access>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 790
 Variable Field Type Valid Values Description

<defaultSvc Choice Full, None Policy that allows the service

ProvAdmin provider administrator Full access
WebBranding to Web Branding (default), or No
Access> access to Web Branding.

<defaultSvc Choice Full, Restricted Default Service Provider

ProvAdmin Administrator Office Zone access
OfficeZone setting. Controls whether a
Access> Service Provider administrator
can configure office zones at the
group/user level.

<default Choice Full, Restricted, None Policy that allows Enterprise

Enterprise Administrator, Number Activation
AdminNumber access (Default).
Activation
Access>

<defaultSvc Choice Full, Restricted Default Service Provider

ProvAdmin Administrator Communication
Communication Barring access setting. Controls
BarringAccess> whether a Service Provider
administrator can configure
communication barring control
settings at the service provider/
group level.

<defaultSvc Choice Full, Restricted, None Policy that allows the service
ProvAdmin provider administrator access to
Dialable Dialable Caller ID (Full, Read-
CallerID only, or No access).
Access>

11.19.3 CallProcessing
This level is used to manage call processing policies.

11.19.3.1 CallLimits
This level is used to view and modify the Call Limits policy-related attributes at the system-level.
11.19.3.1.1 get
This command is used to view the Call Limits policy-related attributes at the system-level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/CallProcessing/CallLimits>
level.
2) Enter:
get↵
11.19.3.1.2 set
This command is used to modify the Call Limits policy-related attributes at the system-level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/CallProcessing/CallLimits>
level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 791
 Variable Field Type Valid Values Description

<attribute> MultipleChoice defaultUseMaxCallTimeFor The name of an attribute to

UnansweredCalls, defaultMax modify.
CallTimeForUnansweredCallsIn
Minutes, defaultUseMaxNumber
SimultaneousVideoCalls, default
MaxNumberSimultaneousVideo
Calls, defaultUseMaxCallTime
ForAnsweredCalls, defaultMax
CallTimeForAnsweredCalls
InMinutes, defaultUseMax
NumberSimultaneousCalls,
defaultMaxNumberSimultaneous
Calls, defaultUseMaxNumber
ConcurrentRedirectedCalls,
defaultMaxNumberConcurrent
RedirectedCalls, defaultUse
MaxFindMeFollowMeDepth,
defaultMaxFindMeFollowMe
Depth, defaultMaxRedirection
Depth, defaultUseMaxNumber
ConcurrentFindMeFollowMe
Invocations, defaultMaxNumber
ConcurrentFindMeFollowMe
Invocations

<default Integer 1 through 999999 Specifies the maximum number

MaxNumber of simultaneous calls per user.
Simultaneous The default value is 10.
Calls>

<defaultUse Choice true, false Enables or disables the Default

MaxNumber Max Number Simultaneous Calls
Simultaneous attribute.
Calls>

<default Integer 1 through 999999 Enables or disables the Group

MaxNumber User Enhanced Call Logs Access
Simultaneous attribute.
VideoCalls>

<defaultUse Choice true, false Specifies the maximum number

MaxNumber of simultaneous video calls per
Simultaneous user. A value of 0 indicates an
VideoCalls> unlimited number of simultaneous
calls. The default is 0 (unlimited).

<defaultMax Integer 3 through 2880 Indicates, in minutes, the

CallTimeFor maximum call time for an
AnsweredCalls answered call. The default value
InMinutes> is 600 minutes.

<defaultUse Choice true, false Enables or disables the Default

MaxCallTime Max Call Time For Answered
ForAnswered Calls In Minutes attribute.
Calls>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 792
 Variable Field Type Valid Values Description

<defaultMax Integer 1 through 2880 Indicates in minutes the

CallTimeFor maximum call time for an
Unanswered unanswered call.
CallsIn
Minutes>

<defaultUse Choice true, false Enables or disables the ability

MaxCall of the administrator to specify
TimeFor a maximum call time for an
Unanswered unanswered call.
Calls>

<defaultUse Choice true, false When enabled, the administrator

MaxNumber can change the limit of
Concurrent simultaneous redirections.
Redirected
Calls>

<default Integer 1 through 999999 Specifies the limit of simultaneous

MaxNumber redirections for each subscriber.
Concurrent
Redirected
Calls>

<defaultUse Choice true, false When enabled, the administrator

MaxFindMe can change the cascading limit of
FollowMe forking services.
Depth>

<defaultMax Integer 1 through 100 Specifies the cascading limit of

FindMeFollow forking services (Simultaneous
MeDepth> Ringing and Sequential Ringing).

<defaultMax Integer 1 through 100 Specifies the maximum number

Redirection of cascaded redirections.
Depth>

<defaultUse Choice true, false When enabled, the administrator

MaxNumber can limit the number of
ConcurrentFind simultaneous invocations of Find
MeFollowMe Me/Follow Me services. These
Invocations> services include Simultaneous
Ringing, Sequential Ringing, and
Remote Office.

<default Integer 1 through 999999 Specifies the limit of simultaneous

MaxNumber invocations of Find Me/Follow Me
ConcurrentFind services.
MeFollowMe
Invocations>

11.19.3.2 CallingLineId
This level is used to view or modify CallingLineId-related attributes.
11.19.3.2.1 get
This command is used to view CallingLineId Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/CallProcessing/CallingLineId>
level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 793
 get↵
11.19.3.2.2 set
This command is used to modify CallingLineId Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/CallProcessing/CallingLineId>
level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice defaultCLIDPolicy, default The name of an attribute to

EnterpriseCallsCLIDPolicy, modify.
defaultEnterpriseGroupCallsCLID
Policy, defaultServiceProvider
GroupCallsCLIDPolicy, default
EmergencyCLIDPolicy, default
AllowAlternateNumbersFor
RedirectingIdentity, defaultBlock
CallingNameForExternalCalls,
defaultAllowConfigurableCLIDFor
RedirectingIdentity

<defaultCLID Choice useDN, useConfigurableCLID Indicates which CLID policy

Policy> should be used as the default.

<default Choice useExtension, useLocationCode Determines which Internal Call

Enterprise PlusExtension, useDefaultCLID Calling Line ID (CLID) policy is
CallsCLID Policy used as the default for inter-group
Policy> calls within an enterprise.

<default Choice useExtension, useLocationCode Determines which Internal Call

Enterprise PlusExtension, useDefaultCLID Calling Line ID (CLID) policy is
Group Policy used as the default for intra-group
CallsCLID calls within an enterprise.
Policy>

<defaultService Choice useExtension, useDefaultCLID Determines which Internal Call

ProviderGroup Policy Calling Line ID (CLID) policy is
CallsCLID used as the default for intra-group
Policy> calls within a service provider.

<default Choice useDN, useConfigurableCLID Indicates which CLID policy

EmergencyCLID should be used as the default for
Policy> emergency calls.

<defaultAllow Choice true, false Indicates if alternate numbers can

Alternate be used as identity for redirected
NumbersFor calls.
Redirecting
Identity>

<defaultBlock Choice true, false Default system setting for

CallingName blocking Calling Name for
ForExternal external calls.
Calls>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 794
 Variable Field Type Valid Values Description

<defaultAllow Choice true, false Indicates if the configurable

ConfigurableCLID calling line id can be used as
ForRedirecting identity for redirected calls.
Identity>

11.19.3.3 Conferencing
This level is used to view, add, modify, and clear Conferencing-related attributes.
11.19.3.3.1 get
This command is used to view Conferencing Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/CallProcessing/Conferencing>
level.
2) Enter:
get↵
11.19.3.3.2 set
This command is used to modify Conferencing Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/CallProcessing/Conferencing>
level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice maxConferenceParties, The name of an attribute to

conferenceURI modify.

<max Integer 4 through 15 The maximum number of parties

Conference allowed in a conference call.
Parties>

<conferenceURI> String 1 to 161 characters The conference URI, which

is used to identify an INVITE
request for a BroadWorks
conference resource. It is used
for Three-Way and N-Way calls.

11.19.3.3.3 clear
This command is used to clear Conferencing Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/CallProcessing/Conferencing>
level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice conferenceURI The name of the attribute(s) to

clear.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 795
11.19.3.4 DialableCallerID
This level is used to view and modify DialableCallerID-related attributes.
11.19.3.4.1 get
This command is used to view DialableCallerID Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/CallProcessing/
DialableCallerID> level.
2) Enter:
get↵
11.19.3.4.2 set
This command is used to modify DialableCallerID Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/CallProcessing/
DialableCallerID> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled The name of an attribute to

modify.

<enabled> Choice true, false Shows whether the Dialable

Caller ID service is enabled at the
System level.

11.19.3.5 Media
This level is used to view, add, modify, and clear Media -related attributes.
11.19.3.5.1 get
This command is used to view Media Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/CallProcessing/Media> level.
2) Enter:
get↵
11.19.3.5.2 set
This command is used to modify Media Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/CallProcessing/Media> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice defaultMediaPolicy, default The name of an attribute to

SupportedMediaSet modify.

<defaultMedia Choice forceUncompressedCodec, use Specifies the default media

Policy> SupportedMedia, noRestriction policy.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 796
 Variable Field Type Valid Values Description

<default String 1 to 80 characters Specifies the default supported

Supported media set.
MediaSet>

11.19.3.5.3 clear
This command is used to clear Media Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/CallProcessing/Media> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice defaultSupportedMediaSet The name of the attribute(s) to

clear.

11.19.3.6 RoutingXLA
This level is used to view, add, modify, and clear RoutingXLA -related attributes.
11.19.3.6.1 get
This command is used to view RoutingXLA Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/CallProcessing/RoutingXLA>
level.
2) Enter:
get↵
11.19.3.6.2 set
This command is used to modify RoutingXLA Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/CallProcessing/RoutingXLA>
level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice defaultNetworkUsage, default The name of an attribute to

AllowEnterpriseGroupCallTyping modify.
ForPrivateDialingPlan, default
AllowEnterpriseGroupCallTyping
ForPublicDialingPlan, default
OverrideCLIDRestrictionFor
PrivateCallCategory, default
EnableEnterpriseExtension
Dialing, defaultEnforceGroup
CallingLineIdentityRestriction,
defaultEnforceEnterpriseCalling
LineIdentityRestriction, default
UseEnterpriseCLIDForPrivateCall
Category

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 797
 Variable Field Type Valid Values Description

<default Choice forceAllCalls, noForceEntGroup When set to "forceAllCalls",

Network Calls, noForceExtAndLoc this choice forces all calls
Usage> to use the network. When
set to "noForceExtAndLoc",
this choice forces all none-
location+extension calls to
use the network. When set to
"noForceEntGroupCalls", this
choice forces all non-extension
calls to use the network.

<defaultAllow Choice true, false Specifies whether the Allow

Enterprise Enterprise Group Call Typing For
GroupCall Private Dialing Plan feature is
TypingFor enabled by default.
PrivateDialing
Plan>

<defaultAllow Choice true, false Specifies whether the default

Enterprise value for the Allow Enterprise
GroupCall Group Call Typing For Public
TypingFor Dialing Plan feature is enabled or
PublicDialing disabled.
Plan>

<default Choice true, false Specifies whether the default

OverrideCLID value for the Override CLID
RestrictionFor Restriction For Private Call
PrivateCall Category feature is enabled or
Category> disabled.

<defaultEnable Choice true, false Specifies whether the Enable

Enterprise Enterprise Extension Dialing
Extension feature is enabled by default.
Dialing>

<defaultEnforce Choice true, false When enabled, this attribute

Enterprise enforces enterprise calling line
CallingLine identity restrictions.
Identity
Restriction>

<defaultEnforce Choice true, false When enabled, this attribute

GroupCalling enforces group calling line identity
LineIdentity restrictions.
Restriction>

<defaultUse Choice true, false Specifies whether the default

EnterpriseCLID value for the Use Enterprise CLID
ForPrivateCall for Private Call Category feature
Category> is enabled or disabled.

11.19.4 DialPlan
This level is used to view and modify Dial Plan policy-related attributes.

11.19.4.1 get
This command is used to view Dial Plan Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/DialPlan> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 798
 2) Enter:
get↵

11.19.4.2 set
This command is used to modify Dial Plan Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/DialPlan> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice requiresAccessCodeForPublic The name of an attribute to

Calls, allowE164PublicCalls, modify.
preferE164FormatForCallback
Services, publicDigitMap, private
DigitMap

<requires Choice true, false Determines whether dialing an

AccessCode access code is enforced for public
ForPublicCalls> calls. Typically, this is enforced
by the Network Server Voice
VPN policy. However, this allows
the implementation of a non-
permissive private dial plan for
smaller enterprises without the
need to configure the Voice VPN
policy on the Network Server.

<allowE164 Choice true, false Determines whether E.164

PublicCalls> addresses are allowed for public
calls regardless of the non-
permissive option setting. This
option is only relevant when the
non-permissive option is set.

<preferE164 Choice true, false If set to "true", E.164 formatted

FormatFor callback numbers are not
Callback transformed into a national-
Services> prefixed number by the callback
services.

<publicDigit String 1 to 2048 characters The digit maps are sent by the
Map> Application Server in the context
of a call origination from an
MGCP device or a call origination
that involves the Media Server for
digit collection. This digit map is
mandatory.

<privateDigit String 1 to 2048 characters This digit map is optional, but

Map> must be configured if the Enabled
secondary dial tone option of an
access code is set.

11.19.4.3 clear
This command is used to clear (set to no value) Dial Plan policy-related attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 799
 1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/DialPlan> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice privateDigitMap The name of the attribute(s) to

clear.

11.19.4.4 AccessCodes
This level is used to view and modify Dial Plan policy access code attributes. System-wide access codes
are used for all users in the system unless overridden by different access codes at the service provider or
group level.
11.19.4.4.1 get
This command is used to view Dial Plan policy access code attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/DialPlan/AccessCodes> level.
2) Enter:
get↵
11.19.4.4.2 detail
This command is used to view Dial Plan Policy Access Codes details.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/DialPlan/AccessCodes> level.
2) Enter:
detail <accessCode>↵
where:
Variable Field Type Valid Values Description

<accessCode> String 1 to 5 characters The network access code for an

outside line.

11.19.4.4.3 add
This command is used to add new Dial Plan policy access code.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/DialPlan/AccessCodes> level.
2) Enter:
add <accessCode> <includeCodeForNetworkTranslationsAndRouting>
<includeCodeForScreeningServices> <enableSecondaryDialTone> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<accessCode> String 1 to 5 characters The network access code for an

outside line.

<includeCode Choice true, false Determines whether the access

ForNetwork code should be included as
Translations part of the dialed digits for the
AndRouting> purpose of network translations
and routing.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 800
 Variable Field Type Valid Values Description

<includeCode Choice true, false Determines whether the access

ForScreening code should be included as part
Services> of the dialed digits for the purpose
of call screening (for example,
Outgoing Digit Plan and Outgoing
Calling Plan).

<enable Choice true, false Determines whether secondary

SecondaryDial dial tone is applicable for calls
Tone> initiated from an MGCP device
or for call originations that
involve the Media Server for
digit collection. If this attribute is
set, then the private digit map is
initially used for digit collection.
This attribute cannot be set
unless a private digit map is
configured.

<attribute> MultipleChoice description Additional attributes to include

through the add command.

<description> String 1 to 80 characters The description of the access

code.

11.19.4.4.4 set
This command is used to modify Dial Plan policy access code-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/DialPlan/AccessCodes> level.
2) Enter:
set <accessCode> <attribute>↵
where:
Variable Field Type Valid Values Description

<accessCode> String 1 to 5 characters The network access code for an

outside line.

<attribute> MultipleChoice includeCodeForNetwork The name of an attribute to

TranslationsAndRouting, include modify.
CodeForScreeningServices,
enableSecondaryDialTone,
description

<includeCode Choice true, false Determines whether the access

ForNetwork code should be included as
Translations part of the dialed digits for the
AndRouting> purpose of network translations
and routing.

<includeCode Choice true, false Determines whether the access

ForScreening code should be included as part
Services> of the dialed digits for the purpose
of call screening (for example,
Outgoing Digit Plan and Outgoing
Calling Plan).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 801
 Variable Field Type Valid Values Description

<enable Choice true, false Determines whether secondary

SecondaryDial dial tone is applicable for calls
Tone> initiated from an MGCP device
or for call originations that
involve the Media Server for
digit collection. If this attribute is
set, then the private digit map is
initially used for digit collection.
This attribute cannot be set
unless a private digit map is
configured.

<description> String 1 to 80 characters The description of the access

code.

11.19.4.4.5 delete
This command is used to delete an existing Dial Plan Policy access code.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/DialPlan/AccessCodes> level.
2) Enter:
delete <accessCode>↵
where:
Variable Field Type Valid Values Description

<accessCode> String 1 to 5 characters The network access code to be

deleted.

11.19.4.4.6 clear
This command is used to clear (set to no value) Dial Plan Policy access code-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/DialPlan/AccessCodes> level.
2) Enter:
clear <accessCode> <attribute>↵
where:
Variable Field Type Valid Values Description

<accessCode> String 1 to 5 characters The network access code.

<attribute> MultipleChoice description The name of the attribute(s) to

clear.

11.19.5 Multimedia
This level is used to view and modify existing Multimedia policies.

11.19.5.1 get
This command is used to view existing Multimedia policies.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/Multimedia> level.
2) Enter:
get↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 802
11.19.5.2 set
This command is used to modify the attributes of a Multimedia policy.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/Multimedia> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice restrictNonAudioVideoMedia The name of an attribute to

Types modify.

<restrictNon Choice true, false restrictNonAudioVideoMediaTypes

AudioVideo controls feature enable/disable.
MediaTypes>

11.19.5.3 Media
This level allows system administrators to add, delete, and modify media type policies. System
administrators can provision which media (codec) a subscriber is permitted to use. These media type
policies are added to media sets that can be applied to a subscriber, group, service provider/enterprise,
and system levels.
11.19.5.3.1 get
This command is used to view existing media type policies.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/Multimedia/Media> level.
2) Enter:
get↵
11.19.5.3.2 add
This command is used to add new media type policy to the system.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/Multimedia/Media> level.
2) Enter:
add <name> <codec> <mediaType> <bandwidthEnforcementType>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters Specifies the name of the media

type policy.

<codec> String 1 to 80 characters Indicates the name of the

audio or video codec (that is,
G.711, G.722, H.263, or H.264)
associated with this media type
policy.

<mediaType> String 1 to 127 characters The media-type to accept in

the context of Call Processing
policies, as it appears in SIP
messages.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 803
 Variable Field Type Valid Values Description

<bandwidth Choice allowAll, allowUnspecified, When set to "allowAll", the

Enforcement enforceAll bandwidth is not checked even
Type> if bandwidth value has been
provisioned for this codec. When
set to "allowUnspecified", the
codec has been provisioned with
a bandwidth requirement, but it is
only enforced when the Transport
Independent Application Specific
(TIAS) parameter is in the offer/
answer Session Description
Protocol (SDP). When set
to "enforceAll", enforces he
bandwidth requirement that has
been provisioned with the codec.
If the TIAS parameter is not
present in the SDP the codec
validation fails.

Variable: allowUnspecified

allowUnspecified Configuration of options.

<bandwidthIn Integer 1 through 100000000 Specifies the bandwidth limit for

BitsPerSec> this codec.

Variable: enforceAll

enforceAll Configuration of options.

<bandwidthIn Integer 1 through 100000000 Specifies the bandwidth limit for

BitsPerSec> this codec.

11.19.5.3.3 set
This command is used to modify the attributes of an existing media type policy.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/Multimedia/Media> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters Specifies the name of the media

type policy.

<attribute> MultipleChoice codec, bandwidthEnforcement The name of an attribute to

Type, bandwidthInBitsPerSec modify.

<codec> String 1 to 80 characters Indicates the name of the

audio or video codec (that is,
G.711, G.722, H.263, or H.264)
associated with this media type
policy.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 804
 Variable Field Type Valid Values Description

<bandwidth Choice allowAll, allowUnspecified, When set to "allowAll", the

Enforcement enforceAll bandwidth is not checked even
Type> if bandwidth value has been
provisioned for this codec. When
set to "allowUnspecified", the
codec has been provisioned with
a bandwidth requirement, but it is
only enforced when the Transport
Independent Application Specific
(TIAS) parameter is in the offer/
answer Session Description
Protocol (SDP). When set
to "enforceAll", enforces he
bandwidth requirement that has
been provisioned with the codec.
If the TIAS parameter is not
present in the SDP the codec
validation fails.

<bandwidthIn Integer 1 through 100000000 Specifies the bandwidth limit for

BitsPerSec> this codec.

11.19.5.3.4 delete
This command is used to delete an existing media type policy from the system.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/Multimedia/Media> level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters Specifies the name of the media

type policy.

11.19.5.3.5 clear
This command is used to clear the bandwidthInBits attribute from an existing media type policy.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/Multimedia/Media> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters The name of an attribute to

modify.

<attribute> MultipleChoice bandwidthInBitsPerSec The name of the attribute(s) to

clear.

11.19.5.4 MediaSet
This level allows system administrators to add, delete, and modify media sets. Administrators can also add
or remove media (codecs) from existing media sets. A sample list of media/codec sets is provided below.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 805
11.19.5.4.1 get
This command is used to view media sets currently available.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/Multimedia/MediaSet> level.
2) Enter:
get↵
11.19.5.4.2 detail
This command is used to view specific media set attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/Multimedia/MediaSet> level.
2) Enter:
detail <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters The name of the media set.

11.19.5.4.3 add
This command is used to add a new media set to the system.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/Multimedia/MediaSet> level.
2) Enter:
add <name> <media>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters The name of the media set.

<media> String 1 to 80 characters The name of the media.

11.19.5.4.4 delete
This command is used to delete a media set from the system.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/Multimedia/MediaSet> level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters The name of the media set.

11.19.5.4.5 addMedia
This command is used to add media to an existing media set.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/Multimedia/MediaSet> level.
2) Enter:
addMedia <name> <media> <locationInSet>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 806
 Variable Field Type Valid Values Description

<name> String 1 to 80 characters The name of the media set.

<media> String 1 to 80 characters The name of the media.

<locationInSet> Choice top, bottom Specifies the location within the

media set to add new media.

11.19.5.4.6 deleteMedia
This command is used to delete media from an existing media set.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/Multimedia/MediaSet> level.
2) Enter:
deleteMedia <name> <media>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters The name of the media set.

<media> String 1 to 80 characters The name of the media.

11.19.5.4.7 reorderMedia
This command is used to reorder media in the media set.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Policy/Multimedia/MediaSet> level.
2) Enter:
reorderMedia <name> <media> <reorderAction>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters The name of the media set.

<media> String 1 to 80 characters The name of the media.

<reorder Choice up, down Reorders the media in the media

Action> set in ascending or descending
order.

11.20 ServicePackMigration
This level is used to view and modify system level Service Pack Migration attributes.

11.20.1 get
This command is used to view system level Service Pack Migration attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServicePackMigration> level.
2) Enter:
get↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 807
11.20.2 set
This command is used to modify system level Service Pack Migration attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServicePackMigration> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice maxSimultaneousMigrationTasks The name of an attribute to

modify.

<max Integer 1 through 10 This parameter determines

Simultaneous the maximum number of
Migration simultaneously running service
Tasks> pack migration tasks.

11.21 ServiceProvider
Service provider-related attributes, such as the service provider name and the service provider profile
containing the address, contact information, password rules, and so on, are accessed using this command.

11.21.1 get
If you use the Get command alone, a list of all service providers will be displayed. If you use the Get
command to locate a specific service provider, that service provider's profile will appear.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider> level.
2) Enter:
get <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice svcProviderIdStarts, svcProvider The name of an attribute to filter

IdContains, svcProviderIdEquals, on.
svcProviderNameStarts, svc
ProviderNameContains, svc
ProviderNameEquals

<svcProviderId String 0 to 30 characters Return all the Service Provider

Starts> with the Service Provider ID that
start with a specific string.

<svcProviderId String 0 to 30 characters Return all the Service Provider

Contains> with the Service Provider ID that
contain with a specific string.

<svcProviderId String 1 to 30 characters Return a specific Service Provider

Equals> based on the Service Provider ID.

<svcProvider String 0 to 80 characters Return all the Service Provider

NameStarts> with the Service Provider Name
that start with a specific string.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 808
 Variable Field Type Valid Values Description

<svcProvider String 0 to 80 characters Return all the Service Provider

Name with the Service Provider Name
Contains> that contain with a specific string.

<svcProvider String 1 to 80 characters Return a specific Service Provider

NameEquals> based on the Service Provider
Name.

11.21.2 detail
This command is used to view details of the specified service provider or enterprise profile.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider> level.
2) Enter:
detail <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

11.21.3 add
When adding a new service provider to the system, the service provider ID used by the system, the
company name, the contact's name, phone number, and e-mail address, and the support e-mail address
can be set.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider> level.
2) Enter:
add <svcProviderId> <enterpriseFlag> <false> <defaultDomainName> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider.

Id> If the "enterpriseFlag" variable
below is set to "true", this ID must
be unique across all networked
Application Server clusters.

<enterprise Choice true, false When set to "true", indicates

Flag> if the service provider is an
enterprise. When set to "false",
indicate the service provider
is not an enterprise. The
useCustomRoutingProfile
attribute is only enabled when
enterpriseFlag is set to false.

<false>

<defaultDomain String 2 to 80 characters Specifies the default domain

Name> name.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 809
 Variable Field Type Valid Values Description

<attribute> MultipleChoice svcProviderName, contact Additional attributes to include

Name, contactNumber, contact through the add command.
Email, supportEmail, address
Line1, addressLine2, city, state
OrProvince, zipOrPostalCode,
country

<svcProvider String 1 to 80 characters The name of the service provider.

Name>

<contactName> String 1 to 30 characters The name of the contact person

for this service provider.

<contact String 1 to 30 characters The phone number of the contact

Number> person for this service provider.

<contactEmail> String 1 to 80 characters The e-mail address of the contact

person for this service provider.

<supportEmail> String 1 to 80 characters The e-mail of the person

responsible for support.

<address String 1 to 80 characters The first line of the service

Line1> provider address.

<address String 1 to 80 characters The second line of the service

Line2> provider address.

<city> String 1 to 50 characters The city of the service provider.

<stateOr String 1 to 50 characters The state or province of the

Province> service provider.

<zipOrPostal String 1 to 50 characters The zip or postal code of the

Code> service provider.

<country> String 1 to 50 characters The country of the service

provider.

11.21.4 set
Service provider-related attributes, such as the company name, the contact's name, phone number, e-mail
address and a support e-mail address, and so on, are changed using this command. The service provider
ID is used to identify the record to be changed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider> level.
2) Enter:
set <svcProviderId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 810
 Variable Field Type Valid Values Description

<attribute> MultipleChoice svcProviderName, defaultDomain The name of an attribute to

Name, useServiceProvider modify.
Languages, contactName,
contactNumber, contactEmail,
supportEmail, addressLine1,
addressLine2, city, stateOr
Province, zipOrPostalCode,
country

<svcProvider String 1 to 80 characters The name of the service provider.

Name>

<defaultDomain String 2 to 80 characters The default domain name.

Name>

<useService Choice true, false Controls supported languages

Provider for a service provider. When set
Languages> to "true", languages at service
provider level are used. When set
to "false", languages at system
level are used.

<contactName> String 1 to 30 characters The name of the contact person

for this service provider.

<contact String 1 to 30 characters The phone number of the contact

Number> person for this service provider.

<contactEmail> String 1 to 80 characters The e-mail address of the contact

person for this service provider.

<supportEmail> String 1 to 80 characters The e-mail of the person

responsible for support.

<address String 1 to 80 characters The first line of the service

Line1> provider address.

<address String 1 to 80 characters The second line of the service

Line2> provider address.

<city> String 1 to 50 characters The city of the service provider.

<stateOr String 1 to 50 characters The state or province of the

Province> service provider.

<zipOrPostal String 1 to 50 characters The zip or postal code of the

Code> service provider.

<country> String 1 to 50 characters The country of the service

provider.

11.21.5 delete
Service providers can be deleted using this command. The unique service provider name is used to delete
the associated record.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 811
 delete <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

11.21.6 clear
Service provider-related attributes, such as the company name, the contact's name, phone number, e-mail
address and a support e-mail address, and so on, are cleared using this command.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider> level.
2) Enter:
clear <svcProviderId> <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

<clearAttribute> MultipleChoice svcProviderName, contact The name of the attribute(s) to

Name, contactNumber, contact clear.
Email, supportEmail, address
Line1, addressLine2, city, state
OrProvince, zipOrPostalCode,
country

11.21.7 Administrator
This level allows for the configuration of service provider administrators.

11.21.7.1 get
Service provider administrator-related attributes, such as the corresponding service provider, the service
provider administrator's user ID, first name, and last names are viewed using this command.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Administrator> level.
2) Enter:
get <svcProviderId> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

<attribute> MultipleChoice userId, lastName, firstName, The name of an attribute to filter

language on.

<userId> String 2 to 80 characters The user ID for the service

provider administrator.

<lastName> String 1 to 30 characters The service provider

administrator's last name.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 812
 Variable Field Type Valid Values Description

<firstName> String 1 to 30 characters The service provider

administrator's first name.

<language> String 1 to 40 characters The service provider's supported

language.

11.21.7.2 add
When adding a new service provider administrator to the system, the corresponding service provider
administrator's user ID, first name, and last names are set. You are prompted for password information.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Administrator> level.
2) Enter:
add <svcProviderId> <userId> <adminType> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider.

Id>

<userId> String 2 to 80 characters The user ID for the service

provider administrator.

<adminType> Choice normal, customer, password When set to "normal", the

ResetOnly service provider administrator
has all standard access rights
and privileges. When set to
"customer", the customer
administrator only has access
to the Group, User, and Change
Password web portal pages.
Also, the customer administrator
has no access to Call Capacity
and has read-only access to
Intercept Group pages. When
set to "passwordResetOnly", this
value allows the service provider
administrator to reset the user's
web and portal password only.

<attribute> MultipleChoice lastName, firstName, language Additional attributes to include

through the add command.

<lastName> String 1 to 30 characters The service provider

administrator's last name.

<firstName> String 1 to 30 characters The service provider

administrator's first name.

<language> String 1 to 40 characters The service provider's supported

language.

11.21.7.3 set
Service provider administrator-related attributes, such as the first and last names, are changed using this
command. The unique user ID combination is used to identify the record to be changed.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 813
 1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Administrator> level.
2) Enter:
set <userId> <attribute>↵
where:
Variable Field Type Valid Values Description

<userId> String 2 to 80 characters The user ID for the service

provider administrator.

<attribute> MultipleChoice lastName, firstName, password, The name of an attribute to

language modify.

<lastName> String 1 to 30 characters The service provider

administrator's last name.

<firstName> String 1 to 30 characters The service provider

administrator's first name.

<language> String 1 to 40 characters The service provider's supported

language.

11.21.7.4 delete
Service provider administrators can be deleted using this command. The unique user ID/service provider
combination is used to delete the associated record.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Administrator> level.
2) Enter:
delete <userId>↵
where:
Variable Field Type Valid Values Description

<userId> String 2 to 80 characters The user ID for the service

provider administrator.

11.21.7.5 clear
Service provider administrator-related attributes, such as the first and last names, are cleared using this
command.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Administrator> level.
2) Enter:
clear <userId> <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<userId> String 2 to 80 characters The user ID for the service

provider administrator.

<clearAttribute> MultipleChoice lastName, firstName The name of the attribute(s) to

clear.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 814
11.21.7.6 Policy
This level is used to view and modify service provider administrator policy-related attributes.
11.21.7.6.1 get
This command is used to view service provider administrator policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Administrator/
Policy> level.
2) Enter:
get <userId>↵
where:
Variable Field Type Valid Values Description

<userId> String 2 to 161 characters The user ID for the service

provider administrator.

11.21.7.6.2 set
This command is used to modify service provider administrator policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Administrator/
Policy> level.
2) Enter:
set <userId> <attribute>↵
where:
Variable Field Type Valid Values Description

<userId> String 2 to 161 characters The user ID for the service

provider administrator.

<attribute> MultipleChoice profileAccess, groupAccess, The name of an attribute to

userAccess, adminAccess, dept modify.
Access, deviceAccess, network
PolicyAccess, numberExtension
Access, callingLineIdNumber
Access, serviceAccess, service
PackAccess, webBranding
Access, officeZoneAccess,
sessionAdmissionControlAccess,
communicationBarringAccess,
numberActivationAccess, dialable
CallerIDAccess, verifyTranslation
AndRoutingAccess

<profile Choice Full, Restricted, None Policy that allows the service
Access> provider administrator access
to service provider profile (Full,
Read-only, or No access).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 815
 Variable Field Type Valid Values Description

<groupAccess> Choice Full, Restricted, None Policy that allows the service
provider administrator:full access
to groups (default).Restricted
from adding or removing groups:
The add/add wizard button on
the Service Provider: Profile ->
Groups page will not be shown.
The delete button on the Group:
Profile -> Profile will not be
shownNo Access to groups;
The Service Provider: Profile ->
Groups will not be shown on the
Profile menu.

<userAccess> Choice Full, Restricted-FullProfile, Policy that allows the service

Restricted-ReadProfile,
Restricted-NoProfile, None
provider administrator:full access
to users (default).Restricted from
adding or removing users; full
access to user profile. Restricted
from adding or removing users;
read-only access to user profile.
Restricted from adding or
removing users; no access to
user profile.No Access to users;
The Service Provider: Profile ->
Users will not be shown on the
Profile menu.

<admin Choice Full, Restricted, None Policy that allows the service
Access> provider administrator access to
service provider administrators
(Full, Read-only or no access).

<deptAccess> Choice Full, Restricted, None Policy that allows the service
provider administrator full
access to departments (default),
Restricted from adding or
removing departments, or No
Access to departments.

<device Choice Full, Restricted, Restricted-No Policy that allows the service
Access> UserAssociation provider administrator full access
to devices (default), or read-only
access to devices.

<networkPolicy Choice Full, None Policy that allows an enterprise

Access> administrator full or no access to
Voice VPN configuration. Does
not apply to service providers.

<number Choice Full, Restricted-NoGroup, Policy that allows the service

Extension Restricted provider administrator full access
Access> to Numbers (default), or Read-
only access to Numbers.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 816
 Variable Field Type Valid Values Description

<callingLine Choice Full, Restricted Policy that allows the service

IdNumber provider administrator full or no
Access> access to Calling Line Id Number
configuration.

<service Choice Full, Restricted-NoAuthorize, Policy that allows the service

Access> Restricted provider administrator full access
to services (default), restricts the
ability to authorize services to
a group, and restricts access of
services to Read-only.

<servicePack Choice Full, None Policy that allows the service

Access> provider administrator full access
to service packs (default) or No
access to service packs.

<webBranding Choice Full, None Policy that allows the service

Access> provider administrator full access
to Web Branding (default), or No
access to Web Branding.

<officeZone Choice Full, Restricted Policy that allows the service

Access> provider administrator full or
Read-only access to office zones
configuration.

<session Choice Full, Restricted, None Policy that allows the service
Admission provider administrator full, Read-
ControlAccess> only or no access to session
admission control configuration.

<communication Choice Full, Restricted Policy that allows or restricts

BarringAccess> the service provider/enterprise
administrator from accessing
communication barring settings
at the Service Provider and lower
levels.

<number Choice Full, Restricted, None Policy that allows or restricts the
Activation enterprise administrator from
Access> activating phone numbers at the
group level. Does not apply to
service provider administrators.

<dialable Choice Full, Restricted, None Policy that allows or restricts the
CallerID service provider administrator
Access> full, restricted, or no access to
dialable caller id.

<verify Choice Full, None Policy that allows the service

Translation provider administrator full
AndRouting or no access to the web
Access> verify translation and routing
functionality.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 817
11.21.8 Announcements
This level is used to load custom announcements in for a service provider.

11.21.8.1 scan
This command is used to scan the audio file system for new announcements for a Service Provider.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Announcements> level.
2) Enter:
scan <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

11.21.9 AuthenticationPasswordRules
This level is used to manage Authentication Password Rules.

11.21.9.1 DeviceProfile
This level is used to view and modify the device profile authentication password rules.
11.21.9.1.1 get
This command is used to view the device profile authentication password-related attributes for service
providers, such as the allowable authentication failures, minimum password length, whether the
authentication name can be used as a password, and whether passwords can contain numbers or
symbols, and so on.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
AuthenticationPasswordRules/DeviceProfile> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider Id.

Id>

11.21.9.1.2 set
This command is used to modify the device profile authentication password-related attributes for
service providers, such as the allowable authentication failures, minimum password length, whether
the authentication name can be used as a password, and whether passwords can contain numbers or
symbols, and so on.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
AuthenticationPasswordRules/DeviceProfile> level.
2) Enter:
set <svcProviderId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider Id.

Id>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 818
 Variable Field Type Valid Values Description

<attribute> MultipleChoice useServiceProviderSetting, The name of the attribute to

containNonAlphaNumChars, modify.
containNonAlphaNum, contain
LowerAlphaChars, contain
LowerAlpha, containUpperAlpha
Chars, containUpperAlpha,
containNumberChars, contain
Number, notReverseOfOld
Password, notOldPassword, not
AuthenticationName, minimum
Length, sendPermanentLockout
Notification, permanentLockout
NotifyEmailAddress, deviceProfile
AuthenticationLockoutType,
deviceProfileTemporaryLockout
Threshold, deviceProfileWait
Algorithm, deviceProfileLockout
FixedMinutes, deviceProfile
PermanentLockoutThreshold

<useService Choice true, false When set to "true" the service

Provider provider device profile
Setting> authentication settings are used.
When set to "false", the system
settings are used.

<containNon Integer 1 through 10 The number of non-alphanumeric

AlphaNum characters that must be present
Chars> in the password.

<containNon Choice true, false When set to "false", the password

AlphaNum> does not have to contain non-
alphanumeric characters. When
set to "true", the password
must contain non-alphanumeric
characters.

<containLower Integer 1 through 10 The number of lower case

AlphaChars> alphabetic characters the
password must contain.

<containLower Choice true, false When set to "false", the password

Alpha> does not have to contain lower-
case alphabetic characters. When
set to "true", the password must
contain lower-case alphabetic
characters.

<containUpper Integer 1 through 10 The number of upper-case

AlphaChars> alphabetic characters the
password must contain.

<containUpper Choice true, false When set to "false", the password

Alpha> does not have to contain upper-
case alphabetic characters. When
set to "true", the password must
contain upper-case alphabetic
characters.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 819
 Variable Field Type Valid Values Description

<contain Integer 1 through 10 The number of numeric

NumberChars> characters the password must
contain.

<contain Choice true, false When set to "false", the password

Number> does not have to contain numeric
characters. When set to "true",
the password must contain
numeric characters.

<not Choice true, false When set to "false", the password

Authentication can be the same as the
Name> authentication name. When set
to "true", the password must be
different from the authentication
name.

<notOld Choice true, false When set to "false", the password

Password> is allowed to be the previous
password. When set to "true", the
password cannot be the previous
password.

<notReverseOf Choice true, false When set to "false", the password

OldPassword> is allowed to be the reverse
characters of the previous
password. When set to "true", the
password cannot be the reverse
characters of the previous
password.

<minimum Integer 3 through 40 The minimum length allowed for

Length> passwords.

<send Choice true, false When set to "false", do not

Permanent send notice of a permanent
Lockout authentication lockout. When
Notification> set to "true", send notice that a
permanent authentication lockout
has occurred.

<permanent String 1 to 80 characters E-mail address to which

LockoutNotify notification is sent when a
EmailAddress> permanent authentication lockout
occurs.

<deviceProfile Choice never, temporary, permanent The method of authentication

Authentication disabling to use. When set to
LockoutType> never, authentication is not
disabled. When set to temporary,
only temporary lockouts are
used. When set to permanent,
both temporary and permanent
lockouts are used.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 820
 Variable Field Type Valid Values Description

<deviceProfile Integer 1 through 10 The number of authentication

Temporary failures allowed before temporary
Lockout lockout occurs.
Threshold>

<deviceProfile Choice double, fixed The method of timeout to

WaitAlgorithm> use for lockouts. When
set to Fixed, the lockout
duration is specified by the
deviceProfileLockoutFixedMinutes
setting. When set to Double,
the lockout timeout starts at 5
minutes and doubles with each
successive invalid authentication.

<deviceProfile Choice 5, 10, 20, 40, 60 When authentication is

LockoutFixed temporarily locked out, the
Minutes> time in minutes to wait after
each additional authentication
attempt. Applies only when
deviceProfileWaitAlgorithm is set
to Fixed.

<deviceProfile Integer 2 through 10 When authentication is

Permanent temporarily locked out, the
Lockout number of additional temporary
Threshold> lockouts to allow before
permanent lockout.

11.21.9.1.3 clear
This command is used to clear (set to no value) the device profile authentication password-related
attributes for service providers, such as the allowable authentication failures, minimum password length,
whether the authentication name can be used as a password, and whether passwords can contain
numbers or symbols, and so on.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
AuthenticationPasswordRules/DeviceProfile> level.
2) Enter:
clear <svcProviderId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider Id.

Id>

<attribute> MultipleChoice permanentLockoutNotifyEmail The name of the attribute(s) to

Address clear.

11.21.9.2 SIP
This level is used to manage Session Initiation Protocol (SIP) authentication password rules.
11.21.9.2.1 get
This command is used to view the SIP Session Initiation Protocol (SIP) authentication password rules-
related attributes for system administrators, such as the allowable login failures, minimum password
length, whether the authentication name can be used as a password, and whether passwords can contain
numbers or symbols, and so on.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 821
 1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
AuthenticationPasswordRules/SIP> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider Id.

Id>

11.21.9.2.2 set
This command is used to modify the Session Initiation Protocol (SIP) authentication password rules-
related attributes for system administrators, such as the allowable login failures, minimum password
length, whether the authentication name can be used as a password, and whether passwords can contain
numbers or symbols, and so on.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
AuthenticationPasswordRules/SIP> level.
2) Enter:
set <svcProviderId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider Id.

Id>

<attribute> MultipleChoice useServiceProviderSetting, The name of the attribute to

containNonAlphaNumChars, modify.
containNonAlphaNum, contain
LowerAlphaChars, containLower
Alpha, containUpperAlphaChars,
containUpperAlpha, contain
NumberChars, containNumber,
notReverseOfOldPassword, not
OldPassword, notAuthentication
Name, minimumLength, send
PermanentLockoutNotification,
permanentLockoutNotifyEmail
Address, endpointAuthentication
LockoutType, endpointTemporary
LockoutThreshold, endpointWait
Algorithm, endpointLockoutFixed
Minutes, endpointPermanent
LockoutThreshold, trunkGroup
AuthenticationLockoutType,
trunkGroupTemporaryLockout
Threshold, trunkGroupWait
Algorithm, trunkGroupLockout
FixedMinutes, trunkGroup
PermanentLockoutThreshold

<useService Choice true, false When set to "true" the service

Provider provider SIP authentication
Setting> settings are used. When set to
"false", the system settings are
used.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 822
 Variable Field Type Valid Values Description

<containNon Integer 1 through 10 The number of non-alphanumeric

AlphaNum characters that must be present
Chars> in the password.

<containNon Choice true, false When set to "false", the password

AlphaNum> does not have to contain non-
alphanumeric characters. When
set to "true", the password
must contain non-alphanumeric
characters.

<containLower Integer 1 through 10 The number of lower case

AlphaChars> alphabetic characters the
password must contain.

<containLower Choice true, false When set to "false", the password

Alpha> does not have to contain lower-
case alphabetic characters. When
set to "true", the password must
contain lower-case alphabetic
characters.

<containUpper Integer 1 through 10 The number of upper-case

AlphaChars> alphabetic characters the
password must contain.

<containUpper Choice true, false When set to "false", the password

Alpha> does not have to contain upper-
case alphabetic characters. When
set to "true", the password must
contain upper-case alphabetic
characters.

<contain Integer 1 through 10 The number of numeric

NumberChars> characters the password must
contain.

<contain Choice true, false When set to "false", the password

Number> does not have to contain numeric
characters. When set to "true",
the password must contain
numeric characters.

<not Choice true, false When set to "false", the password

Authentication can be the same as the
Name> authentication name. When set
to "true", the password must be
different from the authentication
name.

<notOld Choice true, false When set to "false", the password

Password> is allowed to be the previous
password. When set to "true", the
password cannot be the previous
password.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 823
 Variable Field Type Valid Values Description

<notReverseOf Choice true, false When set to "false", the password

OldPassword> is allowed to be the reverse
characters of the previous
password. When set to "true", the
password cannot be the reverse
characters of the previous
password.

<minimum Integer 3 through 40 The minimum length allowed for

Length> passwords.

<send Choice true, false When set to "false", do not

Permanent send notice of a permanent
Lockout authentication lockout. When
Notification> set to "true", send notice that a
permanent authentication lockout
has occurred.

<permanent String 1 to 80 characters E-mail address to which

LockoutNotify notification is sent when a
EmailAddress> permanent authentication lockout
occurs.

<endpoint Choice never, temporary, permanent The method of authentication

Authentication disabling to use. When set to
LockoutType> never, authentication is not
disabled. When set to temporary,
only temporary lockouts are
used. When set to permanent,
both temporary and permanent
lockouts are used.

<endpoint Integer 1 through 10 The number of authentication

Temporary failures allowed before temporary
Lockout lockout occurs.
Threshold>

<endpointWait Choice double, fixed The method of timeout to use for

Algorithm> lockouts. When set to Fixed, the
lockout duration is specified by
the endpointLockoutFixedMinutes
setting. When set to Double,
the lockout timeout starts at 5
minutes and doubles with each
successive invalid authentication.

<endpoint Choice 5, 10, 20, 40, 60 When authentication is

LockoutFixed temporarily locked out, the
Minutes> time in minutes to wait after
each additional authentication
attempt. Applies only when
endpointWaitAlgorithm is set to
Fixed.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 824
 Variable Field Type Valid Values Description

<endpoint Integer 2 through 10 When authentication is

Permanent temporarily locked out, the
Lockout number of additional temporary
Threshold> lockouts to allow before
permanent lockout.

<trunkGroup Choice never, temporary, permanent The method of authentication

Authentication disabling to use. When set to
LockoutType> never, authentication is not
disabled. When set to temporary,
only temporary lockouts are
used. When set to permanent,
both temporary and permanent
lockouts are used.

<trunkGroup Integer 1 through 10 The number of authentication

Temporary failures allowed before temporary
Lockout lockout occurs.
Threshold>

<trunkGroup Choice double, fixed The method of timeout to

WaitAlgorithm> use for lockouts. When
set to Fixed, the lockout
duration is specified by the
trunkGroupLockoutFixedMinutes
setting. When set to Double,
the lockout timeout starts at 5
minutes and doubles with each
successive invalid authentication.

<trunkGroup Choice 5, 10, 20, 40, 60 When authentication is

LockoutFixed temporarily locked out, the
Minutes> time in minutes to wait after
each additional authentication
attempt. Applies only when
trunkGroupWaitAlgorithm is set to
Fixed.

<trunkGroup Integer 2 through 10 When authentication is

Permanent temporarily locked out, the
Lockout number of additional temporary
Threshold> lockouts to allow before
permanent lockout.

11.21.9.2.3 clear
This command is used to clear (set to no value) the Session Initiation Protocol (SIP) authentication
password rules-related attributes for system administrators, such as the allowable login failures, minimum
password length, whether the authentication name can be used as a password, and whether passwords
can contain numbers or symbols, and so on.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
AuthenticationPasswordRules/SIP> level.
2) Enter:
clear <svcProviderId> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 825
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider Id.

Id>

<attribute> MultipleChoice permanentLockoutNotifyEmail The name of the attribute(s) to

Address clear.

11.21.10 Carrier
This level is used to view, add, delete, or modify service provider carriers in the Application Server. Each
service provider can have a different carrier record provisioned for every country code. Each of those
carrier records can specify the system-level carriers to use for inter-LATA, intra-LATA and international
calls originating from its associated country code.

11.21.10.1 get
This command is used to view service provider carrier-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Carrier> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

11.21.10.2 add
This command is used to add a new service provider carrier.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Carrier> level.
2) Enter:
add <svcProviderId> <countryCode> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<countryCode> Digit String 1 to 3 digits The number representing the

country where the carrier is
located.

<attribute> MultipleChoice intraLataPIC, interLataPIC, Additional attributes to include

internationalPIC through the add command.

<intraLataPIC> String 1 to 80 characters The name of the carrier that is

allowed to transport intra-LATA
calls.

<interLataPIC> String 1 to 80 characters The name of the carrier that is

allowed to transport inter-LATA
calls.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 826
 Variable Field Type Valid Values Description

<internationalPIC> String 1 to 80 characters The name of the carrier that is

allowed to transport international
calls.

11.21.10.3 set
This command is used to modify service provider carrier-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Carrier> level.
2) Enter:
set <svcProviderId> <countryCode> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<countryCode> Digit String 1 to 3 digits The number representing the

country where the carrier is
located.

<attribute> MultipleChoice intraLataPIC, interLataPIC, The name of an attribute to

internationalPIC modify.

<intraLataPIC> String 1 to 80 characters The name of the carrier that is

allowed to transport intra-LATA
calls.

<interLataPIC> String 1 to 80 characters The name of the carrier that is

allowed to transport inter-LATA
calls.

<internationalPIC> String 1 to 80 characters The name of the carrier that is

allowed to transport international
calls.

11.21.10.4 delete
This command is used to delete an existing service provider carrier.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Carrier> level.
2) Enter:
delete <svcProviderId> <countryCode>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<countryCode> Digit String 1 to 3 digits The number representing the

country where the carrier is
located.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 827
11.21.10.5 clear
This command is used to clear service provider carrier-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Carrier> level.
2) Enter:
clear <svcProviderId> <countryCode> <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<countryCode> Digit String 1 to 3 digits The number representing the

country where the carrier is
located.

<clearAttribute> MultipleChoice intraLataPIC, interLataPIC, The name of the attribute(s) to

internationalPIC clear.

11.21.11 ClientApplicationLaunchProfiles
This level is used to view and modify the client application launch profiles at the service provider level.

11.21.11.1 get
This command is used to view the client application launch profile-related attributes at the service provider
level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
ClientApplicationLaunchProfiles> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The Service Provider.

Id>

11.21.11.2 add
This command is used to add the client application launch profile-related attributes at the service provider
level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
ClientApplicationLaunchProfiles> level.
2) Enter:
add <svcProviderId> <clientApplication> <enabled> <useVersion>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The Service Provider.

Id>

<client Choice callcenter, receptionist The Client Application.

Application>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 828
 Variable Field Type Valid Values Description

<enabled> Choice true, false Whether the client application is

enabled.

<useVersion> Choice current, custom The version to launch for the

given application.

<current> The version matching the current

BroadWorks release.

Variable: custom

custom A custom version.

<version> String 1 to 20 characters When a custom version is used,

the string representing that
version.

11.21.11.3 set
This command is used to modify client application launch profile-related attributes at the service provider
level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
ClientApplicationLaunchProfiles> level.
2) Enter:
set <svcProviderId> <clientApplication> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The Service Provider.

Id>

<client Choice callcenter, receptionist The Client Application.

Application>

<attribute> MultipleChoice enabled, useVersion The attribute to modify.

<enabled> Choice true, false Whether the client application is

enabled.

<useVersion> Choice current, custom The version to launch for the

given application.

<current> The version matching the current

BroadWorks release.

Variable: custom

custom A custom version.

<version> String 1 to 20 characters When a custom version is used,

the string representing that
version.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 829
11.21.11.4 delete
This command is used to delete the client application launch profile-related attributes at the service
provider level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
ClientApplicationLaunchProfiles> level.
2) Enter:
delete <svcProviderId> <clientApplication>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The Service Provider.

Id>

<client Choice callcenter, receptionist The Client Application.

Application>

11.21.12 Department
This level is used to view, add, delete, and modify departments for and enterprise. NOTE: The commands
for the department level (get, add, set, delete, and clear) apply only to enterprises and NOT to service
providers.

11.21.12.1 get
This command allows users to view all the departments in the enterprise.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Department> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

11.21.12.2 add
This command is used to add a new department to the enterprise.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Department> level.
2) Enter:
add <svcProviderId> <department> [<parentDepartment>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<department> String 1 to 50 characters The name of the department.

<parent String 1 to 50 characters Departments are set up in a

Department> hierarchical structure. Specifies
the name of the department
above the one that is being added
(if there is one).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 830
11.21.12.3 set
This command is used to modify department-related attributes at the enterprise level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Department> level.
2) Enter:
set <svcProviderId> <department> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<department> String 1 to 50 characters The name of the department.

<attribute> MultipleChoice newDepartment, parent The name of an attribute to

Department modify.

<new String 1 to 50 characters The new name of the department.

Department>

<parent String 1 to 50 characters Specifies the name of the

Department> department above the one that is
being modified (if there is one).

11.21.12.4 delete
This command is used to delete an existing department from enterprise level. This command fails if the
department has any sub-departments.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Department> level.
2) Enter:
delete <svcProviderId> <department>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<department> String 1 to 50 characters The name of the department.

11.21.12.5 clear
This command is used to remove parent departments from existing departments.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Department> level.
2) Enter:
clear <svcProviderId> <department> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<department> String 1 to 50 characters The name of the department.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 831
 Variable Field Type Valid Values Description

<attribute> MultipleChoice parentDepartment The name of the attribute(s) to

clear.

11.21.13 Device
This level allows for managing access devices related attributes for access devices used by a service
provider.

11.21.13.1 get
This command is used to view device-related attributes. At least one of the parameters defined in the
multiple choice attribute needs to be specified to search access devices. If the search produces more than
1,000 entries, an error message is displayed and you must refine the search criteria to narrow the search.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Device> level.
2) Enter:
get <svcProviderId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<attribute> MultipleChoice deviceNameStarts, deviceName The name of an attribute to filter

Contains, deviceNameEqualTo, on.
deviceTypeEqualTo, ipAddress
Starts, ipAddressContains, ip
AddressEqualTo, macAddress
Starts, macAddressContains,
macAddressEqualTo

<deviceName String 0 to 40 characters Displays only devices with names

Starts> that start with the specified string.

<deviceName String 0 to 40 characters Displays only devices with names

Contains> that contain the specified string.

<deviceName String 1 to 40 characters Displays only devices names that

EqualTo> match the specified string.

<deviceType String 1 to 40 characters Displays only devices with types

EqualTo> that match the specified string.

<ipAddress String 0 to 80 characters Displays only devices with IP

Starts> addresses that start with the
specified string.

<ipAddress String 0 to 80 characters Displays only devices with IP

Contains> addresses that contain the
specified string.

<ipAddress String 1 to 80 characters Displays only devices with

EqualTo> IP addresses that match the
specified string.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 832
 Variable Field Type Valid Values Description

<macAddress String 0 to 12 characters Displays only devices with MAC

Starts> addresses that start with the
specified string.

<macAddress String 0 to 12 characters Displays only devices with MAC

Contains> addresses that contain the
specified string.

<macAddress String 12 to 12 characters Displays only devices with names

EqualTo> that match the specified string.

11.21.13.2 detail
This command is used to view the device details, such as IP address, port, software load, and so on.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Device> level.
2) Enter:
detail <svcProviderId> <deviceName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device for which

you want to view details.

11.21.13.3 add
When adding a new device inventory to the system, the device inventory's corresponding service provider,
device name, and type are set.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Device> level.
2) Enter:
add <svcProviderId> <deviceName> <deviceType> [<attribute>] <true> <true>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device.

<deviceType> String 1 to 40 characters The device type.

<attribute> MultipleChoice ipAddress, port, protocol, Additional attributes to include

transportType, macAddress, through the add command.
serialNumber, description,
outboundProxyServer, stun
Server, physicalLocation, isMM
Device, useCustomUserName
Password

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 833
 Variable Field Type Valid Values Description

<ipAddress> String 1 to 80 characters The corresponding IP address,

host name, or domain for the
device.

<port> Integer 1025 through 65535 The port of the device.

<protocol> String 1 to 41 characters Protocol configured for this device

to use.

<transport Choice udp, tcp, unspecified The device transport type.

Type>

<macAddress> MAC Address 12 characters The MAC address of the device.

<serial String 1 to 80 characters The serial number of the device.

Number>

<description> String 1 to 80 characters The description of the device.

<outbound String 1 to 80 characters Allows the service provider

ProxyServer> administrator to set IP address for
the outbound proxy server.

<stunServer> String 1 to 80 characters Allows the service provider

administrator to set IP address for
the STUN server.

<physical String 1 to 1024 characters Specifies the physical location of

Location> the device.

<isMMDevice> Choice true, false When set to "false", specifies

that this device is not a
Mobility Manager. When set to
"true",:specifies that this device is
a Mobility Manager.

<true>

<useCustom Choice true, false Specifies that a custom password

UserName is not used or not.
Password>

<true>

11.21.13.4 set
Device inventory-related attributes, such as the protocol being used, IP address, and port are changed
using this command. The service provider/device name combination is used to identify the record to be
changed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Device> level.
2) Enter:
set <svcProviderId> <deviceName> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 834
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters Device name to retrieve.

<attribute> MultipleChoice ipAddress, port, protocol, The name of an attribute to

transportType, macAddress, modify.
serialNumber, description,
outboundProxyServer, stun
Server, physicalLocation, mobility
ManagerProvisioningURL,
mobilityManagerProvisioning
UserName, mobilityManager
ProvisioningPassword, mobility
ManagerDefaultOriginating
ServiceKey, mobilityManager
DefaultTerminatingServiceKey,
useCustomUserNamePassword,
userName

<ipAddress> String 1 to 80 characters The corresponding IP address,

host name, or domain for the
device.

<port> Integer 1025 through 65535 The port of the device.

<protocol> String 1 to 41 characters Protocol configured for this device

to use.

<transport Choice udp, tcp, unspecified The device transport type.

Type>

<macAddress> MAC Address 12 characters MAC address of the device.

<serial String 1 to 80 characters Serial number of the device.

Number>

<description> String 1 to 80 characters Description of the device.

<outbound String 1 to 80 characters Allows the service provider

ProxyServer> administrator to set IP address for
the outbound proxy server.

<stunServer> String 1 to 80 characters Allows the service provider

administrator to set IP address for
the STUN server.

<physical String 1 to 1024 characters Specifies the physical location of

Location> the originating device.

<mobility String 1 to 256 characters The Mobility Manager device

Manager provisioning URL.
ProvisioningURL>

<mobility String 1 to 15 characters The Mobility Manager

Manager provisioning user name.
Provisioning
UserName>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 835
 Variable Field Type Valid Values Description

<mobility Integer 0 through 999 The Mobility Manager default

Manager originating service key.
Default
Originating
ServiceKey>

<mobility Integer 0 through 999 The Mobility Manager default

Manager terminating service key.
Default
Terminating
ServiceKey>

<useCustom Choice true, false Specifies that a custom password

UserName is not used or not.
Password>

<userName> String 1 to 161 characters The name of the user using a

custom password.

11.21.13.5 delete
A device inventory can be deleted from the system using this command. The unique service provider/
group/device name combination is used to identify the record to be deleted.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Device> level.
2) Enter:
delete <svcProviderId> <deviceName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device to delete.

11.21.13.6 clear
This command is used to clear attributes related to the service provider access device.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Device> level.
2) Enter:
clear <svcProviderId> <deviceName> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The device name to retrieve.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 836
 Variable Field Type Valid Values Description

<attribute> MultipleChoice ipAddress, port, macAddress, The name of the attribute(s) to

serialNumber, description, clear.
outboundProxyServer, stun
Server, physicalLocation, mobility
ManagerDefaultOriginating
ServiceKey, mobilityManager
DefaultTerminatingServiceKey,
userName

11.21.13.7 lineOrder
Line order is used when an IP Phone is sharing lines and you want to change the order of lines by moving
a subscriber's line up or down.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Device> level.
2) Enter:
lineOrder <svcProviderId> <deviceName> <linePort> <action> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider.

<deviceName> String 1 to 40 characters Device name.

<linePort> String 0 to 161 characters Line port to line is moved.

<action> Choice up, down Direction to move the line.

<attribute> MultipleChoice rebuildFileNow The name of an attribute to filter

on.

<rebuildFile Choice true, false Indicates if the device

Now> configuration file should be built.
This gives you control of when
the file is built. If you do not set
this attribute to true, the file is not
built. This is to prevent the file
from being built and transmitted
every time a line/port is moved.
If you moved a line/port up five
spaces, the file would be built five
times. The default is false.

11.21.13.8 rebuildDefaultFile
This command is used to rebuild each file of the device using the subscribers profile parameter.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Device> level.
2) Enter:
rebuildDefaultFile <svcProviderId> <deviceName>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 837
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device.

<force> Choice force When specified, the templates

are uploaded to the repository
even if the content hasn't
changed since the last rebuilt was
performed.

11.21.13.9 CustomTags
This level allows for the adding, modifying, or removal of devices used by a service provider.
11.21.13.9.1 get
This command is used to view Custom Tag-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Device/CustomTags>
level.
2) Enter:
get <svcProviderId> <deviceName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device.

11.21.13.9.2 add
This command is used to add a new Custom Tag.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Device/CustomTags>
level.
2) Enter:
add <svcProviderId> <deviceName> <tagName> [<tagValue>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The device name to retrieve.

<tagName> String 1 to 64 characters The name of the tag.

<tagValue> String 1 to 256 characters The value of the tag.

11.21.13.9.3 set
This command is used to modify Custom Tag-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Device/CustomTags>
level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 838
 2) Enter:
set <svcProviderId> <deviceName> <tagName> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters Device name to retrieve.

<tagName> String 1 to 64 characters The name of the tag.

<attribute> MultipleChoice tagValue The name of an attribute to

modify.

<tagValue> String 1 to 256 characters The value of the tag.

11.21.13.9.4 delete
This command is used to delete an existing Custom Tag from the system.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Device/CustomTags>
level.
2) Enter:
delete <svcProviderId> <deviceName> <tagName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device to delete.

<tagName> String 1 to 64 characters The name of the tag.

11.21.13.9.5 clear
This command is used to clear Custom Tag-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Device/CustomTags>
level.
2) Enter:
clear <svcProviderId> <deviceName> <tagName> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device.

<tagName> String 1 to 64 characters The tag name.

<attribute> MultipleChoice tagValue The name of the attribute(s) to

clear.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 839
11.21.13.10 Files
This level allows for the adding, modifying, or removal of files used by a service provider.
11.21.13.10.1 get
This command is used to view Service Provider Device Profile File-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Device/Files> level.
2) Enter:
get <svcProviderId> <deviceName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device.

11.21.13.10.2 detail
This command is used to view Service Provider Device Profile File detail attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Device/Files> level.
2) Enter:
detail <svcProviderId> <deviceName> <fileFormat>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device for which

you want to view file details.

<fileFormat> String 1 to 128 characters The file format.

11.21.13.10.3 set
This command is used to modify Service Provider Device Profile File -related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Device/Files> level.
2) Enter:
set <svcProviderId> <deviceName> <fileFormat> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device for which

you want to set file details.

<fileFormat> String 1 to 128 characters The file format.

<attribute> MultipleChoice fileSource, configurationFile The name of an attribute to

Name, extCaptureOnUpload modify.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 840
 Variable Field Type Valid Values Description

<fileSource> Choice manual, default, custom When set to "manual", the

Provisioning Server does not
generate a file for this device
profile. The file must be manually
generated and saved in the file
repository. When set to "default",
the device profile does not use
a custom template. Instead,
the Provisioning Server uses
the corresponding file/template
defined at the device-type level
(or a device-type customization
at the group level) to build the
resulting file for the device profile.
When set to "custom", the device
profile has its own file/template.

<configuration String 1 to 256 characters The configuration file name.

FileName>

<extCaptureOn Choice true, false This parameter enables or

Upload> disables the extended file capture
on upload from a device. When
enabled, new files uploaded from
a device are kept in the extended
capture file repository until a
configurable number of them is
reached. At this point, the oldest
is deleted. When disabled, new
files uploaded from a device
overwrite the previous version
in the file repository. NOTE: The
association between devices and
file repositories is made under the
FileServer context.

11.21.13.11 User
This level is used to view the users associated with a service provider access device.
11.21.13.11.1 get
This command is used to view Device User-related attributes. At least one of the parameters defined in the
multiple choice attribute needs to be specified to search all users for a device. If the search produces over
1,000 entries, an error message appears and you should refine your search criteria to narrow the search.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Device/User> level.
2) Enter:
get <svcProviderId> <deviceName> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<deviceName> String 1 to 40 characters The name of the device.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 841
 Variable Field Type Valid Values Description

<attribute> MultipleChoice linePortUserPartStarts, linePort The name of an attribute to filter

UserPartContains, linePortUser on.
PartEqualTo, linePortDomain
Starts, linePortDomainContains,
linePortDomainEqualTo, userId
Starts, userIdContains, userId
EqualTo, lastNameStarts, last
NameContains, lastNameEqual
To, firstNameStarts, firstName
Contains, firstNameEqualTo,
phoneStarts, phoneContains,
phoneEqualTo, extensionStarts,
extensionContains, extension
EqualTo, groupIdStarts, groupId
Contains, groupIdEqualTo, user
TypeEqualTo

<linePortUser String 0 to 80 characters Displays only users with a line

PartStarts> port that starts with the specified
string.

<linePortUser String 0 to 80 characters Displays only users with a line

PartContains> port that contains the specified
string.

<linePortUser String 1 to 80 characters Displays only users with a line

PartEqualTo> port that matches the specified
string.

<linePort String 0 to 80 characters Displays only users with line

DomainStarts> port domain that starts with the
specified string.

<linePort String 0 to 80 characters Displays only users whose

Domain line port domain contains the
Contains> specified string.

<linePort String 1 to 80 characters Displays only users with a line

DomainEqual port domain that matches the
To> specified string.

<userIdStarts> String 0 to 161 characters Displays only users whose user

ID starts with the specified string.

<userId String 0 to 161 characters Displays only users with a user ID

Contains> that contains the specified string.

<userIdEqual String 1 to 161 characters Displays only users with user ID

To> that matches the specified string.

<lastName String 0 to 30 characters Displays only users with a

Starts> last name that starts with the
specified string.

<lastName String 0 to 30 characters Displays only users whose last

Contains> name contains the specified
string.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 842
 Variable Field Type Valid Values Description

<lastName String 1 to 30 characters Displays only users whose last

EqualTo> name matches the specified
string.

<firstName String 0 to 30 characters Displays only users with a

Starts> first name that starts with the
specified string.

<firstName String 0 to 30 characters Displays only users with a first

Contains> name that contains the specified
string.

<firstName String 1 to 30 characters Displays only users with a first

EqualTo> name that matches the specified
string.

<phoneStarts> String 0 to 23 characters Displays only users whose phone

number starts with the specified
string.

<phone String 0 to 23 characters Displays only users with a

Contains> phone number that contains the
specified string.

<phoneEqual String 1 to 23 characters Displays only users whose phone

To> number matches the specified
string.

<extension String 0 to 20 characters Displays only users whose

Starts> extension starts with the specified
string.

<extension String 0 to 20 characters Displays only users whose

Contains> extension contains the specified
string.

<extension String 2 to 20 characters Displays only users whose

EqualTo> extension matches the specified
string.

<groupId String 0 to 30 characters Displays only users whose group

Starts> ID starts with the specified string.

<groupId String 0 to 30 characters Displays only users whose group

Contains> ID contains the specified string.

<groupIdEqual String 1 to 30 characters Displays only users whose group

To> ID matches the specified string.

<userType Choice normal, autoAttendant, call Specifies the type of user.

EqualTo> Center, huntGroup, instantGroup
Call, routePoint, voiceMessaging

11.21.13.11.2 set
This command is used to modify Service Provider Device Profile User-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Device/User> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 843
 2) Enter:
set <svcProviderId> <deviceName> <linePort> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

<deviceName> String 1 to 40 characters The name of the device.

<linePort> String 1 to 161 characters Port or line of the above device

to assign user to. This is used for
access devices only.

<attribute> MultipleChoice primaryLinePort The name of an attribute to

modify.

<primaryLine Choice true, false Specifies whether the line/port is

Port> the primary line/port.

11.21.14 DeviceFileReposUsers
This level allows for the adding, modifying, or removal of DeviceFileReposUsers access devices.

11.21.14.1 get
This command is used to view File Repository Service Provider User-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
DeviceFileReposUsers> level.
2) Enter:
get <svcProviderId> <fileReposName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<fileRepos String 1 to 40 characters The name of the device file

Name> repository.

11.21.14.2 add
This command is used to add a new File Repository Service Provider User.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
DeviceFileReposUsers> level.
2) Enter:
add <svcProviderId> <fileReposName> <userName> <accessPriv>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 844
 Variable Field Type Valid Values Description

<fileRepos String 1 to 40 characters The device file repository name.

Name>

<userName> String 1 to 30 characters The name of the Service Provider

user to be added.

<accessPriv> MultipleChoice put, delete, get User access privileges.

11.21.14.3 set
This command is used to set File Repository Service Provider User-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
DeviceFileReposUsers> level.
2) Enter:
set <svcProviderId> <fileReposName> <userName> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<fileRepos String 1 to 40 characters The device file repository name.

Name>

<userName> String 1 to 30 characters The name of the user.

<attribute> MultipleChoice accessPriv, password The name of an attribute to

modify.

<accessPriv> MultipleChoice put, delete, get The user access privileges.

11.21.14.4 delete
This command is used to delete an existing File Repository Service Provider User from the system.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
DeviceFileReposUsers> level.
2) Enter:
delete <svcProviderId> <fileReposName> <userName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters Device name to retrieve.

Id>

<fileRepos String 1 to 40 characters The device file repository name.

Name>

<userName> String 1 to 30 characters The name of the user.

11.21.15 Domain
This section of the CLI is used to view, add, and delete information for domain for a service provider.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 845
11.21.15.1 get
This command is used to view domain information related to a specific service provider.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Domain> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

11.21.15.2 detail
This command is used to view details for a specific domain for a service provider.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Domain> level.
2) Enter:
detail <svcProviderId> <domainName> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<domain String 2 to 80 characters The domain of the service

Name> provider.

<attribute> MultipleChoice groupNameStarts, groupName The name of an attribute to filter

Contains, groupNameEqualTo, on.
groupIdStarts, groupIdContains,
groupIdEqualTo

<groupName String 0 to 30 characters Displays only groups with names

Starts> that start with the specified string.

<groupName String 0 to 30 characters Displays only groups with names

Contains> that contain the specified string.

<groupName String 1 to 30 characters Displays only groups with names

EqualTo> that match the specified string.

<groupId String 0 to 30 characters Displays only groups with IDs that

Starts> start with the specified string.

<groupId String 0 to 30 characters Displays only groups with IDs that

Contains> contain the specified string.

<groupIdEqual String 1 to 30 characters Displays only groups with IDs that

To> match the specified string.

11.21.15.3 add
This command is used to add a domain for a service provider.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Domain> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 846
 add <svcProviderId> <domainName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<domain String 2 to 80 characters The domain of the service

Name> provider.

11.21.15.4 delete
This command is used to remove a domain from a service provider.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Domain> level.
2) Enter:
delete <svcProviderId> <domainName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<domain String 2 to 80 characters The domain of the service

Name> provider.

11.21.16 EnterpriseTrunkNumberRanges
This level is used to view, add, delete, activate and deactivate the enterprise trunk number ranges defined
in a service provider.

11.21.16.1 get
This command is used to view the enterprise trunk number ranges defined in a service provider.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
EnterpriseTrunkNumberRanges> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters This parameter specifies the

Id> system ID of the service provider.

11.21.16.2 add
This command is used to add an enterprise trunk number range to a service provider.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
EnterpriseTrunkNumberRanges> level.
2) Enter:
add <svcProviderId> <numberRangeStart> <numberRangeEnd>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 847
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters This parameter specifies the

Id> system ID of the service provider.

<numberRange String 1 to 23 characters This parameter specifies the

Start> starting number for a number
range.

<numberRange String 1 to 23 characters This parameter specifies the

End> ending number for a number
range.

11.21.16.3 delete
This command is used to delete an enterprise trunk number range from a service provider.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
EnterpriseTrunkNumberRanges> level.
2) Enter:
delete <svcProviderId> <numberRangeStart>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters This parameter specifies the

Id> system ID of the service provider.

<numberRange String 1 to 23 characters This parameter specifies the

Start> starting number for a number
range.

11.21.16.4 activate
This command is used to activate an enterprise trunk number range in the service provider.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
EnterpriseTrunkNumberRanges> level.
2) Enter:
activate <svcProviderId> <numberRangeStart>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters This parameter specifies the

Id> system ID of the service provider.

<numberRange String 1 to 23 characters This parameter specifies the

Start> starting number for a number
range.

11.21.16.5 deactivate
This command is used to deactivate an enterprise trunk number range in the service provider.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
EnterpriseTrunkNumberRanges> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 848
 deactivate <svcProviderId> <numberRangeStart>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters This parameter specifies the

Id> system ID of the service provider.

<numberRange String 1 to 23 characters This parameter specifies the

Start> starting number for a number
range.

11.21.17 GroupPagingTargetsCapacity
This level is used to view and modify the Group Paging targets capacity.

11.21.17.1 get
The maximum number of target users in paging groups in the service provider is viewed using this
command. The unique service provider name is used to identify the record to be viewed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
GroupPagingTargetsCapacity> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

11.21.17.2 set
The maximum number of target users in paging groups in the service provider is changed using this
command. The unique service provider ID is used to identify the record to be changed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
GroupPagingTargetsCapacity> level.
2) Enter:
set <svcProviderId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider to

Id> whom the group belongs.

<attribute> MultipleChoice maximumTargets The name of an attribute to

modify.

<maximum Integer 1 through 294 Maximum number of target users

Targets> for groups.

11.21.18 GroupServices
This level allows for the authorization of services and service quantities to be assigned and authorized by
the service provider for groups.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 849
11.21.18.1 get
User service-related attributes, such as the authorization of services and service quantities, are viewed
using this command.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/GroupServices> level.
2) Enter:
get <svcProviderId> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<attribute> MultipleChoice authorized, serviceName The name of an attribute to filter

on.

<authorized> Choice true, false Filter based services being

authorized or not.

<serviceName> String 1 to 80 characters Service name.

11.21.18.2 set
Service-related attributes, such as the authorization of services and service quantities, are modified using
this command.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/GroupServices> level.
2) Enter:
set <svcProviderId> <serviceName> <authorize>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<serviceName> String 1 to 80 characters Service name.

<authorize> Choice false, true When set to "false", removes

authorization from the specified
service provider. When set to
"true", authorizes the service for
the specified service provider.
If you specify true, you must
indicate the capacity of the
service using the "isUnlimited"
variable described below.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 850
 Variable Field Type Valid Values Description

Variable: true

true

<unlimited> Choice false, true True sets the capacity for the
specified service to unlimited.
False limits the capacity to
a quantity specified by the
"quantity" variable.

Variable: false

false

<serviceQty> Integer 1 through 999999 The service quantity limit.

11.21.19 LDAPDirectory
This feature allows the administrators to configure an enterprise LDAP (Lightweight Directory Access
Protocol) directory that can be accessed by the users to make calls through the CommPilot Call Manager.
It is very useful for an enterprise that stores user information in a LDAP directory. For more information
about LDAP attributes, see section 11.7 LDAP Directory. This level of commands is used to display,
modify, and clear the LDAP directory interface.

11.21.19.1 get
This command displays the configuration to use to access a service provider's or an enterprise's private
LDAP directory.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/LDAPDirectory> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

11.21.19.2 set
This command is used to set the configuration that accesses a service provider's or an enterprise's private
LDAP directory.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/LDAPDirectory> level.
2) Enter:
set <svcProviderId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 851
 Variable Field Type Valid Values Description

<attribute> MultipleChoice address, port, searchBase, The name of an attribute to

useSSL, requireAuthentication, modify.
authenticatedDN, authenticated
Password, sortControl, paged
ResultControl, searchFilter,
alwaysInclSearchAttr, colAttr
Name1, colAttrName2, colAttr
Name3, colAttrName4, searchAttr
Col

<address> String 1 to 80 characters The IP address of the LDAP

server.

<port> Integer 1 through 65535 The port of the LDAP server.

<searchBase> String 1 to 256 characters The search base of the LDAP

server, which is the root suffix of
the search. The root suffix should
reflect the domain name of the
site being searched.

<useSSL> Choice true, false When set to "false", the LDAP

connection will not support the
use of an SSL connection to bind
with the LDAP server. When set
to "true", the LDAP connection
will support the use of an SSL
connection to bind with the LDAP
server.

<require Choice true, false When set to "false", the

Authentication> LDAP server does not require
authentication. When set to
"true", the LDAP server requires
authentication.

<authenticatedDN> String 1 to 256 characters If the LDAP server requires

authentication, the authenticated
directory number is required. This
should be a unique identifier of
the user.

<authenticated String 1 to 40 characters If the LDAP server requires

Password> authentication, the authenticated
password for the user is required.

<sortControl> Choice true, false When set to "false", sort controls

are not supported. When set
to "true", sort controls are
supported.

<pagedResult Choice true, false When set to "false", paged result

Control> controls are not supported. When
set to "true", paged result controls
are supported.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 852
 Variable Field Type Valid Values Description

<searchFilter> String 1 to 256 characters Specify a search filter to include

in all directory server searches.
By default, the suggested search
filter is "(telephoneNumber=*)",
which will restrict all directory
server searches made using
the CommPilot Call Manager
to directory users with the
telephoneNumber attribute
specified.

<alwaysIncl Choice true, false When set to "false", the search

SearchAttr> attribute is not included. When
set to "true", the search attribute
is always included. This forces
the current search attribute to be
included in all directory server
searches, even when the user
leaves search parameters blank.
By default, a search with blank
parameters uses only the value
of the search filter, for example,
"(telephoneNumber=*)".

<colAttr String 1 to 80 characters The first column attribute name,

Name1> for example, CN.

<colAttr String 1 to 80 characters The second column

Name2> attribute name, for example,
telephoneNumber.

<colAttr String 1 to 80 characters The third column attribute name.

Name3>

<colAttr String 1 to 80 characters The fourth column attribute name.

Name4>

<searchAttr Choice column1, column2, column3, Specifies which columns to

Col> column4 search.

11.21.19.3 clear
This command is used to clear a configuration attribute for a service provider's or an enterprise's private
LDAP directory.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/LDAPDirectory> level.
2) Enter:
clear <svcProviderId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 853
 Variable Field Type Valid Values Description

<attribute> MultipleChoice address, searchBase, The name of the attribute(s) to

authenticatedDN, authenticated clear.
Password, searchFilter, colAttr
Name2, colAttrName3, colAttr
Name4

11.21.20 MeetMeConfPorts
This level is used to view and modify the service provider level port settings of the Meet-Me Conferencing.

11.21.20.1 get
This command is used to view the service provider level port settings of the Meet-Me Conferencing.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/MeetMeConfPorts> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters Service provider id.

Id>

11.21.20.2 set
This command is used to modify service provider level Meet-Me conference ports.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/MeetMeConfPorts> level.
2) Enter:
set <svcProviderId> <unlimited> <false>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters Service provider id.

Id>

<unlimited> Choice true, false If set to true, unlimited ports

will be allocated to the service
provider.

<false> If you choose false, you must also

specify the maximum number
of Meet-Me conference ports
(integer from 0 through 999999).

11.21.21 Numbers
This level allows the assignment of directory numbers to service providers.

11.21.21.1 get
Service provider number-related attributes, such as the list of numbers in use or reserved for that service
provider, as well as the group IDs and whether the number is assigned, are viewed using this command.
The unique service provider ID is used to identify the record to be viewed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Numbers> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 854
 get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID number.

Id>

11.21.21.2 add
When adding a new service provider number to the system, the corresponding service provider and the
range of numbers reserved for that service provider are set.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Numbers> level.
2) Enter:
add <svcProviderId> <startNumber> [<endNumber>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<startNumber> String 1 to 23 characters The starting number for the range

of numbers to be entered.

<endNumber> String 1 to 23 characters The ending number for the range

of numbers to be entered. If
adding only a single number, do
not enter an ending number.

11.21.21.3 delete
Service provider numbers can be deleted using this command. Either one number or a range of numbers
can be deleted at a time.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Numbers> level.
2) Enter:
delete <svcProviderId> <startNumber> [<endNumber>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<startNumber> String 1 to 23 characters The starting number for the range

of numbers to be deleted.

<endNumber> String 1 to 23 characters The ending number for the range

of numbers to be deleted. If
removing only a single number,
do not enter an ending number.

11.21.22 PasscodeRules
This level is used to manage Service Provider Level Passcode Rule-related attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 855
11.21.22.1 get
This command is used to view system-level passcode rules.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/PasscodeRules> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

11.21.22.2 set
This command is used to modify system-level portal passcode rules.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/PasscodeRules> level.
2) Enter:
set <svcProviderId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<attribute> MultipleChoice notRepeatedDigits, numberOf The name of an attribute to

RepeatedDigits, notRepeated modify.
Patterns, notContiguous
Sequences, numberOfAscending
Digits, numberOfDescending
Digits, notUserNumber, not
ReverseOfUserNumber, not
PreviousPasscodes, numberOf
PreviousPasscodes, notReverse
OfOldPasscode, minimum
Length, maximumLength, expire
Passcode, expirationDays,
disableLogin, allowableLogin
Failures, sendNotification, notify
EmailAddress

<notRepeated Choice true, false This attribute allows or disallows

Digits> the use of repeated digits in the
passcode (for example, 11111 or
22222).

<numberOf Integer 1 through 6 This attribute sets the number of

Repeated repeated digits allowed when the
Digits> notRepeatedDigits attribute is set
to true.

<notRepeated Choice true, false This attribute allows or disallows

Patterns> the use of repeated patterns
in the passcode (for example,
232323 or 1234512345).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 856
 Variable Field Type Valid Values Description

<notContiguous Choice true, false This attribute allows or disallows

Sequences> the use of contiguous sequences
of digits in the passcode (for
example, 12345 or 54321).

<numberOf Integer 2 through 5 When the

Ascending notContiguousSequences
Digits> attribute is set to true, this value
of this attribute determines the
number of sequentially ascending
digits to allow.

<numberOf Integer 2 through 5 When the

Descending notContiguousSequences
Digits> attribute is set to true, this value
of this attribute determines
the number of sequentially
descending digits to allow.

<notUser Choice true, false When enabled, passcodes cannot

Number> contain a user's own extension or
phone number.

<notReverseOf Choice true, false When enabled, passcodes cannot

UserNumber> contain a user's own extension or
phone number reversed.

<notPrevious Choice true, false When enabled, passcodes

Passcodes> cannot contain a user's previous
passcode.

<number Integer 1 through 10 When notPreviousPasscodes is

OfPrevious enabled, the value of this attribute
Passcodes> will determine the number of
previous passcodes to disallow.

<notReverseOf Choice true, false When enabled, passcodes

OldPasscode> cannot contain a user's previous
passcode reversed.

<minimum Integer 2 through 15 This attribute specifies the

Length> minimum length of the passcode.

<maximum Integer 3 through 30 This attribute specifies the

Length> maximum length of the passcode.

<expire Choice true, false With this attribute enabled, the

Passcode> passcode expires according to
the expirationDays attribute.

<expiration Integer 15 through 180 This attribute specifies the

Days> number of days before a
passcode expires.

<disableLogin> Choice true, false When enabled, a user cannot log

in to their account.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 857
 Variable Field Type Valid Values Description

<allowable Integer 2 through 10 This attribute specifies the

LoginFailures> number of times a user can log in
incorrectly before his/her account
is locked out.

<send Choice true, false With this attribute enabled, a

Notification> message is sent via e-mail to the
system administrator, indicating
that a user's account has been
locked out.

<notifyEmail String 1 to 80 characters Specifies the e-mail address of

Address> the person to be notified when a
lockout has occurred.

11.21.22.3 clear
This command is used to the clear portal passcode rules for a specific group.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/PasscodeRules> level.
2) Enter:
clear <svcProviderId> <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<clearAttribute> MultipleChoice notifyEmailAddress The name of the attribute(s) to

clear.

11.21.23 PasswordRules
This level allows system administrators to set password-related restrictions and parameters for service
providers.

11.21.23.1 get
This command is used to view the password rules-related attributes for all service provider administrators.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/PasswordRules> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

11.21.24 Policy
This level is used to manage call processing policy-related attributes.

11.21.24.1 CallProcessing
This level allows the service provider administrator to view and modify the call processing policy attributes
for the service provider/enterprise level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 858
11.21.24.1.1 CallLimits
This level allows the service provider administrator to view and modify the Call Limits policy attributes at
the service provider level.
11.21.24.1.1.1 get
This command is used to view the Call Limits policy-related attributes at the service provider level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/
CallProcessing/CallLimits> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

11.21.24.1.1.2 set
This command is used to modify the Call Limits policy-related attributes at the service provider level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/
CallProcessing/CallLimits> level.
2) Enter:
set <svcProviderId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<attribute> MultipleChoice spUseMaxNumberSimultaneous The name of an attribute to

Calls, spMaxNumber modify.
SimultaneousCalls, spUseMax
NumberSimultaneousVideoCalls,
spMaxNumberSimultaneous
VideoCalls, spUseMaxCall
TimeForAnsweredCalls, spMax
CallTimeForAnsweredCallsIn
Minutes, spUseMaxCallTime
ForUnansweredCalls, spMax
CallTimeForUnansweredCalls
InMinutes, spUseMaxNumber
ConcurrentRedirectedCalls,
spMaxNumberConcurrent
RedirectedCalls, spUseMax
FindMeFollowMeDepth, spMax
FindMeFollowMeDepth, spMax
RedirectionDepth, spUseMax
ConcurrentFindMeFollowMe
Invocations, spMaxConcurrent
FindMeFollowMeInvocations

<spMaxNumber Integer 1 through 999999 Specifies the maximum number

Simultaneous of simultaneous calls per user.
Calls> The default value is 10.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 859
 Variable Field Type Valid Values Description

<spUseMax Choice true, false Enables or disables the SP Max

Number Number Simultaneous Calls
Simultaneous attribute.
Calls>

<spMaxNumber Integer 1 through 999999 Specifies the maximum number

Simultaneous of simultaneous video calls per
VideoCalls> user. A value of 0 indicates an
unlimited number of simultaneous
calls. The default is 0 (unlimited).

<spUseMax Choice true, false Enables or disables the SP Max

Number Number Simultaneous Video
Simultaneous Calls attribute.
VideoCalls>

<spMaxCall Integer 3 through 2880 Indicates the maximum call time

TimeFor in minutes for an answered call.
AnsweredCalls The default value is 600 minutes.
InMinutes>

<spUseMax Choice true, false Enables or disables the SP Use

CallTimeFor Max Call Time For Answered
Answered Calls attribute.
Calls>

<spMaxCall Integer 1 through 2880 Indicates in minutes the

TimeFor maximum call time for an
Unanswered unanswered call.
CallsIn
Minutes>

<spUseMax Choice true, false Enables or disables the ability

CallTimeFor of the administrator to specify
Unanswered a maximum call time for an
Calls> unanswered call.

<spUseMax Choice true, false When enabled, the administrator

Number can change the limit of
Concurrent simultaneous redirections at the
Redirected service provider level.
Calls>

<spMaxNumber Integer 1 through 999999 Specifies the limit of simultaneous

Concurrent redirections for each subscriber.
Redirected
Calls>

<spUseMax Choice true, false When enabled, the administrator

FindMeFollow can change the cascading limit
MeDepth> of forking services at the service
provider level.

<spMaxFind Integer 1 through 100 Specifies the cascading limit of

MeFollowMe forking services (Simultaneous
Depth> Ringing and Sequential Ringing).

<spMax Integer 1 through 100 Specifies the maximum number

Redirection of cascaded redirections at the
Depth> service provider level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 860
 Variable Field Type Valid Values Description

<spUseMax Choice true, false When enabled, the administrator

ConcurrentFind can limit the number of
MeFollowMe simultaneous invocations of Find
Invocations> Me/Follow Me services at the
service provider level. These
services include Simultaneous
Ringing, Sequential Ringing, and
Remote Office.

<spMax Integer 1 through 999999 Specifies the limit of simultaneous

ConcurrentFind invocations of Find Me/Follow Me
MeFollowMe services.
Invocations>

11.21.24.1.2 CallingLineId
This level allows the service provider administrator to view and modify the CallingLineId policy attributes for
the service provider/enterprise level.
11.21.24.1.2.1 get
This command is used to view service provider CallingLineId Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/
CallProcessing/CallingLineId> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

11.21.24.1.2.2 set
This command is used to modify service provider CallingLineId Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/
CallProcessing/CallingLineId> level.
2) Enter:
set <svcProviderId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<attribute> MultipleChoice spCLIDPolicy, spEnterprise The name of an attribute to

CallsCLIDPolicy, sp modify.
GroupCallsCLIDPolicy, sp
EmergencyCLIDPolicy, spAllow
AlternateNumbersForRedirecting
Identity, spBlockCallingName
ForExternalCalls, spAllow
ConfigurableCLIDForRedirecting
Identity

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 861
 Variable Field Type Valid Values Description

<spCLID Choice useDN, useConfigurableCLID Specifies the service provider

Policy> CLID policy for regular calls.

<spEnterprise Choice useExtension, useLocationCode Determines which Internal Call

CallsCLID PlusExtension, useSpCLIDPolicy Calling Line ID (CLID) policy is
Policy> used for inter-group calls within
an enterprise. This applies only
to enterprises and not to service
providers.

<spGroup Choice useExtension, useLocationCode Determines which Internal Call

CallsCLID PlusExtension, useSpCLIDPolicy Calling Line ID (CLID) policy is
Policy> used for intra-group calls.

<sp Choice useDN, useConfigurableCLID Specifies the service provider

EmergencyCLID CLID policy for emergency calls.
Policy>

<spAllow Choice true, false Indicates if the use of alternate

Alternate numbers for the redirecting
NumbersFor identity is allowed.
Redirecting
Identity>

<spBlock Choice true, false Service Provider setting for

CallingName blocking Calling Name for
ForExternal external calls.
Calls>

<spAllow Choice true, false Indicates if the configurable

ConfigurableCLID calling line id can be used as
ForRedirecting identity for redirected calls.
Identity>

11.21.24.1.3 Conferencing
This level allows the service provider administrator to view and modify the Conferencing policy attributes
for the service provider/enterprise level.
11.21.24.1.3.1 get
This command is used to view service provider Conferencing Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/
CallProcessing/Conferencing> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

11.21.24.1.3.2 set
This command is used to modify service provider Conferencing Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/
CallProcessing/Conferencing> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 862
 set <svcProviderId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<attribute> MultipleChoice spUseConferenceURILevel, sp The name of an attribute to

ConferenceURI modify.

<spUse Choice system, sp The conference URI level to be

ConferenceURI used.
Level>

<sp String 1 to 161 characters The service provider Conference

ConferenceURI> URI, which is used to identify an
INVITE request for a BroadWorks
conference resource. Used
for Three-Way and N-Way
settings. It is used when the
spUseConference URILevel is set
to "sp".

11.21.24.1.3.3 clear
This command is used to clear Conferencing Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/
CallProcessing/Conferencing> level.
2) Enter:
clear <svcProviderId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<attribute> MultipleChoice spConferenceURI The name of the attribute(s) to

clear.

11.21.24.1.4 DialableCallerID
This level allows the service provider administrator to view and modify the DialableCallerID policy attributes
for the service provider/enterprise level.
11.21.24.1.4.1 get
This command is used to view service provider DialableCallerID Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/
CallProcessing/DialableCallerID> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 863
11.21.24.1.4.2 set
This command is used to modify service provider DialableCallerID Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/
CallProcessing/DialableCallerID> level.
2) Enter:
set <svcProviderId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<attribute> MultipleChoice useServiceProviderSetting, The name of an attribute to

enabled modify.

<useService Choice true, false Shows whether to use the

Provider ServiceProvider/Enterprise
Setting> settings for Dialable Caller ID or
to inherit the settings from the
system level.

<enabled> Choice true, false Shows whether Dialable Caller ID

is enabled at the Service Provider
level.

11.21.24.1.5 Media
This level allows the service provider administrator to view and modify the Media policy attributes for the
service provider/enterprise level.
11.21.24.1.5.1 get
This command is used to view Service Provider Call Processing Media Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/
CallProcessing/Media> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

11.21.24.1.5.2 set
This command is used to modify Service Provider Call Processing Media Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/
CallProcessing/Media> level.
2) Enter:
set <svcProviderId> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 864
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<attribute> MultipleChoice spMediaPolicy, spSupported The name of an attribute to

MediaSet modify.

<spMedia Choice forceUncompressedCodec, use Defines the media policy for the
Policy> SupportedMedia, noRestriction service provider.

<spSupported String 1 to 80 characters Defines the supported media set

MediaSet> for the service provider.

11.21.24.1.5.3 clear
This command is used to clear Service Provider Call Processing Media Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/
CallProcessing/Media> level.
2) Enter:
clear <svcProviderId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<attribute> MultipleChoice spSupportedMediaSet The name of the attribute(s) to

clear.

11.21.24.1.6 RoutingXLA
This level allows the service provider administrator to view and modify the RoutingXLA policy attributes for
the service provider/enterprise level.
11.21.24.1.6.1 get
This command is used to view Service Provider Call Processing Routing and Translation Policy-related
attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/
CallProcessing/RoutingXLA> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

11.21.24.1.6.2 set
This command is used to modify Service Provider Call Processing Routing and Translation Policy-related
attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/
CallProcessing/RoutingXLA> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 865
 set <svcProviderId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<attribute> MultipleChoice spNetworkUsage, spAllow The name of an attribute to

EnterpriseGroupCallTyping modify.
ForPrivateDialingPlan, sp
AllowEnterpriseGroupCall
TypingForPublicDialingPlan,
spOverrideCLIDRestrictionFor
PrivateCallCategory, spEnable
EnterpriseExtensionDialing, sp
EnforceGroupCallingLineIdentity
Restriction, spEnforceEnterprise
CallingLineIdentityRestriction, sp
UseEnterpriseCLIDForPrivateCall
Category

<spNetwork Choice forceAllCalls, noForceEntGroup When set to "forceAllCalls",

Usage> Calls, noForceExtAndLoc this choice forces all calls
to use the network. When
set to "noForceExtAndLoc",
this choice forces all none-
location+extension calls to
use the network. When set to
"noForceEntGroupCalls", this
choice forces all non-extension
calls to use the network.

<spAllow Choice true, false Specifies whether the Allow

Enterprise Enterprise Group Call Typing For
GroupCall Private Dialing Plan feature is
TypingFor enabled or disabled.
PrivateDialing
Plan>

<spAllow Choice true, false Specifies whether the Allow

Enterprise Enterprise Group Call Typing
GroupCall For Public Dialing Plan feature is
TypingFor enabled or disabled.
PublicDialing
Plan>

<sp Choice true, false Specified whether the Override

OverrideCLID CLID Restriction For Private Call
RestrictionFor Category feature is enabled or
PrivateCall disabled.
Category>

<spEnable Choice true, false Specifies whether the Enable

Enterprise Enterprise Extension Dialing
Extension feature is enabled or disabled.
Dialing>

<spEnforce Choice true, false When enabled, this attribute

GroupCalling enforces group calling line identity
LineIdentity restrictions.
Restriction>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 866
 Variable Field Type Valid Values Description

<spEnforce Choice true, false When enabled, this attribute

Enterprise enforces enterprise calling line
CallingLine identity restrictions.
Identity
Restriction>

<spUse Choice true, false Specifies whether the Use

EnterpriseCLID Enterprise CLID For Private Call
ForPrivateCall Category feature is enabled or
Category> disabled.

11.21.24.2 DialPlan
The Dial Plan policy is implemented on the Application Server and replaces the Digit Collection policy.
The Application Server Dial Plan policy provides a complete outside access code (OAC) function, and this
enables the application of the Outgoing Calling Plan/Outgoing Digit Plan to be transparent with the OAC.
This level is used to manage service provider Dial Plan policy-related attributes.
11.21.24.2.1 get
This command is used to view service provider Dial Plan Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/DialPlan> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

11.21.24.2.2 set
This command is used to modify service provider Dial Plan Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/DialPlan> level.
2) Enter:
set <svcProviderId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<attribute> MultipleChoice requiresAccessCodeForPublic The name of an attribute to

Calls, allowE164PublicCalls, modify.
preferE164FormatForCallback
Services, publicDigitMap, private
DigitMap

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 867
 Variable Field Type Valid Values Description

<requires Choice true, false Determines whether dialing

AccessCode an access code is enforced
ForPublicCalls> to access the public dial plan.
Typically, this is enforced by
the Network Server Voice VPN
policy. However, this allows
the implementation of a non-
permissive private dial plan for
smaller enterprises without the
need to configure the Voice VPN
policy on the Network Server.

<allowE164 Choice true, false Determines whether E.164

PublicCalls> addresses are allowed as public
calls regardless of the non-
permissive option setting. This
option is only relevant when the
non-permissive option is set.

<preferE164 Choice true, false If set to "true", E.164 formatted

FormatFor callback numbers are not
Callback transformed into a national-
Services> prefixed number by the callback
services.

<publicDigit String 1 to 2048 characters Digit maps are sent by the

Map> Application Server in the context
of a call origination from an
MGCP device or a call origination
that involves the Media Server for
digit collection. This digit map is
mandatory.

<privateDigit String 1 to 2048 characters This digit map is optional, but

Map> must be configured if the Enabled
secondary dial tone option of an
access code is set.

11.21.24.2.3 clear
This command is used to clear Dial Plan Policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/DialPlan> level.
2) Enter:
clear <svcProviderId> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<attribute> MultipleChoice publicDigitMap, privateDigitMap The name of the attribute(s) to

clear.

11.21.24.2.4 AccessCodes
This level is used to manage service provider Dial Plan policy access codes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 868
11.21.24.2.4.1 get
This command is used to view Dial Plan Policy Access Codes-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/DialPlan/
AccessCodes> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

11.21.24.2.4.2 detail
This command is used to view Dial Plan Policy Access Codes detail attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/DialPlan/
AccessCodes> level.
2) Enter:
detail <svcProviderId> <accessCode>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<accessCode> String 1 to 5 characters The dial plan policy access code.

11.21.24.2.4.3 add
This command is used to add new Dial Plan Policy Access Codes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/DialPlan/
AccessCodes> level.
2) Enter:
add <svcProviderId> <accessCode> <includeCodeForNetworkTranslationsAndRouting>
<includeCodeForScreeningServices> <enableSecondaryDialTone> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<accessCode> String 1 to 5 characters The dial plan policy access code.

<includeCode Choice true, false Determines whether the access

ForNetwork code should be included as
Translations part of the dialed digits for the
AndRouting> purpose of network translations
and routing.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 869
 Variable Field Type Valid Values Description

<includeCode Choice true, false Determines whether the access

ForScreening code should be included as part
Services> of the dialed digits for the purpose
of call screening (for example,
Outgoing Digit Plan and Outgoing
Calling Plan).

<enable Choice true, false Determines whether secondary

SecondaryDial dial tone is applicable for calls
Tone> initiated from an MGCP device
or for call originations that
involve the Media Server for
digit collection. If this attribute is
set, then the private digit map is
initially used for digit collection.
This attribute cannot be set
unless a private digit map is
configured.

<attribute> MultipleChoice description Additional attributes to include

through the add command.

<description> String 1 to 80 characters The access code description.

11.21.24.2.4.4 set
This command is used to modify Dial Plan Policy Access Codes-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/DialPlan/
AccessCodes> level.
2) Enter:
set <svcProviderId> <accessCode> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<accessCode> String 1 to 5 characters The dial plan policy access code.

<attribute> MultipleChoice includeCodeForNetwork The name of an attribute to

TranslationsAndRouting, include modify.
CodeForScreeningServices,
enableSecondaryDialTone,
description

<includeCode Choice true, false Determines whether the access

ForNetwork code should be included as
Translations part of the dialed digits for the
AndRouting> purpose of network translations
and routing.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 870
 Variable Field Type Valid Values Description

<includeCode Choice true, false Determines whether the access

ForScreening code should be included as part
Services> of the dialed digits for the purpose
of call screening (for example,
Outgoing Digit Plan and Outgoing
Calling Plan).

<enable Choice true, false Determines whether secondary

SecondaryDial dial tone is applicable for calls
Tone> initiated from an MGCP device
or for call originations that
involve the Media Server for
digit collection. If this attribute is
set, then the private digit map is
initially used for digit collection.
This attribute cannot be set
unless a private digit map is
configured.

<description> String 1 to 80 characters The access code description.

11.21.24.2.4.5 delete
This command is used to delete an existing Dial Plan Policy Access Codes from the system.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/DialPlan/
AccessCodes> level.
2) Enter:
delete <svcProviderId> <accessCode>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<accessCode> String 1 to 5 characters The dial plan policy access code.

11.21.24.2.4.6 clear
This command is used to clear service provider carrier-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/Policy/DialPlan/
AccessCodes> level.
2) Enter:
clear <svcProviderId> <accessCode> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<accessCode> String 1 to 5 characters The number representing the

country where the carrier is
located.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 871
 Variable Field Type Valid Values Description

<attribute> MultipleChoice description The name of the attribute(s) to

clear.

11.21.25 ServicePacks
This level is used to display, add, configure, and delete service packs. This level is also used to add
services to an existing service pack.

11.21.25.1 get
This command is used to display Service Pack-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/ServicePacks> level.
2) Enter:
get <svcProviderId> [<servicePackName>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<servicePack String 1 to 80 characters The service pack name.

Name>

11.21.25.2 detail
This command is used to display service pack detail attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/ServicePacks> level.
2) Enter:
detail <svcProviderId> <servicePackName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<servicePack String 1 to 80 characters The service pack name.

Name>

11.21.25.3 add
This command is used to add a new service pack.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/ServicePacks> level.
2) Enter:
add <svcProviderId> <servicePackName> <serviceName> <unlimited> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<servicePack String 1 to 80 characters The name of the service pack.

Name>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 872
 Variable Field Type Valid Values Description

<serviceName> String 1 to 80 characters The name of the service.

<unlimited> Choice false, true Enables unlimited assignment/

authorization. If false, also specify
the maximum quantity.

Variable: false

false

<quantity> Integer 1 through 999999 Specifies a quantity in case

unlimited.

<attribute> MultipleChoice description, enablePack Additional attributes to include

through the add command.

<description> String 1 to 256 characters Description of the service pack.

<enablePack> Choice true, false Enables the service pack for

assignment by the service
provider.

11.21.25.4 set
This command is used to modify Service Pack-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/ServicePacks> level.
2) Enter:
set <svcProviderId> <servicePackName> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<servicePack String 1 to 80 characters The name of the service pack.

Name>

<attribute> MultipleChoice newName, unlimited, quantity, The name of an attribute to

description, enablePack modify.

<newName> String 1 to 80 characters The name of the new service

pack.

<unlimited> Choice true, false Enables unlimited assignment. If

false, also specify the maximum
quantity.

<quantity> Integer 1 through 999999 Specifies a quantity in case

unlimited.

<description> String 1 to 256 characters Description of the service pack.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 873
 Variable Field Type Valid Values Description

<enablePack> Choice true, false Enables the service pack for

assignment by the service
provider.

11.21.25.5 delete
This command is used to delete an existing service pack.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/ServicePacks> level.
2) Enter:
delete <svcProviderId> <servicePackName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<servicePack String 1 to 80 characters The name of the service pack.

Name>

11.21.25.6 addService
This command is used to add a service to a service pack.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/ServicePacks> level.
2) Enter:
addService <svcProviderId> <servicePackName> <serviceName>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

<servicePack String 1 to 80 characters The name of the service pack.

Name>

<serviceName> String 1 to 80 characters The name of the service to be

added to the service pack.

11.21.26 SupportedLanguages
This level is used to configure service provider supported languages.

11.21.26.1 get
This command displays the supported languages for a service provider/enterprise.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/SupportedLanguages>
level.
2) Enter:
get <svcProviderId>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 874
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

11.21.26.2 add
This command is used to add support for a new language for a service provider.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/SupportedLanguages>
level.
2) Enter:
add <svcProviderId> <language>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

<language> String 1 to 40 characters Indicates the language name.

11.21.26.3 set
This command is used to modify an existing, supported language for a service provider/enterprise.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/SupportedLanguages>
level.
2) Enter:
set <svcProviderId> <language> <attribute>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

<language> String 1 to 40 characters Indicates the language name.

<attribute> MultipleChoice default The name of an attribute to

modify.

<default> String true Indicates the default language for

the service provider/enterprise.

11.21.26.4 delete
This command is used to delete an existing, supported language for a service provider/enterprise.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/SupportedLanguages>
level.
2) Enter:
delete <svcProviderId> <language>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 875
 Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

<language> String 1 to 40 characters Indicates the language name.

11.21.27 TrunkingCallCapacity
This level is used to configure the maximum simultaneous calls for a service provider.

11.21.27.1 get
This command is used to display the maximum number of simultaneous calls available to a service
provider.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
TrunkingCallCapacity> level.
2) Enter:
get <svcProviderId>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

11.21.27.2 set
This command is used to set the maximum number of simultaneous calls available to a service provider
or enterprise.NOTE: The "unlimited" option for maxSimultaneousCalls is only valid for service providers. If
you try to set it for an enterprise you will get an error message.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/
TrunkingCallCapacity> level.
2) Enter:
set <svcProviderId> <attribute> <limited> <limited>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The system ID of the service

Id> provider or enterprise.

<attribute> MultipleChoice maxSimultaneousCalls, max The name of an attribute to

BurstingSimultaneousCalls modify.

<max Choice true, false When set to "unlimited", allows an

Simultaneous unlimited amount of simultaneous
Calls> calls for the specified service
provider. This option is not valid
for an enterprise. When set to
"limited", restricts the maximum
number of simultaneous calls
to the amount indicated by the
numberOfCalls variable.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 876
 Variable Field Type Valid Values Description

<limited> Optional attributes required in

case limited.

<maxBursting Choice true, false When set to "unlimited", allows

Simultaneous an unlimited amount of bursting
Calls> simultaneous calls for the
specified service provider or
enterprise. When set to "limited",
restricts the maximum number
of bursting simultaneous calls
to the amount indicated by the
numberOfBurstingCalls variable.

<limited> Optional attributes required in

case limited.

11.21.28 UserServices
This level allows for the authorization of services and service quantities for use by the service provider.

11.21.28.1 get
User service-related attributes, such as the authorization of services and service quantities, are viewed
using this command.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/UserServices> level.
2) Enter:
get <svcProviderId> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider.

Id>

<attribute> MultipleChoice authorized, serviceName The name of an attribute to filter

on.

<authorized> Choice true, false The service is authorized or not.

<serviceName> String 1 to 80 characters The service name.

11.21.28.2 set
Service-related attributes, such as the authorization of services and service quantities, are modified using
this command.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/ServiceProvider/UserServices> level.
2) Enter:
set <svcProviderId> <serviceName> <authorize>↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The service provider ID.

Id>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 877
 Variable Field Type Valid Values Description

<serviceName> String 1 to 80 characters The service name.

<authorize> Choice false, true False removes authorization from

the specified service provider.
True authorizes the service for
the specified service provider.
If you specify true, you must
indicate the capacity of the
service using the "isUnlimited"
variable described below.

Variable: true

true

<unlimited> Choice false, true True sets the capacity for the
specified service to unlimited.
False limits the capacity to
a quantity specified by the
"quantity" variable.

Variable: false

false

<serviceQty> Integer 1 through 999999 The service quantity limit.

11.22 SupportedLanguages
This level is used to view and modify system-wide attributes related to supported languages.

11.22.1 get
Service-related attributes, such as the authorization of services and service quantities, are modified using
this command.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/SupportedLanguages> level.
2) Enter:
get↵

11.22.2 add
This command is used to add support for a new language.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/SupportedLanguages> level.
2) Enter:
add <language> <locale> <encoding>↵
where:
Variable Field Type Valid Values Description

<language> String 1 to 40 characters Indicates the language name.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 878
 Variable Field Type Valid Values Description

<locale> String 1 to 5 characters Specifies a specific geographical,

political, or cultural region.
The format of locale is <ISO
Language Code>_<ISO Country
Code> or <ISO Language Code>
only. An ISO language code
is a lowercase two-letter code
as defined by ISO-639. The
full list of codes is available at:
http://www.ics.uci.edu/pub/ietf/
http/related/iso639.txt.An ISO
country code is an uppercase
two-letter code as defined
by ISO-3166. The full list of
codes is available at: http://
www.chemie.fu-berlin.de/diverse/
doc/ISO_3166.html.

<encoding> String 1 to 40 characters Encoding is a scheme for

representing the numeric values
in a character set. Encoding is
needed to display the character
set correctly.

11.22.3 set
This command is used to modify attributes related to supported languages.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/SupportedLanguages> level.
2) Enter:
set <language> <attribute>↵
where:
Variable Field Type Valid Values Description

<language> String 1 to 40 characters Indicates the language name.

<attribute> MultipleChoice default, locale, encoding The name of an attribute to

modify.

<default> String true Specifies the default language.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 879
 Variable Field Type Valid Values Description

<locale> String 1 to 5 characters Specifies a specific geographical,

political, or cultural region.
The format of locale is <ISO
Language Code>_<ISO Country
Code> or <ISO Language Code>
only. An ISO language code
is a lowercase two-letter code
as defined by ISO-639. The
full list of codes is available at:
http://www.ics.uci.edu/pub/ietf/
http/related/iso639.txt.An ISO
country code is an uppercase
two-letter code as defined
by ISO-3166. The full list of
codes is available at: http://
www.chemie.fu-berlin.de/diverse/
doc/ISO_3166.html.

<encoding> String 1 to 40 characters Encoding is a scheme for

representing the numeric values
in a character set. Encoding is
required to correctly display the
character set.

11.22.4 delete
This command is used to delete an existing, supported language from the system.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/SupportedLanguages> level.
2) Enter:
delete <language>↵
where:
Variable Field Type Valid Values Description

<language> String 1 to 40 characters Indicates the language to be

deleted.

11.23 SystemConfig
This level is used to view and modify subscriber-related system settings.

11.23.1 CallProcessing
This level is used to view and modify system configured call processing attributes.

11.23.1.1 get
This command is used to view system configured call processing attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/SystemConfig/CallProcessing> level.
2) Enter:
get↵

11.23.1.2 set
This command is used to modify system configured call processing attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 880
 1) Ensure you are at the /AS_CLI/SubscriberMgmt/SystemConfig/CallProcessing> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice extendedCallingLineID, ring The name of an attribute to

TimeoutSeconds, ringTimeout modify.
Active, allowEmergencyRemote
OfficeOriginations, maxNo
AnswerNumberOfRings,
incomingCallToUserAlias
Mode, bypassTerminationLoop
Detection, honorCLIDBlocking
ForEmergencyCalls, useUnicode
IdentityName

<extended Choice true, false Specifies whether the Extended

CallingLineID> Calling Line Id is active. When
active, the presented caller's
name may be modified to one of:
{Operator, Payphone, Overseas,
Transfer} depending on the
nature of the call. Note that
most forking services, including
simultaneous ringing, are using
redirection elements which may
cause secondary legs to be
considered as Transfers from a
call processing standpoint.

<ringTimeout Integer 1 through 180 Specifies the ring timeout.

Seconds>

<ringTimeout Choice true, false Specifies whether ring timeout is

Active> enabled.

<allow Choice true, false Enables or disables the

Emergency origination of emergency calls
RemoteOffice initiated from a remote office
Originations> location.

<maxNoAnswer Integer 6 through 20 The system-wide maximum

NumberOf number of rings configurable by
Rings> the user on no-answer condition.
Some IP Multimedia Subsystem
(IMS) solutions may not work
properly with a value as high as
20 rings. This feature allows you
to set a system-wide maximum
number of rings allowed to
be configured for No-Answer
functionality. This maximum
cannot be exceeded by any
service configuring a no-answer
number of rings even if allowed
by the Open Client Interface-
Provisioning (OCI-P) requests for
such services.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 881
 Variable Field Type Valid Values Description

<incomingCall Choice enabled, explicitAlias, disabled This parameter is used to control

ToUserAlias which user alias the AS is allowed
Mode> to use to perform translations for
incoming calls.

<bypass Choice true, false This parameter is used to enable

Termination or disable the loop detection on
LoopDetection> terminating calls.

<honorCLID Choice true, false This parameter is used to enable

BlockingFor or disable honoring CLID privacy
Emergency settings for emergency calls.
Calls>

<useUnicode Choice true, false This parameter is used to control

IdentityName> which field is used for calling line
ID. When this parameter is true,
User First Name and Last Name
are used for users instead of
Calling Line ID First/Last Name;
Group Name is used for Group
instead of Calling Line ID Group
Name; DNIS Name field is used
for Call Center/Route Point DNIS
instead of Calling Line ID First/
Last Name; Department Name
field is used for departments
instead of Department Calling
Line ID Name; Name field is used
for all service instances instead of
Calling Line ID First/Last Name.

11.23.1.3 ServiceActivationAccessCode
This level is used to view, add, modify, and delete ServiceActiviationCode entries.
11.23.1.3.1 get
This command is used to view Service Activation Access Code-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/SystemConfig/CallProcessing/
ServiceActivationAccessCode> level.
2) Enter:
get↵
11.23.1.3.2 set
This command is used to Service Activation Access Code-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/SystemConfig/CallProcessing/
ServiceActivationAccessCode> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enabled, terminatingAccessCode, The name of an attribute to

redirectingAccessCode, clickTo modify.
DialAccessCode

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 882
 Variable Field Type Valid Values Description

<enabled> Choice true, false Specifies whether the Access

Code header feature is activated.
When the feature is activated, the
AccessCode header is proxied or
added in any INVITE messages.
The default is "false".

<terminating String 1 to 80 characters The terminating access code.

AccessCode> When an initial INVITE is sent
to an access device for a user
termination, the AccessCode
header is added using the system
terminatingAccessCode.

<redirecting String 1 to 80 characters The redirecting access code.

AccessCode> When an initial INVITE is routed
via the network for a user
redirection, the AccessCode
header shall be added using the
system redirectingAccessCode.

<clickToDial String 1 to 80 characters The click-to-dial access code.

AccessCode> When an initial INVITE is sent
for the first leg of a Click-to-Dial
call, the AccessCode header
shall be added using the system
clickToDialAccessCode.

11.23.1.3.3 clear
This command is used to clear Service Activation Access Code-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/SystemConfig/CallProcessing/
ServiceActivationAccessCode> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice terminatingAccessCode, The name of the attribute(s) to

redirectingAccessCode, clickTo clear.
DialAccessCode

11.23.2 Login
This level is used to view and modify Subscriber Mgmt. System Login Settings-related attributes.

11.23.2.1 get
This command is used to view Subscriber Mgmt. System Login Settings-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/SystemConfig/Login> level.
2) Enter:
get↵

11.23.2.2 set
This command is used to modify Subscriber Mgmt. System Login Settings-related attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 883
 1) Ensure you are at the /AS_CLI/SubscriberMgmt/SystemConfig/Login> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice maxFailedLoginAttempts, min The name of an attribute to

LoginIdLength modify.

<maxFailed Integer 1 through 1000 The maximum number of failed

LoginAttempts> login attempts.

<minLoginId Integer 2 through 80 The minimum length of a login ID.

Length>

11.23.3 Provisioning
This level is used to view and modify system configured provisioning attributes.

11.23.3.1 get
This command is used to view system configured provisioning attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/SystemConfig/Provisioning> level.
2) Enter:
get↵

11.23.3.2 set
This command is used to modify system configured provisioning attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/SystemConfig/Provisioning> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice configurableCLIDNormalization The name of an attribute to

modify.

<configurableCLID Choice true, false This parameter controls the E.164

Normalization> normalization of the configurable
Calling Line ID (CLID) before it is
stored into the database.

11.24 SystemServices
This level is used to view and modify the system services.

11.24.1 Numbers
This level is used to view and modify the phone numbers for system services.

11.24.1.1 get
This command is used to view the system service phone numbers assignment.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 884
 1) Ensure you are at the /AS_CLI/SubscriberMgmt/SystemServices/Numbers> level.
2) Enter:
get↵

11.24.1.2 add
This command is used to add system service phone numbers.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/SystemServices/Numbers> level.
2) Enter:
add <startNumber> [<endNumber>]↵
where:
Variable Field Type Valid Values Description

<startNumber> String 1 to 23 characters The starting number for the range

of numbers to be entered.

<endNumber> String 1 to 23 characters The ending number for the range

of numbers to be entered. If
adding only a single number, do
not enter an ending number.

11.24.1.3 delete
This command is used to delete system service phone numbers.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/SystemServices/Numbers> level.
2) Enter:
delete <startNumber> [<endNumber>]↵
where:
Variable Field Type Valid Values Description

<startNumber> String 1 to 23 characters The starting number for the range

of numbers to be deleted.

<endNumber> String 1 to 23 characters The ending number for the range

of numbers to be deleted. If
deleting only a single number, do
not enter an ending number.

11.24.1.4 Usage
This level is used to view the list of assigned system service phone numbers.
11.24.1.4.1 get
This command is used to view the system service phone number-related attributes, such as the number,
the system serviceID, the name, and the system service.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/SystemServices/Numbers/Usage> level.
2) Enter:
get↵

11.24.2 Policy
This level is used to view and modify the system service policies.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 885
11.24.2.1 CallProcessing
This level is used to view and modify the system service call processing policies.
11.24.2.1.1 CallLimits
This level is used to view and modify the system serviceCall Processing Call Limitspolicy.
11.24.2.1.1.1 get
This command is used to view the system service ''Call Processing Call Limits'' policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/SystemServices/Policy/
CallProcessing/CallLimits> level.
2) Enter:
get↵
11.24.2.1.1.2 set
This command is used to modify the system service ''Call Processing Call Limits'' policy-related attributes.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/SystemServices/Policy/
CallProcessing/CallLimits> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice useMaxNumberSimultaneous The name of an attribute to

Calls, maxNumberSimultaneous modify.
Calls, useMaxNumber
SimultaneousVideoCalls, max
NumberSimultaneousVideo
Calls, useMaxNumberConcurrent
RedirectedCalls, maxNumber
ConcurrentRedirectedCalls, use
MaxCallTimeForAnsweredCalls,
maxCallTimeForAnsweredCallsIn
Minutes

<useMax Choice true, false Enables or disables the Max

Number Number Simultaneous Calls
Simultaneous attribute.
Calls>

<maxNumber Integer 1 through 999999 Specifies the maximum number

Simultaneous of simultaneous calls for system
Calls> services.

<useMax Choice true, false Enables or disables the Max

Number Number Simultaneous Video
Simultaneous Calls attribute.
VideoCalls>

<maxNumber Integer 1 through 999999 Specifies the maximum number

Simultaneous of simultaneous video calls for
VideoCalls> system services.

<useMax Choice true, false Enables or disables the Max

Number Number Concurrent Redirected
Concurrent Calls attribute.
Redirected
Calls>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 886
 Variable Field Type Valid Values Description

<maxNumber Integer 1 through 999999 Specifies the maximum number

Concurrent of simultaneous redirections for
Redirected system services.
Calls>

<useMax Choice true, false Enables or disables the Max

CallTimeFor Call Time For Answered Calls In
Answered Minutes attribute.
Calls>

<maxCall Integer 3 through 2880 Indicates, in minutes, the

TimeFor maximum call time for answered
AnsweredCalls calls for system services.
InMinutes>

11.25 User
This level is used to view, add, modify, and delete group members, or users.

11.25.1 get
Group member-related attributes, such as the corresponding service provider, group name and user ID,
as well as the corresponding DN, e-mail, first and last names, and so on, are viewed using this command.
If you use this command alone, all records will be displayed. If you use the command with a specified
variable only, records matching that criterion will be displayed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/User> level.
2) Enter:
get <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice userIdStarts, userIdContains, The name of an attribute to filter

userIdEqualTo, lastNameStarts, on.
lastNameContains, lastName
EqualTo, firstNameStarts, first
NameContains, firstNameEqual
To, phoneStarts, phoneContains,
phoneEqualTo, extensionStarts,
extensionContains, extension
EqualTo, emailStarts, email
Contains, emailEqualTo, svc
ProviderIdEqualTo, groupId
Starts, groupIdContains, groupId
EqualTo, userInTrunkGroup

<userIdStarts> String 0 to 161 characters Displays only users whose user

ID starts with the specified string.

<userId String 0 to 161 characters Displays only users whose user

Contains> ID contains the specified string.

<userIdEqual String 1 to 161 characters Displays only users whose user

To> ID matches the specified string.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 887
 Variable Field Type Valid Values Description

<lastName String 0 to 30 characters Displays only users whose last

Starts> names start with the specified
string.

<lastName String 0 to 30 characters Displays only users whose last

Contains> names contain the specified
string.

<lastName String 1 to 30 characters Displays only users whose last

EqualTo> names match the specified string.

<firstName String 0 to 30 characters Displays only users whose first

Starts> names start with the specified
string.

<firstName String 0 to 30 characters Displays only users whose first

Contains> names contain the specified
string.

<firstName String 1 to 30 characters Displays only users whose first

EqualTo> names match the specified string.

<phoneStarts> String 0 to 23 characters Displays only users whose phone

numbers start with the specified
string.

<phone String 0 to 23 characters Displays only users whose phone

Contains> numbers contain the specified
string.

<phoneEqual String 1 to 23 characters Displays only users whose phone

To> numbers match the specified
string.

<extension String 0 to 20 characters Displays only users whose

Starts> extension starts with the specified
string.

<extension String 0 to 20 characters Displays only users whose

Contains> extension contains the specified
string.

<extension String 2 to 20 characters Displays only users whose

EqualTo> extension matches the specified
string.

<emailStarts> String 0 to 80 characters Displays only users whose e-mail

addresses start with the specified
string.

<email String 0 to 80 characters Displays only users whose e-mail

Contains> addresses contain the specified
string.

<emailEqual String 1 to 80 characters Displays only users whose e-mail

To> addresses match the specified
string.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 888
 Variable Field Type Valid Values Description

<svcProviderId String 1 to 30 characters Displays only users whose

EqualTo> service provider IDs match the
specified string.

<groupId String 0 to 30 characters Displays only users whose group

Starts> IDs start with the specified string.

<groupId String 0 to 30 characters Displays only users whose group

Contains> IDs contain the specified string.

<groupIdEqual String 1 to 30 characters Displays only users whose group

To> IDs match the specified string.

<userInTrunk Choice true, false Specifies whether the user is part

Group> of a trunk group.

11.25.2 detail
This command allows you to view the profile details for a specified user.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/User> level.
2) Enter:
detail <userId>↵
where:
Variable Field Type Valid Values Description

<userId> String 2 to 161 characters The group member user ID.

11.25.3 add
When adding a new user to the system, there are a number of attributes that must be specified. This
command is used to add a user to the system.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/User> level.
2) Enter:
add <svcProviderId> <groupId> <userId> <lastName> <firstName> <clidLastName>
<clidFirstName> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<svcProvider String 1 to 30 characters The ID of the service provider.

Id>

<groupId> String 1 to 30 characters The ID of the group.

<userId> String 2 to 161 characters The group member user ID. This
ID must be unique across all
networked Application Server
clusters.

<lastName> String 1 to 30 characters The user's last name.

<firstName> String 1 to 30 characters The user's first name.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 889
 Variable Field Type Valid Values Description

<clidLast String 1 to 30 characters The user's last name to appear

Name> on the CLID phone.

<clidFirst String 1 to 30 characters The user's first name to appear

Name> on the CLID phone.

<attribute> MultipleChoice nameDialingName, hiragana Additional attributes to include

LastName, hiraganaFirstName, through the add command.
phone, extension, clidPhone, time
Zone, language, alias1, alias2,
alias3, device, title, department,
pager, mobile, email, yahooI
D, addressLocation, address
Line1, addressLine2, city, state
OrProvince, zipOrPostalCode,
country

Variable: nameDialingName

nameDialingName This parameter specifies the

name used for the name dialing
specified in a pair, last followed
by first.

<nameDialing String 1 to 30 characters The user's last name dialing

LastName> name.

<nameDialing String 1 to 30 characters The user's first name dialing

FirstName> name.

<hiraganaLast String 1 to 30 characters Japanese Hiragana language

Name> characters for the user's last
name.

<hiraganaFirst String 1 to 30 characters Japanese Hiragana language

Name> characters for the user's first
name.

<phone> String 1 to 23 characters The user's phone number.

<extension> Digit String 2 to 20 digits The user's phone extension.

<clidPhone> String 1 to 23 characters The phone number to appear on

the CLID phone.

<timeZone> String 1 to 127 characters The time zone for this user.

<language> String 1 to 40 characters The user's default language.

<alias1> String 0 to 161 characters The user's alias - 1 of 3 possible.

<alias2> String 0 to 161 characters The user's alias - 2 of 3 possible.

<alias3> String 0 to 161 characters The user's alias - 3 of 3 possible.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 890
 Variable Field Type Valid Values Description

<device> Choice deviceProfile, trunking When set to "deviceProfile", the

user is assigned a device profile.
When set to "trunking", the user is
a trunking user.

Variable: deviceProfile

deviceProfile Device Profile related attributes.

<category> Choice system, svcProvider, group Specifies the category that the
user's device belongs to.

<name> String 1 to 40 characters Name of the existing device to

assign user to.

<linePort> String 1 to 161 characters Port or line of the above device

to assign user to. This is used for
access devices only.

<attribute> MultipleChoice portNumber, contact1, contact2, Additional attributes to include

contact3, contact4, contact5 through the add command.

<portNumber> Integer 1 through 1024 Specifies the port number on

the device that the user address
is assigned to when static line
ordering is enabled.

<contact1> String 1 to 1020 characters The SIP URL for a third-party

call center for queue users or
devices with static registration. 1
of 5 possible.

<contact2> String 1 to 1020 characters The SIP URL for devices with
static registration. 2 of 5 possible.
This parameter cannot be used in
IMS mode.

<contact3> String 1 to 1020 characters The SIP URL for devices with
static registration. 3 of 5 possible.
This parameter cannot be used in
IMS mode.

<contact4> String 1 to 1020 characters The SIP URL for devices with
static registration. 4 of 5 possible.
This parameter cannot be used in
IMS mode.

<contact5> String 1 to 1020 characters The SIP URL for devices with
static registration. 5 of 5 possible.
This parameter cannot be used in
IMS mode.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 891
 Variable Field Type Valid Values Description

Variable: trunking

trunking Trunking related attributes.

<trunking> MultipleChoice trunkGroup, alternateTrunk Trunking related attributes.

Identity, enterpriseTrunkName

Variable: trunkGroup

trunkGroup Trunk Group related attributes.

<name> String 1 to 40 characters Name of the existing device to

assign user to.

<linePort> String 1 to 161 characters Port or line of the above device

to assign user to. This is used for
access devices only.

<attribute> MultipleChoice contact1, contact2, contact3, Additional attributes to include

contact4, contact5 through the add command.

<contact1> String 1 to 1020 characters The SIP URL for a third-party

call center for queue users or
devices with static registration. 1
of 5 possible.

<contact2> String 1 to 1020 characters The SIP URL for devices with
static registration. 2 of 5 possible.
This parameter cannot be used in
IMS mode.

<contact3> String 1 to 1020 characters The SIP URL for devices with
static registration. 3 of 5 possible.
This parameter cannot be used in
IMS mode.

<contact4> String 1 to 1020 characters The SIP URL for devices with
static registration. 4 of 5 possible.
This parameter cannot be used in
IMS mode.

<contact5> String 1 to 1020 characters The SIP URL for devices with
static registration. 5 of 5 possible.
This parameter cannot be used in
IMS mode.

<alternateTrunk String 1 to 80 characters Alternate Trunk Identity.

Identity>

<enterprise String 1 to 30 characters Enterprise Trunk Name.

TrunkName>

<title> String 1 to 50 characters The group member's title.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 892
 Variable Field Type Valid Values Description

<department> Choice enterpriseDept, groupDept When set to "enterpriseDept",

indicates the group member's
department is at the enterprise
level. You must also specify the
department name. When set
to "groupDept", indicates the
group member's department is
at the group level. You must also
specify the department name.

<enterprise String 1 to 50 characters Indicates the group member's

Dept> department is at the enterprise
level.

<groupDept> String 1 to 50 characters Indicates the group member's

department is at the group level.

<pager> String 1 to 30 characters The group member's pager

number.

<mobile> String 1 to 30 characters The group member's mobile

phone number.

<email> String 1 to 80 characters The user's e-mail address.

<yahooID> String 1 to 30 characters The user's Yahoo ID.

<address String 1 to 80 characters The physical location of the

Location> specified address.

<address String 1 to 80 characters The service provider address: line

Line1> 1.

<address String 1 to 80 characters The service provider address: line

Line2> 2.

<city> String 1 to 50 characters The service provider address:

city.

<stateOr String 1 to 50 characters The service provider address:

Province> state or province.

<zipOrPostal String 1 to 50 characters The service provider address: zip

Code> or postal code.

<country> String 1 to 50 characters The service provider address:

country.

11.25.4 set
User-related attributes, such as the phone number, extension, e-mail, first and last names, and so on, are
changed using this command. Note that the service provider ID, group ID, and user ID cannot be changed.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/User> level.
2) Enter:
set <userId> <attribute>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 893
 where:
Variable Field Type Valid Values Description

<userId> String 2 to 161 characters The group member user ID.

<attribute> MultipleChoice lastName, firstName, clidLast The name of an attribute to

Name, clidFirstName, name modify.
DialingName, hiraganaLast
Name, hiraganaFirstName,
phone, extension, clidPhone, time
Zone, language, alias, device,
title, department, pager, mobile,
email, yahooID, addressLocation,
addressLine1, addressLine2, city,
stateOrProvince, zipOrPostal
Code, country, password, impId,
impPassword

<lastName> String 1 to 30 characters The user's last name.

<firstName> String 1 to 30 characters The user's first name.

<clidLast String 1 to 30 characters The user's last name to appear

Name> on the CLID phone.

<clidFirst String 1 to 30 characters The user's first name to appear

Name> on the CLID phone.

Variable: nameDialingName

nameDialingName The user's name dialing name,

both or neither fields must be
specified.

<nameDialing String 1 to 30 characters The user's last name dialing

LastName> name.

<nameDialing String 1 to 30 characters The user's first name dialing

FirstName> name.

<hiraganaLast String 1 to 30 characters Japanese hiragana language

Name> characters for the user's last
name.

<hiraganaFirst String 1 to 30 characters Japanese hiragana language

Name> characters for the user's first
name.

<phone> String 1 to 23 characters The user's phone number.

<extension> Digit String 2 to 20 digits The user's phone extension.

<clidPhone> String 1 to 23 characters The phone number to appear on

the CLID phone.

<timeZone> String 1 to 127 characters The time zone for this user.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 894
 Variable Field Type Valid Values Description

<language> String 1 to 40 characters The user's default language.

Variable: alias

alias Specify an alias.

<alias1> String 0 to 161 characters The user's alias (1 of 3 possible).

<alias2> String 0 to 161 characters The user's alias (2 of 3 possible).

<alias3> String 0 to 161 characters The user's alias (3 of 3 possible).

<device> Choice deviceProfile, trunking When set to "deviceProfile", the

user is assigned a device profile.
When set to "trunking", the user is
a trunking user.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 895
 Variable Field Type Valid Values Description

Variable: deviceProfile

deviceProfile Device Profile related attributes.

<category> Choice system, svcProvider, group Specifies the category that the
user's device belongs to.

<name> String 1 to 40 characters Name of the existing device to

assign user to.

<linePort> String 1 to 161 characters Port or line of the above device

to assign user to. This is used for
access devices only.

<attribute> MultipleChoice portNumber, contact1, contact2, The name of an attribute to

contact3, contact4, contact5 modify.

<portNumber> Integer 1 through 1024 Specifies the port number on

the device that the user address
is assigned to when static line
ordering is enabled.

<contact1> String 1 to 1020 characters The SIP URL for a third-party

call center for queue users or
devices with static registration. 1
of 5 possible.

<contact2> String 1 to 1020 characters The SIP URL for devices with
static registration. 2 of 5 possible.
This parameter cannot be used in
IMS mode.

<contact3> String 1 to 1020 characters The SIP URL for devices with
static registration. 3 of 5 possible.
This parameter cannot be used in
IMS mode.

<contact4> String 1 to 1020 characters The SIP URL for devices with
static registration. 4 of 5 possible.
This parameter cannot be used in
IMS mode.

<contact5> String 1 to 1020 characters The SIP URL for devices with
static registration. 5 of 5 possible.
This parameter cannot be used in
IMS mode.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 896
 Variable Field Type Valid Values Description

Variable: trunking

trunking Trunking related attributes.

<trunking> MultipleChoice trunkGroup, alternateTrunk Trunking related attributes.

Identity, enterpriseTrunkName

Variable: trunkGroup

trunkGroup Trunk Group related attributes.

<name> String 1 to 40 characters Name of the existing device to

assign user to.

<linePort> String 1 to 161 characters Port or line of the above device

to assign user to. This is used for
access devices only.

<attribute> MultipleChoice contact1, contact2, contact3, The name of an attribute to

contact4, contact5 modify.

<contact1> String 1 to 1020 characters The SIP URL for a third-party

call center for queue users or
devices with static registration. 1
of 5 possible.

<contact2> String 1 to 1020 characters The SIP URL for devices with
static registration. 2 of 5 possible.
This parameter cannot be used in
IMS mode.

<contact3> String 1 to 1020 characters The SIP URL for devices with
static registration. 3 of 5 possible.
This parameter cannot be used in
IMS mode.

<contact4> String 1 to 1020 characters The SIP URL for devices with
static registration. 4 of 5 possible.
This parameter cannot be used in
IMS mode.

<contact5> String 1 to 1020 characters The SIP URL for devices with
static registration. 5 of 5 possible.
This parameter cannot be used in
IMS mode.

<alternateTrunk String 1 to 80 characters Alternate Trunk Identity.

Identity>

<enterprise String 1 to 30 characters Enterprise Trunk Name.

TrunkName>

<title> String 1 to 50 characters The group member's title.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 897
 Variable Field Type Valid Values Description

<department> Choice enterpriseDept, groupDept When set to "enterpriseDept",

indicates the group member's
department is at the enterprise
level. You must also specify the
department name. When set
to "groupDept", indicates the
group member's department is
at the group level. You must also
specify the department name.

<enterprise String 1 to 50 characters Indicates the group member's

Dept> department is at the enterprise
level.

<groupDept> String 1 to 50 characters Indicates the group member's

department is at the group level.

<pager> String 1 to 30 characters The group member's pager

number.

<mobile> String 1 to 30 characters The group member's mobile

phone number.

<email> String 1 to 80 characters The user's e-mail address.

<yahooID> String 1 to 30 characters The user's Yahoo ID.

<address String 1 to 80 characters The physical location of the

Location> specified address.

<address String 1 to 80 characters The service provider address: line

Line1> 1.

<address String 1 to 80 characters The service provider address: line

Line2> 2.

<city> String 1 to 50 characters The service provider address:

city.

<stateOr String 1 to 50 characters The service provider address:

Province> state or province.

<zipOrPostal String 1 to 50 characters The service provider address: zip

Code> or postal code.

<country> String 1 to 50 characters The service provider address:

country.

<impId> String 1 to 196 characters The user's IM&P ID. It can be set
only when the Third-Party IM&P
service is assigned to the user. It
cannot be set if impPassword is
empty.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 898
11.25.5 delete
Group members can be deleted using this command. The unique user ID is used to delete the associated
record.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/User> level.
2) Enter:
delete <userId>↵
where:
Variable Field Type Valid Values Description

<userId> String 2 to 161 characters The group member user ID.

11.25.6 clear
This command is used to clear one or more attributes of the user profile.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/User> level.
2) Enter:
clear <userId> <attribute>↵
where:
Variable Field Type Valid Values Description

<userId> String 2 to 161 characters The group member user ID.

<attribute> MultipleChoice nameDialingName, extension, The name of the attribute(s) to

clidPhone, device, title, clear.
department, pager, mobile,
email, yahooID, addressLocation,
addressLine1, addressLine2,
city, stateOrProvince, zipOr
PostalCode, country, impId, imp
Password

11.25.7 ClientApplicationLaunchProfiles
This level is used to view and modify the Client Application Launch Profiles at the user level.

11.25.7.1 get
This command is used to view Client Application Launch Profile-related attributes at the user level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/User/
ClientApplicationLaunchProfiles> level.
2) Enter:
get <userId>↵
where:
Variable Field Type Valid Values Description

<userId> String 1 to 161 characters The User.

11.25.7.2 add
This command is used to add a new Client Application Launch Profile at the user level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 899
 1) Ensure you are at the /AS_CLI/SubscriberMgmt/User/
ClientApplicationLaunchProfiles> level.
2) Enter:
add <userId> <clientApplication> <enabled> <useVersion>↵
where:
Variable Field Type Valid Values Description

<userId> String 1 to 161 characters The User.

<client Choice callcenter, receptionist The Client Application.

Application>

<enabled> Choice true, false Whether the client application is

enabled.

<useVersion> Choice current, custom The version to launch for the

given application.

<current> The version matching the current

BroadWorks release.

Variable: custom

custom A custom version.

<version> String 1 to 20 characters When a custom version is used,

the string representing that
version.

11.25.7.3 set
This command is used to modify Client Application Launch Profile-related attributes at the user level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/User/
ClientApplicationLaunchProfiles> level.
2) Enter:
set <userId> <clientApplication> <attribute>↵
where:
Variable Field Type Valid Values Description

<userId> String 1 to 161 characters The User.

<client Choice callcenter, receptionist The Client Application.

Application>

<attribute> MultipleChoice enabled, useVersion The attribute to modify.

<enabled> Choice true, false Whether the client application is

enabled.

<useVersion> Choice current, custom The version to launch for the

given application.

<current> The version matching the current

BroadWorks release.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 900
 Variable Field Type Valid Values Description

Variable: custom

custom A custom version.

<version> String 1 to 20 characters When a custom version is used,

the string representing that
version.

11.25.7.4 delete
This command is used to delete a Client Application Launch Profile at the user level.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/User/
ClientApplicationLaunchProfiles> level.
2) Enter:
delete <userId> <clientApplication>↵
where:
Variable Field Type Valid Values Description

<userId> String 1 to 161 characters The User.

<client Choice callcenter, receptionist The Client Application.

Application>

11.26 Util
This level is for subscriber management utilities.

11.26.1 BroadWorksAnywhereNumberLookup
This level is used to lookup if a given number is defined as a BroadWorks Anywhere number in the system.

11.26.1.1 get
This command is used to lookup if the number is defined as a BroadWorks Anywhere number.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Util/BroadWorksAnywhereNumberLookup>
level.
2) Enter:
get <number>↵
where:
Variable Field Type Valid Values Description

<number> String 1 to 23 characters This parameter specifies the

number to lookup in the system.

11.26.2 ChangeUserId
This level is used to change a user's existing user ID.

11.26.2.1 set
This command allows you to change a user's existing user ID.
1) Ensure you are at the /AS_CLI/SubscriberMgmt/Util/ChangeUserId> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 901
 2) Enter:
set <userId> <newUserId>↵
where:
Variable Field Type Valid Values Description

<userId> String 2 to 161 characters The current user ID.

<newUserId> String 2 to 161 characters The new user ID.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 902
12 Service

This level is used to view and modify the options available for the Application Server services.
Announcements (or.WAVfiles) heard for each service can be customized and uploaded to the following
directory on the Media Server:/var/broadworks/userfiles/{servicename}/. These directories are created
during the installation process. If you want to modify the announcements played by the services in the
directory above, you must place new, correctly encoded.WAVfiles into the directory for each service.
NOTE: If you update an existing file with the same name, the Media Server must be rebooted for the
changed announcement to be active.

12.1 AdviceOfCharge
This level is used to view, modify, and clear Advice of Charge-related attributes.

12.1.1 get
This command is used to view the Advice Of Charge-related attributes.
1) Ensure you are at the /AS_CLI/Service/AdviceOfCharge> level.
2) Enter:
get↵

12.1.2 set
This command is used to modify the Advice Of Charge-related attributes.
1) Ensure you are at the /AS_CLI/Service/AdviceOfCharge> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice delayBetweenNotificationIn The name of an attribute to

Seconds, incomingAocHandling, modify.
useOCSEnquiry, OCSEnquiry
Type

<delayBetween Integer 5 through 1800 This parameter specifies the

NotificationIn interval for sending out Advice
Seconds> of Charge During call (AoC-
D) information to the caller (in
seconds). A low duration for this
value can have a negative impact
on the system performance.
It should, therefore, be set
appropriately. Values under 20
seconds are not recommended.

<incomingAoc Choice charge, ignore This parameter determines

Handling> how an incoming Advice of
Charge (AoC) is processed by the
Application Server.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 903
 Variable Field Type Valid Values Description

<useOCS Choice true, false This parameter specifies whether

Enquiry> a Service Price or Advice of
Charge (AoC) enquiry is sent
to the Online Charging System
(OCS). The default value is false.

<OCSEnquiry Choice ServicePrice, AoC This parameter specifies the type

Type> of enquiry request to send to
Online Charging System (OCS).
The default value is AoC.

12.1.3 CostInformationSource
This level is used to add, view, modify, and delete Advice Of Charge Cost Information Sources.

12.1.3.1 get
This command is used to view all Advice Of Charge Cost Information Sources.
1) Ensure you are at the /AS_CLI/Service/AdviceOfCharge/CostInformationSource> level.
2) Enter:
get↵

12.1.3.2 add
This command is used to add an Advice Of Charge Cost Information Source to the system.
1) Ensure you are at the /AS_CLI/Service/AdviceOfCharge/CostInformationSource> level.
2) Enter:
add <peerIdentity> <priority>↵
where:
Variable Field Type Valid Values Description

<peerIdentity> String 1 to 80 characters This parameter specifies the

diameter peer identity. The
Enquiry request is sent to this
peer.

<priority> Integer 0 through 9 This parameter determines the

priority of the peer. The lower
the value, the higher the priority.
The value 0 is the highest priority
(preferred).

12.1.3.3 set
This command is used to modify an Advice Of Charge Cost Information Source.
1) Ensure you are at the /AS_CLI/Service/AdviceOfCharge/CostInformationSource> level.
2) Enter:
set <peerIdentity> <priority>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 904
 Variable Field Type Valid Values Description

<peerIdentity> String 1 to 80 characters This parameter specifies the

diameter peer identity to modify.
The Enquiry request is sent to
this peer.

<priority> Integer 0 through 9 This parameter determines the

priority of the peer. The lower
the value, the higher the priority.
The value 0 is the highest priority
(preferred).

12.1.3.4 delete
This command is used to remove an Advice Of Charge Cost Information Source from the system.
1) Ensure you are at the /AS_CLI/Service/AdviceOfCharge/CostInformationSource> level.
2) Enter:
delete <peerIdentity>↵
where:
Variable Field Type Valid Values Description

<peerIdentity> String 1 to 80 characters This parameter identifies the peer

identity to be removed.

12.2 AnonymousCallRejection
This level is used to view, modify, and clear Anonymous Call Rejection-related attributes.

12.2.1 get
This command is used to view the system-level Anonymous Call Rejection service settings.
1) Ensure you are at the /AS_CLI/Service/AnonymousCallRejection> level.
2) Enter:
get↵

12.2.2 set
This command is used to modify system-level Anonymous Call Rejection settings.
1) Ensure you are at the /AS_CLI/Service/AnonymousCallRejection> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice paiRequired, screenOnlyLocal The name of an attribute to

Calls modify.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 905
 Variable Field Type Valid Values Description

<paiRequired> Choice true, false This parameter sets whether

P-Asserted-Identity is required
or not for the invocation of the
Anonymous Call Rejection
service. It only applies in IMS
mode.

<screenOnly Choice true, false This parameter sets whether or

LocalCalls> not only local calls should be
subject to the Anonymous Call
Rejection service. It only applies
in IMS mode.

12.3 AttendantConsole
The Front Office solution includes a web-based Attendant Console, simply called the "Attendant Console".
It uses two services: one to enable the client (this service is also called Attendant Console) and one to
configure the list of monitored users (this service is called Phone Status Monitoring). The web-based
Attendant Console client is packaged with the BroadWorks server product.

12.3.1 get
This command is used to display parameters associated with the Attendant Console.
1) Ensure you are at the /AS_CLI/Service/AttendantConsole> level.
2) Enter:
get↵

12.3.2 set
This command is used to modify parameters associated with the Attendant Console.
1) Ensure you are at the /AS_CLI/Service/AttendantConsole> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice maxMonitoredUsers The name of an attribute to

modify.

<maxMonitored Integer 1 through 1000 The maximum number of users

Users> that can be added to the list of
users to be monitored on startup.
The default value is 200.

12.4 AutoAttendant
This level is used for system-level configuration of the AutoAttendant service for groups.

12.4.1 get
This command is used to display parameters associated with the AutoAttendant.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 906
 1) Ensure you are at the /AS_CLI/Service/AutoAttendant> level.
2) Enter:
get↵

12.4.2 set
This command is used to modify parameters associated with the AutoAttendant.
1) Ensure you are at the /AS_CLI/Service/AutoAttendant> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice maxReentryForSameCall The name of an attribute to

modify.

<maxReentry Integer 1 through 200 Identifies the maximum number of

ForSameCall> re-entries for the same call.

12.5 AutomaticCallback
This level is used for system-level configuration of the Automatic Callback service for groups.

12.5.1 get
This command is used to view parameters associated with the AutomaticCallback service.
1) Ensure you are at the /AS_CLI/Service/AutomaticCallback> level.
2) Enter:
get↵

12.5.2 set
This command is used to modify parameters associated with the AutomaticCallback service.
1) Ensure you are at the /AS_CLI/Service/AutomaticCallback> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice monitorMinutes, maxOriginator The name of an attribute to

Sessions, maxTerminator modify.
Sessions, maxRetryRings, idle
GuardSeconds, callbackMethod,
pollingIntervalSeconds, activation
Digit

<monitor Integer 5 through 180 The monitor period in seconds.

Minutes>

<maxOriginator Integer 1 through 30 The maximum number of

Sessions> originator sessions.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 907
 Variable Field Type Valid Values Description

<max Integer 1 through 30 The maximum number of

Terminator terminator sessions.
Sessions>

<maxRetry Integer 3 through 8 The maximum number of retry

Rings> rings.

<idleGuard Integer 5 through 300 The idle guard period in seconds.

Seconds>

<callback Choice notifyOnly, notifyIfPossibleAnd The method used to determine if

Method> PollingOtherwise the called party is available.

<pollingInterval Integer 60 through 900 The automatic callback polling

Seconds> interval in seconds.

<activation Integer 0 through 9 When a subscriber - which has

Digit> Automatic Callback assigned
- originates a call to a busy
subscriber, they receive a prompt
to enter a digit to activate ACB.
The value of the activationDigit
will determine the digit the
subscriber must press to activate
ACB.

12.5.3 ReleaseCause
This level is used to configure the behavior of Automatic Callback based on SIP Status codes. In this way,
the list could be defaulted to 486 (Busy Here) and 600 (Busy Everywhere); however the administrator has
the ability to add or remove response codes to this list.

12.5.3.1 get
The get command is used to view Automatic Callback Release Causes.
1) Ensure you are at the /AS_CLI/Service/AutomaticCallback/ReleaseCause> level.
2) Enter:
get↵

12.5.3.2 add
This command is used to add Automatic Callback release causes.
1) Ensure you are at the /AS_CLI/Service/AutomaticCallback/ReleaseCause> level.
2) Enter:
add <releaseCause>↵
where:
Variable Field Type Valid Values Description

<release Choice busy, forbidden, globalFailure, This is a system defined Release

Cause> requestFailure, requestTimeout, Cause that will be added from
serverFailure, temporarily the list of release causes that will
Unavailable, translationFailure, invoke automatic call back when
userNotFound automatic callback is enabled.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 908
12.5.3.3 delete
This command is used to delete Automatic Callback release causes.
1) Ensure you are at the /AS_CLI/Service/AutomaticCallback/ReleaseCause> level.
2) Enter:
delete <releaseCause>↵
where:
Variable Field Type Valid Values Description

<release Choice busy, forbidden, globalFailure, This is a system defined Release

Cause> requestFailure, requestTimeout, Cause that will be added from
serverFailure, temporarily the list of release causes that will
Unavailable, translationFailure, invoke automatic call back when
userNotFound automatic callback is enabled.

12.6 BroadWorksMobileManager
This level is used for system-level configuration of the BroadWorks Mobile Manager service.

12.6.1 get
This command is used to view the BroadWorks Mobile Manager-related attributes.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobileManager> level.
2) Enter:
get↵

12.6.2 set
This command is used to modify BroadWorks Mobile Manager-related attributes.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobileManager> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice scfApiNetAddress1, scfApiNet The name of an attribute to

Address2, username, emailFrom modify.
Address, scfIMSOnly, signalingIP
Address, signalingPort, password

<scfApiNet String 1 to 80 characters First IP or hostname to be used

Address1> when connecting to the SCF
provisioning web services.

<scfApiNet String 1 to 80 characters Second IP or hostname to be

Address2> used when connecting to the SCF
provisioning web services.

<username> String 1 to 32 characters User name to be used when

connecting to the SCF
provisioning web services.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 909
 Variable Field Type Valid Values Description

<emailFrom String 1 to 80 characters Email address that will be used

Address> for the email generated by
BroadWorks to send the carrier
information file and carrier
certificate file to the Mobile
Manager administrator.

<scfIMSOnly> Choice true, false Flag to indicate if the SCF has

been deployed in IMS Only mode
or not. Not to be confused with
the flag to indicate if BroadWorks
is deployed in IMS Only mode.

<signalingIP String 1 to 39 characters Flag to indicate if the SCF has

Address> been deployed in IMS Only mode
or not. Not to be confused with
the flag to indicate if BroadWorks
is deployed in IMS Only mode.

<signalingPort> Integer 1 through 65535 Port for Signaling IP.

12.6.3 clear
This command is used to clear BroadWorks Mobile Manager-related attributes.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobileManager> level.
2) Enter:
clear <clearAttribute>↵
where:
Variable Field Type Valid Values Description

<clearAttribute> MultipleChoice scfApiNetAddress1, scfApiNet The name of an attribute to clear.

Address2, username, password,
emailFromAddress, signalingIP
Address, signalingPort

12.7 BroadWorksMobility
This level is used to view and modify BroadWorks Mobility-related attributes.

12.7.1 get
This command is used to view the BroadWorks Mobility-related attributes.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility> level.
2) Enter:
get↵

12.7.2 set
This command is used to modify the BroadWorks Mobility-related attributes.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility> level.
2) Enter:
set <attribute>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 910
 where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enableLocationServices, The name of an attribute to

enableMSRNLookup, enable modify.
MobileStateChecking, deny
CallOriginations, denyCall
Terminations, IMRNTimeout
Milliseconds

<enable Choice true, false When set to "true", it allows the

Location Broadworks Mobility solution
Services> to query the subscriber's
HLR for current location of
the subscriber's mobile in the
network. When set to "false", the
location query is disabled.

<enableMSRN Choice true, false When set to "true", the Enterprise

Lookup> Least Cost Routing feature is
enabled. When set to "false", it is
disabled.

<enableMobile Choice true, false When set to "true", it allows

StateChecking> Broadworks Mobility to query the
current status of the subscriber's
mobile. When set to "false", the
mobile will not be queried.

<denyCall Choice true, false When set to "true", mobile

Originations> outgoing calls will not be allowed.
When set to "false", mobile
outgoing calls are allowed.

<denyCall Choice true, false When set to "true", mobile

Terminations> incoming calls will not be allowed.
When set to "false", mobile
incoming calls are allowed.

<IMRNTimeout Integer 100 through 60000 The value in milliseconds

Milliseconds> specifying how long to wait before
releasing an IMRN number when
a call has not been properly
anchored.

12.7.3 IMRN
This level is used to view and modify BroadWorks Mobility IMRN phone numbers defined.

12.7.3.1 get
This command is used to view BroadWorks Mobility IMRN phone numbers defined.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/IMRN> level.
2) Enter:
get <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 911
 Variable Field Type Valid Values Description

<attribute> MultipleChoice numberStartsWith, number The name of an attribute to use

Contains, numberEqualTo as a filter for the phone number to
view.

<numberStarts String 0 to 23 characters Displays only numbers that start

With> with the specified string.

<number String 0 to 23 characters Displays only numbers that

Contains> contain the specified string.

<numberEqual String 1 to 23 characters Displays only numbers that match

To> the specified string.

12.7.3.2 add
This command is used to add BroadWorks Mobility IMRN phone numbers defined.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/IMRN> level.
2) Enter:
add <startNumber> [<endNumber>]↵
where:
Variable Field Type Valid Values Description

<startNumber> String 1 to 23 characters The starting number for the range

of numbers to be added.

<endNumber> String 1 to 23 characters The ending number for the range

of numbers to be added. If adding
only a single number, do not
enter an ending number.

12.7.3.3 delete
This command is used to remove BroadWorks Mobility IMRN phone numbers defined.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/IMRN> level.
2) Enter:
delete <number>↵
where:
Variable Field Type Valid Values Description

<number> String 1 to 23 characters The number to be deleted.

12.7.4 MobileNetwork
This level is used to add, view, modify, and delete BroadWorks Mobility Mobile Networks.

12.7.4.1 get
This command is used to view the list of Mobile Networks.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/MobileNetwork> level.
2) Enter:
get↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 912
12.7.4.2 detail
This command is used to view the attributes of a Mobile Network.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/MobileNetwork> level.
2) Enter:
detail <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the

name of the Mobile Network.

12.7.4.3 add
This command is used to add a Mobile Network.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/MobileNetwork> level.
2) Enter:
add <name> <refreshPeriodSeconds> <maxConsecutiveFailures>
<maxResponseWaitTimeMilliseconds> <enableAnnouncementSuppression> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the

name of the Mobile Network.

<refreshPeriod Integer 10 through 1800 This parameter specifies the

Seconds> period of time to wait before
retrying a failed server (in
seconds).

<max Integer 1 through 10 This parameter specifies the

Consecutive number of failure detections it
Failures> takes to mark a server out of
service.

<maxResponse Integer 100 through 10000 This parameter specifies to wait

WaitTime for response from the server (in
Milliseconds> milliseconds).

<enable Choice true, false This parameter determines

Announcement whether the network
Suppression> announcement is suppressed.
When the value is set to "true",
the network announcement is
suppressed. When the value
is set to "false", the network
announcement is not suppressed.

<attribute> MultipleChoice scfSignalingNetAddress, scf The name of the attribute(s) to

SignalingPort, serviceAccess add.
CodeListName

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 913
 Variable Field Type Valid Values Description

<scfSignaling String 1 to 80 characters This parameter specifies the IP

NetAddress> address, host, or domain for the
SCF, used by all modes except
the IMS-only SIP trigger interface.

<scfSignaling Integer 1 through 65535 This parameter specifies the port

Port> for Signaling IP.

<serviceAccess String 1 to 80 characters This parameter specifies the

CodeList name of a list of Service Access
Name> Codes. When this list is provided
the list is assigned to the Mobile
Network.

12.7.4.4 set
This command is used to modify a Mobile Network.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/MobileNetwork> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the

name of the Mobile Network.

<attribute> MultipleChoice newName, scfSignalingNet The name of the attribute(s) to

Address, scfSignalingPort, modify.
refreshPeriodSeconds, max
ConsecutiveFailures, max
ResponseWaitTimeMilliseconds,
enableAnnouncement
Suppression, serviceAccessCode
ListName

<newName> String 1 to 80 characters This parameter specifies the new

name of the Mobile Network.

<scfSignaling String 1 to 80 characters This parameter specifies the IP

NetAddress> address, host, or domain for the
SCF, used by all modes except
the IMS-only SIP trigger interface.

<scfSignaling Integer 1 through 65535 This parameter specifies the port

Port> for Signaling IP.

<refreshPeriod Integer 10 through 1800 This parameter specifies the

Seconds> period of time to wait before
retrying a failed server (in
seconds).

<max Integer 1 through 10 This parameter specifies the

Consecutive number of failure detections it
Failures> takes to mark a server out of
service.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 914
 Variable Field Type Valid Values Description

<maxResponse Integer 100 through 10000 This parameter specifies to wait

WaitTime for response from the server (in
Milliseconds> milliseconds).

<enable Choice true, false This parameter determines

Announcement whether the network
Suppression> announcement is suppressed.
When the value is set to "true",
the network announcement is
suppressed. When the value
is set to "false", the network
announcement is not suppressed.

<serviceAccess String 1 to 80 characters This parameter specifies the

CodeList name of a list of Service Access
Name> Codes. When this list is provided
the list is assigned to the Mobile
Network.

12.7.4.5 delete
This command is used to delete a Mobile Network.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/MobileNetwork> level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the

name of the Mobile Network.

12.7.4.6 clear
This command is used to clear the attributes of a Mobile Network.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/MobileNetwork> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the

name of the Mobile Network.

<attribute> MultipleChoice scfSignalingNetAddress, scf The name of the attribute(s) to

SignalingPort, serviceAccess clear.
CodeListName

12.7.4.7 IMRN
This level is used to view and modify BroadWorks Mobility IMRN phone numbers defined for Mobile
Networks.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 915
12.7.4.7.1 get
This command is used to view BroadWorks Mobility Intermediate Routing Number (IMRN) phone numbers
in a Mobile Network.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/MobileNetwork/IMRN> level.
2) Enter:
get <mobileNetworkName> <attribute>↵
where:
Variable Field Type Valid Values Description

<mobile String 1 to 80 characters This parameter specifies the

NetworkName> name of the Mobile Network.

<attribute> MultipleChoice numberStartsWith, number This parameter specifies the

Contains, numberEqualTo name of an attribute to use as
a filter for the phone number to
view.

<numberStarts String 0 to 23 characters This parameter filters only

With> numbers that start with the
specified string.

<number String 0 to 23 characters This parameter filters only

Contains> numbers that contain the
specified string.

<numberEqual String 1 to 23 characters This parameter filters only

To> numbers that match the specified
string.

12.7.4.7.2 add
This command is used to add BroadWorks Mobility Intermediate Routing Number (IMRN) phone numbers
to a Mobile Network.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/MobileNetwork/IMRN> level.
2) Enter:
add <mobileNetworkName> <startNumber> [<endNumber>]↵
where:
Variable Field Type Valid Values Description

<mobile String 1 to 80 characters This parameter specifies the

NetworkName> name of the Mobile Network to
which the number is added.

<startNumber> String 1 to 23 characters This parameter specifies the start

number for the range of numbers
to be added.

<endNumber> String 1 to 23 characters This parameter specifies the end

number for the range of numbers
to be added. If adding only a
single number, do not enter an
ending number.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 916
12.7.4.7.3 delete
This command is used to remove BroadWorks Mobility Intermediate Routing Number (IMRN) phone
numbers from a Mobile Network.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/MobileNetwork/IMRN> level.
2) Enter:
delete <mobileNetworkName> <number>↵
where:
Variable Field Type Valid Values Description

<mobile String 1 to 80 characters This parameter specifies the

NetworkName> name of the Mobile Network.

<number> String 1 to 23 characters This parameter specifies the

number to be deleted.

12.7.5 ServiceAccessCodeList
This level is used to add, view, get usage and delete BroadWorks Mobility service access code lists
defined.

12.7.5.1 get
This command is used to view all the Service Access Code list names.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/ServiceAccessCodeList>
level.
2) Enter:
get↵

12.7.5.2 add
This command is used to add a Service Access Code list.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/ServiceAccessCodeList>
level.
2) Enter:
add <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the

name of the Service Access Code
list.

12.7.5.3 set
This command is used to modify a Service Access Code list related attributes.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/ServiceAccessCodeList>
level.
2) Enter:
set <name> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 917
 Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the

name of the Service Access Code
list which is having the attribute
modified.

<attribute> MultipleChoice newName The name of the attribute(s) to

set.

<newName> String 1 to 80 characters This parameter specifies the

new name for the list of Service
Access Codes.

12.7.5.4 delete
This command is used to delete a list of Service Access Codes from the system.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/ServiceAccessCodeList>
level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the

name of Service Access Code list
to delete.

12.7.5.5 usage
This command is used to view the usage of a Service Access Code list by the Mobile Networks.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/ServiceAccessCodeList>
level.
2) Enter:
usage <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters This parameter specifies the

name of the Service Access Code
list.

12.7.5.6 ServiceAccessCode
This level is used to add, view, modify, and delete BroadWorks Mobility service access codes defined.
12.7.5.6.1 get
This command is used to view all BroadWorks Mobility Service Access Codes in a list.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/ServiceAccessCodeList/
ServiceAccessCode> level.
2) Enter:
get <serviceAccessCodeListName>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 918
 Variable Field Type Valid Values Description

<serviceAccess String 1 to 80 characters This parameter specifies the

CodeList name of the Service Access Code
Name> list.

12.7.5.6.2 add
This command is used to add BroadWorks Mobility Service Access Codes to a list.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/ServiceAccessCodeList/
ServiceAccessCode> level.
2) Enter:
add <serviceAccessCodeListName> <countryCode> <serviceAccessCode> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<serviceAccess String 1 to 80 characters This parameter specifies the

CodeList name of the Service Access Code
Name> list to add the code to.

<countryCode> Integer 1 through 999 This parameter specifies the

Country Code (CC) number; it
must be a system defined CC.

<serviceAccess String 1 to 10 characters This parameter specifies the

Code> Service Access Code. The value
must contain only "0-9", "*" or "#".

<attribute> MultipleChoice description The name of the attribute(s) to

add.

<description> String 1 to 80 characters This parameter specifies the

description of the Service Access
Code.

12.7.5.6.3 set
This command is used to modify BroadWorks Mobility Service Access Codes in a list.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/ServiceAccessCodeList/
ServiceAccessCode> level.
2) Enter:
set <serviceAccessCodeListName> <countryCode> <serviceAccessCode> <attribute>↵
where:
Variable Field Type Valid Values Description

<serviceAccess String 1 to 80 characters This parameter specifies the

CodeList name of the Service Access Code
Name> list associated with the code to
modify.

<countryCode> Integer 1 through 999 This parameter specifies the

Country Code (CC) number. It
must be defined system CC.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 919
 Variable Field Type Valid Values Description

<serviceAccess String 1 to 10 characters This parameter specifies the

Code> Service Access Code. The value
must contain only "0-9", "*" or "#".

<attribute> MultipleChoice description The name of the attribute(s) to

set.

<description> String 1 to 80 characters This parameter specifies the

description of the Service Access
Code.

12.7.5.6.4 delete
This command is used to remove BroadWorks Mobility Service Access Codes from a list.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/ServiceAccessCodeList/
ServiceAccessCode> level.
2) Enter:
delete <serviceAccessCodeListName> <countryCode> <serviceAccessCode>↵
where:
Variable Field Type Valid Values Description

<serviceAccess String 1 to 80 characters This parameter specifies the

CodeList name of the Service Access Code
Name> list associated with the code to
delete.

<countryCode> Integer 1 through 999 This parameter specifies the

Country Code (CC) number. It
must be a defined system CC.

<serviceAccess String 1 to 10 characters This parameter specifies the

Code> Service Access Code. The value
must contain only "0-9", "*" or "#".

12.7.5.6.5 clear
This command is used to clear BroadWorks Mobility Service Access Code related attributes.
1) Ensure you are at the /AS_CLI/Service/BroadWorksMobility/ServiceAccessCodeList/
ServiceAccessCode> level.
2) Enter:
clear <serviceAccessCodeListName> <countryCode> <serviceAccessCode> <attribute>↵
where:
Variable Field Type Valid Values Description

<serviceAccess String 1 to 80 characters This parameter specifies the

CodeList name of the Service Access Code
Name> list associated with the code to
clear.

<countryCode> Integer 1 through 999 This parameter specifies the

Country Code (CC) number. It
must be a defined system CC.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 920
 Variable Field Type Valid Values Description

<serviceAccess String 1 to 10 characters This parameter specifies the

Code> Service Access Code. The value
must contain only "0-9", "*" or "#".

<attribute> MultipleChoice description The name of the attribute(s) to

clear.

12.8 BusyLampField
This level is used for system-level configuration of the Busy Lamp Field service for users.

12.8.1 get
This command is used to view Busy Lamp Field related attributes.
1) Ensure you are at the /AS_CLI/Service/BusyLampField> level.
2) Enter:
get↵

12.8.2 set
This command is used to modify Busy Lamp Field related attributes.
1) Ensure you are at the /AS_CLI/Service/BusyLampField> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice displayLocalUserIdentityLast The name of an attribute to

NameFirst, forceUseOfTCP modify.

<displayLocal Choice true, false If set to true, Busy Lamp Field

UserIdentity service provides display name
LastNameFirst> with last name first.

<forceUse Choice true, false If set to true, BroadWorks

OfTCP> Application Server sends the
Busy Lamp Field service SIP
NOTIFY requests over TCP
instead of honoring the implicit,
explicit, or DNS resolved
indication to use UDP. This
behavior also depends on
BroadWorks Application Server
setting supportTcp being set to
true.

12.9 COLP
This level is used for system-level configuration of the Connected Line Identification service for users.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 921
12.9.1 get
This command is used to view COLP related attributes.
1) Ensure you are at the /AS_CLI/Service/COLP> level.
2) Enter:
get↵

12.9.2 set
This command is used to modify COLP related attributes.
1) Ensure you are at the /AS_CLI/Service/COLP> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enforceUserServiceAssignment The name of an attribute to

modify.

<enforce Choice true, false If set to true, Connected Line

UserService Identification Presentation service
Assignment> must be assigned to the user for
the originator to receive COLP.

12.10 CallCenter
This level is used for system-level configuration of the CallCenter service for groups.

12.10.1 get
This command is used to view Call Center-related attributes.
1) Ensure you are at the /AS_CLI/Service/CallCenter> level.
2) Enter:
get↵

12.10.2 set
This command permits modification of the attributes of CallCenter feature.
1) Ensure you are at the /AS_CLI/Service/CallCenter> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 922
 Variable Field Type Valid Values Description

<attribute> MultipleChoice defaultFromAddress, statistics The name of an attribute to

SamplingPeriodInMinutes, modify.
defaultEnableGuardTimer,
defaultGuardTimerSeconds,
forceAgentUnavailableOnDND
Activation, forceAgentUnavailable
OnPersonalCalls, forceAgent
UnavailableOnBouncedCallLimit,
numberConsecutiveBounced
CallsToForceAgentUnavailable,
forceAgentUnavailableOnNot
Reachable, defaultPlayRingWhen
OfferCall, uniformCallDistribution
PolicyScope, callHandling
SamplingPeriodMinutes, call
HandlingMinimumSamplingSize,
playToneToAgentForEmergency
Call, emergencyCallCLIDPrefix,
thresholdCrossingNotification
EmailGuardTimerSeconds, allow
AgentDeviceInitiatedForward

<defaultFrom String 1 to 80 characters The default from address.

Address>

<statistics Choice 15, 30 The statistics sampling period in

SamplingPeriod minutes.
InMinutes>

<defaultEnable Choice true, false The system default for enabling

GuardTimer> the guard timer.

<defaultGuard Integer 1 through 25 The system default guard timer

TimerSeconds> value in seconds.

<forceAgent Choice true, false The system default flag for forcing
Unavailable agents to be unavailable when
OnDND they turn on DND.
Activation>

<forceAgent Choice true, false The system default flag for forcing
UnavailableOn agents to be unavailable when
PersonalCalls> they take a personal call.

<forceAgent Choice true, false The system default flag for forcing
UnavailableOn agents to be unavailable when
BouncedCall they have had the maximum
Limit> number of consecutive bounced
calls.

<number Integer 1 through 5 The system default setting for the

Consecutive consecutive number of bounced
BouncedCalls calls to force an agent to be
ToForceAgent unavailable.
Unavailable>

<forceAgent Choice true, false The system default flag for forcing
UnavailableOn agents to be unavailable when
NotReachable> deemed as not reachable.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 923
 Variable Field Type Valid Values Description

<defaultPlay Choice true, false The system default for playing

RingWhenOffer ring when offer call.
Call>

<uniformCall Choice agent, callCenter The system default configuration

Distribution to determine if the idle time of
PolicyScope> an agent is calculated on a per
agent basis or on a per call center
basis.

<callHandling Integer 5 through 30 The system configuration to

SamplingPeriod control the period for which the
Minutes> call handling moving average is
calculated.

<callHandling Integer 1 through 100 The system configuration to

Minimum control the minimum number of
SamplingSize> entries in the given period for the
moving average to be valid.

<playTone Choice true, false The system default configuration

ToAgentFor to determin if a tone gets played
Emergency when a supervisor joins via an
Call> emergency call. The default value
is false.

<emergency String 1 to 10 characters The system default value for

CallCLID the prefix added to the CLID
Prefix> information sent to the supervisor
to indicate that the call is an
emergency call from an agent.
The default value is "EMY - ".

<threshold Integer 3 through 60 The number of seconds the

Crossing system should wait before
Notification generating threshold notification
EmailGuard emails. This is used to prevent
TimerSeconds> multiple notification emails are
generated in a short period of
time as a statistic swings back
and forth across a threshold.

<allowAgent Choice true, false This parameter allows use of

DeviceInitiated SIP 302 Moved Temporarily
Forward> responses specifically for
Call Center and Route Point
terminations to agents.

12.10.3 EnhancedReporting
This level is used to view and modify Call Center Enhanced Reporting Scheduled Reports-related
attributes.

12.10.3.1 get
This command is used to view Call Center Enhanced Reporting Scheduled Reports-related attributes.
1) Ensure you are at the /AS_CLI/Service/CallCenter/EnhancedReporting> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 924
 get↵

12.10.3.2 set
This command is used to modify Call Center Enhanced Reporting Scheduled Reports-related attributes.
1) Ensure you are at the /AS_CLI/Service/CallCenter/EnhancedReporting> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice scheduledReportSearchInterval The name of an attribute to

Minutes, maximumScheduled modify.
ReportsPerInterval, delete
ScheduledReportDaysAfter
Completion

<scheduled Integer 1 through 1440 The number of minutes the

ReportSearch system waits before searching
Interval for more scheduled report to
Minutes> process.

<maximum Integer 1 through 100000 The maximum number of

Scheduled scheduled reports the system
ReportsPer would process during each
Interval> search intervals.

<delete Integer 1 through 365 The number of days the system

Scheduled will wait after a scheduled report
Report is completed before deleting.
DaysAfter
Completion>

12.11 CallForwardingNotReachable
This level is used for the system-level configuration of the Call Forwarding Not Reachable service.

12.11.1 get
This command is used to view the system level Call Forwarding Not Reachable attributes.
1) Ensure you are at the /AS_CLI/Service/CallForwardingNotReachable> level.
2) Enter:
get↵

12.11.2 set
This command is used to modify the system level Call Forwarding Not Reachable attributes.
1) Ensure you are at the /AS_CLI/Service/CallForwardingNotReachable> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 925
 Variable Field Type Valid Values Description

<attribute> MultipleChoice terminateUnreachableTrigger The name of an attribute to

DetectionOnReceiptOf18x modify.

<terminate Choice true, false If set to true, call forwarding

Unreachable not reachable is not triggered
Trigger after receiving 18x and the call
DetectionOn is blocked. If set to false, call
ReceiptOf18x> forwrading not reachable is
triggered after receiving 18x and
the call is forwarded to the user
configured destination.

12.12 CallMeNow
This level is used for the system-level configuration of the Call Me Now service.

12.12.1 get
This command is used to view the system level Call Me Now attributes.
1) Ensure you are at the /AS_CLI/Service/CallMeNow> level.
2) Enter:
get↵

12.12.2 set
This command is used to modify the system level Call Me Now attributes.
1) Ensure you are at the /AS_CLI/Service/CallMeNow> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice passcodeLength, passcode The name of an attribute to

TimeoutSeconds modify.

<passcode Integer 2 through 30 The number of characters for the

Length> Call Me Now passcode.

<passcode Integer 30 through 180 The length of time allowed for the
Timeout passcode to be accepted.
Seconds>

12.13 CallNotify
This level is used for the system-level configuration of the Call Notify service.

12.13.1 get
This command is used to view the Call Notify-related attributes (the default From e-mail address of text
messages sent to users when incoming calls are received). The Call Notify default e-mail address appears
when the actual address is unknown. If the e-mail address of the caller is available, it displays.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 926
 1) Ensure you are at the /AS_CLI/Service/CallNotify> level.
2) Enter:
get↵

12.13.2 set
This command is used to modify the Call Notify-related attributes (the default From e-mail address of text
messages sent to users when incoming calls are received).
1) Ensure you are at the /AS_CLI/Service/CallNotify> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice defaultFromAddress, short The name of an attribute to

SubjectLine, dnInMailBody modify.

<defaultFrom String 1 to 80 characters The default From e-mail address

Address> of text messages sent to users
when incoming calls are received.

<shortSubject Choice true, false If true, allows for subject line in

Line> the e-mail sent to the default
address.

<dnInMail Choice true, false If true, allows for a destination

Body> number to be specified along with
the default address.

12.14 CallRecording
This level is used to manage system level Call Recording attributes.

12.14.1 get
This command is used to view the behavior of the system when a call recording fails.
1) Ensure you are at the /AS_CLI/Service/CallRecording> level.
2) Enter:
get↵

12.14.2 set
This command is used to modify the behavior of the system when a call recording fails.
1) Ensure you are at the /AS_CLI/Service/CallRecording> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 927
 Variable Field Type Valid Values Description

<attribute> MultipleChoice continueCallAfterRecording The name of an attribute to

Failure, refreshPeriodSeconds, modify.
maxConsecutiveFailures, max
ResponseWaitTimeMilliseconds,
continueCallAfterVideoRecording
Failure

<continueCall Choice true, false This parameter controls if call

AfterRecording recording continues after a call
Failure> recording fails. When set to "true"
the call is allowed to continue
after call recording fails.

<max Integer 1 through 10 The number of failure detections

Consecutive it takes to mark a server out of
Failures> service.

<maxResponse Integer 1000 through 10000 The value in milliseconds

WaitTime specifying how long to wait for a
Milliseconds> response from the server.

<refreshPeriod Integer 10 through 300 The value in seconds specifying

Seconds> how long to wait before retrying a
failed server.

<continueCall Choice true, false When set to true the call will be
AfterVideo allowed to continue after video
Recording recording fails.
Failure>

12.14.3 Platform
This level is used to manage system level Call Recording platform attributes.

12.14.3.1 get
This command is used to view the list of recording platforms and their attributes.
1) Ensure you are at the /AS_CLI/Service/CallRecording/Platform> level.
2) Enter:
get↵

12.14.3.2 add
This command is used to add a recording platform.
1) Ensure you are at the /AS_CLI/Service/CallRecording/Platform> level.
2) Enter:
add <name> <netAddress> <port> <transportType> <mediaStream> <schemaVersion>
<supportVideoRecording> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters The name of the recording

platform.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 928
 Variable Field Type Valid Values Description

<netAddress> String 1 to 80 characters The net address of the recording

platform.

<port> Integer 1 through 65535 The port of the recording

platform.

<transport Choice udp, tcp, unspecified The transport type of the

Type> recording platform (udp, tcp,
unspecified).

<media Choice dual, single The media stream of the

Stream> recording platform (dual, single).

<schema Choice 1.0, 2.0, 3.0 This parameter specifies the

Version> schema version.

<supportVideo Choice true, false This parameter determines if

Recording> video call recording is supported
by the recording platform.

<attribute> MultipleChoice description The name of an attribute to add.

<description> String 1 to 80 characters The description of the recording

platform.

12.14.3.3 set
This command is used to modify the recording platform attributes.
1) Ensure you are at the /AS_CLI/Service/CallRecording/Platform> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters The name of the recording

platform.

<attribute> MultipleChoice netAddress, port, transportType, The name of an attribute to

mediaStream, systemDefault, modify.
schemaVersion, supportVideo
Recording, description

<netAddress> String 1 to 80 characters The net address of the recording

platform.

<port> Integer 1 through 65535 The port of the recording

platform.

<transport Choice udp, tcp, unspecified The transport type of the

Type> recording platform (udp, tcp,
unspecified).

<media Choice dual, single The media stream of the

Stream> recording platform (dual, single).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 929
 Variable Field Type Valid Values Description

<system String true The system default recording

Default> platform assigned to the group
when the service is initially
authorized to the group.

<schema Choice 1.0, 2.0, 3.0 This parameter specifies the

Version> schema version.

<supportVideo Choice true, false This parameter determines if

Recording> video call recording is supported
by the recording platform.

<description> String 1 to 80 characters The description of the recording

platform.

12.14.3.4 delete
This command is used to delete a recording platform.
1) Ensure you are at the /AS_CLI/Service/CallRecording/Platform> level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters The name of the recording

platform.

12.14.3.5 clear
This command clears the attributes of a recording platform.
1) Ensure you are at the /AS_CLI/Service/CallRecording/Platform> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 80 characters The name of the recording

platform.

<attribute> MultipleChoice description The name of an attribute to clear.

12.14.3.6 usage
This command list all the enterprises/service providers and groups currently using the specified recording
platform.
1) Ensure you are at the /AS_CLI/Service/CallRecording/Platform> level.
2) Enter:
usage <name>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 930
 Variable Field Type Valid Values Description

<name> String 1 to 80 characters The name of the recording

platform.

12.15 CallReturn
This level is used for system-level configuration of the Call Return service for groups.

12.15.1 get
This command is used to view the attributes of the Call Return service.
1) Ensure you are at the /AS_CLI/Service/CallReturn> level.
2) Enter:
get↵

12.15.2 set
This command is used to modify the attributes of the Call Return service.
1) Ensure you are at the /AS_CLI/Service/CallReturn> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice twoLevelActivation, provide The name of an attribute to

Date, lastUnansweredCallOnly, modify.
confirmationKey, allowRestricted
Number, deleteNumberAfter
AnsweredCallReturn

<twoLevel Choice true, false Determines whether the Call

Activation> Return service should use two-
level activation, which requires
the pressing of confirmation key.

<provideDate> Choice true, false Determines whether the date

should be provided. Only applies
to two-level activation.

<last Choice true, false Determines whether the service

Unanswered applies to the last incoming call
CallOnly> or only to the last unanswered
incoming call.

<confirmation Choice *, #, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 The confirmation key for the two-

Key> level activation of Call Return
service.

<allow Choice true, false Determines if Call Return to a

Restricted restricted number is allowed.
Number>

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 931
 Variable Field Type Valid Values Description

<deleteNumber Choice true, false Determines whether the number

AfterAnswered is deleted from the incoming call
CallReturn> memory upon successful call
return.

12.15.3 clear
This command is used to clear (set to no value) Call Return-related attributes.
1) Ensure you are at the /AS_CLI/Service/CallReturn> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice confirmationKey The name of the attribute(s) to

clear.

12.16 CallWaiting
This level is used to modify the Call Waiting service to optionally provide a distinct ringback tone to the
caller when the called party is busy on a call. This capability is required in some markets by regulation and
is also commonly used in Europe with mobile phones.

12.16.1 get
This command is used to view the status of the playDistinctiveRingback system parameter.
1) Ensure you are at the /AS_CLI/Service/CallWaiting> level.
2) Enter:
get↵

12.16.2 set
This command is used to enable or disable the playDistinctiveRingback parameter. When enabled,
Distinctive Call Waiting Ringback has precedence over Custom Ringback for waiting calls. The exact Call
Waiting Ringback tone to be played is selected based on the country code of the called party.
1) Ensure you are at the /AS_CLI/Service/CallWaiting> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice playDistinctiveRingBack The name of an attribute to

modify.

<playDistinctive Choice true, false This attribute is used to determine

RingBack> whether the system should apply
a distinctive ringback tone to the
caller when the called is busy and
has Call Waiting.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 932
12.17 CallingNameRetrieval
This level is used to display, modify, and clear Calling Name Retrieval-related attributes.

12.17.1 get
This command is used to view Calling Name Retrieval-related attributes.
1) Ensure you are at the /AS_CLI/Service/CallingNameRetrieval> level.
2) Enter:
get↵

12.17.2 set
This command is used to modify Calling Name Retrieval-related attributes.
1) Ensure you are at the /AS_CLI/Service/CallingNameRetrieval> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice triggerCNAMQueriesForAll The name of an attribute to

NetworkCalls, triggerCNAM modify.
QueriesForGroupAndEnterprise
Calls, queryProtocol, query
TimeoutInMilliseconds, route
AdvanceTimerMilliseconds,
retryFailedCNAMServer
IntervalSeconds, ignore
RestrictedPresentationIndicator,
supportsDNSSRV, sipExternal
DatabaseURI, sipExternal
DatabasePort, sipExternal
DatabaseTransport, soapExternal
DatabaseURI, callingName
Source

<triggerCNAM Choice true, false Parameter that determines

QueriesForAll whether the Application Server
NetworkCalls> triggers a query for calling name
information for all network calls.

<triggerCNAM Choice true, false Parameter that determines

QueriesFor whether the Application Server
GroupAnd triggers a query for calling name
Enterprise information regardless of whether
Calls> the incoming call is an intra-
enterprise call.

<query Choice sip, soap Specifies the protocol used by the

Protocol> Calling Name Service for calling
name information query.

<queryTimeout Integer 100 through 10000 The time allotted for timer
InMilliseconds> querying.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 933
 Variable Field Type Valid Values Description

<route Integer 100 through 2000 This parameter specifies the

AdvanceTimer time allotted to query a Caller
Milliseconds> ID with NAMe (CNAM) server
before it is routed to the next
CNAM server. This value must
be smaller than the value of the
queryTimeoutInMilliseconds
parameter.

<retry Integer 0 through 604800 This parameter specifies the

FailedCNAM duration (in seconds) before a
ServerInterval non-responding Caller ID with
Seconds> NAMe (CNAM) server is queried.
When this value is set to "0", the
CNAM server is always queried.

<ignore Choice true, false This parameter controls if a

Restricted restricted presentation indicator is
Presentation ignored and the returned calling
Indicator> name is presented.

<supportsDNSSRV> Choice true, false This parameter determines

whether a DNS SRV query is
used before a DNS A query is
invoked. The default value is
"true".

<sipExternal String 1 to 80 characters In IP address, host, or domain

DatabaseURI> name of the database for SIP.

<sipExternal Integer 1025 through 65355 The port number of the external
DatabasePort> database for SIP.

<sipExternal Choice udp, tcp, unspecified Specifies which transport type is

Database used by this device for SIP. When
Transport> unspecified is selected, either
protocol is allowed.

<soapExternal String 1 to 80 characters In IP address, host, or domain

DatabaseURI> name of the database for SOAP.

<callingName Choice presentationIdentity, asserted Specifies whether to use the

Source> Identity presentation number or the
asserted number to query the
CNAM server.

12.17.3 clear
This command is used to clear (set to no value) CallingNameRetrieval-related attributes.
1) Ensure you are at the /AS_CLI/Service/CallingNameRetrieval> level.
2) Enter:
clear <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 934
 Variable Field Type Valid Values Description

<attribute> MultipleChoice sipExternalDatabaseURI, sip The name of the attribute(s) to

ExternalDatabasePort, soap clear.
ExternalDatabaseURI

12.18 CallingPartyCategory
This level is used to view, add, modify, delete, clear, and detail CallingPartyCategory entries.

12.18.1 get
This command is used to view CallingPartyCategory attributes.
1) Ensure you are at the /AS_CLI/Service/CallingPartyCategory> level.
2) Enter:
get↵

12.18.2 detail
This command is used to view CallingPartyCategory attributes.
1) Ensure you are at the /AS_CLI/Service/CallingPartyCategory> level.
2) Enter:
detail <category>↵
where:
Variable Field Type Valid Values Description

<category> String 1 to 20 characters This is the unique key for the

calling party category.

12.18.3 add
This command is used to add CallingPartyCategory attributes.
1) Ensure you are at the /AS_CLI/Service/CallingPartyCategory> level.
2) Enter:
add <category> <userCategory> <payPhone> <operator> <default> <collectCall> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<category> String 1 to 20 characters This is the unique key for the

calling party category.

<user Choice true, false Controls which Calling Party

Category> Category (CPC) choices are
shown in the web drop-down box.

<payPhone> Choice true, false Indicates a call originated from a

pay phone.

<operator> Choice true, false Indicates a call originated by an

operator.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 935
 Variable Field Type Valid Values Description

<default> Choice true, false Only one CPC can be the

default. This CPC is assigned to
users when the CPC feature is
assigned to the user.

<collectCall> Choice true, false Indicates a collect call.

<attribute> MultipleChoice cpcValue, isupOliValue, gtdOli Additional attributes to include

Value, webDisplayKey through the add command.

<cpcValue> String 1 to 20 characters The SIP Calling Party Category

parameter.

<isupOliValue> Integer 0 through 255 The ISDN user part originating

line information.

<gtdOliValue> String 1 to 3 characters The ISDN generic transparency

descriptor OLI value.

<webDisplay String 1 to 40 characters Identifies a key in the

Key> BroadWorksLabels.properties file
to be used to display the localized
category name.

12.18.4 set
This command is used to modify CallingPartyCategory attributes.
1) Ensure you are at the /AS_CLI/Service/CallingPartyCategory> level.
2) Enter:
set <category> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<category> String 1 to 20 characters This is the unique key for the

calling party category.

<attribute> MultipleChoice userCategory, payPhone, The name of an attribute to

operator, default, collectCall, cpc modify.
Value, isupOliValue, gtdOliValue,
webDisplayKey

<user Choice true, false Controls which Calling Party

Category> Category (CPC) choices are
shown in the web drop down box.

<payPhone> Choice true, false Indicates a call originated from a

pay phone.

<operator> Choice true, false Indicates a call originated by an

operator.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 936
 Variable Field Type Valid Values Description

<default> String true Only one CPC can be the

default. This CPC is assigned to
users when the CPC feature is
assigned to the user.

<collectCall> Choice true, false Indicates a collect call.

<cpcValue> String 1 to 20 characters The SIP Calling Party Category

parameter.

<isupOliValue> Integer 0 through 255 The ISDN user part originating

line information.

<gtdOliValue> String 1 to 3 characters The ISDN generic transparency

descriptor OLI value.

<webDisplay String 1 to 40 characters Identifies a key in the

Key> BroadWorksLabels.properties file
to be used to display the localized
category name.

12.18.5 delete
This command is used to delete CallingPartyCategory attributes.
1) Ensure you are at the /AS_CLI/Service/CallingPartyCategory> level.
2) Enter:
delete <category>↵
where:
Variable Field Type Valid Values Description

<category> String 1 to 20 characters This is the unique key for the

calling party category to delete.

12.18.6 clear
This command is used to clear CallingPartyCategory attributes.
1) Ensure you are at the /AS_CLI/Service/CallingPartyCategory> level.
2) Enter:
clear <category> <attribute>↵
where:
Variable Field Type Valid Values Description

<category> String 1 to 20 characters This is the unique key of the

calling party category.

<attribute> MultipleChoice cpcValue, isupOliValue, gtdOli The name of the attribute(s) to

Value, webDisplayKey clear.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 937
12.19 Classmark
This level controls the Classmark to be communicated within Session Initiation Protocol (SIP) messaging
between the BroadWorks Application Server and the service provider softswitch during call setup. This is
accomplished by including new telephone-subscriber parameter, classmark, within the INVITE's From sip-
uri or telephone-uri.
The BroadWorks Application Server sends classmark according to configuration and proxy rules.

12.19.1 get
This command is used to view the list of classmarks.
1) Ensure you are at the /AS_CLI/Service/Classmark> level.
2) Enter:
get↵

12.19.2 add
This command is used to add a new classmark.
1) Ensure you are at the /AS_CLI/Service/Classmark> level.
2) Enter:
add <name> <value> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters Defines the name of the

Classmark.

<value> String 1 to 32 characters Defines the value of the

Classmark.

<attribute> MultipleChoice webDisplayKey Additional attributes to include

through the add command.

<webDisplay String 1 to 40 characters Identifies a key in the

Key> BroadWorksLabels.properties file
to be used to display the localized
Classmark name.

12.19.3 set
This command is used to modify existing classmark.
1) Ensure you are at the /AS_CLI/Service/Classmark> level.
2) Enter:
set <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters Defines the name of the

Classmark.

<attribute> MultipleChoice value, webDisplayKey The name of an attribute to

modify.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 938
 Variable Field Type Valid Values Description

<value> String 1 to 32 characters Defines the value of the

Classmark.

<webDisplay String 1 to 40 characters Identifies a key in the

Key> BroadWorksLabels.properties file
to be used to display the localized
category name.

12.19.4 delete
This command is used to delete an existing classmark from the system.
1) Ensure you are at the /AS_CLI/Service/Classmark> level.
2) Enter:
delete <name>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters Defines the name of the

Classmark.

12.19.5 clear
This command is used to clear Classmark-related attributes.
1) Ensure you are at the /AS_CLI/Service/Classmark> level.
2) Enter:
clear <name> <attribute>↵
where:
Variable Field Type Valid Values Description

<name> String 1 to 40 characters Defines the name of the

Classmark.

<attribute> MultipleChoice webDisplayKey The name of the attribute(s) to

clear.

12.19.6 Utilization
This level is used to view the utilization of the classmarks.

12.19.6.1 get
This command is used to view Classmark Utilization-related attributes. If the search produces over 1,000
entries, an error message will be displayed and user should refine the search criteria to narrow the search.
User's userId, last name, first name, phone number, extension, service provider Id and group Id can be
used as search criteria.
1) Ensure you are at the /AS_CLI/Service/Classmark/Utilization> level.
2) Enter:
get <name> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 939
 Variable Field Type Valid Values Description

<name> String 1 to 40 characters Defines the name of the

Classmark.

<attribute> MultipleChoice userIdStarts, userIdContains,

userIdEqualTo, lastNameStarts,
lastNameContains, lastName
EqualTo, firstNameStarts, first
NameContains, firstNameEqual
To, phoneStarts, phoneContains,
phoneEqualTo, extensionStarts,
extensionContains, extension
EqualTo, svcProviderIdEqualTo,
groupIdStarts, groupIdContains,
groupIdEqualTo

<userIdStarts> String 0 to 161 characters Displays only users whose user

ID starts with the specified string.

<userId String 0 to 161 characters Displays only users whose user

Contains> ID contains the specified string.

<userIdEqual String 1 to 161 characters Displays only users whose user

To> ID matches the specified string.

<lastName String 0 to 30 characters Displays only users whose last

Starts> name starts with the specified
string.

<lastName String 0 to 30 characters Displays only users whose last

Contains> name contains the specified
string.

<lastName String 1 to 30 characters Displays only users whose last

EqualTo> name matches the specified
string.

<firstName String 0 to 30 characters Displays only users whose first

Starts> name starts with the specified
string.

<firstName String 0 to 30 characters Displays only users whose first

Contains> name contains the specified
string.

<firstName String 1 to 30 characters Displays only users whose first

EqualTo> name matches the specified
string.

<phoneStarts> String 0 to 23 characters Displays only users whose phone

number starts with the specified
string.

<phone String 0 to 23 characters Displays only users whose phone

Contains> number contains the specified
string.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 940
 Variable Field Type Valid Values Description

<phoneEqual String 1 to 23 characters Displays only users whose phone

To> number matches the specified
string.

<extension String 0 to 20 characters Displays only users whose

Starts> extension starts with the specified
string.

<extension String 0 to 20 characters Displays only users whose

Contains> extension contains the specified
string.

<extension String 2 to 20 characters Displays only users whose

EqualTo> extension matches the specified
string.

<svcProviderId String 1 to 30 characters Displays only users whose

EqualTo> service provider IDs match the
specified string.

<groupId String 0 to 30 characters Displays only users whose group

Starts> ID starts with the specified string.

<groupId String 0 to 30 characters Displays only users whose group

Contains> ID contains the specified string.

<groupIdEqual String 1 to 30 characters Displays only users whose group

To> ID matches the specified string.

12.20 Collaborate
This level is used to view and modify Collaborate-related attributes in the system.

12.20.1 get
This command is used to view the system-level settings for the Collaborate Services.
1) Ensure you are at the /AS_CLI/Service/Collaborate> level.
2) Enter:
get↵

12.20.2 set
This command is used to modify system-level Collaborate parameters.
1) Ensure you are at the /AS_CLI/Service/Collaborate> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 941
 Variable Field Type Valid Values Description

<attribute> MultipleChoice collaborateRoomIdLength, instant The name of an attribute to

RoomIdleTimeoutSeconds, modify.
collaborateRoomMaximum
DurationMinutes, supportOutdial,
maximumCollaborateRoom
Participants, activeTalkerRefresh
IntervalSeconds, terminate
CollaborateRoomAfterGrace
Period, collaborateGracePeriod,
sendActiveCollaborateRoom
Notification, collaborateFrom
Address

<collaborate Integer 4 through 15 This parameter specifies the

RoomId maximum number of digits for the
Length> Collaborate room ID.

<instantRoom Integer 1 through 3600 This parameter determine how

IdleTimeout long an instant room runs without
Seconds> a participant, the wait time for the
first participant to join and the
wait time after the last participant
leaves the Collaborate room.

<collaborate Integer 1 through 7200 This parameter specifies the

RoomMaximum maximum duration of the
Duration Collaborate room session.
Minutes>

<support Choice true, false This parameter specifies the

Outdial> support of outdial during a
Collaborate room session. This
parameter also controls whether
the support outdial configuration
parameter can be controlled at
the collaborate bridge level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 942
 Variable Field Type Valid Values Description

<maximum Integer 3 through 30 This parameter specifies the

Collaborate maximum number of participants
Room in a single Collaborate room.
Participants> When the maximum collaborate
room participants setting is
changed, each provisioned
collaborate bridge (default and
non-default) whose maximum
collaborate room participants
setting exceeds that of the new
system maximum collaborate
room participants setting the
provisioned collaborate bridge
is updated with the new system-
level maximum collaborate room
participant setting. No change
to those provisioned collaborate
bridge (default and non-default)
whose maximum collaborate
room participants setting do not
exceed that of the new system-
level maximum collaborate room
participant setting.

<activeTalker Integer 1 through 5 The interval in which the Video

RefreshInterval Server uses to refresh the active
Seconds> talker details.

<terminate Choice true, false This parameter specifies whether

Collaborate the Collaborate room session
RoomAfter is terminated after the specified
GracePeriod> Collaborate grace period.

Variable: collaborateGracePeriod

collaborateGracePeriod This parameter specifies the

Collaborate grace period in hours
and minutes.

<collaborate Integer 0 through 23 This parameter specifies the

GracePeriod hours portion of the Collaborate
Hours> grace period.

<collaborate Choice 0, 15, 30, 45 This parameter specifies the

GracePeriod minutes portion of the Collaborate
Minutes> grace period.

<sendActive Choice true, false This parameter specifies whether

Collaborate or not an e-mail is sent to the
Room Collaborate owner when the first
Notification> participant joins the Collaborate
room session.

<collaborate String 1 to 80 characters This parameter specifies the from

FromAddress> e-mail address for the e-mail that
is sent to the Collaborate owner
when the first participant joins the
Collaborate room session.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 943
12.20.3 clear
This command is used to clear the system level Collaborate parameters.
1) Ensure you are at the /AS_CLI/Service/Collaborate> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice collaborateFromAddress The name of the attribute(s) to be

cleared.

12.21 CommunicationBarring
This level is used to view and modify CommunicationBarring-related attributes.

12.21.1 get
This command is used to view CommunicationBarring-related attributes.
1) Ensure you are at the /AS_CLI/Service/CommunicationBarring> level.
2) Enter:
get↵

12.21.2 set
This command is used to modify CommunicationBarring-related attributes.
1) Ensure you are at the /AS_CLI/Service/CommunicationBarring> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice directTransferScreening The name of an attribute to

modify.

<directTransfer Choice true, false When enabled, transferred

Screening> calls use the Communication
Barring Profile's originating
rules for screening. When
disabled, transferred calls use the
Communication Barring Profile's
redirecting rules for screening.

12.22 CommunicationBarringUserControl
This level is used to view and modify CommunicationBarringUserControl-related attributes.

12.22.1 get
This command is used to view CommunicationBarringUserControl-related attributes.
1) Ensure you are at the /AS_CLI/Service/CommunicationBarringUserControl> level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 944
 2) Enter:
get↵

12.22.2 set
This command is used to modify CommunicationBarringUserControl-related attributes.
1) Ensure you are at the /AS_CLI/Service/CommunicationBarringUserControl> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice enableLockout, maxNumberOf The name of an attribute to

FailedAttempts, lockoutDurationIn modify.
Minutes

<enable Choice true, false This is used to enable the ability

Lockout> to lockout users after a specified
number of failed attempts with the
wrong pin code.

<maxNumber Integer 1 through 10 This parameter dictates how

OfFailed many failed pin code attempts are
Attempts> allowed before lockout if lockout
is enabled.

<lockout Integer 1 through 600 This parameter dictates how long

DurationIn a lockout will last in minutes.
Minutes>

12.23 CustomerOriginatedTrace
This level is used to view and modify Customer Originated Trace-related attributes in the system.

12.23.1 get
This command is used to view Customer Originated Trace-related attributes.
1) Ensure you are at the /AS_CLI/Service/CustomerOriginatedTrace> level.
2) Enter:
get↵

12.23.2 set
This command is used to modify Customer Originated Trace-related attributes.
1) Ensure you are at the /AS_CLI/Service/CustomerOriginatedTrace> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice screenMaliciousCallers The name of an attribute to

modify.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 945
 Variable Field Type Valid Values Description

<screen Choice true, false Controls the service from creating

Malicious SCR records upon COT service
Callers> invocation from a user.

12.24 EmergencyZones
This level is used to view and modify the Emergency Zones-related attribute. You can enter the e-mail
address from which Emergency Zone e-mails are sent. This e-mail address is always used in the From
field of the e-mail sent to the user.

12.24.1 get
This command is used to view the Emergency Zones-related attribute.
1) Ensure you are at the /AS_CLI/Service/EmergencyZones> level.
2) Enter:
get↵

12.24.2 set
This command is used to modify the Emergency Zones-related attribute.
1) Ensure you are at the /AS_CLI/Service/EmergencyZones> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice defaultFromAddress The name of an attribute to

modify.

<defaultFrom String 1 to 80 characters The default From e-mail address

Address> of text messages sent to users
when incoming calls are received.

12.25 EnhancedCallLogs
This level is used to view and modify the Enhanced Call Logs related attribute. You can set to use DBS
instead of CDS as your call log server.

12.25.1 get
This command is used to view the Enhanced Call Logs (ECL)-related attributes.
1) Ensure you are at the /AS_CLI/Service/EnhancedCallLogs> level.
2) Enter:
get↵

12.25.2 set
This command is used to modify the Enhanced Call Logs (ECL)-related attributes.
1) Ensure you are at the /AS_CLI/Service/EnhancedCallLogs> level.
2) Enter:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 946
 set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice useDBS, maxNonPaged The name of an attribute to

ResponseSize, eclQuery modify.
ApplicationURL, eclQueryData
RepositoryURL

<useDBS> Choice true, false This parameter determines where

call log entries are stored. When
the value is set to "true", call log
entries are stored in the Database
Server. When the value is set to
"false", call log entries are stored
in the Call Detail Server.

<maxNon Integer 100 through 1000 This parameter specifies the

Paged maximum number of call log
ResponseSize> entries to return when paging
information is not specified
in the Open Client Interface-
Provisioning (OCI-P) request.
This parameter only applies when
the useDBS parameter is set to
"true".

<eclQuery String 1 to 256 characters This parameter specifies the URL

ApplicationURL> of the Enhanced Call Logs (ECL)
Query web application. The host
portion can be an IP address, a
host or a domain.

<eclQueryData String 1 to 256 characters This parameter specifies the URL

RepositoryURL> of the repository for the Enhanced
Call Logs (ECL) Query data.
The host portion can be an IP
address, a host or a domain.

12.25.3 clear
This command is used to clear the Enhanced Call Logs (ECL)-related attributes.
1) Ensure you are at the /AS_CLI/Service/EnhancedCallLogs> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice eclQueryApplicationURL, ecl The name of an attribute to clear.

QueryDataRepositoryURL

12.26 Executive
This level is used to view or modify the Executive related attribute.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 947
12.26.1 get
This command is used to view the system level Executive service settings.
1) Ensure you are at the /AS_CLI/Service/Executive> level.
2) Enter:
get↵

12.26.2 set
This command is used to modify the system level Executive service settings.
1) Ensure you are at the /AS_CLI/Service/Executive> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice treatVirtualOnNetCallsAsInternal The name of an attribute to

modify.

<treatVirtual Choice true, false This parameter controls if Virtual

OnNetCallsAs On-Net calls are treated as
Internal> internal calls for Executive call
filtering.

12.27 GroupNightForwarding
This level is used to view and modify the Group Night Forwarding-related attributes.

12.27.1 get
This command is used to view the Group Night Forwarding service settings.
1) Ensure you are at the /AS_CLI/Service/GroupNightForwarding> level.
2) Enter:
get↵

12.27.2 set
This command is used to modify the Group Night Forwarding service settings.
1) Ensure you are at the /AS_CLI/Service/GroupNightForwarding> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice nightForwardGroupCallsWithin The name of an attribute to

Enterprise modify.

<nightForward Choice true, false Defines if inter-group calls within

Group an enterprise will be forwarded
CallsWithin when the feature is activated on a
Enterprise> group within the enterprise.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 948
12.28 HuntGroup
This level is used to view and modify Hunt Group-related attributes.

12.28.1 get
This command is used to view Hunt Group-related attributes.
1) Ensure you are at the /AS_CLI/Service/HuntGroup> level.
2) Enter:
get↵

12.28.2 set
This command is used to modify Hunt Group-related attributes.
1) Ensure you are at the /AS_CLI/Service/HuntGroup> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice removeHuntGroupNameFromCLI The name of an attribute to

D, uniformCallDistributionPolicy modify.
Scope, allowAgentDeviceInitiated
Forward

<removeHunt Choice true, false When set to "true", the Hunt

GroupName Group name is removed from the
FromCLID> CLID. When set to "false", the
Hunt Group name is displayed in
the CLID.

<uniformCall Choice agent, huntGroup The system default configuration

Distribution to determine if the idle time of
PolicyScope> an agent is calculated on a per
agent basis or on a per call center
basis.

<allowAgent Choice true, false This parameter controls the use

DeviceInitiated of SIP 302 Moved Temporarily
Forward> responses specifically for Hunt
Group terminations to Agents.

12.29 INServiceControl
This level is used to view and modify Intelligent Network (IN) Service Control-related attributes. The IN
Service Control service allows legacy Public Switched Telephone Network (PSTN) subscribers to use a
subset of BroadWorks services. BroadWorks acts as an off-board extension of a Service Control Point
(SCP), allowing calls from the PSTN to be served by BroadWorks.
PSTN subscribers configure their services (such as Remote Office, Call Forwarding Busy, and Sequential
Ringing) from a web browser and they control their calls from a third-party application. PSTN subscribers
do not have to dial Feature Access Codes (FACs) or call the telephone company to make configuration
changes. The BroadWorks services that a PSTN subscriber can use are as follows: Alternate Numbers,
Call Forwarding, Call Forwarding Always, Call Forwarding Busy, Call Forwarding No Answer, Selective

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 949
 Call Notify, Do Not Disturb, Remote Office, Selective Call Acceptance, Selective Call Rejection, Sequential
Ringing, and Third-Party Voice Mail Support.
You can to view and modify the treatments available that are used for pre-answer actions and forwarding
actions for Do Not Disturb, Selective Call Acceptance, and Selective Call Rejection. These treatments are
not played back by BroadWorks but are used by the Service Control Point (SCP) to play back messages
from an intelligent peripheral. The treatments and their default values are as follows:
* msgRejectVoiceMail - TrtSelectCallReject.wav (This is reserved for future use.)
* msgRejectNoVoiceMail - TrtSelectCallReject.wav
* msgPreAnswerWait - TrtPreAnswerWait.wav
* msgBusy - TrtBusy.wav
* msgRelease - TrtRelease.wav
* msgNoAnswer - TrtNoAnswer.wav

12.29.1 get
This command is used to display IN Service Control-related attributes.
1) Ensure you are at the /AS_CLI/Service/INServiceControl> level.
2) Enter:
get↵

12.29.2 set
This command is used to modify IN Service Control-related attributes.
1) Ensure you are at the /AS_CLI/Service/INServiceControl> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice preAnswerActionTimeout, msg The name of an attribute to

RejectNoVoiceMail, msgReject modify.
VoiceMail, msgPreAnswerWait,
msgBusy, msgRelease, msgNo
Answer, msgOcpReject, msg
ForwardLoop, msgTemporarily
Unavailable

<preAnswer Integer 6 through 36 The pre-answer action timeout

ActionTimeout> period (in seconds).

<msgRejectNo String 1 to 161 characters The treatment to be played

VoiceMail> for msgRejectNoVoiceMail.
The default is
TrtSelectCallReject.wav.

<msgReject String 1 to 161 characters The treatment to be played for

VoiceMail> msgRejectVoiceMail. The default
is TrtSelectCallReject.wav.Note
that this parameter is reserved for
future use.

<msgPre String 1 to 161 characters The treatment to be played for

AnswerWait> msgPreAnswerWait. The default
is TrtPreAnswerWait.wav.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 950
 Variable Field Type Valid Values Description

<msgBusy> String 1 to 161 characters The treatment to be played

for msgBusy. The default is
TrtBusy.wav.

<msgRelease> String 1 to 161 characters The treatment to be played for

msgRelease. The default is
TrtRelease.wav.

<msgNo String 1 to 161 characters The treatment to be played for

Answer> msgNoAnswer. The default is
TrtNoAnswer.wav.

<msgOcp String 1 to 161 characters The treatment to be played for

Reject> msgOcpReject. The default is
TrtOutCallRestrict.wav.

<msgForward String 1 to 161 characters The treatment to be played for

Loop> msgForwardLoop. The default is
TrtMaxForwards.wav.

<msg String 1 to 161 characters The treatment to be played for

Temporarily msgTemporarilyUnavailable. The
Unavailable> default is TrtBusy.wav.

12.30 InCallServiceActivation
The In-Call Service Activation service extends the basic TDM overlay model by allowing TDM-hosted users
to activate mid-call services via dual-tone multi-frequency (DTMF) digits. This level is used to view and
modify IncallServiceActivation attributes.

12.30.1 get
This command is used to view In-Call Service Activation attributes.
1) Ensure you are at the /AS_CLI/Service/InCallServiceActivation> level.
2) Enter:
get↵

12.30.2 set
This command is used to modify In-Call Service Activation attributes.
1) Ensure you are at the /AS_CLI/Service/InCallServiceActivation> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice flashActivationDigits, callTransfer The name of an attribute to

ActivationDigits modify.

<flashActivation String 1 to 8 characters Default DTMF digits used to

Digits> activate flash in call.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 951
 Variable Field Type Valid Values Description

<callTransfer String 1 to 8 characters Default DTMF digits used to

Activation activate call transfer in call.
Digits>

12.31 IntegratedIMP
This level is used to view, modify, and clear the Integrated Instant Messaging and Presence (IM&P)-related
attributes.

12.31.1 get
This command is used to view the Integrated Instant Messaging and Presence (IM&P)-related attributes.
1) Ensure you are at the /AS_CLI/Service/IntegratedIMP> level.
2) Enter:
get↵

12.31.2 set
This command is used to modify the Integrated Instant Messaging and Presence (IM&P)-related attributes.
1) Ensure you are at the /AS_CLI/Service/IntegratedIMP> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice serviceDomain, servicePort, add The name of an attribute to

ServiceProviderInIMUsername, modify.
boshURL, allowImpPassword
Retrieval

<service String 1 to 80 characters The domain of the Instant

Domain> Messaging and Presence (IM&P)
XMPP Messaging Server cluster.

<servicePort> Integer 1 through 65535 The address port of the Instant

Messaging and Presence (IM&P)
Messaging Server cluster.

<addService Choice true, false When true the service provider

ProviderInIM name will be included in the IM
Username> username for Integrated Instant
Messaging and Presence (IM&P)
service.

<boshURL> String 1 to 256 characters The URL the client applications

should use to communicate using
BOSH with the XMPP server.

<allowImp Choice true, false This parameter determines

Password whether the Instant Messaging
Retrieval> and Presence (IM&P) password
is returned to authenticated client
applications.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 952
12.31.3 clear
This command is used to clear Integrated Instant Messaging and Presence (IM&P)-related attributes.
1) Ensure you are at the /AS_CLI/Service/IntegratedIMP> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice serviceDomain, servicePort, The name of an attribute to clear.

boshURL

12.32 Intercept
This level is used to temporarily suspend service for users who are roaming outside of the carrier serving
area.

12.32.1 SystemAllowedDNList
This level is used to view and modify System Allowed DN List-related attributes.

12.32.1.1 get
This command is used to view System Allowed Directory Number (DN) List-related attributes.
1) Ensure you are at the /AS_CLI/Service/Intercept/SystemAllowedDNList> level.
2) Enter:
get↵

12.32.1.2 add
This command is used to add System Allowed Directory Number (DN) List-related attributes.
1) Ensure you are at the /AS_CLI/Service/Intercept/SystemAllowedDNList> level.
2) Enter:
add <number> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<number> String 1 to 23 characters The Phone number of the entry to

add.

<attribute> MultipleChoice description Additional attributes to include

through the add command.

<description> String 1 to 80 characters Provides more detail about this

phone number.

12.32.1.3 set
This command is used to modify System Allowed Directory Number (DN) List-related attributes.
1) Ensure you are at the /AS_CLI/Service/Intercept/SystemAllowedDNList> level.
2) Enter:
set <number> <attribute>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 953
 where:
Variable Field Type Valid Values Description

<number> String 1 to 23 characters The Phone number of the entry to

modify.

<attribute> MultipleChoice description The name of an attribute to

modify.

<description> String 1 to 80 characters Provides more detail about this

phone number.

12.32.1.4 delete
This command is used to delete System Allowed Directory Number (DN) List-related attributes.
1) Ensure you are at the /AS_CLI/Service/Intercept/SystemAllowedDNList> level.
2) Enter:
delete <number>↵
where:
Variable Field Type Valid Values Description

<number> String 1 to 23 characters The Phone number of the entry to

delete.

12.32.1.5 clear
This command is used to clear (set to no value) System Allowed Directory Number (DN) List-related
attributes.
1) Ensure you are at the /AS_CLI/Service/Intercept/SystemAllowedDNList> level.
2) Enter:
clear <number> <attribute>↵
where:
Variable Field Type Valid Values Description

<number> String 1 to 23 characters The Phone number of the entry to

clear.

<attribute> MultipleChoice description The name of the attribute(s) to

clear.

12.32.2 User
This level allows carriers to temporarily suspend service for users who are roaming outside of the carrier
serving area.

12.32.2.1 get
This command is used to view system-wide settings for the Intercept User service.
1) Ensure you are at the /AS_CLI/Service/Intercept/User> level.
2) Enter:
get↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 954
12.32.2.2 set
This command is used to modify system-wide settings for the Intercept User service.
1) Ensure you are at the /AS_CLI/Service/Intercept/User> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice emergencyAndRepairIntercept The name of an attribute to

modify.

<emergency Choice true, false When set to "true", this service

AndRepair blocks all calls including
Intercept> emergency and repair calls.

12.33 InventoryReport
This level is used to view and modify the Inventory Report-related attribute. You can enter the e-mail
address from which the Inventory Report e-mails are sent. This e-mail address is always used in the From
field of the Inventory Report e-mail that is sent to specified users.

12.33.1 get
This command is used to view the Inventory Report-related attribute.
1) Ensure you are at the /AS_CLI/Service/InventoryReport> level.
2) Enter:
get↵

12.33.2 set
This command is used to the modify Inventory Report-related attribute.
1) Ensure you are at the /AS_CLI/Service/InventoryReport> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice defaultFromAddress The name of an attribute to

modify.

<defaultFrom String 1 to 80 characters The default From e-mail address

Address> of text messages sent to users for
the Inventory Report.

12.34 LegacyAutomaticCallback
This level is used to manage the implementation of the legacy Automatic Callback (ACB) feature on
BroadWorks that a customer currently has deployed on the Nortel CS 2000s in their network. This
capability allows a caller to "camp-on" a busy called party and be automatically called back when the called
party hangs up.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 955
12.34.1 get
This command is used to view Legacy Automatic Callback-related attributes.
1) Ensure you are at the /AS_CLI/Service/LegacyAutomaticCallback> level.
2) Enter:
get↵

12.34.2 set
This command is used to modify Legacy Automatic Callback-related attributes.
1) Ensure you are at the /AS_CLI/Service/LegacyAutomaticCallback> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice maxOriginatorSessions, max The name of an attribute to

TerminatorSessions, t7, tRing, t2, modify.
t5, t6, t10_O, t4, t8, t10_T

<maxOriginator Integer 1 through 30 The total number of outstanding

Sessions> Automatic Callback sessions
that can be initiated by one
subscriber.

<max Integer 1 through 30 The total number of outstanding

Terminator Automatic Callback sessions that
Sessions> can be queued against the same
subscriber.

<t7> Integer 5 through 180 Specifies the duration timer sent

from originating switch that is
run at the terminating switch.
It is the number of minutes the
originating switch is potentially
willing to wait for the called party
to become free. It is started with
the acceptance of request to
send notification. It is stopped
when cancelled or the called
party becomes free for the
queued caller. If the timer expires,
notification of expiration may be
sent to the originating switch. The
unit of measure is minutes.

<tRing> Integer 1 through 120 Monitors the length of time that

the calling party may receive
Special Rering. The unit of
measure is seconds.

<t2> Integer 1 through 20 Waiting period between

unanswered Special Rering and
re-initiation of the service. The
unit of measure is minutes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 956
 Variable Field Type Valid Values Description

<t5> Integer 2 through 10 Specifies the time allowed by the

originating switch to receive a
response from the terminating
switch. The timer is started when
a message is sent and stopped
when the expected response is
received. The unit of measure in
seconds.

<t6> Integer 1 through 60 This timer is started as soon as

the request has been validated
and delayed processing is
invoked. It determines how
long the originating switch is
continually willing to wait for
the called party to become free
without requiring the calling party
to extend the interval. When it
expires a dequeue message and
maybe cancellation message is
sent to the terminating switch.
The unit of measure is minutes.

<t10_O> Integer 1 through 120 This timer is started when the

request has been validated and
an initial query message has
been sent to the terminating
switch. It is the length of time
that originating switch is willing to
allow the call to remain queued
for callback. It is stopped by the
service being completed (T6
expires, Normal Call Setup, etc.).
The unit of measure is minutes.

<t4> Integer 0 through 15 This is defined as Guard

Time used by the terminating
switch. After the called party
becomes free, this is the time
allowed for the called party to be
become busy again and preempt
informing origination switch that
called party is free. The unit of
measure is seconds.

<t8> Integer 0 through 120 This timer is started in the

terminating switch when a calling
party is notified that the called
party is idle (either a "free"
message is sent or a "free"
response to a query is sent). The
unit of measure is seconds.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 957
 Variable Field Type Valid Values Description

<t10_T> Integer 1 through 120 This timer is started when the

terminating switch has queued
the incoming request. It is
stopped by the incoming dequeue
request, or an internal timeout. If
the timer expires, the queued call
is removed. T10 determines the
maximum time that a call can stay
in the queue. The unit of measure
is minutes.

12.34.3 LineTypes
This level is used to manage the Legacy Automatic Callback Line Type-related attributes.

12.34.3.1 get
This command is used to view Legacy Automatic Callback Line Type-related attributes.
1) Ensure you are at the /AS_CLI/Service/LegacyAutomaticCallback/LineTypes> level.
2) Enter:
get↵

12.34.3.2 set
This command is used to modify Legacy Automatic Callback Line Type-related attributes.
1) Ensure you are at the /AS_CLI/Service/LegacyAutomaticCallback/LineTypes> level.
2) Enter:
set <lineType> <attribute>↵
where:
Variable Field Type Valid Values Description

<lineType> Choice individual, coin, series, hunt, The line type.

unassigned, pbx, multiparty,
choke, oos, nonspecific,
telecampus, isdn, telekibutz,
spare

<attribute> MultipleChoice match, noMatch The name of an attribute to

modify.

<match> Choice accept, deny Action if value "match" is returned

in the attribute "match". "match"
will be set if the called number
in the servicekey matches user's
configurable caller ID or user's
group configurable caller ID (if it
is set).

<noMatch> Choice accept, deny Action if value "nomatch" is

returned in the attribute "match".
"nomatch" is returned if the
called number in the servicekey
does not match the user's
configurable caller ID or user's
group configurable caller ID.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 958
12.35 LocationBasedCallingRestrictions
This level is used to manage the system level configuration for the Location Based Calling Restriction.

12.35.1 get
This command is used to get the system level Location Based Calling Restriction attributes.
1) Ensure you are at the /AS_CLI/Service/LocationBasedCallingRestrictions> level.
2) Enter:
get↵

12.35.2 set
This command is used to modify the system level Location Based Calling Restriction attributes.
1) Ensure you are at the /AS_CLI/Service/LocationBasedCallingRestrictions> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice physicalLocationIndicator, The name of an attribute to

enforceMscValidation, enable modify.
OfficeZoneAnnouncement,
enhanceOfficeZone

<physical Choice ci, lac-ci, pani, disregardZones Used to indicate where the
Location physical location is extracted
Indicator> from. *ci: Cell Identification field of
the P CAMEL CellIDorLAI header
(5 digits) *lac-ci: Location Area
Code + Cell Identification fields of
the P CAMEL CellIDorLAI header
(10 digits) *pani: P Network
Address Info (PANI) header (refer
to RFC 3455) *disregardZones:
Zones are disregarded.

<enforceMsc Choice true, false Controls whether the home

Validation> network and roaming network
addresses provisioned are used
in service logic.

<enable Choice true, false Controls whether the Location-

OfficeZone Based Calling Restrictions plays
Announcement> a system announcement when a
user originates a call from within
their office zone.

<enhanceOffice Choice true, false Controls whether the Roaming is

Zone> check only when Location-Based
Calling Restrictions is assigned to
the user or not.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 959
12.36 MaliciousCallTrace
This level is used to view and modify Malicious Call Trace-related attributes.

12.36.1 get
This command is used to view Malicious Call Trace-related attributes.
1) Ensure you are at the /AS_CLI/Service/MaliciousCallTrace> level.
2) Enter:
get↵

12.36.2 set
This command is used to modify Malicious Call Trace-related attributes.
1) Ensure you are at the /AS_CLI/Service/MaliciousCallTrace> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice playMCTWarningAnnouncement The name of an attribute to

modify.

<playMCT Choice true, false Controls whether the malicious

Warning call trace warning announcement
Announcement> should be played.

12.37 MeetMeConferencing
This level is used to view and modify MeetMeConferencing-related attributes in the system.

12.37.1 get
This command is used to view the system level settings of the Meet-Me Conferencing.
1) Ensure you are at the /AS_CLI/Service/MeetMeConferencing> level.
2) Enter:
get↵

12.37.2 set
This command is used to modify system level conference parameters.
1) Ensure you are at the /AS_CLI/Service/MeetMeConferencing> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 960
 Variable Field Type Valid Values Description

<attribute> MultipleChoice conferenceIdLength, moderator The name of an attribute to

PinLength, enableConference modify.
EndDateRestriction, conference
EndDateRestrictionInMonths,
deleteExpiredConferenceAfter
HoldPeriod, expiredConference
HoldPeriodInDays, recording
WebAppURL, recordingFile
Format, terminateAfterGrace
Period, conferenceGracePeriod,
conferenceParticipantEarlyEntry
Minutes, enableConference
ExpiryNotification, enable
ActiveConferenceNotification,
conferenceFromAddress, max
RecordingDurationPerConference
InHours, conferenceActiveTalker
RefreshIntervalSeconds

<conferenceId Integer 6 through 12 Length of conference id.

Length>

<moderatorPin Integer 6 through 12 Length of moderator pin.

Length>

<enable Choice true, false Enable or disable the system

Conference level restriction on end dates.
EndDate
Restriction>

<conference Integer 1 through 99 Number of months the system

EndDate should allow the conferences to
RestrictionIn be active.
Months>

<deleteExpired Choice true, false Enable or disable the deletion of

Conference expired conferences.
AfterHold
Period>

<expired Choice 1, 2, 3, 4, 5, 6, 7, 15, 30, 60 Number of days the system

Conference should hold the expired
HoldPeriodIn conferences before deletion.
Days>

<recordingWeb String 1 to 256 characters The URL of the Recording Web

AppURL> Application.

<recordingFile Choice WAV, MP3 The file format for audio

Format> conference recordings.

<terminateAfter Choice true, false Enable or disable automatic

GracePeriod> conference termination after the
grace period.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 961
 Variable Field Type Valid Values Description

Variable: conferenceGracePeriod

conferenceGracePeriod Grace period in hours and

minutes before forcefully ending
the conference.

<conference Integer 0 through 23 Hours portion of conference

GracePeriod grace period.
Hours>

<conference Choice 0, 15, 30, 45 Minutes portion of conference

GracePeriod grace period.
Minutes>

<conference Integer 0 through 15 Early entry allowed into the

ParticipantEarly conference prior to conference
EntryMinutes> start in minutes.

<enable Choice true, false Enable or disable the conference

Conference expiry email notification.
Expiry
Notification>

<enableActive Choice true, false Enable or disable the active

Conference conference email notification.
Notification>

<conference String 1 to 80 characters Default "From:" email address

FromAddress> from which email notifications are
sent.

<maxRecording Integer 1 through 12 Maximum duration of the

DurationPer recording in hours.
ConferenceIn
Hours>

<conference Integer 1 through 5 The interval in which the media

ActiveTalker server uses to refresh the active
RefreshInterval talker details.
Seconds>

12.37.3 clear
This command is used to clear the system level settings of the Meet-Me Conferencing.
1) Ensure you are at the /AS_CLI/Service/MeetMeConferencing> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice recordingWebAppURL The name of the attribute(s) to be

cleared.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 962
12.38 MusicOnHold
When a device initiates a call transfer using a hold INVITE followed by the REFER method, the time for
the device to process and send the REFER may be longer than the Music On Hold processing delay on
the BroadWorks Application Server. This level is used to configure a timer which delays Music On Hold
when a hold request is received. This ensures the user does not hear Music On Hold for common transfer
scenarios.

12.38.1 get
This command is used to view Music On Hold-related attributes.
1) Ensure you are at the /AS_CLI/Service/MusicOnHold> level.
2) Enter:
get↵

12.38.2 set
This command is used to modify Music On Hold-related attributes.
1) Ensure you are at the /AS_CLI/Service/MusicOnHold> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice delayMilliseconds The name of an attribute to

modify.

<delay Integer 0 through 5000 Specifies the delay in

Milliseconds> milliseconds before Music On
Hold is triggered.

12.39 NumberPortability
This level is used to view and modify the system number portability service settings.

12.39.1 get
This command is used to view the system Number Portability service settings.
1) Ensure you are at the /AS_CLI/Service/NumberPortability> level.
2) Enter:
get↵

12.39.2 set
This command is used to modify the system number portability service settings.
1) Ensure you are at the /AS_CLI/Service/NumberPortability> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 963
 Variable Field Type Valid Values Description

<attribute> MultipleChoice continueCallAsDialedOnTimeout The name of an attribute to

OrError, nameLookupTimeout modify.
Milliseconds

<continueCall Choice true, false This parameter determines how

AsDialedOn the call is treated when a timer
TimeoutOr expires or an error response is
Error> received.

<nameLookup Integer 100 through 10000 This parameter specifies the

Timeout name lookup timeout value.
Milliseconds>

12.39.3 Status
This level is used to view, add, modify, and delete Number Portability status announcement file mappings.

12.39.3.1 get
This command is used to view the Number Portability status announcement file mappings.
1) Ensure you are at the /AS_CLI/Service/NumberPortability/Status> level.
2) Enter:
get↵

12.39.3.2 add
This command is used to add the Number Portability status announcement file mappings.
1) Ensure you are at the /AS_CLI/Service/NumberPortability/Status> level.
2) Enter:
add <status> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<status> String 1 to 40 characters This parameter specifies the

name of the Number Portability
status.

<attribute> MultipleChoice announcementFile Additional attributes to include

through the add command.

<announcement String 1 to 256 characters This parameter specifies the

File> name of the audio file to play
as the announcement for the
specified status. This file name
must be relative to the localized
system prompts directory, where
current system-defined audio
treatments are located (that
is, files must be copied to that
directory). The file must be in
the proper format (Linear Pulse
Code Modulation (PCM) 16 bit @
16kHz mono .wav file).

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 964
12.39.3.3 set
This command is used to modify the Number Portability status announcement file mappings.
1) Ensure you are at the /AS_CLI/Service/NumberPortability/Status> level.
2) Enter:
set <status> <attribute>↵
where:
Variable Field Type Valid Values Description

<status> String 1 to 40 characters This parameter specifies the

name of the Number Portability
status.

<attribute> MultipleChoice newStatus, announcementFile The name of an attribute to

modify.

<newStatus> String 1 to 40 characters This parameter specifies the new

status name.

<announcement String 1 to 256 characters This parameter specifies the

File> name of the audio file to play
as the announcement for the
specified status. This file name
must be relative to the localized
system prompts directory, where
current system-defined audio
treatments are located (that
is, files must be copied to that
directory). The file must be in
the proper format (Linear Pulse
Code Modulation (PCM) 16 bit @
16kHz mono .wav file).

12.39.3.4 delete
This command is used to delete an existing Number Portability status announcement file mapping.
1) Ensure you are at the /AS_CLI/Service/NumberPortability/Status> level.
2) Enter:
delete <status>↵
where:
Variable Field Type Valid Values Description

<status> String 1 to 40 characters This parameter specifies the

name of the Number Portability
status to be deleted.

12.39.3.5 clear
This command is used to clear attributes for the specified Number Portability Status.
1) Ensure you are at the /AS_CLI/Service/NumberPortability/Status> level.
2) Enter:
clear <status> <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 965
 Variable Field Type Valid Values Description

<status> String 1 to 40 characters This parameter specifies the

name of the Number Portability
status.

<attribute> MultipleChoice announcementFile This parameter specifies the

name of the attribute(s) to clear.

12.39.3.6 DigitPatterns
This level is used to view, add, modify, and delete Number Portability status Digit Pattern mappings.
12.39.3.6.1 get
This command is used to view the number portability query digit pattern to number portability status
mappings.
1) Ensure you are at the /AS_CLI/Service/NumberPortability/Status/DigitPatterns> level.
2) Enter:
get [<attribute>]↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice digitPatternStarts, digitPattern The name of a digit pattern

Contains, digitPatternEquals, search criteria.
statusStarts, statusContains,
statusEquals

<digitPattern String 0 to 160 characters Displays only digit patterns that

Starts> start with the specified string.

<digitPattern String 0 to 160 characters Displays only digit patterns that

Contains> contain the specified string.

<digitPattern String 1 to 160 characters Displays only the digit pattern that
Equals> is equal to the specified string.

<statusStarts> String 0 to 40 characters Displays only digitPatterns whose

statuses start with the specified
string.

<status String 0 to 40 characters Displays only digitPatterns whose

Contains> statuses contain the specified
string.

<statusEquals> String 1 to 40 characters Displays only the digitPatterns

whose status is equal to the
specified string.

12.39.3.6.2 add
This command is used to add number portability query digit pattern to number portability status mappings.
1) Ensure you are at the /AS_CLI/Service/NumberPortability/Status/DigitPatterns> level.
2) Enter:
add <digitPattern> <status>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 966
 Variable Field Type Valid Values Description

<digitPattern> String 1 to 160 characters This parameter specifies the

Number Portability digit pattern.
The following wildcards are
allowed: *$ - Denotes any number
of digits. For example, "555$"
matches any string of digits
beginning with 555. The "$"
can only appear at the end of
a digit pattern. *? - Denotes
any single digit. For example,
"555?" matches any four-digit
string beginning with "555". *[]
- Denotes a single digit that
satisfies the specified range
of digits. A consecutive range
is indicated with a hyphen "-",
while a nonconsecutive range
is indicated with a comma ",".
Hyphens and commas can be
used in combination, for example
"[5-7,9]". *+ - Denotes an E.164
digit pattern and is only allowed
as the first character of the
pattern.

<status> String 1 to 40 characters This parameter specifies the

name of the Number Portability
status.

12.39.3.6.3 set
This command is used to modify number portability query digit pattern to number portability status
mappings.
1) Ensure you are at the /AS_CLI/Service/NumberPortability/Status/DigitPatterns> level.
2) Enter:
set <digitPattern> <attribute>↵
where:
Variable Field Type Valid Values Description

<digitPattern> String 1 to 160 characters This parameter specifies the

Number Portability digit pattern
being modified.

<attribute> MultipleChoice newDigitPattern, status The name of an attribute to

modify.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 967
 Variable Field Type Valid Values Description

<newDigit String 1 to 160 characters This parameter specifies the

Pattern> new Number Portability digit
pattern. The following wildcards
are allowed: *$ - Denotes any
number of digits. For example,
"555$" matches any string of
digits beginning with 555. The
"$" can only appear at the end
of a digit pattern. *? - Denotes
any single digit. For example,
"555?" matches any four-digit
string beginning with "555". *[]
- Denotes a single digit that
satisfies the specified range
of digits. A consecutive range
is indicated with a hyphen "-",
while a nonconsecutive range
is indicated with a comma ",".
Hyphens and commas can be
used in combination, for example
"[5-7,9]". *+ - Denotes an E.164
digit pattern and is only allowed
as the first character of the
pattern.

<status> String 1 to 40 characters This parameter specifies the

name of the Number Portability
status.

12.39.3.6.4 delete
This command is used to delete number portability query digit pattern to number portability status
mappings.
1) Ensure you are at the /AS_CLI/Service/NumberPortability/Status/DigitPatterns> level.
2) Enter:
delete <digitPattern>↵
where:
Variable Field Type Valid Values Description

<digitPattern> String 1 to 160 characters This parameter specifies the

Number Portability digit pattern
being deleted.

12.40 OutgoingCPCallTypes
This level is used to view, add, and delete call type entries for the Outgoing Calling Plan service.

12.40.1 get
This command lists the outgoing calling plan digit mappings for a specified country code. If no country code
is specified, data for all defined country codes are displayed.
1) Ensure you are at the /AS_CLI/Service/OutgoingCPCallTypes> level.
2) Enter:
get [<countryCode>]↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 968
 where:
Variable Field Type Valid Values Description

<countryCode> Integer 1 through 999 The international dialing code

assigned to a specific country.

12.40.2 add
This command adds a new outgoing calling plan, call mapping for a specified country code.
1) Ensure you are at the /AS_CLI/Service/OutgoingCPCallTypes> level.
2) Enter:
add <countryCode> <publicDigitMap> <callType>↵
where:
Variable Field Type Valid Values Description

<countryCode> Integer 1 through 999 The international dialing code

assigned to the specific country;
must be a valid, defined system
country code.

<publicDigit String 1 to 30 characters This is a 1 to 30 digit pattern

Map> containing digits, "x", ".", or "#".
Where "x" = single digit wildcard,
"." = multiple digit wildcard, and
"#" = # key. The "." can only be
the last character in the map.

<callType> String 1 to 40 characters Adds a valid call type.

12.40.3 delete
This command removes the mapping of the specified digitMap to an outgoing calling plan call type for the
specified country code.
1) Ensure you are at the /AS_CLI/Service/OutgoingCPCallTypes> level.
2) Enter:
delete <countryCode> <publicDigitMap>↵
where:
Variable Field Type Valid Values Description

<countryCode> Integer 1 through 999 The international dialing code

assigned to the specific country;
must be a valid, defined system
country code.

<publicDigit String 1 to 30 characters This is a 1 to 30 digit pattern

Map> containing digits, "x", ".", or "#".
Where "x" = single digit wildcard,
"." = multiple digit wildcard, and
"#" = # key. The "." can only be
the last character in the map.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 969
12.41 OutgoingCallingPlan
This activity introduces a new system parameter, Direct Transfer Screening. This system parameter
defines how the Outgoing Calling Plan (OCP) and Outgoing Digit Plan (ODP) Restrictions apply to
transferred calls. When disabled (default), OCP and ODP function as usual and the transfer restrictions
are bundled with the forward restrictions under the Initiating Call Forwards/Transfers tab. When enabled,
the OCP functionality is changed as follows:The Initiating Call Forwards/Transfers tab is changed to an
Initiating Call Forwards tab. Transferred calls are subject to regular call restrictions instead of forwarded
call restrictions. In a scenario where A calls B and B transfers to C, when B makes the transfer, OCP
no longer screens the B to A and the B to C legs. Note that this activity has no impact on the Being
Forwarded/Transferred tab. Similarly, when enabled, the Outgoing Digit Plan functionality is changed as
follows:The Initiating Call Forwards/Transfers tab is changed to an Initiating Call Forwards tab. Transferred
calls are subject to regular digit restrictions instead of forwarded digit restrictions. In a scenario where A
calls B and B transfers to C, when B makes the transfer, ODP no longer screens the B to A and the B to
C legs. Hence, when the Direct Transfer Screening parameter is enabled, all calls made by the user are
tested against the OCP/ODP originating call criteria, and no further screening is performed upon transfer.
This feature has no impact on the OCP/ODP screening currently performed on the setup of a Remote
Office call leg.

12.41.1 get
This command is used to view Outgoing Calling Plan-related attributes.
1) Ensure you are at the /AS_CLI/Service/OutgoingCallingPlan> level.
2) Enter:
get↵

12.41.2 set
This command is used to modify Outgoing Calling Plan-related attributes.
1) Ensure you are at the /AS_CLI/Service/OutgoingCallingPlan> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice directTransferScreening, enable The name of an attribute to

EnhancedTollCallTyping modify.

<directTransfer Choice true, false This attribute defines how the

Screening> Outgoing Calling Plan (OCP)
and Outgoing Digit Plan (ODP)
restrictions apply to transferred
calls.

<enable Choice true, false This attribute defines if "TO"

EnhancedToll prefixed calls would be
CallTyping> considered toll calls or not.

12.42 PersonalAssistant
This level is used to view and modify the Personal Assistant Voice Portal key settings at the system level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 970
12.42.1 get
This command is used to view the Personal Assistant Voice Portal key settings at the system level.
1) Ensure you are at the /AS_CLI/Service/PersonalAssistant> level.
2) Enter:
get↵

12.42.2 set
This command is used to modify the Personal Assistant Voice Portal key settings at the system level.
1) Ensure you are at the /AS_CLI/Service/PersonalAssistant> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice transferToAttendantKey, transfer The name of an attribute to

ToVoiceMessagingKey modify.

<transferTo Choice 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, *, # This parameter specifies the key

AttendantKey> to transfer to attendant.

<transfer Choice 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, *, # This parameter specifies the key

ToVoice to transfer to voice mail.
Messaging
Key>

12.43 PhysicalLocation
This level allows an emergency call to continue even if it would have been blocked otherwise by physical
location screening.

12.43.1 get
This command is used to view Physical Location-related attributes.
1) Ensure you are at the /AS_CLI/Service/PhysicalLocation> level.
2) Enter:
get↵

12.43.2 set
This command is used to modify Physical Location-related attributes.
1) Ensure you are at the /AS_CLI/Service/PhysicalLocation> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice alwaysAllowEmergencyCalls The name of an attribute to

modify.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 971
 Variable Field Type Valid Values Description

<alwaysAllow Choice true, false When set to "true", emergency

Emergency calls are allowed.
Calls>

12.44 ReceptionistEnterprise
As an alternative to the Attendant Console, the BroadWorks Receptionist can be installed on a desktop
computer. It also uses two services: Receptionist service, to enable the client, and Phone Status
Monitoring (PSM) service, to configure a static list of users to monitor. The Phone Status Monitoring
service is limited in scope to the users in a given group, but it imposes no hard limit on the number of users
that can be monitored. In addition, the Receptionist allows dynamic monitoring of up to 100 users in the
entire enterprise.This level is used to view, add, modify, and delete ReceptionistEnterprise entries.

12.44.1 get
This command is used to display parameters associated with ReceptionistEnterprise.
1) Ensure you are at the /AS_CLI/Service/ReceptionistEnterprise> level.
2) Enter:
get↵

12.44.2 set
This command is used to modify parameters associated with Receptionist Enterprise.
1) Ensure you are at the /AS_CLI/Service/ReceptionistEnterprise> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice maxMonitoredUsers The name of an attribute to

modify.

<maxMonitored Integer 1 through 1000 The maximum number of users

Users> that can be added to the list of
users to be monitored on startup.
The default value is 200.

12.45 SelectiveServices
This level is used to view and set SelectiveServices related attributes. Changes made apply to all selective
services.

12.45.1 get
This command is used to view the selective services-related attributes.
1) Ensure you are at the /AS_CLI/Service/SelectiveServices> level.
2) Enter:
get↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 972
12.45.2 set
This command is used to modify the selective services-related attributes.
1) Ensure you are at the /AS_CLI/Service/SelectiveServices> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice scheduleCombination, screen The name of an attribute to

PrivateNumber modify.

<schedule Choice union, intersection Determines the processing logic

Combination> for selective services that use
Time and Holiday Schedules.

<screenPrivate Choice true, false Controls whether specific phone

Number> numbers with privacy should be
screened by Selective services.

12.46 SessionAdmissionControl
This level is used to view and set SessionAdmissionControl related attributes.

12.46.1 get
This command is used to view session admission control-related attributes.
1) Ensure you are at the /AS_CLI/Service/SessionAdmissionControl> level.
2) Enter:
get↵

12.46.2 set
This command is used to modify session admission control-related attributes.
1) Ensure you are at the /AS_CLI/Service/SessionAdmissionControl> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice countLongConnectionsToMedia The name of an attribute to

Server, SACHandlingForMoH, modify.
blockVMDepositDueToSACLimits

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 973
 Variable Field Type Valid Values Description

<blockVM Choice true, false This parameter determines if calls

DepositDue to a voice mail deposit session
ToSACLimits> are allowed and counted when
it exceeds the capacity of the
Service Access Code (SAC)
group. When set to "true", the
current behavior to the SAC
group service is maintained.
When set to "false", calls to a
voice mail deposit session will
beare allowed and counted even
when it exceeds the capacity of
the SAC group.

<SACHandling Choice doNotPlayMusicIfLimitReached, This parameter controls how

ForMoH> playMusicAndCount Music on Hold is treated when the
countLongConnectionsToMediaServer
parameter is set to
"true". When set to
"doNotPlayMusicIfLimitReached",
the hold music is not played if the
Media Server connection count
limit has been reached. If set to
"playMusicAndCount", hold music
is played, and the Media Server
connection count is incremented
and allowed to exceed the limit.

<countLong Choice true, false This parameter determines

ConnectionsTo how long connections are
MediaServer> counted. When set to "false", the
current behavior to the Session
Admission Control (SAC) group
service is maintained. When set
to "true", long connections to the
Media Server (such as Music on
Hold) are counted.

12.47 ShortMessageService
This level is used to view and set ShortMessageService related attributes.

12.47.1 get
This command is used to view system Short Message Service related attributes.
1) Ensure you are at the /AS_CLI/Service/ShortMessageService> level.
2) Enter:
get↵

12.47.2 set
This command is used to modify Short Message Service related attributes.
1) Ensure you are at the /AS_CLI/Service/ShortMessageService> level.
2) Enter:
set <attribute>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 974
 where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice routeTimeoutSeconds, sendE164 The name of an attribute to

ToNetworkDevice, sendE164To modify.
AccessDevice

<routeTimeout Integer 1 through 25 The length of time the server

Seconds> should wait before it route
advances for short messages.

<sendE164 Choice true, false Controls sending of E.164

ToNetwork normalized SIP FROM and SIP
Device> P-Asserted-Identity headers in
the outbound SIP MESSAGE to
non NS network devices.

<sendE164To Choice false, perDeviceE164Capability, Controls sending of E.164

AccessDevice> true normalized SIP FROM and SIP
P-Asserted-Identity headers in
the outbound SIP MESSAGE
to access devices. True means
to always send E.164, false
means never send E.164 and
perDeviceE164Capability means
to send E.164 only if the device
profile is E.164 capable.

12.48 SpeedDial100
This level is used to view and modify SpeedDial100 entries.

12.48.1 get
This command is used to view SpeedDial100-related attributes.
1) Ensure you are at the /AS_CLI/Service/SpeedDial100> level.
2) Enter:
get↵

12.48.2 set
This command is used to modify SpeedDial100-related attributes.
1) Ensure you are at the /AS_CLI/Service/SpeedDial100> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice defaultPrefix The name of an attribute to

modify.

<defaultPrefix> String 1 to 2 characters The speed dial 100.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 975
12.49 ThirdPartyIMP
This level is used to view, modify, and clear Third-Party IM&P-related attributes.

12.49.1 get
This command is used to view Third-Party IM&P service-specific settings.
1) Ensure you are at the /AS_CLI/Service/ThirdPartyIMP> level.
2) Enter:
get↵

12.49.2 set
This command is used to modify the Third-Party IM&P service-specific settings.
1) Ensure you are at the /AS_CLI/Service/ThirdPartyIMP> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice serviceNetAddress, servicePort, The name of an attribute to

boshURL modify.

<serviceNet String 1 to 80 characters The IP address/host/domain of

Address> the IM&P third-party XMPP server
cluster.

<servicePort> Integer 1 through 65535 The address port of the IM&P

third-party XMPP server cluster.

<boshURL> String 1 to 256 characters The URL the clients applications

uses to communicate using
BOSH with the XMPP server.

12.49.3 clear
This command is used to clear Third-Party IM&P Service-specific settings.
1) Ensure you are at the /AS_CLI/Service/ThirdPartyIMP> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice serviceNetAddress, servicePort, The name of an attribute to clear.

boshURL

12.50 ThirdPartyVoiceMailSupport
This level is used to manage Third Party Voice Mail Support-related attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 976
12.50.1 get
This command is used to view Third Party Voice Mail Support-related attributes.
1) Ensure you are at the /AS_CLI/Service/ThirdPartyVoiceMailSupport> level.
2) Enter:
get↵

12.50.2 set
This command is used to modify Third Party Voice Mail Support-related attributes.
1) Ensure you are at the /AS_CLI/Service/ThirdPartyVoiceMailSupport> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice overrideAltCallerIdForVM The name of an attribute to

Retrieval, stripDiversionOnVM modify.
DestinationRetrieval

<overrideAlt Choice true, false Controls whether to override

CallerIdForVM alternate Caller ID for voice mail
Retrieval> retrieval.

<stripDiversion Choice true, false Controls whether to strip the

OnVM diversion header on voice mail
Destination retrieval.
Retrieval>

12.50.3 Destinations
This level is used to view, add, modify, delete, and clear Third Party Voice Mail Support Destinations
entries.

12.50.3.1 get
This command is used to view third-party voice mail destinations list-related attributes, such as Number
and Description.
1) Ensure you are at the /AS_CLI/Service/ThirdPartyVoiceMailSupport/Destinations>
level.
2) Enter:
get <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice numberStarts, numberContains, The name of an attribute to filter

numberEqualTo on.

<number String 0 to 23 characters Displays only Directory Numbers

Starts> (DNs) whose number starts with
the specified string.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 977
 Variable Field Type Valid Values Description

<number String 0 to 23 characters Displays only Directory Numbers

Contains> (DNs) whose number contains
the specified string.

<numberEqual String 1 to 23 characters Displays only Directory Numbers

To> (DNs) whose number matches
specified string.

12.50.3.2 add
This command is used to add a third-party voicemail destination.
1) Ensure you are at the /AS_CLI/Service/ThirdPartyVoiceMailSupport/Destinations>
level.
2) Enter:
add <number> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<number> String 1 to 23 characters The phone number of the entry to

add.

<attribute> MultipleChoice description Additional attributes to include

through the add command.

<description> String 1 to 80 characters Provides more detail about this

phone number.

12.50.3.3 set
This command is used to modify the third-party voice mail destination attributes.
1) Ensure you are at the /AS_CLI/Service/ThirdPartyVoiceMailSupport/Destinations>
level.
2) Enter:
set <number> <attribute>↵
where:
Variable Field Type Valid Values Description

<number> String 1 to 23 characters The Phone number of the entry to

modify.

<attribute> MultipleChoice description The name of an attribute to

modify.

<description> String 1 to 80 characters Provides more detail about this

phone number.

12.50.3.4 delete
This command is used to delete the third-party voice mail destination.
1) Ensure you are at the /AS_CLI/Service/ThirdPartyVoiceMailSupport/Destinations>
level.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 978
 2) Enter:
delete <number>↵
where:
Variable Field Type Valid Values Description

<number> String 1 to 23 characters The Phone number of the entry to

delete.

12.50.3.5 clear
This command is used to clear the third-party voice mail destination attributes.
1) Ensure you are at the /AS_CLI/Service/ThirdPartyVoiceMailSupport/Destinations>
level.
2) Enter:
clear <number> <attribute>↵
where:
Variable Field Type Valid Values Description

<number> String 1 to 23 characters The Phone number of the entry to

clear.

<attribute> MultipleChoice description The name of the attribute(s) to

clear.

12.51 TrunkGroup
This level is used to manage Trunk Group related attributes.

12.51.1 get
This command is used to view Trunk Group related attributes.
1) Ensure you are at the /AS_CLI/Service/TrunkGroup> level.
2) Enter:
get↵

12.51.2 set
This command is used to modify Trunk Group related attributes.
1) Ensure you are at the /AS_CLI/Service/TrunkGroup> level.
2) Enter:
set <attribute>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 979
 Variable Field Type Valid Values Description

<attribute> MultipleChoice enforceCLIDServiceAssignment The name of an attribute to

ForPilotUser, terminate modify.
UnreachableTriggerDetection
OnReceiptOf18x, pilotUser
CallingLineAssertedIdentity
Policy, enforceOutOfDialogPBX
RedirectionPolicies, unscreened
RedirectionHandling, enable
HoldoverOfHighwaterCallCounts,
holdoverPeriodMinutes, time
ZoneOffsetMinutes, clidSource
ForScreenedCallsPolicy, user
LookupPolicy, outOfDialogPBX
RedirectionCLIDMapping, enforce
OutOfDialogPBXRedirection
TrunkGroupCapacity, support
ConnectedIdentityPolicy

<enforceCLID Choice true, false Controls whether the CLID

Service service assignment is required for
AssignmentFor Trunk Group pilot users.
PilotUser>

<terminate Choice true, false If it is true, TrunkGroup

Unreachable unreachable condition is not
Trigger triggered after receiving 18x. If it
DetectionOn is false, TrunkGroup unreachable
ReceiptOf18x> condition is triggered after
receiving 18x.

<pilotUser Choice allOriginatingCalls, unscreened This parameter controls when

CallingLine OriginatingCalls to use the pilot user's asserted
Asserted identity for trunking originations.
IdentityPolicy> Individual trunk group can define
its own policy to override the
default system policy.

<enforceOut Choice true, false This parameter determines

OfDialogPBX whether to apply Pilot User
Redirection Identity Policies for Trunking
Policies> Out-of-Dialog Private Branch
Exchange (PBX) Redirections.

<unscreened Choice reject, ignore, ignoreIfUnscreened Controls how to handle the

Redirection CallsDisallowed, rejectIf trunk group INVITEs with an
Handling> UnscreenedCallsDisallowed unscreened redirecting identity.

<enable Choice true, false Controls whether the holdover

HoldoverOf performance measures for trunk
HighwaterCall groups should be captured for the
Counts> period.

<holdover Choice 5, 10, 15, 20, 30, 60 The period in minutes for which
PeriodMinutes> the holdover values are captured.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 980
 Variable Field Type Valid Values Description

<timeZone Choice 0, 30, 45 Used to synchronize the high-

OffsetMinutes> water mark snapshot capture
times on different servers based
on the configured timezone offset
value. Default value is 0. Note:
This configuration should be
updated only for servers that
are on timezones with 30 or 45
minute offsets on the whole hour.

<clidSourceFor Choice profileNameProfileNumber, This parameter determines the

ScreenedCalls receivedNameProfileNumber, default system policy to control
Policy> receivedNameReceivedNumber the source of CLID for screened
trunk group calls. Individual trunk
group can define its own policy
to override the default system
policy.

<userLookup Choice basic, extended This parameter determines the

Policy> default system policy for user
lookup process for non-static
trunk group calls. Individual trunk
group can define its own policy
to override the default system
policy.

<outOf Choice disabled, enabledAndIgnore This parameter determines

DialogPBX Policies, enabledAndApply whether to enable Trunking Out-
RedirectionCLID Policies of-Dialog PBX Redirection Calling
Mapping> Line ID (CLID) mapping. When
the CLID mapping functionality
is enabled and a presentation
number match is found from
the map, it controls whether to
apply the pilot user identity usage
policies.

<enforceOut Choice true, false This parameter determines

OfDialogPBX whether a trunking Out-Of-
Redirection Dialog (OOD) Private Branch
TrunkGroup Exchange (PBX) redirection
Capacity> should be counted as a trunk
group origination with respect to
trunking capacity.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 981
 Variable Field Type Valid Values Description

<support Choice disabled, enabled This parameter specifies if

Connected the Application Server should
IdentityPolicy> select the connected identity
in accordance with the calling
line identity (CLID) policies. If
the parameter is in effect for
a trunk group and is false, the
Application Server always selects
the called user's profile identity. If
the parameter is in effect and is
true, the Application Server can
receive the connected identity
from the access device or can
select the pilot user's identity,
based on the CLID selection
policies.

12.51.3 OptionsMessageResponseStatusCode
This level is used to view, add, and delete system-wide successful SIP OPTIONS message response
status codes.

12.51.3.1 get
This command is used to display the system-wide successful SIP OPTIONS message response status
codes.
1) Ensure you are at the /AS_CLI/Service/TrunkGroup/
OptionsMessageResponseStatusCode> level.
2) Enter:
get↵

12.51.3.2 add
This command is used to add a system-wide successful SIP OPTIONS message response status code
pattern.
1) Ensure you are at the /AS_CLI/Service/TrunkGroup/
OptionsMessageResponseStatusCode> level.
2) Enter:
add <statusCode>↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 982
 Variable Field Type Valid Values Description

<statusCode> String 3 to 40 characters This parameter specifies the

new SIP OPTIONS message
response status code pattern.
Status codes can be any three-
digit string ranging from "000"
to "999", inclusively. A status
code pattern consists of digits
"0" through "9" and the following
wild cards: ?: Denotes any single
digit. For example, "2??" matches
any three-digit string beginning
with "2". "?" cannot be used within
brackets. []: Denotes a single digit
that satisfies the specified range
of digits. A consecutive range
is indicated with a hyphen "-",
while a nonconsecutive range
is indicated with a comma ",".
Hyphens and commas can be
used in combination, for example
"[5-7,9]". Brackets cannot be
nested. "?" cannot be used within
brackets.

12.51.3.3 delete
This command is used to delete a system-wide successful SIP OPTIONS message response status code
pattern. At any time at least one status code needs to be present at the system level.
1) Ensure you are at the /AS_CLI/Service/TrunkGroup/
OptionsMessageResponseStatusCode> level.
2) Enter:
delete <statusCode>↵
where:
Variable Field Type Valid Values Description

<statusCode> String 3 to 40 characters This parameter specifies the SIP

OPTIONS message response
status code pattern being deleted.

12.52 TwoStageDialing
This level is used to view, add, modify, delete, and clear TwoStageDialing entries.

12.52.1 get
This command is used to view Two-Stage Dialing attributes.
1) Ensure you are at the /AS_CLI/Service/TwoStageDialing> level.
2) Enter:
get [<number>]↵
where:

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 983
 Variable Field Type Valid Values Description

<number> String 1 to 23 characters A valid phone number. The

format is the same as that used
for adding a DN to a service
provider.

12.52.2 add
This command is used to add Two-Stage Dialing attributes.
1) Ensure you are at the /AS_CLI/Service/TwoStageDialing> level.
2) Enter:
add <number> [<attribute>]↵
where:
Variable Field Type Valid Values Description

<number> String 1 to 23 characters A valid phone number. The

format is the same as that used
for adding a DN to a service
provider.

<attribute> MultipleChoice description Additional attributes to include

through the add command.

<description> String 1 to 80 characters The description that helps identify

the number's use.

12.52.3 set
This command is used to modify Two-Stage Dialing attributes.
1) Ensure you are at the /AS_CLI/Service/TwoStageDialing> level.
2) Enter:
set <number> <attribute>↵
where:
Variable Field Type Valid Values Description

<number> String 1 to 23 characters A valid phone number. The

format is the same as for adding
a DN to a service provider.

<attribute> MultipleChoice description The name of an attribute to

modify.

<description> String 1 to 80 characters The description that helps identify

the number's use.

12.52.4 delete
This command is used to delete Two-Stage Dialing attributes.
1) Ensure you are at the /AS_CLI/Service/TwoStageDialing> level.
2) Enter:
delete <number>↵

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 984
 where:
Variable Field Type Valid Values Description

<number> String 1 to 23 characters The phone number identifying the

entry to be deleted.

12.52.5 clear
This command is used to clear Two-Stage Dialing attributes.
1) Ensure you are at the /AS_CLI/Service/TwoStageDialing> level.
2) Enter:
clear <number> <attribute>↵
where:
Variable Field Type Valid Values Description

<number> String 1 to 23 characters The phone number identifying the

entry.

<attribute> MultipleChoice description The name of the attribute(s) to

clear.

12.53 VoiceMailNotification
This level is used to view and modify Voice Mail (VM) Notification-related attributes.

12.53.1 get
This command is used to view Voice Mail Notification-related attributes.
1) Ensure you are at the /AS_CLI/Service/VoiceMailNotification> level.
2) Enter:
get↵

12.53.2 set
This command is used to modify VM Notification-related attributes.
1) Ensure you are at the /AS_CLI/Service/VoiceMailNotification> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice shortSubjectLine, dnInMailBody The name of an attribute to

modify.

<shortSubject Choice true, false Indicates whether or not a short

Line> subject line is included for the
voice mail notification.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 985
 Variable Field Type Valid Values Description

<dnInMail Choice true, false Indicates whether or not the

Body> directory number (DN) is included
in the e-mail body of the message
for the voice mail notification.

12.54 VoiceMessageSummaryUpdate
This level allows the Application Server to send a Message-Summary status to a device after processing
a REGISTER. This is useful in cases such as when supporting devices lose their MWI (message waiting
indicator) status after a reboot.

12.54.1 get
This command is used to view Message Summary Update attributes.
1) Ensure you are at the /AS_CLI/Service/VoiceMessageSummaryUpdate> level.
2) Enter:
get↵

12.54.2 set
This command is used to modify Message Summary Update attributes.
1) Ensure you are at the /AS_CLI/Service/VoiceMessageSummaryUpdate> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice sendSavedAndUrgentMWI The name of an attribute to

OnNotification, sendMessage modify.
SummaryUpdateOnRegister, min
TimeBetweenMWIOnRegisterIn
Seconds

<sendSaved Choice true, false When set to "true", Old, New-

AndUrgentMWI Urgent, and Old-Urgent counters
OnNotification> are inserted into the voice-
message line of the simple-
message-summary body.

<sendMessage Choice true, false When set to "true", an update

Summary is applied to the MWI summary
UpdateOn notification when the device is
Register> registered.

<minTime Integer 0 through 86400 Specifies the minimum delay

BetweenMWI for subsequent message-
OnRegisterIn summary notification after device
Seconds> registration. This delay allows
BroadWorks to avoid sending the
message-summary each time
a device tries to register to the
Application Server.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 986
12.55 VoiceMsg
This level is used to view and modify the Voice Messaging (VM) group service attributes.

12.55.1 get
This command is used to view Voice Messaging-related attributes. The Voice Messaging service answers
a user's phone and records incoming messages from callers. This command is used to display the system
default hold period, the minimum and maximum length of messages, and so on.
1) Ensure you are at the /AS_CLI/Service/VoiceMsg> level.
2) Enter:
get↵

12.55.2 set
This command is used to modify Voice Messaging-related attributes.
1) Ensure you are at the /AS_CLI/Service/VoiceMsg> level.
2) Enter:
set <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice maxMessageLength, maxMailbox The name of an attribute to

Length, msgAging, holdPeriod, modify.
mailServerForSystemVM, mail
ServerProtocolForSystemVM,
realDeleteForImap, delivery
DefaultFromAddress, notification
DefaultFromAddress, voice
PortalLockOutDefaultFrom
Address, outgoingMWIOnSMD
I, systemMWIDelaySeconds,
voicePortalScope, networkWide
Messaging, useExternalRouting,
externalRoutingAddress, vmOnly
System, clientInitiatedMailServer
SessionTimeoutMinutes, vm
RecordingAudioFileFormat

<maxMessage Integer 1 through 10 The length of an incoming

Length> message (in minutes).

<maxMailbox Choice 10, 20, 30, 40, 50, 60, 70, 80, 90, The total length of all messages
Length> 100, 200, 300, 400, 500, 600, that can be left in a user's mailbox
700, 800, 900 (in minutes).

<msgAging> Choice true, false When set to "false", messages

are not deleted. When set to
"true", messages are deleted after
the hold period.

<holdPeriod> Choice 0, 1, 2, 3, 4, 5, 6, 7, 15, 30, 60 The number of days saved

messages remain on the
Application Server before being
marked for deletion.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 987
 Variable Field Type Valid Values Description

<mailServerFor String 1 to 80 characters The host name of the server to

SystemVM> which voice mails are sent and
then retrieved by the user.

<mailServer Choice POP3, IMAP When set to "POP3", use the

ProtocolFor POP3 protocol to connect to the
SystemVM> mail server. When set to "IMAP",
use the IMAP protocol to connect
to the mail server.

<realDeleteFor Choice true, false When set to "true", use this

Imap> option to expunge a user's IMAP
mailbox at the end of a voice mail
retrieval (VMR) call. (A VMR call
is one where a user listens to his/
her messages via the portal.)With
this option messages are actually
deleted rather than just marked
for deletion.(See NOTE below.)
When set to "false", voice mails
that are deleted during the VMR
call are only marked for deletion
in the user's e-mail account on
the mail server. This option is
the default.(Use this option for
Unified Messaging users. For
more information, see the NOTE
below).

<delivery String 1 to 80 characters The e-mail address from which

DefaultFrom voice mail messages are sent.
Address> This e-mail address is always
used in the From field of the e-
mail sent to the user. Note that if
the e-mail address of the caller is
available, it is added to the Reply-
To field.

<notification String 1 to 80 characters The e-mail address from which

DefaultFrom voice message notification
Address> e-mails are sent. This e-mail
address is always used in the
From field of an e-mail sent to
a user. Note that if the e-mail
address of the caller is available,
it is added to the Reply-To field.

<voicePortal String 1 to 80 characters Specifies the Voice Portal

LockOutDefault Passcode Lockout from e-mail
FromAddress> address. This e-mail address is
used when sending an e-mail to
the user notifying the user that
his/her voice portal is locked.

<outgoingMWI Choice true, false Enables or disables the outgoing

OnSMDI> message waiting indicator.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 988
 Variable Field Type Valid Values Description

<systemMWI Integer 0 through 300 The delay in seconds applied only

DelaySeconds> for message waiting indicators,
sent after a voice mail is sent.
Setting it to "0" disables the delay.

<voicePortal Choice ServiceProviderSettings, System When set to "System", users

Scope> can call any group voice portal
(hosted on the same Application
Server as they are) rather than
only the voice portal of their
own group to initiate the login
process. Users are redirected to
their own voice portal and have
access to their full feature set.
Typically, only one of the voice
portal numbers is publicized and
presented as the "system voice
portal" number. When set to
"Configured by Service Providers
or Enterprises", the voice portal
scope is configured at the service
provider or enterprise level.

<networkWide Choice true, false This attribute enhances the

Messaging> BroadWorks Messaging service
to allow users to compose,
forward, and reply to users
hosted on a different BroadWorks
Application Server.

<useExternal Choice true, false When set to "true", an active

Routing> voice portal call is routed to an
external voice device (that is,
text-to-speech device).

<external String 1 to 161 characters Specifies the DN/URL of the

Routing external device.
Address>

<vmOnly Choice true, false This attribute controls whether

System> the mailbox owners are rolled
over to and from the secondary
Application Server.

<clientInitiated Integer 1 through 10 This parameter specifies the

MailServer length of time a subscriber's
Session client-initiated Voice Messaging
Timeout User session is kept alive
Minutes> following the receipt of a Voice
Messaging client request.

<vmRecording Choice WAV, MP3 This parameter specifies the

AudioFile audio encoding format for Voice
Format> Messaging recording files.

12.55.3 clear
This command is used to clear Voice Messaging-related attributes.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 989
 1) Ensure you are at the /AS_CLI/Service/VoiceMsg> level.
2) Enter:
clear <attribute>↵
where:
Variable Field Type Valid Values Description

<attribute> MultipleChoice mailServerForSystemVM, The name of the attribute(s) to

externalRoutingAddress clear.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 990
Acronyms and Abbreviations

3GPP 3rd Generation Partnership Project

AA Auto Attendant
ABNF Augmented Backus-Naur Format
ACB Automatic Callback
ACR Accounting Request
ACL Access Control List
AoC Advice of Charge
API Application Programming Interface
AS Application Server
ASR Automated Speech Recognition
AVP Attribute-Value Pair
BCCT BroadWorks Common Communication Transport
BTLU Business Trunking License Unit
BW BroadWorks
CAC Carrier Access Code
CAMEL Customized Applications for Mobile Network Enhanced Logic
CAP Client Application Protocol
CC Country Code
CDR Call Detail Record
CEA Capabilities-Exchange-Answer
CER Capabilities-Exchange-Request
CLI Command Line Interface
CLID Calling Line ID
CNAM Caller ID with NAMe
COT Customer Originated Trace
CPC Calling Party Category
CPE Customer Premises Equipment
CPL Call Processing Language
CPU Central Processing Unit
CSCF Call Session Control Function
CSV Comma Separated Value
CTI Computer Telephony Integration
DBS Database Server
DN Directory Number
DND Do Not Disturb
DNIS Dialed Number Identification Service
DNS Domain Name System

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 991
DSN Database Store Name
DTD Document Type Definition
DTMF Dual-Tone Multi-Frequency
E164 An ITU-T recommendation for international telecommunication numbering
ECL Enhanced Call Log
EV ExtraView
FAC Feature Access Codes
FQDN Fully Qualified Domain Name
FS Functional Specification
FTP File Transfer Protocol
GSM Global System for Mobile Communications
HSS Home Subscriber Server
HTTP Hypertext Transfer Protocol
IM Instant Messaging
IMAP Internet Message Access Protocol
IMRN IP Multimedia Routing Number
IMS IP Multimedia Subsystem
IN International
IP Internet Protocol
IPv4 Internet Protocol Version 4
IPv6 Internet Protocol Version 6
ISDN Integrated Services Digital Network
ISO International Organization for Standardization
IVR Interactive Voice Response
JVM Java Virtual Machine
JWS Java Web Start
LATA Local Access Transport Area
LDAP Lightweight Directory Access Protocol
LI Lawful Intercept
MAC Media Access Control
MD5 Message Digest 5 Algorithm
MGCP Media Gateway Control Protocol
MIB Management Information Base
MIME Multipurpose Internet Mail Extensions
MOH Music On Hold
MSC Mobile Switching Centre
MWI Message Waiting Indicator or Indication
NAPTR Naming Authority Pointer
NCOS Network Class of Service

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 992
NPA Numbering Plan Area
NS Network Server
OCI Open Client Interface
OSS Operations Support System
PBX Private Branch Exchange
PCM Pulse Code Modulation
PM Performance Measurement
PRACK Provisional Response Acknowledgement
PRI Primary Rate Interface
PSTN Public Switched Telephone Network
PTT Push To Talk
RADIUS Remote Authentication Dial-In User Service
RAM Random Access Memory
SCA Selective Call Acceptance
SCR Selective Call Rejection
SDP Session Description Protocol
Sh The interface between an IP Multimedia Subsystem (IMS) Application Server (AS) and an
IMS Home Subscriber Server (HSS)
SIP Session Initiation Protocol
SMDI Simplified Message Desk Interface
SMS Short Message Service
SMTP Simple Mail Transfer Protocol
SNMP Simple Network Management Protocol
SOAP Simple Object Access Protocol
SQL Structured Query Language
SSL Secure Sockets Layer
TCP Transmission Control Protocol
TDM Time Division Multiplexing
TFTP Trivial File Transfer Protocol
TTL Time to Live
UA User Agent
UDP User Datagram Protocol
uLaw North American Standard for Analog to Digital Audio Data Conversion
URI Uniform Resource Identifier
URL Uniform Resource Locator
UUID Universally Unique Identifier
VM Voice Messaging
VMR Voice Mail Retrieval
VMS Voice Mail System
VoIP Voice Over Internet Protocol

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 993
VPN Virtual Private Network
VTR Verify Translation and Routing
WAS Web-based Authentication Server
WAV Waveform Audio File Format, a Microsoft and IBM audio file format standard for storing an
audio bitstream.
WebDAV Web-based Distributed Authoring and Versioning
XS Execution Server
XSP Xtended Services Platform

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 994
Index

A BTLU 326
BusyLampField 921
AccessCodes 765, 800, 868
AccessControlList 399
AccessDevice 199
C
AccessLevels 662 CallBlockingServiceMap 104
AccessList 651 CallCenter 330, 922
AccessRouting 61 CallControl 255, 571, 616
AccessSIPStatusMap 103 CallCorrelation 62
Accounting 538 CallForwardingNotReachable 925
ActivatableFeature 59 CallingLineId 757, 793, 861
Administrator 670, 710, 719, 812 CallingNameRetrieval 933
AdviceOfCharge 903 CallingPartyCategory 935
Agent 652 CallLimits 755, 791, 859, 886
AJP 424 CallLogs 333, 567
Alarm 448 CallMeNow 926
AlarmsTable 454 CallNotify 926
Alias 60 CallP 61, 270
AliasesPrefix 350 CallProcessing 755, 791, 858, 880, 886
AltCallIndicators 64 CallpUtil 54
AnnouncementRepository 672 CallRecording 927
Announcements 818 CallReturn 931
AnonymousCallRejection 905 CallTrace 326
Apache 423 CallTypes 63, 65
Application 257 CallWaiting 932
ApplicationController 289, 292 CAP 252, 566
Applications 342 Capabilities 272
ApplicationServerId 60 CAPProxy 399
AppServerSet 673 Carrier 113, 826
ASClusterName 58 Categories 347, 365, 378
ASDiagnostic 43 Change levels 34
ASDump 325 ChangeUserId 901
ASR 537 Channels 235
Assign 740 ChannelSets 235
AttendantConsole 906 ChargingFunctionElement 544
AuditLog 364 Classmark 938
AuthenticationLockout 675 CLI
AuthenticationPasswordRules 682, 818 Change levels 34
Authorize 742, 769 Commands
AutoAttendant 906 Alias 39
AutomaticCallback 907 Entering 32, 33
AutoRebuildConfig 167 Exit 40
Help 32
B History 38
SIP URL 32
Bcct 239, 356, 370 Start 32
BCCT 659 Syntax 33
BlackList 293 Configure 37
BroadWorks server Guides 30
Keys 31 Log in 34
Messages 31 Menus 34
Software version 31 Read files 35
System conventions Write (output to file) 36
Shortcuts 33 CLI level
BroadWorksAnywhereNumberLookup 901 Applications
BroadWorksCDRInterface 538 CommPilot
BroadWorksMobileManager 909 ClientApplicationLaunchUrls 342
BroadWorksMobility 910 FileTransfer
Browser 557 Link 344

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 995
 GeneralSettings 344 Logging
Logging InputChannels 396
InputChannels OutputChannels 397
Categories 347 OCSConnectivity 398
OutputChannels 348 OpenClientServer
RelativeUrl CAPProxy 399
AliasesPrefix 350 ExternalAuthentication
VisualDeviceManagement 351 AccessControlList 399
WebBranding 352 GeneralSettings 401
DeviceManagementFiles JVMStatsCollector
Logging GeneralSettings 402
InputChannels 354 HeapUsageThreshold 403
OutputChannels 355 NonHeapUsageThreshold 403
ExecutionAndProvisioning Logging
Encryption 356 InputChannels 405
PS OutputChannels 406
Bcct 356 NameService 408
Database NSOCIProxy 407
Databases OCIProxy
Sites 358 LoginLevelAllowed 410
Schemas ResponseCache
Instances 360 RequestExclusionFilter 413
Logging RequestInclusionFilter 414
InputChannels SSLConfiguration
AuditLog 364 ClientAuthentication
Categories 365 Trusts 420
OutputChannels 366 WebContainer
SecurityLogging Apache
InputChannels 368 GeneralSettings
OutputChannels 369 WorkersBusyThreshold 424
XS Tomcat
Bcct 370 Executors
Database AJP
Databases Queue
Sites 372 LatencyThreshold 425
Schemas SizeThreshold 426
Instances 374 ThreadPool
Logging UsageThreshold 427
InputChannels CTI
Categories 378 Queue
OutputChannels 380 LatencyThreshold 429
SecurityLogging SizeThreshold 429
InputChannels 382 ThreadPool
OutputChannels 383 ProcessingTimeThreshold
JWSFiles 431
Logging UsageThreshold 431
InputChannels 384 HTTPNio
OutputChannels 385 Queue
Users 386 LatencyThreshold 433
MediaFiles SizeThreshold 433
GeneralSettings 387 ThreadPool
Logging ProcessingTimeThreshold
InputChannels 389 435
OutputChannels 390 UsageThreshold 435
Users 390 GeneralSettings 436
OCIFiles JVMStatsCollector
Logging GeneralSettings 437
InputChannels 392 HeapUsageThreshold 437
OutputChannels 393 NonHeapUsageThreshold 438
OCIOverSoap Logging
GeneralSettings 394 InputChannels 439
OutputChannels 440

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 996
 NameService 441 LDAPDirectory 605
OverloadProtection Mail 610
Server 442 MediaFileSize 611
Webapps 443 Messaging 614
SessionManagement MGCP 608
Server 445 NetServSync 615
Webapps 446 OCI
ASDiagnostic CallControl 616
Diag 44 Reporting 618
Diameter ProvisioningValidation 620
Peers 53 Sh
Realms NonTransparentData
RoutingPeers 54 SystemRefresh 668
DNS 43 SIP
OverloadControls ContentType
CallpUtil 54 Content 640
Neighbors 55 DiversionReasonMap 641
NonCallpUtil 56 ProxyPolicy
QueueStats 57 HeaderPolicy 642
Interface OptionTagPolicy 644
Accounting Rule 645
BroadWorksCDRInterface UnmatchedHeaderPolicy 647
Diameter UnmatchedOptionTagPolicy 648
ChargingFunctionElement 544 SMDI 649
InhibitedAVPCodeList 546 SMPP 649
Offline 547 SNMP
Online 549 AccessList 651
File Agent 652
FTP 553 Logging
Radius InputChannels 654
Device 555 OutputChannels 655
Browser 557 Reporting
FieldIdMapping 565 FTP 657
ASR 537 SMAP
CallLogs 567 BCCT 659
CAP 566 TrapTable 659
CommonCommunicationTransport V3AccessControl
OCI Groups
CallControl AccessLevels 662
Interfaces 572 V3Users 664
Provisioning Maintenance
Interfaces 573 ContainerOptions 514
Cr 574 Extraview 516
Diameter ManagedObjects 517
Peers 578 Patching 525
Realms Scheduler
RoutingPeers 582 FileCollector
FTP 584 SrcDestPathsContext 533
Http Tools 534
ClientAuthentication Monitoring
Trusts 585 Alarm
WebApps AlarmsTable 454
Resources 590 Threshold
GeneralSettings 593 Default 459
HttpAlias 593 PM
HttpBinding 595 ConfigurationManagement 460
HttpServer 597 Execution 464
INServiceControl 602 HostRessources 468
LDAP LicenseManager 472
Client Mib-II 476
LocalUsers 603 OpenClientServer 480
Servers 604 Provisioning 484

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 997
 Subscriber 488 OutgoingCPCallTypes 968
UCD-SNMP 492 PersonalAssistant 970
WebContainer 496 PhysicalLocation 971
ProtocolMonitor 500 ReceptionistEnterprise 972
Report 507 SelectiveServices 972
Threshold 508 SessionAdmissionControl 973
Service ShortMessageService 974
AdviceOfCharge SpeedDial100 975
CostInformationSource 904 ThirdPartyIMP 976
AnonymousCallRejection 905 ThirdPartyVoiceMailSupport
AttendantConsole 906 Destinations 977
AutoAttendant 906 TrunkGroup
AutomaticCallback OptionsMessageResponseStatusCode 982
ReleaseCause 908 TwoStageDialing 983
BroadWorksMobileManager 909 VoiceMailNotification 985
BroadWorksMobility VoiceMessageSummaryUpdate 986
IMRN 911 VoiceMsg 987
MobileNetwork SubscriberMgmt
IMRN 915 Administrator 670
ServiceAccessCodeList AnnouncementRepository 672
ServiceAccessCode 918 AppServerSet
BusyLampField 921 Group 673
CallCenter ServiceProvider 674
EnhancedReporting 924 AuthenticationLockout
CallForwardingNotReachable 925 DeviceProfile 676
CallingNameRetrieval 933 SIP
CallingPartyCategory 935 Endpoint 678
CallMeNow 926 TrunkGroup 680
CallNotify 926 AuthenticationPasswordRules
CallRecording DeviceProfile 682
Platform 928 SIP 685
CallReturn 931 ClientApplicationLaunchProfiles 689
CallWaiting 932 Device
Classmark CustomTags 695
Utilization 939 Files 697
Collaborate 941 User 698
COLP 921 DeviceInventory 701
CommunicationBarring 944 Domain 702
CommunicationBarringUserControl 944 EnterpriseTrunkNumberRanges 703
CustomerOriginatedTrace 945 Extensions 704
EmergencyZones 946 FeatureAccessCodes 704
EnhancedCallLogs 946 Group
Executive 947 Administrator
GroupNightForwarding 948 Policy 712
HuntGroup 949 ClientApplicationLaunchProfiles 714
InCallServiceActivation 951 Department
INServiceControl 949 Administrator 719
IntegratedIMP 952 Device
Intercept CustomTags 728
SystemAllowedDNList 953 Files 730
User 954 User 732
InventoryReport 955 DeviceFileReposUsers 734
LegacyAutomaticCallback Domain 736
LineTypes 958 EnterpriseTrunkNumberRanges 737
LocationBasedCallingRestrictions 959 Extensions 739
MaliciousCallTrace 960 GroupPagingTargetsCapacity 740
MeetMeConferencing 960 GroupServices
MusicOnHold 963 Assign 740
NumberPortability Authorize 742
Status LDAPDirectory 743
DigitPatterns 966 MeetMeConfPorts 746
OutgoingCallingPlan 970 Numbers 747

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 998
 PasscodeRules 749 Policy
PasswordRules 752 CallProcessing
Policy CallingLineId 861
CallProcessing CallLimits 859
CallingLineId 757 Conferencing 862
CallLimits 755 DialableCallerID 863
DialableCallerID 759 Media 864
Media 760 RoutingXLA 865
RoutingXLA 761 DialPlan
DialPlan AccessCodes 868
AccessCodes 765 ServicePacks 872
TrunkingCallCapacity 768 SupportedLanguages 874
UserServices TrunkingCallCapacity 876
Authorize 769 UserServices 877
ExistingUser 771 SupportedLanguages 878
NewUser 772 SystemConfig
MobileSubscriberDirectoryNumbers 774 CallProcessing
NumberActivation 777 ServiceActivationAccessCode 882
Numbers Login 883
Utilization 778 Provisioning 884
PasscodeRules 778 SystemServices
PasswordRules 781 Numbers
Policy Usage 885
CallProcessing Policy
CallingLineId 793 CallProcessing
CallLimits 791 CallLimits 886
Conferencing 795 User
DialableCallerID 796 ClientApplicationLaunchProfiles 899
Media 796 Util
RoutingXLA 797 BroadWorksAnywhereNumberLookup 901
DialPlan ChangeUserId 901
AccessCodes 800 System
Multimedia ActivatableFeature 59
Media 803 Alias 60
MediaSet 805 ApplicationServerId 60
ServicePackMigration 807 ASClusterName 58
ServiceProvider CallP
Administrator AccessRouting 61
Policy 815 CallCorrelation 62
Announcements 818 CallTypes 63
AuthenticationPasswordRules CommunicationBarring
DeviceProfile 818 AltCallIndicators 64
SIP 821 CallTypes 65
Carrier 826 CountryCodes 66
ClientApplicationLaunchProfiles 828 DNS 69
Department 830 DTMFTransmission 70
Device ExpensiveCalls
CustomTags 838 ExpensiveCallTypes 72
Files 840 ExternalEmergencyRouting 74
User 841 NetProgression 75
DeviceFileReposUsers 844 Routing
Domain 845 MediaServerSelection
EnterpriseTrunkNumberRanges 847 MediaServerDevice 77
GroupPagingTargetsCapacity 849 Route
GroupServices 849 Device 80
LDAPDirectory 851 RouteParms 82
MeetMeConfPorts 854 RoutingXLA 84
Numbers 854 VideoServerSelection
PasscodeRules 855 VideoServerDevice 86
PasswordRules 858 ServiceCodes 88
SessionAudit 89

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 999
 Treatment NetworkDevice 200
ConfigurableTreatment NetworkServers
AccessSIPStatusMap 103 Routing 201
CallBlockingServiceMap 104 Synch 203
InternalReleaseCauseMap 107 SMDI
NetworkSIPStatusMap 109 Routing 206
NSTreatmentMap 108 DeviceTagSet
Q850CauseMap 111 Tags 208
VirtualOnNetCallTypes 112 DeviceType
Carrier 113 MGCP 210
ClientApplications 115 SIP
ClientSession Files 225
InactivityTimer 117 Languages 230
ServerAddresses 117 LineOrdering 231
CommunicationUtility Services 232
DefaultSettings Domain 232
Executors EventNotification
OCIC ChannelSets
Queue Channels 235
LatencyThreshold 122 Subscription 236
SizeThreshold 123 GeneralSettings 238
ThreadPool Licensing
ProcessingTimeThreshold LicenseManager
124 Bcct
UsageThreshold 125 Ports 239
OCIP GeneralSettings 240
Queue GracePeriods 241
LatencyThreshold 127 LicenseStore 241
SizeThreshold 127 Logging
ThreadPool InputChannels 243
ProcessingTimeThreshold OutputChannels 244
128 ManagementAccessList 245
UsageThreshold 129 MediaFileSystem 247
ExternalAuthentication MobileNetwork
EmbeddedAgent 131 HomeNetwork 248
HealthCheck 131 RoamingNetwork 249
Kerberos5 132 NetworkAccessLists
LDAP CAP 252
SASL ExtAuth 254
Digest-MD5 136 OCI
Kerberos5 137 CallControl
Simple 139 Application 257
UserToDNMapping 140 Provisioning 259
RADIUS 141 Reporting
WAS 142 MessageTypes 262
ConfigAgent SIP 263
Logging SMDI 265
InputChannels 144 OverloadControls
OutputChannels 145 CallP 270
Device ManagedNeighbors
EnhancedReportingServer 146 Capabilities 272
FileRepos States 273
Users 150 NonCallP 275
IpDeviceMgmt Peering
AutoRebuildConfig 167 Peers 279
CustomTags 168 ProfileTuning
DMEventQueues 179 GeneralSettings 281
Files 182 Redundancy
Fileserver 189 GeoProxy
MgcpCodec 198 UnreachableFromPrimary 283
Monitor MigratedUsers 283
AccessDevice 199 PeerSIPConnectionMonitoring 283

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 1000
 Registration CustomerOriginatedTrace 945
Contacts 285 CustomTags 168, 695, 728, 838
Resources
Memory
Containers 289
D
RoutePoint Database 357, 370
ApplicationController 289 Databases 357, 370
ExternalSystem Default 459
ApplicationController 292 DefaultSettings 119
Utilization 293 Department 716, 830
Security Destinations 977
BlackList 293 Device 80, 146, 555, 690, 721, 832
WhiteList 295 DeviceFileReposUsers 734, 844
SessionDataReplication 297 DeviceInventory 701
StartupParam 298 DeviceManagementFiles 353
Util DeviceProfile 676, 682, 818
ASDump 325 DeviceTagSet 207
BTLU 326 DeviceType 210
CallTrace 326 Diag 44
EnhancedReporting DialableCallerID 759, 796, 863
CallCenter DialPlan 763, 798, 867
EventArchive 331 Diameter 52, 540, 575
CallLogs Digest-MD5 136
EventArchive 333 DigitPatterns 966
ListFiles 335 DiversionReasonMap 641
Messaging 336 DMEventQueues 179
QueryGroup 336 DNS 43, 69
QueryUser 336 Document conventions 31
SubscriberExport 337 Domain 232, 702, 736, 845
Zone DTMFTransmission 70
IPAddress 338
LocationBasedPhysicalLocations 339
ZoneCallingPhysicalLocation 340 E
Client 602
EmbeddedAgent 131
ClientApplicationLaunchProfiles 689, 714, 828, 899
EmergencyZones 946
ClientApplicationLaunchUrls 342
Encryption 356
ClientApplications 115
Endpoint 678
ClientAuthentication 420, 585
EnhancedCallLogs 946
ClientSession 117
EnhancedReporting 330, 924
Collaborate 941
EnhancedReportingServer 146
COLP 921
Entering commands 32
Command alias 39
EnterpriseTrunkNumberRanges 703, 737, 847
Commands history 38
EventArchive 331, 333
CommonCommunicationTransport 569
EventNotification 233
CommPilot 342
Execution 464
CommunicationBarring 64, 944
ExecutionAndProvisioning 356
CommunicationBarringUserControl 944
Executive 947
CommunicationUtility 119
Executors 122, 424
Conferencing 795, 862
ExistingUser 771
ConfigAgent 143
Exit 40
ConfigurableTreatment 94
ExpensiveCalls 71
ConfigurationManagement 460
ExpensiveCallTypes 72
Configure 37
ExtAuth 254
Contacts 285
Extensions 704, 739
ContainerOptions 514
ExternalAuthentication 130, 399
Containers 289
ExternalEmergencyRouting 74
Content 640
ExternalSystem 290
ContentType 640
Extraview 516
CostInformationSource 904
CountryCodes 66
Cr 574 F
CTI 428
FeatureAccessCodes 704

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 1001
FieldIdMapping 565 K
File 552
FileCollector 533 Kerberos5 132, 137
FileRepos 147
Files 182, 225, 697, 730, 840
Fileserver 189
L
FileTransfer 343 Languages 230
FTP 553, 584, 657 LatencyThreshold 122, 127, 425, 429, 433
LDAP 134, 602
G LDAPDirectory 605, 743, 851
LegacyAutomaticCallback 955
GeneralSettings 238, 240, 281, 344, 387, 394, 401, 402, LicenseManager 239, 472
423, 436, 437, 593 LicenseStore 241
GeoProxy 282 Licensing 239
GracePeriods 241 LineOrdering 231
Group 673, 705 LineTypes 958
GroupNightForwarding 948 Link 344
GroupPagingTargetsCapacity 740, 849 ListFiles 335
Groups 662 LocalUsers 603
GroupServices 740, 849 LocationBasedCallingRestrictions 959
LocationBasedPhysicalLocations 339
Log in 34
H Logging 143, 242, 345, 353, 362, 376, 384, 388, 392, 395,
HeaderPolicy 642 404, 438, 653
HealthCheck 131 Login 883
HeapUsageThreshold 403, 437 LoginLevelAllowed 410
HomeNetwork 248
HostRessources 468 M
Http 585
HttpAlias 593 Mail 610
HttpBinding 595 Maintenance 514
HTTPNio 432 MaliciousCallTrace 960
HttpServer 597 ManagedNeighbors 271
HuntGroup 949 ManagedObjects 517
ManagementAccessList 245
Media 760, 796, 803, 864
I MediaFiles 387
IMRN 911, 915 MediaFileSize 611
InactivityTimer 117 MediaFileSystem 247
InCallServiceActivation 951 MediaServerDevice 77
InhibitedAVPCodeList 546 MediaServerSelection 76
InputChannels 144, 243, 346, 354, 363, 368, 377, 382, 384, MediaSet 805
389, 392, 396, 405, 439, 654 MeetMeConferencing 960
INServiceControl 602, 949 MeetMeConfPorts 746, 854
Instances 360, 374 Memory 288
IntegratedIMP 952 Menus 34
Intercept 953 MessageTypes 262
Interface 537 Messaging 336, 614
Interfaces 572, 573 MGCP 210, 608
InternalReleaseCauseMap 107 MgcpCodec 198
InventoryReport 955 Mib-II 476
IPAddress 338 MigratedUsers 283
IpDeviceMgmt 151 MobileNetwork 248, 912
MobileSubscriberDirectoryNumbers 774
Monitor 199
J Monitoring 448
Multimedia 802
JVMStatsCollector 402, 437
MusicOnHold 963
JWSFiles 384

N
NameService 408, 441

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 1002
Neighbors 55 Q
NetProgression 75
NetServSync 615 Q850CauseMap 111
NetworkAccessLists 252 QueryGroup 336
NetworkDevice 200 QueryUser 336
NetworkServers 201 Queue 122, 126, 424, 428, 432
NetworkSIPStatusMap 109 QueueStats 57
NewUser 772
NonCallP 275
NonCallpUtil 56
R
NonHeapUsageThreshold 403, 438 Radius 554
NonTransparentData 667 RADIUS 141
NSOCIProxy 407 Read files 35
NSTreatmentMap 108 Realms 54, 580
NumberActivation 777 ReceptionistEnterprise 972
NumberPortability 963 Redundancy 281
Numbers 747, 777, 854, 884 Registration 284
RelativeUrl 349
O ReleaseCause 908
Report 507
OCI 255, 571, 616 Reporting 260, 618, 656
OCIC 122 RequestExclusionFilter 413
OCIFiles 392 RequestInclusionFilter 414
OCIOverSoap 394 Resources 288, 590
OCIP 126 ResponseCache 411
OCIProxy 409 RoamingNetwork 249
OCSConnectivity 398 Route 79
Offline 547 RouteParms 82
Online 549 RoutePoint 289
OpenClientServer 398, 480 Routing 76, 201, 206
OptionsMessageResponseStatusCode 982 RoutingPeers 54, 582
OptionTagPolicy 644 RoutingXLA 84, 761, 797, 865
OutgoingCallingPlan 970 Rule 645
OutgoingCPCallTypes 968
OutputChannels 145, 244, 348, 355, 366, 369, 380, 383,
385, 390, 393, 397, 406, 440, 655
S
OverloadControls 54, 267 SASL 135
OverloadProtection 442 Scheduler 530
Schemas 360, 373
P Security 293
SecurityLogging 367, 381
PasscodeRules 749, 778, 855 SelectiveServices 972
PasswordRules 752, 781, 858 Server 442, 445
Patching 525 ServerAddresses 117
Peering 277 Servers 604
Peers 53, 279, 578 Service 903
PeerSIPConnectionMonitoring 283 ServiceAccessCode 918
PersonalAssistant 970 ServiceAccessCodeList 917
PhysicalLocation 971 ServiceActivationAccessCode 882
Platform 928 ServiceCodes 88
PM 460 ServicePackMigration 807
Policy 712, 752, 784, 815, 858, 885 ServicePacks 872
Ports 239 ServiceProvider 674, 808
Procedural steps 40 Services 232
ProcessingTimeThreshold 124, 128, 431, 435 SessionAdmissionControl 973
ProfileTuning 281 SessionAudit 89
ProtocolMonitor 500 SessionDataReplication 297
Provisioning 259, 484, 572, 884 SessionManagement 445
ProvisioningValidation 620 Sh 666
ProxyPolicy 642 ShortMessageService 974
PS 356 Simple 139
Purpose 30 SIP 211, 263, 621, 678, 685, 821

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 1003
Sites 358, 372 VideoServerDevice 86
SizeThreshold 123, 127, 426, 429, 433 VideoServerSelection 85
SMAP 658 VirtualOnNetCallTypes 112
SMDI 204, 265, 649 VisualDeviceManagement 351
SMPP 649 VoiceMailNotification 985
SNMP 651 VoiceMessageSummaryUpdate 986
SpeedDial100 975 VoiceMsg 987
SrcDestPathsContext 533
SSLConfiguration 415
Start command 32
W
StartupParam 298 WAS 142
States 273 Webapps 443, 446
Status 964 WebApps 588
Subscriber 488 WebBranding 352
SubscriberExport 337 WebContainer 423, 496
SubscriberMgmt 670 WhiteList 295
Subscription 236 WorkersBusyThreshold 424
SupportedLanguages 874, 878 Write (output to file) 36
Synch 203
Syntax 33
System 58 X
System conventions 32, 33
XS 370
SystemAllowedDNList 953
SystemConfig 880
SystemRefresh 668 Z
SystemServices 884
Zone 337
ZoneCallingPhysicalLocation 340
T
Tags 208
ThirdPartyIMP 976
ThirdPartyVoiceMailSupport 976
ThreadPool 124, 128, 426, 430, 434
Threshold 455, 508
Tomcat 424
Tools 534
TrapTable 659
Treatment 92
TrunkGroup 680, 979
TrunkingCallCapacity 768, 876
Trusts 420, 585
TwoStageDialing 983

U
UCD-SNMP 492
UnmatchedHeaderPolicy 647
UnmatchedOptionTagPolicy 648
UnreachableFromPrimary 283
Usage 885
UsageThreshold 125, 129, 427, 431, 435
User 698, 732, 841, 887, 954
Users 150, 386, 390
UserServices 769, 877
UserToDNMapping 140
Util 325, 901
Utilization 293, 778, 939

V
V3AccessControl 662
V3Users 664

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 1004
References

[1] BroadSoft, Inc. 2014. BroadWorks Access Mediation Server Command Line Interface
Administration Guide, Release 21.0.
Available from BroadSoft at http://xchange.broadsoft.com/php/xchange/getFile?name=BW-
AMSCLIAdminGuide-R210.pdf.
[2] BroadSoft, Inc. 2014. BroadWorks Application Server Command Line Interface Administration
Guide, Release 21.0.
Available from BroadSoft at http://xchange.broadsoft.com/php/xchange/getFile?name=BW-
ASCLIAdminGuide-R210.pdf.
[3] BroadSoft, Inc. 2014. BroadWorks Database Server Command Line Interface Administration
Guide, Release 21.0.
Available from BroadSoft at http://xchange.broadsoft.com/php/xchange/getFile?name=BW-
DBSCLIAdminGuide-R210.pdf.
[4] BroadSoft, Inc. 2014. BroadWorks Element Management System Command Line Interface
Administration Guide, Release 21.0.
Available from BroadSoft at http://xchange.broadsoft.com/php/xchange/getFile?name=BW-
EMSCLIAdminGuide-R210.pdf.
[5] BroadSoft, Inc. 2014. BroadWorks Execution Server Command Line Interface Administration
Guide, Release 21.sp1.
Available from BroadSoft at http://xchange.broadsoft.com/php/xchange/getFile?name=BW-
XSCLIAdminGuide-R21.sp1.pdf.
[6] BroadSoft, Inc. 2014. BroadWorks Media Server Command Line Interface Administration Guide,
Release 21.0.
Available from BroadSoft at http://xchange.broadsoft.com/php/xchange/getFile?name=BW-
MSCLIAdminGuide-R210.pdf.
[7] BroadSoft, Inc. 2014. BroadWorks Messaging Server Command Line Interface Administration
Guide, Release 21.sp1.
Available from BroadSoft at http://xchange.broadsoft.com/php/xchange/getFile?name=BW-
UMSCLIAdminGuide-R21.sp1.pdf.
[8] BroadSoft, Inc. 2014. BroadWorks Network Function Manager Command Line Interface
Administration Guide, Release 21.sp1.
Available from BroadSoft at http://xchange.broadsoft.com/php/xchange/getFile?name=BW-
NFMCLIAdminGuide-R21.sp1.pdf.
[9] BroadSoft, Inc. 2014. BroadWorks Network Server Command Line Interface Administration
Guide, Release 21.0.
Available from BroadSoft at http://xchange.broadsoft.com/php/xchange/getFile?name=BW-
NSCLIAdminGuide-R210.pdf.
[10] BroadSoft, Inc. 2014. BroadWorks Profile Server Command Line Interface Administration Guide,
Release 21.0.
Available from BroadSoft at http://xchange.broadsoft.com/php/xchange/getFile?name=BW-
PSCLIAdminGuide-R210.pdf.
[11] BroadSoft, Inc. 2014. BroadWorks Service Control Function Command Line Interface
Administration Guide, Release 21.0.
Available from BroadSoft at http://xchange.broadsoft.com/php/xchange/getFile?name=BW-
SCFCLIAdminGuide-R210.pdf.
[12] BroadSoft, Inc. 2014. BroadWorks Sharing Server Command Line Interface Administration
Guide, Release 21.sp1.
Available from BroadSoft at http://xchange.broadsoft.com/php/xchange/getFile?name=BW-
USSCLIAdminGuide-R21.sp1.pdf.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 1005
[13] BroadSoft, Inc. 2014. BroadWorks Video Server Command Line Interface Administration Guide,
Release 21.sp1.
Available from BroadSoft at http://xchange.broadsoft.com/php/xchange/getFile?name=BW-
UVSCLIAdminGuide-R21.sp1.pdf.
[14] BroadSoft, Inc. 2014. BroadWorks WebRTC Server Command Line Interface Administration
Guide, Release 21.sp1.
Available from BroadSoft at http://xchange.broadsoft.com/php/xchange/getFile?name=BW-
WRSCLIAdminGuide-R21.sp1.pdf.
[15] BroadSoft, Inc. 2014. BroadWorks Xsp Command Line Interface Administration Guide, Release
21.0.
Available from BroadSoft at http://xchange.broadsoft.com/php/xchange/getFile?name=BW-
XspCLIAdminGuide-R210.pdf.

BROADWORKS APPLICATION SERVER COMMAND LINE INTERFACE ADMINISTRATION GUIDE 10-BD5113-00

©2015 BROADSOFT, INC. PAGE 1006