.. _local-break-out-and-analog-gateway-events-ios-commands-and-variables:

Local Break Out and Analog Gateway Events, IOS Commands, and Variables
----------------------------------------------------------------------

Local Break Out and Analog Gateway Events

.. tabularcolumns:: |p{10cm}|p{5cm}|

+--------------------------------------------------------------+---------------+
| Default IOS Commands                                         | Notes         |
+==============================================================+===============+
| **HcsAddIOSDeviceEVT** An IOS Device is added.               |               |
+--------------------------------------------------------------+---------------+
|                                                              |               |
| ::                                                           |               |
|                                                              |               |
|    conf t                                                    |               |
|                                                              |               |
|    voice service VoIP                                        |               |
|                                                              |               |
|    no IP address trusted authenticate                        | If you are    |
|                                                              | generating    |
|    y                                                         | the command   |
|                                                              | for VG350     |
|    fax protocol t38 ls-redundancy 0 hs-redundancy 0 fallback | analog        |
|    pass-through g711ulaw                                     | gateway,      |
|                                                              | remove y from |
|    modem passthrough nse codec g711ulaw                      | the generated |
|                                                              | commands, and |
|    voice class codec 1                                       | then paste it |
|                                                              | to the analog |
|    codec preference 1 g729r8 bytes 30                        | gateway       |
|                                                              | console.      |
|    codec preference 2 g711ulaw                               |               |
|                                                              |               |
|    codec preference 3 g711alaw                               |               |
|                                                              |               |
|    end                                                       |               |
|                                                              |               |
+--------------------------------------------------------------+---------------+

.. tabularcolumns:: |p{15cm}|

+-----------------------------------------------------+
| Default IOS Commands                                |
+=====================================================+
| **HcsDeleteIOSDeviceEVT** An IOS Device is deleted. |
+-----------------------------------------------------+
|                                                     |
| ::                                                  |
|                                                     |
|     conf t                                          |
|     no voice service VoIP                           |
|     no voice class codec 1                          |
|     end                                             |
|                                                     |
+-----------------------------------------------------+



.. tabularcolumns:: |p{10cm}|p{5cm}|

+---------------------------------------------------------------------+---------------------------------+
| Default IOS Commands                                                | Available Variables             |
+=====================================================================+=================================+
| **HcsAddAnalogGatewayEVT** An Analog Gateway is added.              |                                 |
+---------------------------------------------------------------------+---------------------------------+
|                                                                     |                                 |
| ::                                                                  |                                 |
|                                                                     |                                 |
|    conf t                                                           |                                 |
|                                                                     |                                 |
|    stcapp ccm-group 1                                               |                                 |
|                                                                     |                                 |
|    stcapp                                                           |                                 |
|                                                                     |                                 |
|    stcapp feature access-code                                       |                                 |
|                                                                     |                                 |
|    stcapp feature speed-dial                                        |                                 |
|                                                                     |                                 |
|    sccp local {{ pwf.GatewayDAT.networkInterface }}                 |                                 |
|                                                                     |                                 |
|    sccp                                                             | pwf.GatewayDAT.networkInterface |
|                                                                     | - This is the physical device   |
|    bind interface {{ pwf.GatewayDAT.networkInterface }}             | network interface (Ethernet     |
|                                                                     | Port) for the analog gateway.   |
|    sccp ccm group 1                                                 |                                 |
|                                                                     |                                 |
|    {{ macro.HcsAnalogGwCommandForCCMIdentAndAssocMCR }} ccm-manager |                                 |
|    config server {{ fn.one macro.HcsCucmsAssociatedToNDLRMCR}}      |                                 |
|                                                                     |                                 |
|    ccm-manager sccp local {{ pwf.GatewayDAT.networkInterface }}     |                                 |
|                                                                     |                                 |
|    ccm-manager sccp                                                 |                                 |
|                                                                     |                                 |
|    stcapp                                                           |                                 |
|                                                                     |                                 |
|    end                                                              |                                 |
+---------------------------------------------------------------------+---------------------------------+

.. tabularcolumns:: |p{10cm}|p{5cm}|

+---------------------------------------------------------------------+----------------------------------+
| Default IOS Commands                                                | Available Variables              |
+=====================================================================+==================================+
| **HcsAddAnalogGatewayEndpointEVT** An Endpoint is added for the     |                                  |
| Analog Gateway.                                                     |                                  |
+---------------------------------------------------------------------+----------------------------------+
|                                                                     |                                  |
| ::                                                                  |                                  |
|                                                                     |                                  |
|     conf t                                                          | pwf.PORT_NUM - This is the FXS   |
|                                                                     | port number of the analog        |
|     voice-port {{ pwf.PORT_NUM }}                                   | gateway device.                  |
|                                                                     |                                  |
|     caller-id enable                                                | pwf.GatewayDAT.disconnectTimeout |
|                                                                     | - Time in seconds for which a    |
|     timeouts call-disconnect {{ fn.as_string                        | connection is maintained after   |
|     pwf.GatewayDAT.disconnectTimeout }}                             | the completion of a              |
|                                                                     | communication exchange.          |
|     cptone {{ pwf.GatewayDAT.cpTone }}                              |                                  |
|                                                                     | pwf.GatewayDAT.cpTone - This is  |
|     signal {{macro.HcsIosCmdAnalogGwSignalMCR}}                     | the call progress tone of the    |
|                                                                     | country that supports each       |
|     no shutdown                                                     | analog device in the gateway.    |
|                                                                     |                                  |
|     dial-peer voice {{ pwf.DIAL_PEER_NO }} pots                     | pwf.DIAL_PEER_NO - returns the   |
|                                                                     | dial peer number we use to       |
|     service stcapp                                                  | generate dial peer. It starts    |
|                                                                     | from 4 for the first dial peer,  |
|     port {{ pwf.PORT_NUM }}                                         | and increase by 1 for the next   |
|                                                                     | one.                             |
|     end                                                             |                                  |
+---------------------------------------------------------------------+----------------------------------+


.. tabularcolumns:: |p{10cm}|p{5cm}|


+----------------------------------------------------------------+----------------------------------+
| Default IOS Commands                                           | Available Variables              |
+================================================================+==================================+
| **HcsAddAnalogGatewayEndpointModEVT** An Endpoint Module is    |                                  |
| added for the Analog Gateway.                                  |                                  |
+----------------------------------------------------------------+----------------------------------+
|                                                                |                                  |
| ::                                                             |                                  |
|                                                                |                                  |
|    conf t                                                      | pwf.PORT_NUM - This is the FXS   |
|                                                                | port number of the analog        |
|    voice-port {{ pwf.PORT_NUM }}                               | gateway device.                  |
|                                                                |                                  |
|    caller-id enable                                            | pwf.GatewayDAT.cpTone - This is  |
|                                                                | the call progress tone of the    |
|    timeouts call-disconnect {{ fn.as_string                    | country that supports each       |
|    pwf.GatewayDAT.disconnectTimeout }}                         | analog device in the gateway.    |
|                                                                |                                  |
|    cptone {{ pwf.GatewayDAT.cpTone }}                          | pwf.GatewayDAT.disconnectTimeout |
|                                                                | - Time in seconds for which a    |
|    signal {{macro.HcsIosCmdAnalogGwSignalMCR}}                 | connection is maintained after   |
|                                                                | the completion of a              |
|    no shutdown                                                 | communication exchange.          |
|                                                                |                                  |
|    dial-peer voice {{ pwf.DIAL_PEER_NO }} pots                 | pwf.DIAL_PEER_NO - returns the   |
|                                                                | dial peer number we use to       |
|    service stcapp                                              | generate dial peer. It starts    |
|                                                                | from 4 for the first dial peer,  |
|    port {{ pwf.PORT_NUM }}                                     | and increase by 1 for the next   |
|                                                                | one.                             |
|    end                                                         |                                  |
|                                                                |                                  |
+----------------------------------------------------------------+----------------------------------+


.. tabularcolumns:: |p{15cm}|

+----------------------------------------------------------------------+
| Default IOS Commands                                                 |
+======================================================================+
| **HcsDeleteAnalogGatewayEVT** An Analog Gateway is deleted.          |
+----------------------------------------------------------------------+
|                                                                      |
| ::                                                                   |
|                                                                      |
|    conf t                                                            |
|    no stcapp                                                         |
|    no ccm-manager sccp local {{ input.GatewayDAT.networkInterface }} |
|    no ccm-manager sccp                                               |
|    no sccp                                                           |
|    no sccp local {{ input.GatewayDAT.networkInterface }}             |
|    no sccp ccm group 1                                               |
|    end                                                               |
|                                                                      |
+----------------------------------------------------------------------+



.. tabularcolumns:: |p{10cm}|p{5cm}|

+---------------------------------------------------------------------+---------------------------------+
| Default IOS Commands                                                | Available Variables             |
+=====================================================================+=================================+
| **HcsDeleteAnalogGatewayEndpointEVT** An Analog Gateway Endpoint    |                                 |
| is deleted.                                                         |                                 |
+---------------------------------------------------------------------+---------------------------------+
|                                                                     |                                 |
| ::                                                                  |                                 |
|                                                                     |                                 |
|    conf t                                                           |                                 |
|                                                                     |                                 |
|    voice-port {{ pwf.PORT_NUM }}                                    |                                 |
|                                                                     |                                 |
|    no caller-id enable                                              | pwf.PORT_NUM - This is the FXS  |
|                                                                     | port number of the analog       |
|    no timeouts call-disconnect                                      | gateway device.                 |
|                                                                     |                                 |
|    no cptone                                                        | pwf.DIAL_PEER_NO - returns the  |
|                                                                     | dial peer number we use to      |
|    no signal                                                        | generate dial peer. It starts   |
|                                                                     | from 4 for the first dial peer, |
|    shutdown                                                         | and increase by 1 for the next  |
|                                                                     | one.                            |
|    no dial-peer voice {{ pwf.DIAL_PEER_NO }} pots                   |                                 |
|                                                                     |                                 |
|    no port {{ pwf.PORT_NUM }}                                       |                                 |
|                                                                     |                                 |
|    end                                                              |                                 |
|                                                                     |                                 |
+---------------------------------------------------------------------+---------------------------------+

.. tabularcolumns:: |p{10cm}|p{5cm}|

+---------------------------------------------------------------+---------------------------------+
| Default IOS Commands                                          | Available Variables             |
+===============================================================+=================================+
| **HcsDeleteAnalogGatewayEndpointModEVT** An Analog Gateway    |                                 |
| Endpoint Module is deleted.                                   |                                 |
+---------------------------------------------------------------+---------------------------------+
|                                                               |                                 |
| ::                                                            |                                 |
|                                                               |                                 |
|    conf t                                                     |                                 |
|                                                               |                                 |
|    voice-port {{ pwf.PORT_NUM }}                              |                                 |
|                                                               |                                 |
|    no caller-id enable                                        | pwf.PORT_NUM - This is the FXS  |
|                                                               | port number of the analog       |
|    no timeouts call-disconnect                                | gateway device.                 |
|                                                               |                                 |
|    no cptone                                                  | pwf.DIAL_PEER_NO - returns the  |
|                                                               | dial peer number we use to      |
|    no signal                                                  | generate dial peer. It starts   |
|                                                               | from 4 for the first dial peer, |
|    shutdown                                                   | and increase by 1 for the next  |
|                                                               | one.                            |
|    no dial-peer voice {{ pwf.DIAL_PEER_NO }} pots             |                                 |
|                                                               |                                 |
|    no port {{ pwf.PORT_NUM }}                                 |                                 |
|                                                               |                                 |
|    end                                                        |                                 |
|                                                               |                                 |
+---------------------------------------------------------------+---------------------------------+