{"id":287,"date":"2023-01-28T17:16:35","date_gmt":"2023-01-29T00:16:35","guid":{"rendered":"https:\/\/datashed.tech\/?p=287"},"modified":"2023-01-28T17:16:35","modified_gmt":"2023-01-29T00:16:35","slug":"att-merlin-legend-pri-to-freepbx-asterisk","status":"publish","type":"post","link":"https:\/\/datashed.tech\/index.php\/2023\/01\/28\/att-merlin-legend-pri-to-freepbx-asterisk\/","title":{"rendered":"AT&T Merlin Legend PRI to FreePBX\/Asterisk"},"content":{"rendered":"

DISCLAIMER:\u00a0<\/strong>I am a telephony hobbyist, and nothing remotely resembling a professional installer or consultant. What I’ve done here is tied to a particular hardware and software configuration, and a specific set of goals for how I want my phone network to work. My limited experience thus far has taught me that ISDN PRIs–especially<\/strong>\u00a0on gear of this vintage, and with its many quirks–can be configured in nearly any way you can imagine, in pursuit of nearly any functional outcome, depending entirely on what you want your system to do. Thus, this guide is necessarily narrow in its focus, and cannot possibly begin to cover every scenario you might dream up. We will only cover the particular scenario I developed in my mind way back when I first got my Merlin Legend. I will try to keep things as generic as possible, but YMMV.<\/em><\/p>\n

About the AT&T Merlin Legend<\/h1>\n

\"\"<\/p>\n

The AT&T Merlin Legend is a wonderful old PBX system. Wonderful, old, cranky and cantankerous, frustrating, and immensely rewarding,\u00a0once you get it working<\/em>. I am\u00a0not\u00a0<\/em>a telephony professional, nor do I play one on TV, and as a great many seasoned veterans (many of whom can undoubtedly trace many a gray hair and facial wrinkle back to adventures with this hardware) will tell you, the Merlin Legend is probably a less-than-optimal choice for a hobbyist’s first PBX: Fisher-Price\u00a0My First PBX<\/em> it most decidedly is not. However, the aesthetics of MLX handsets, the aesthetics of the PBX itself, and its vibe–reminiscent of a bygone era–proved irresistible to me.<\/p>\n

I probably would choose something else if I had to do it over again, but in the end, it’s been a highly-rewarding learning experience.<\/p>\n

My Gear<\/h1>\n

This is the gear I had coming into the project:<\/p>\n

Merlin Legend PBX<\/h2>\n
    \n
  • Processor: CKE4<\/li>\n
  • Slot 1: 008 MLX – 8 MLX (Digital) Telephones<\/li>\n
  • Slot 2: Merlin Messaging R1 with 4 ports<\/li>\n
  • Slot 3: 100D – 1 DS1 Trunk<\/li>\n
  • Slot 4: 408 MLX GS\/LS-ID<\/li>\n
  • Slot 5: 016 with Ring Gen. – 16 Basic Telephone Sets<\/li>\n<\/ul>\n

    I’m running the Merlin Legend with the following basic characteristics:<\/p>\n

      \n
    • System mode is\u00a0Hybrid\/PBX\u00a0<\/strong>(Key mode is decidedly\u00a0not\u00a0<\/em>what you want for this setup)<\/li>\n
    • Numbering scheme is\u00a0Default Numbering -> 2-digit Extensions<\/strong><\/li>\n
    • The operator station is\u00a0Extension 10<\/strong> and is an MLX-20L, if memory serves<\/li>\n
    • The line\/trunk pool in use for outbound calling is\u00a0Pool 70,\u00a0<\/strong>which I believe is the norm on the Merlin Legend<\/li>\n<\/ul>\n

      FreePBX\/Asterisk Server<\/h2>\n
        \n
      • Dell PowerEdge R610 1U server<\/li>\n
      • Sangoma A102 2-port PCIe T1 card<\/li>\n
      • Running the Sangoma FreePBX distribution<\/li>\n<\/ul>\n

        My first run at this fence was with a Digium TE110PE T1 card–it would NOT talk to the 100D board in slot 3 of the Merlin Legend by any craft I possess, nor would any amount of coaxing, wheedling, or bold-faced threats dissuade it from its indefatigable contumacy. It also threw spurious interrupts constantly, and caused the server to hard reboot and throw fatal PCIe errors constantly. I do not\u00a0<\/em>recommend the Digium card! Also, the Sangoma\u00a0wanpipe\u00a0<\/em>tools cannot deal with it at all, making DAHDI troubleshooting way harder than it needs to be. Spare yourself the trouble I went through and find yourself a Sangoma A102!<\/em><\/p>\n

        Now, let’s take a look at the goals I had when looking to set up an ISDN PRI between the Merlin Legend and FreePBX.<\/p>\n

        Goals<\/h1>\n

        Going into this, I already had a SIP trunk on the FreePBX server going off to voip.ms, where I have 16 DIDs, as well as a Cisco 7965G IP phone running SCCP firmware, using the chan_sccp\u00a0<\/em>Asterisk module. I could place and receive calls with this system. Configuring IP phones and SIP trunks is out of the scope of this article, but it is decidedly the\u00a0easy\u00a0<\/em>part, and others have covered it far better than I ever could.<\/p>\n

        Also, the Merlin Legend already had a single LS trunk (extension 827) provisioned from Xfinity, which could place and receive calls. Extensions could dial each other and dial out. I have the Merlin Messaging board running an auto-attendant that helps filter my incoming calls.<\/p>\n

        What I wanted was as follows:<\/p>\n

          \n
        • The ability to dial Merlin Legend extensions from my IP phones on the FreePBX side<\/li>\n
        • The ability to dial FreePBX IP phone extensions from the Merlin Legend side<\/li>\n
        • The ability for the Merlin Legend to place outbound calls through FreePBX, allowing more than one concurrent conversation involving the PSTN to take place<\/li>\n<\/ul>\n

          Let’s get into the setup!<\/p>\n

          Setup<\/h1>\n

          Cable Plant<\/h2>\n

          First, we’ll tackle the physical layer here. You will need a\u00a0T1 Crossover Cable\u00a0<\/em>to connect the FreePBX server to the 100D board in your Merlin Legend. You do\u00a0not\u00a0<\/em>need a channel service unit in between. I used plain, unshielded twisted pair Category 5e cable. See the image below for the correct pinout.<\/p>\n

          \"\"

          Figure 1: T1\/E1 Crossover Cable<\/p><\/div>\n

          Note that in the above diagram, pins 3 and 6-8 are not connected.<\/p>\n

          Merlin Legend T1 Configuration<\/h2>\n

          A T1 line consists of 24 channels each having 64K\/s bandwidth. Think of it as the delivery mechanism on which our PRI will be carried.<\/p>\n

          The 100D DS1 Trunk board in the Merlin Legend is\u00a0notoriously\u00a0<\/em>picky. The slightest misconfiguration will not allow it to work. Please follow the below steps\u00a0very carefully,\u00a0<\/em>but\u00a0don’t panic<\/em>.<\/p>\n

          In all of these Merlin Legend menu instructions,\u00a0<slot-number<\/em>> refers to the slot in the Merlin Legend where your 100D board is installed. In mine, that’s slot 3.<\/p>\n

          If you have just installed a 100D board in your Merlin Legend, you will need to do a board renumber<\/strong> to make sure all of the board’s trunks are added to the system inventory. Please note that this will very like change the trunk numbers on boards\u00a0subsequent to\u00a0<\/strong>your 100D board, and thus may require some fairly substantial re-programming efforts. For example, if your 100D is in slot 3 (like mine), any trunks appearing in slots 4 and 5 will likely be re-numbered.<\/em><\/p>\n

          If possible, it would be ideal to put your 100D board in the\u00a0last\u00a0<\/strong>slot (slot 5) of your Merlin Legend chassis. It is also advisable to keep a backup of your configuration on hand, in case you blow anything up! I restored mine from backup several times during this process.<\/em><\/p>\n

          \u00a0Framing and Suppression<\/h3>\n

          Framing must be set to ESF:<\/p>\n

          Sys Program -> Exit -> LinesTrunks -> LS\/GS\/DS1 -> <slot-number> -> Frame Format -> Extended Super Frame -> Enter<\/pre>\n
          Suppression must be set to B8ZS:<\/p>\n
          Sys Program -> Exit -> LinesTrunks -> LS\/GS\/DS1 -> <slot-number> -> Suppression -> B8ZS -> Enter<\/pre>\n
          Type<\/h3>\n
          Type must be set to PRI:<\/p>\n
          Sys Program -> Exit -> LinesTrunks -> LS\/GS\/DS1 -> <slot-number> -> Type -> PRI -> Enter<\/pre>\n
          This will cause the PBX to reboot.<\/em><\/p>\n
          Merlin Legend PRI Configuration<\/h2>\n
          PRI (Primary Rate Interface<\/em>) is an ISDN (Integrated Services Digital Network<\/em>) technology. For our purposes, the PRI consists of twenty-three B-channels (or bearer channels<\/em>) that each carry a single telephone line, and one D-channel (or\u00a0data channel<\/em>) that is used by our equipment as a control plane, dealing with call setup and teardown, and other such tasks.<\/p>\n
          Switch Type<\/h3>\n
          First, we will set the PRI switch type to 5ESS<\/em>:<\/p>\n
          Sys Program -> Exit -> LinesTrunks -> PRI -> SwitchType -> 5ESS -> Enter<\/pre>\n
          T1 Clock Source<\/h3>\n
          You will need to set the primary clock source on the Merlin Legend to\u00a0Loop,\u00a0<\/em>causing the Merlin to derive clocking for the T1 from the line, rather than generating the clock locally. This is required for our configuration.<\/p>\n
          TODO: document the location of this setting in the operator console<\/em><\/p>\n
          Line Buildout<\/h3>\n
          The line buildout on the Merlin Legend must be set to\u00a01.<\/strong><\/p>\n
          TODO: document the location of this setting in the operator console<\/em><\/p>\n
          B-Channel Group<\/h3>\n
          Next, we will set up a B-channel group (group 1) containing channels 1-23:<\/p>\n
          Sys Program -> Exit -> LinesTrunks -> PRI -> B-Channel Group -> B-Channel -> 1 -> Enter<\/pre>\n
          At this point, you will be prompted for B-channels to add to the channel group. The format here is\u00a0SSCC<\/em>, where SS\u00a0<\/em>represents the slot number of our 100D board, and\u00a0CC\u00a0<\/em>represents the B-channel number in the specified slot. We need to add channels SS<\/em>01 through\u00a0SS<\/em>23 to B-channel group 1.<\/p>\n
          Once this is done, you can get out of this menu and head back to the B-Channel Group menu.<\/p>\n
          Lines<\/h3>\n
          Next, we need to add the first 23 lines on the 100D board to the inventory of lines associated with B-channel group 1. On my system, these are lines 801-823. Having an up-to-date inventory report on your Merlin Legend’s contents from WinSPM is very handy here.<\/p>\n
          Sys Program -> Exit -> LinesTrunks -> PRI -> B-Channel Group -> 1 -> Lines -> 1 -> Enter<\/pre>\n
          From this point, you are associating line numbers with B-channel group 1. Add the first 23 lines. Do\u00a0not\u00a0<\/em>add the 24th line, as it is the D-channel, and adding it to the lines for the b-channel group will prevent your PRI from functioning correctly.<\/p>\n
          Network Service<\/h3>\n
          We need to set the Network Service to CBC (Call-by-call).<\/p>\n
          Sys Program -> Exit -> LinesTrunks -> PRI -> B-Channel Group -> 1 -> NtwkSvc -> Misc -> CallByCall -> Enter<\/pre>\n
          Incoming Routing<\/h3>\n
          We need to set incoming routing to\u00a0Dial Plan<\/em>:<\/p>\n
          Sys Program -> Exit -> LinesTrunks -> PRI -> B-Channel Group -> 1 -> IncomingRtg -> Dial Plan -> Enter<\/pre>\n
          Dial Plan Routing<\/h3>\n
          Next, we’ll set Dial Plan Routing to\u00a0Any<\/em>:<\/p>\n
          Sys Program -> Exit -> LinesTrunks -> PRI -> Dial PlanRouting -> Service -> 0 -> Misc -> Any -> Enter<\/pre>\n
          Outgoing Table<\/h3>\n
          This gets a little bit complex. Basically, the outgoing table for call-by-call service has 10 patterns, numbered 0 through 9, that it will use to match the phone numbers of outbound calls.\u00a0 For example, a pattern of 8\u00a0<\/em>matches any number beginning with\u00a08\u00a0<\/em>(e.g. 8, 813, 890).<\/p>\n
          Since we’re looking to have any phone number match, we need patterns of 0, 1, 2, 3, 4, 5, 6, 7, 8, and 9:<\/p>\n
          Sys Program -> Exit -> LinesTrunks -> PRI -> Outgoing Table -> CBC Svc -> Pattern -> 00 -> Enter<\/pre>\n
          At this point, you will be prompted for a pattern number. Enter:<\/p>\n
          0 -> Next -> 1 -> Next -> 2 -> Next. . . 8-> Next 9-> Enter<\/pre>\n
          Network Service<\/h3>\n
          Next, we’ll set the network service:<\/p>\n
          Sys Program -> Exit -> LinesTrunks -> PRI -> NtwkSvc -> Misc -> No -> Enter<\/p>\n
          Special Service Table<\/h3>\n
          We must now set all eight DelDigit entries in the Special Service Table to zero, as we don’t want to chop off any digits for calls going out through our PRI:<\/p>\n
          Sys Program -> Exit -> LinesTrunks -> PRI -> Outgoing Table -> Special Svc -> Del Digit -> 0 -> Enter<\/pre>\n
          At this point, set all DelDigit entries to\u00a00<\/em>:<\/p>\n
          (Change to 0) -> Next -> (change to 0) -> Next<\/pre>\n
          Until entries 0-7 are all 0.<\/p>\n
          Add PRI Lines to Line Pool 70<\/h3>\n
          Next, you need to add lines 1-23 on your 100D board to line pool 70:<\/p>\n
          Sys Program -> Exit -> LinesTrunks -> Pools -> 70<\/pre>\n
          And add those first 23 lines. On my rig, this is lines 801-823. Consult your inventory!<\/p>\n
          This will cause the Merlin Legend to try your PRI lines for any attempted outbound call.<\/p>\n
          At this point, use your maintenance menu to un-busy the slot where your 100D board is, as well as all ports on that slot. Explaining how to un-busy (aka\u00a0Restore<\/em>) slots and ports is beyond the scope of this article, at least for now.<\/p>\n
          FreePBX PRI Configuration<\/h2>\n
          Now, we turn our attention to the other end of our little setup here.<\/p>\n
          TIP: If FreePBX complains that it cannot connect to Asterisk after clicking\u00a0Restart DAHDI and Asterisk\u00a0<\/em>in any of the below steps, log into your FreePBX server via SSH, and type the following command at the UNIX shell prompt:<\/span><\/p>\n
          fwconsole restart<\/pre>\n
          DAHDI Channel Configuration<\/h3>\n
          DAHDI is the\u00a0Digium Asterisk Hardware Device Interface<\/em>, and is the component of an Asterisk (and by extension, FreePBX) system that handles communication with T1, PRI, FXO, and FXS interfaces, among others.<\/p>\n
          Configure Sangoma Settings<\/h3>\n
            \n
          1. In the FreePBX menus, navigate to\u00a0Connectivity -> DAHDi Config<\/em><\/li>\n
          2. Click\u00a0Sangoma Settings\u00a0<\/em>on the right side of the screen<\/li>\n
          3. Configure per Figure 2, below<\/li>\n
          4. Click the red Apply Config\u00a0<\/em>button at the top right of the screen<\/li>\n
          5. Click the\u00a0Restart DAHDI and Asterisk\u00a0<\/em>button beneath the DAHDI Configuration\u00a0<\/em>tabs<\/li>\n<\/ol>\n
            \"\"
            Figure 2: Sangoma Settings<\/p><\/div>\n
            The crucial settings here are WANPIPE_GLOBAL_FE_MEDIA<\/em> and WANPIPE_GLOBAL_FE_CLOCK.\u00a0<\/em>Remember, for a PRI, the Merlin Legend requires the T1 clocksource to come from the loop, not local. Setting\u00a0WANPIPE_GLOBAL_FE_CLOCK\u00a0<\/em>to\u00a0Master<\/em> is crucial for that.<\/p>\n
            Configure T1 Span<\/h3>\n
              \n
            1. In the FreePBX menus, navigate to\u00a0Connectivity -> DAHDi Config<\/em><\/li>\n
            2. If you are using a Sangoma A102 T1 interface, in the\u00a0Digital Hardware<\/em> tab, you should see two spans,\u00a0Sangoma Technologies – wanpipe1 card 0 [1]\u00a0<\/em>and\u00a0Sangoma Technologies – wanpipe2 card 1 [2],\u00a0<\/em>representing the first and second ports on the A102 card; we assume that you have the Merlin Legend 100D board connected to the first<\/li>\n
            3. Click the\u00a0Edit\u00a0<\/em>hyperlink for the first card\/port<\/li>\n
            4. Configure per Figure 3, below<\/li>\n
            5. Click the red\u00a0Apply Config\u00a0<\/em>button at the top right of the screen<\/li>\n
            6. Click the\u00a0Restart DAHDI and Asterisk\u00a0<\/em>button beneath the\u00a0DAHDI Configuration\u00a0<\/em>tabs<\/li>\n<\/ol>\n
              \"\"
              Figure 3: Span Configuration<\/p><\/div>\n
              When you change\u00a0Signaling\u00a0<\/em>to\u00a0PRI – Net<\/em>, please note that the switchtype will automatically change to\u00a0EuroISDN<\/em>, which is\u00a0not\u00a0<\/em>what we want. Switchtype\u00a0must\u00a0<\/em>be\u00a0Lucent 5ESS<\/em>.<\/p>\n
              The Sync\/Clock Source<\/em> setting being 0 means that we will generate our own clocking. Line Build Out (LBO) being set to 0db (CSU)\/0-133 feet (DSX-1)\u00a0<\/em>is critical for our purposes.<\/p>\n
              I left\u00a0PRI Dialplan, PRI Local Dialplan,\u00a0<\/em>and\u00a0PRI Exclusive\u00a0<\/em>settings, as well as the TX\/RX gain settings, at their defaults.<\/p>\n
              NOTE ON SWITCHTYPES:\u00a0<\/strong>Many of you with Merlin Legend experience will probably be shouting at the screen that we didn’t do anything to option our PRI for\u00a0AT&T Custom\u00a0<\/em>protocol. I chased this for\u00a0days\u00a0<\/em>when I was trying to get this set up initially, convinced that this was why I had a yellow alarm on the Asterisk side and a red alarm on the 100D board. It was not the reason. The reason was the awful Digium TE110PE board. The long and short of it is, from an Asterisk perspective, setting the switchtype to\u00a0Lucent 5ESS\u00a0<\/em>is enough. There\u00a0is no setting in DAHDI for AT&T Custom protocol,\u00a0<\/em>and setting your switchtype to\u00a0Lucent 5ESS\u00a0<\/em>provisions this automatically. Apparently, DAHDI and Asterisk don’t support a 5ESS switchtype using NI2 protocol, or any others. So\u00a0don’t worry about it!<\/em><\/p>\n
              Asterisk Context<\/h4>\n
              Note that in Figure 3, Context\u00a0<\/em>is set to\u00a0from-internal.\u00a0<\/em>This was a manual change, as the setting will default to\u00a0from-digital.\u00a0<\/em>This affects our PRI’s interaction with the Asterisk dialplan rules, and is the key to allowing Asterisk to route calls from the Merlin to a SIP trunk. Leaving Context at\u00a0from-digital <\/em>will cause our calls originating from the Merlin and destined for the PSTN through our SIP trunk to fail.<\/p>\n
              Create DAHDI Trunk<\/h3>\n
              For this step, navigate through the FreePBX GUI menus to\u00a0Connectivity -> Trunks,\u00a0<\/em>then click\u00a0Add Trunk ->\u00a0<\/em>Add DAHDi Trunk<\/em>, and configure your trunk as in Figures 4 and 5, below:<\/p>\n
              \"\"
              Figure 4: DAHDi Trunk Settings<\/p><\/div>\n
               <\/p>\n
              \"\"
              Figure 5: DAHDi Settings<\/p><\/div>\n
              In Figure 5, note that the DAHDi identifier is g0<\/strong>. The 0\u00a0<\/em>represents the group number displayed in our DAHDi Span Settings in Figure 3. This is how we associate our new DAHDi trunk with our PRI.<\/p>\n
              Set Inbound Routes<\/h3>\n
              We will need an inbound route to tell Asterisk how to route calls coming from our PRI (and ultimately from the Merlin Legend) that follow the North American Numbering Plan. This route will take such calls and route them through a SIP trunk. Note that if you live outside the United States, you will need to modify this route.<\/p>\n
              To do this, navigate in the FreePBX GUI menus to\u00a0Connectivity -> Inbound Routes<\/em>, click the\u00a0Add Inbound Route<\/em> button, and configure your new route as follows:<\/p>\n
              \"\"
              Figure 6: Inbound Route Configuration<\/p><\/div>\n
              You can change the\u00a0Description<\/em> if you wish. I like to name routes in a consistent manner that reveals something about their purpose. The non-default fields here are:<\/p>\n