ZyXEL Communications X6004 User's Guide

www.zyxel.comX6004IP PBX CLI Reference GuideVersion 1.09/2007Edition 1DEFAULT LOGINUser Name adminPassword 1234

10

Appendix A Legal InformationX6004 CLI Reference Guide100

[Document Title]101APPENDIX B Customer SupportPlease have the following information ready when you contact customer support.Required Information• Pro

Appendix B Customer Support[Document Title]102• Regular Mail: ZyXEL Communications, Czech s.r.o., Modranská 621, 143 01 Praha 4 - Modrany, Ceská Repub

Appendix B Customer Support[Document Title]103India• Support E-mail: [email protected]• Sales E-mail: [email protected]• Telephone: +91-11-30888144 to +9

Appendix B Customer Support[Document Title]104• Regular Mail: ZyXEL Communications Inc., 1130 N. Miller St., Anaheim, CA 92806-2001, U.S.A.Norway• Sup

Appendix B Customer Support[Document Title]105Sweden• Support E-mail: [email protected]• Sales E-mail: [email protected]• Telephone: +46-31-744-7700• Fax

Appendix B Customer Support[Document Title]106

Index of CommandsX6004 CLI Reference Guide107Index of Commands1 Use of undocumented commands or misconfiguration can damage the unit and possibly ren

Index of CommandsX6004 CLI Reference Guide108mal|alert> ... 83log del logging mail &l

Index of CommandsX6004 CLI Reference Guide109network ddns set mail_exchanger <exchange-server|off> ... 21network ddns

X6004 CLI Reference Guide11CHAPTER 1 How to Access and Use the CLIThis chapter introduces the command line interface (CLI).1.1 Use the Console Port

Index of CommandsX6004 CLI Reference Guide110pbx cdr set email <email> ... 87pbx cdr set i

Index of CommandsX6004 CLI Reference Guide111pbx outbound aa add aa_name <name> description <description> ... 59pbx ou

Index of CommandsX6004 CLI Reference Guide112pbx outbound lcr del name <name> ... 63pbx outbound

Index of CommandsX6004 CLI Reference Guide113pbx reload ... 31pbx server auto_pr

Index of CommandsX6004 CLI Reference Guide114pbx server featurecode set dndoff <code> ... 29pbx server fe

Index of CommandsX6004 CLI Reference Guide115pbx server phonebook ldap set attr department <attribute-name> ... 37pbx server p

Index of CommandsX6004 CLI Reference Guide116pbx server qos set ds <ds> ... 35pbx server qo

Index of CommandsX6004 CLI Reference Guide117register show reg ... 79stack add serial &

Index of CommandsX6004 CLI Reference Guide118

Chapter 1 How to Access and Use the CLIX6004 CLI Reference Guide121.3 Command Presentation in Summary TablesThe summary tables group commands by the

Chapter 1 How to Access and Use the CLIX6004 CLI Reference Guide13username <admin_username>= Specifies the administrative account you want to e

Chapter 1 How to Access and Use the CLIX6004 CLI Reference Guide14

X6004 CLI Reference Guide15CHAPTER 2 General CommandsThis chapter discusses commands related to navigating within the CLI, saving your configuration

Chapter 2 General CommandsX6004 CLI Reference Guide162.2.1 List of Available CommandsEnter “?” or hit [TAB] to display a list of commands you can use

Chapter 2 General CommandsX6004 CLI Reference Guide17" The history command displays all user entered commands regardless of whether they were su

Chapter 2 General CommandsX6004 CLI Reference Guide18

19PART IIReferenceNetwork Commands (21)SIP Server Commands (25)Auto Provisioning Commands (31)QoS Commands (35)Phone Book Commands (37)Extension

20

X6004 CLI Reference Guide21CHAPTER 3 Network CommandsThis chapter describes the commands used to configure the network settings on the X6004. 3.1 DD

Chapter 3 Network CommandsX6004 CLI Reference Guide22• Displays DDNS settings.3.2 Network Interface CommandsThis section describes the commands used

Chapter 3 Network CommandsX6004 CLI Reference Guide23• Displays network interface settings.3.3 Time CommandsThe following table describes commands r

Chapter 3 Network CommandsX6004 CLI Reference Guide243.4 Static Routes CommandsThis section describes the commands used to configure static routes on

X6004 CLI Reference Guide25CHAPTER 4 SIP Server CommandsThis chapter shows you how to configure auto provisioning via commands. 4.1 SIP Server Comma

Chapter 4 SIP Server CommandsX6004 CLI Reference Guide264.1.1 SIP Server Command ExamplesThis example:• Sets the SIP listening port on the X6004 to 5

Chapter 4 SIP Server CommandsX6004 CLI Reference Guide274.3 Call Block CommandsThe following table describes commands related to the call blocking f

Chapter 4 SIP Server CommandsX6004 CLI Reference Guide284.4 DSP Management CommandsThe following table describes commands related to Digital Signal P

Chapter 4 SIP Server CommandsX6004 CLI Reference Guide294.5 Feature Code CommandsThe following table describes commands related to feature codes on

About This CLI Reference GuideX6004 CLI Reference Guide3About This CLI Reference GuideIntended AudienceThis manual is a complementary supplement to

Chapter 4 SIP Server CommandsX6004 CLI Reference Guide30• Displays the feature codes configured on the X6004.> pbx server featurecode set blacklist

X6004 CLI Reference Guide31CHAPTER 5 Auto Provisioning CommandsThis chapter shows you how to configure auto provisioning via commands. 5.1 Auto Prov

Chapter 5 Auto Provisioning CommandsX6004 CLI Reference Guide325.1.1 Auto Provisioning Command ExamplesThis example:• Specifies the ZyXEL IP phone wi

Chapter 5 Auto Provisioning CommandsX6004 CLI Reference Guide33• Displays the configuration file for extension 1005.> pbx server auto_provision se

Chapter 5 Auto Provisioning CommandsX6004 CLI Reference Guide34

X6004 CLI Reference Guide35CHAPTER 6 QoS CommandsThis chapter shows you how to configure QoS settings via commands. 6.1 QoS CommandsThe following ta

Chapter 6 QoS CommandsX6004 CLI Reference Guide36

X6004 CLI Reference Guide37CHAPTER 7 Phone Book CommandsThis chapter shows you how to configure phone book settings via commands.7.1 Phonebook Comma

Chapter 7 Phone Book CommandsX6004 CLI Reference Guide38pbx server phonebook ldap set hour <hh> Modifies phonebook update from LDAP server hour

Chapter 7 Phone Book CommandsX6004 CLI Reference Guide397.1.1 Phonebook Command ExamplesThis example:• Adds a local phonebook entry Andre.• Adds the

Document ConventionsX6004 CLI Reference Guide4Document ConventionsWarnings and NotesThese are how warnings and notes are shown in this CLI Reference G

Chapter 7 Phone Book CommandsX6004 CLI Reference Guide40• Displays the details for the Andre entry.> pbx server phonebook add display_name Andre>

X6004 CLI Reference Guide41CHAPTER 8 Extension ManagementCommandsThis chapter shows you how to configure authority groups and extensions via commands

Chapter 8 Extension Management CommandsX6004 CLI Reference Guide428.2 Authority Group CommandsThe following table describes commands related to the P

Chapter 8 Extension Management CommandsX6004 CLI Reference Guide43• Displays the authority groups configured on the X6004.8.3 SIP Extensions Command

Chapter 8 Extension Management CommandsX6004 CLI Reference Guide448.3.1 SIP Extensions Command ExamplesThis example:• Adds extension 5001 to an autho

Chapter 8 Extension Management CommandsX6004 CLI Reference Guide45pbx server fxs mid <mid> slot <slot> port <port> caller_id_ring_t

Chapter 8 Extension Management CommandsX6004 CLI Reference Guide468.4.1 FXS Interface Command ExamplesThis example:• Adds the FXS port 1 in slot D of

Chapter 8 Extension Management CommandsX6004 CLI Reference Guide478.5 Ring Group CommandsThe following table describes commands related to the ring

Chapter 8 Extension Management CommandsX6004 CLI Reference Guide488.6.1 Hunt Group Command ExamplesThis example:• Creates a hunt group number 0000 in

Chapter 8 Extension Management CommandsX6004 CLI Reference Guide498.7.1 Page Group Command ExamplesThis example:• Creates a page group number 9999 i

Document ConventionsX6004 CLI Reference Guide5Command summary tables are organized as follows: The Table title identifies commands or the specific fe

Chapter 8 Extension Management CommandsX6004 CLI Reference Guide508.8 Pickup Group CommandsThe following table describes commands related to the pick

X6004 CLI Reference Guide51CHAPTER 9 Outbound Line GroupCommandsThis chapter shows you how to manage outside lines via commands. 9.1 Outbound Line G

Chapter 9 Outbound Line Group CommandsX6004 CLI Reference Guide529.1.1 Outbound Line Group Command ExamplesThis example:• Creates an outbound line gr

Chapter 9 Outbound Line Group CommandsX6004 CLI Reference Guide539.2 SIP Trunk CommandsThe following table summarizes commands related to the SIP tr

Chapter 9 Outbound Line Group CommandsX6004 CLI Reference Guide549.2.1 SIP Trunk Command ExamplesThis example:• Creates a SIP trunk called ITSPTrunk.

Chapter 9 Outbound Line Group CommandsX6004 CLI Reference Guide559.3 Trusted Peer CommandsThe following table summarizes commands related to the tru

Chapter 9 Outbound Line Group CommandsX6004 CLI Reference Guide56• Displays the configuration details of BranchOffice.9.4 FXO Interface CommandsThe f

Chapter 9 Outbound Line Group CommandsX6004 CLI Reference Guide579.4.1 FXO Interface Command ExamplesThis example:• Adds the FXO port 3 in slot B of

Chapter 9 Outbound Line Group CommandsX6004 CLI Reference Guide58

X6004 CLI Reference Guide59CHAPTER 10 Auto-Attendant CommandsThis chapter shows you how to manage auto-attendant via commands. 10.1 Auto-Attendant C

Document ConventionsX6004 CLI Reference Guide6

Chapter 10 Auto-Attendant CommandsX6004 CLI Reference Guide60pbx outbound aa-main change action repeat aa_name <name> aa_type <oh|ns> aa_k

Chapter 10 Auto-Attendant CommandsX6004 CLI Reference Guide61pbx outbound aa-sub add fwtonext aa_name <name> aa_type <oh|ns> aa_key <k

Chapter 10 Auto-Attendant CommandsX6004 CLI Reference Guide6210.1.1 Auto-Attendant Command ExamplesThis example:• Creates a new auto-attendant config

X6004 CLI Reference Guide63CHAPTER 11 Outbound Dial Rule (LCR)CommandsThis chapter shows you how to manage LCRs via commands.11.1 LCR CommandsThe fo

Chapter 11 Outbound Dial Rule (LCR) CommandsX6004 CLI Reference Guide6411.1.1 LCR Command ExamplesThis example:• Creates an LCR called VoIPCalls with

Chapter 11 Outbound Dial Rule (LCR) CommandsX6004 CLI Reference Guide65

Chapter 11 Outbound Dial Rule (LCR) CommandsX6004 CLI Reference Guide66

X6004 CLI Reference Guide67CHAPTER 12 Group Management CommandsThis chapter shows you how to use commands to manage groups on the X6004. 12.1 Group

Chapter 12 Group Management CommandsX6004 CLI Reference Guide68• Displays group management configuration on the X6004. > pbx group_management inclu

X6004 CLI Reference Guide69CHAPTER 13 Call Services CommandsThis chapter describes the commands used to configure call services on the X6004. 13.1 A

Contents OverviewX6004 CLI Reference Guide7Contents OverviewIntroduction ...

Chapter 13 Call Services CommandsX6004 CLI Reference Guide70The following table lists the commands for this feature.13.2.1 Call Parking Command Examp

Chapter 13 Call Services CommandsX6004 CLI Reference Guide71• Enables distinctive ring.• Specifies distinctive ring type 1 for FXO calls, 4 for SIP c

Chapter 13 Call Services CommandsX6004 CLI Reference Guide7213.4.1 Emergency Call Command ExamplesThis example:• Adds an outbound line group PSTN1 to

Chapter 13 Call Services CommandsX6004 CLI Reference Guide73• Displays conference room settings.13.6 Music on Hold CommandUse the pbx call_service m

Chapter 13 Call Services CommandsX6004 CLI Reference Guide74

X6004 CLI Reference Guide75CHAPTER 14 ZyStack CommandsThis chapter discusses the commands used for the ZyStack function on the X6004. 14.1 Stacking

Chapter 14 ZyStack CommandsX6004 CLI Reference Guide7614.1.1 ZyStack Command ExamplesThis example:• Displays the ZyStack configuration of X6004. >

X6004 CLI Reference Guide77CHAPTER 15 System AdministratorCommandsThis chapter discusses the commands used for managing administrative accounts on th

Chapter 15 System Administrator CommandsX6004 CLI Reference Guide7815.1.1 System Administrator Command ExamplesThis example:• Creates a new administr

X6004 CLI Reference Guide79CHAPTER 16 Registration CommandsThis chapter describes how to use commands to register the X6004 with myZyXEL.com. 16.0.1

Contents OverviewX6004 CLI Reference Guide8

Chapter 16 Registration CommandsX6004 CLI Reference Guide80• Displays the registration status of the X6004. > register set email [email protected]

X6004 CLI Reference Guide81CHAPTER 17 Log CommandsThis chapter describes the commands used to configure logging on the X6004. 17.1 System Log Comman

Chapter 17 Log CommandsX6004 CLI Reference Guide8217.1.1 Remote Log Server Command ExamplesThis example:• Displays all log categories.• Specifies the

Chapter 17 Log CommandsX6004 CLI Reference Guide8317.2 Email Profile Log Commands The following table describes commands related to the email log fu

Chapter 17 Log CommandsX6004 CLI Reference Guide8417.2.1 Email Profile Command ExamplesThis example:• Enables email log profile 1.• Specifies the ema

Chapter 17 Log CommandsX6004 CLI Reference Guide8517.3 Syslog Server CommandsThe following table describes commands related to the syslog functions

Chapter 17 Log CommandsX6004 CLI Reference Guide86• Displays the syslog settings.> log set logging syslog 1server '1': on> log set log

X6004 CLI Reference Guide87CHAPTER 18 CDR CommandsThis chapter describes the commands used to configure Call Detail Record (CDR) on the X6004. 18.1

Chapter 18 CDR CommandsX6004 CLI Reference Guide88• Provides the username (CDRuser) and password (CDRpass) for authentication with the remote database

X6004 CLI Reference Guide89CHAPTER 19 Status CommandsThis chapter describes the commands used to view status details on the X6004. 19.1 Status Comma

9PART IIntroductionHow to Access and Use the CLI (11)General Commands (15)

Chapter 19 Status CommandsX6004 CLI Reference Guide9019.1.1 Status Command ExamplesThis example:• Displays information about all FXS extension not be

X6004 CLI Reference Guide91CHAPTER 20 Diagnostics CommandsThis chapter covers the diagnostics commands you can execute on the X6004.20.1 System Diag

Chapter 20 Diagnostics CommandsX6004 CLI Reference Guide9220.2 Network Diagnostic CommandsThe following table describes commands related to the netwo

Chapter 20 Diagnostics CommandsX6004 CLI Reference Guide9320.3.1 PBX Diagnostics Command ExamplesThis example displays whether the SIP database is f

Chapter 20 Diagnostics CommandsX6004 CLI Reference Guide94

95PART IIIAppendices and Index of CommandsLegal Information (97)Customer Support (101)Index of Commands (107)

96

X6004 CLI Reference Guide97APPENDIX A Legal InformationCopyrightCopyright © 2007 by ZyXEL Communications Corporation.The contents of this publication

Appendix A Legal InformationX6004 CLI Reference Guide98FCC WarningThis device has been tested and found to comply with the limits for a Class A digita

Appendix A Legal InformationX6004 CLI Reference Guide99condition. Any replacement will consist of a new or re-manufactured functionally equivalent pr