.. _mgcp_local_analog_gateway_events_and_ios_commands:

MGCP Analog Gateway Events and IOS Commands
-------------------------------------------

MGCP Analog Gateway Events


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

+--------------------------------------------------------------------------------------------------------+----------------------------------+
| Default IOS Commands                                                                                   | Available Variables              |
+========================================================================================================+==================================+
| **HcsAddAnalogGatewayEVT** Adds an Analog MGCP Gateway.                                                |                                  |
+--------------------------------------------------------------------------------------------------------+----------------------------------+
|                                                                                                        |                                  |
| ::                                                                                                     |                                  |
|                                                                                                        |                                  |
|    conf t                                                                                              | pwf.GatewayDAT.networkInterface- |
|    hostname {{pwf.GatewayDAT.domainName}}                                                              | returns the Network Interface    |
|    ccm-manager config server {{ fn.one macro.HcsCucmsAssociatedToNDLRMCR}}                             | based on the configuration in    |
|    ccm-manager config                                                                                  | the Gateway.                     |
|    mgcp call-agent {{ fn.one macro.HcsCucmsAssociatedToNDLRMCR}} 2427 service-type mgcp version 1.0    |                                  |
|    ccm-manager mgcp                                                                                    |                                  |
|    ! ccm-manager redundant-host                                                                        |                                  |
|    ccm-manager switchback Graceful                                                                     |                                  |
|    ccm-manager fallback-mgcp                                                                           |                                  |
|    mgcp bind control source-int {{ pwf.GatewayDAT.networkInterface }}                                  |                                  |
|    mgcp bind media source-int {{ pwf.GatewayDAT.networkInterface }}                                    |                                  |
|    mgcp dtmf-relay voip codec all mode out-of-band                                                     |                                  |
|    mgcp modem passthrough voip mode nse                                                                |                                  |
|    mgcp package-capability sst-package                                                                 |                                  |
|    no mgcp package-capability sst-package                                                              |                                  |
|    end                                                                                                 |                                  |
|                                                                                                        |                                  |
+--------------------------------------------------------------------------------------------------------+----------------------------------+

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

+--------------------------------------------------------------------------------------------------------+----------------------------------+
| Default IOS Commands                                                                                   | Available Variables              |
+========================================================================================================+==================================+
| **HcsAddAnalogGatewayEndpointEVT** Adds an Endpoint for the Analog MGCP Gateway.                       |                                  |
+--------------------------------------------------------------------------------------------------------+----------------------------------+
|                                                                                                        |                                  |
| ::                                                                                                     |                                  |
|                                                                                                        |                                  |
|    conf t                                                                                              | pwf.GatewayDAT.cpTone - This is  |
|    voice-port {{ pwf.PORT_NUM }}                                                                       | the call progress tone of the    |
|    timeouts call-disconnect {{ fn.as_string pwf.GatewayDAT.disconnectTimeout }}                        | country that supports each       |
|    cptone {{ pwf.GatewayDAT.cpTone }}                                                                  | analog device in the gateway.    |
|    signal {{macro.HcsIosCmdAnalogGwSignalMCR}}                                                         |                                  |
|    ring frequency 25                                                                                   | pwf.DIAL_PEER_NO - returns the   |
|    description {{ fn.sub_string macro.HcsAnalogGatewayIOSCmdDesc, 0, 63 }}                             | dial peer number that is used to |
|    timing hookflash-in 250 80                                                                          | generate the dial peer. It       |
|    no shutdown                                                                                         | starts from 4 for the first dial |
|    exit                                                                                                | peer, and increase by 1 for the  |
|    dial-peer voice {{ pwf.DIAL_PEER_NO }} pots                                                         | next one.                        |
|    service mgcpapp                                                                                     |                                  |
|    port {{ pwf.PORT_NUM }}                                                                             |                                  |
|    end                                                                                                 |                                  |
|                                                                                                        |                                  |
+--------------------------------------------------------------------------------------------------------+----------------------------------+

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

+--------------------------------------------------------------------------------------------------------+----------------------------------+
| Default IOS Commands                                                                                   | Available Variables              |
+========================================================================================================+==================================+
| **HcsAddAnalogMGCPGatewayEndpointModEVT** Adds an Endpoint Module for the Analog MGCP gateway.         |                                  |
+--------------------------------------------------------------------------------------------------------+----------------------------------+
|                                                                                                        |                                  |
| ::                                                                                                     |                                  |
|                                                                                                        |                                  |
|    conf t                                                                                              | pwf.PORT_NUM - This is the FXS   |
|    voice-port {{ pwf.PORT_NUM }}                                                                       | port number of the analog        |
|    timeouts call-disconnect {{ fn.as_string pwf.GatewayDAT.disconnectTimeout }}                        | gateway device.                  |
|    cptone {{ pwf.GatewayDAT.cpTone }}                                                                  |                                  |
|    signal {{macro.HcsIosCmdAnalogGwSignalMCR}}                                                         | pwf.GatewayDAT.disconnectTimeout |
|    ring frequency 25                                                                                   | - Time in seconds for which a    |
|    description {{ fn.sub_string macro.HcsAnalogGatewayIOSCmdDesc, 0, 63 }}                             | connection is maintained after   |
|    timing hookflash-in 250 80                                                                          | the completion of a              |
|    no shutdown                                                                                         | communication exchange.          |
|    exit                                                                                                |                                  |
|    dial-peer voice {{ pwf.DIAL_PEER_NO }} pots                                                         | pwf.GatewayDAT.cpTone - This is  |
|    service mgcpapp                                                                                     | the call progress tone of the    |
|    port {{ pwf.PORT_NUM }}                                                                             | country that supports each       |
|    end                                                                                                 | analog device in the gateway.    |
|                                                                                                        |                                  |
|                                                                                                        | pwf.DIAL_PEER_NO - returns the   |
|                                                                                                        | dial peer number we use to       |
|                                                                                                        | generate dial peer. It starts    |
|                                                                                                        | from 4 for the first dial peer,  |
|                                                                                                        | and increase by 1 for the next   |
|                                                                                                        | one.                             |
+--------------------------------------------------------------------------------------------------------+----------------------------------+

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

+--------------------------------------------------------------------------------------------------------+----------------------------------+
| Default IOS Commands                                                                                   | Available Variables              |
+========================================================================================================+==================================+
| **HcsDeleteAnalogGatewayEVT** Deletes an Analog MGCP Gateway.                                          |                                  |
+--------------------------------------------------------------------------------------------------------+----------------------------------+
|                                                                                                        |                                  |
| ::                                                                                                     |                                  |
|                                                                                                        |                                  |
|    conf t                                                                                              | pwf.GatewayDAT.networkInterface  |
|    no mgcp call-agent {{ fn.one macro.HcsCucmsAssociatedToNDLRMCR}} 2427 service-type mgcp version 1.0 | - This is the physical device    |
|    no ccm-manager config server {{ fn.one macro.HcsCucmsAssociatedToNDLRMCR}}                          | network interface (Ethernet      |
|    mgcp                                                                                                | Port) for the analog gateway.    |
|    no ccm-manager mgcp                                                                                 |                                  |
|    ! no ccm-manager redundant-host                                                                     |                                  |
|    no ccm-manager switchback Graceful                                                                  |                                  |
|    no ccm-manager fallback-mgcp                                                                        |                                  |
|    no mgcp bind control source-int {{ pwf.GatewayDAT.networkInterface }}                               |                                  |
|    no mgcp bind media source-int {{ pwf.GatewayDAT.networkInterface }}                                 |                                  |
|    no mgcp dtmf-relay voip codec all mode out-of-band                                                  |                                  |
|    no mgcp modem passthrough voip mode nse no ccm-manager music-on-hold                                |                                  |
|    no ccm-manager config                                                                               |                                  |
|    no mgcp package-capability rtp-package                                                              |                                  |
|    no  mgcp package-capability sst-package                                                             |                                  |
|    no  mgcp default-package mt-package                                                                 |                                  |
|    no mgcp timer receive-rtcp                                                                          |                                  |
|    no  mgcp sdp simple                                                                                 |                                  |
|    no mgcp fax t38 inhibit                                                                             |                                  |
|    no mgcp                                                                                             |                                  |
|    end                                                                                                 |                                  |
|                                                                                                        |                                  |
+--------------------------------------------------------------------------------------------------------+----------------------------------+

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

+--------------------------------------------------------------------------------------------------------+----------------------------------+
| Default IOS Commands                                                                                   | Available Variables              |
+========================================================================================================+==================================+
| **HcsDeleteAnalogGatewayEndpointEVT** Deletes an Endpoint for the Analog MGCP Gateway.                 |                                  |
+--------------------------------------------------------------------------------------------------------+----------------------------------+
|                                                                                                        |                                  |
| ::                                                                                                     |                                  |
|                                                                                                        |                                  |
|    conf t                                                                                              | pwf.PORT_NUM - This is the FXS   |
|    voice-port {{ pwf.PORT_NUM }}                                                                       | port number of the analog        |
|    no timeouts call-disconnect                                                                         | gateway device.                  |
|    default cptone                                                                                      |                                  |
|    default timing hookflash-in                                                                         | pwf.DIAL_PEER_NO - returns the   |
|    default description                                                                                 | dial peer number we use to       |
|    no signal                                                                                           | generate dial peer. It starts    |
|    default ring frequency                                                                              | from 4 for the first dial peer,  |
|    shutdown                                                                                            | and increase by 1 for the next   |
|    exit                                                                                                | one.                             |
|    no dial-peer voice {{ pwf.DIAL_PEER_NO }} pots                                                      |                                  |
|    end                                                                                                 |                                  |
|                                                                                                        |                                  |
+--------------------------------------------------------------------------------------------------------+----------------------------------+

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

+--------------------------------------------------------------------------------------------------------+----------------------------------+
| Default IOS Commands                                                                                   | Available Variables              |
+========================================================================================================+==================================+
| **HcsDeleteAnalogMGCPGatewayEndpointModEVT** Deletes an Endpoint Module for the Analog MGCP Gateway.   |                                  |
+--------------------------------------------------------------------------------------------------------+----------------------------------+
|                                                                                                        |                                  |
| ::                                                                                                     |                                  |
|                                                                                                        |                                  |
|    conf t                                                                                              | pwf.PORT_NUM - This is the FXS   |
|    voice-port {{ pwf.PORT_NUM }}                                                                       | port number of the analog        |
|    no timeouts call-disconnect                                                                         | gateway device.                  |
|    default cptone                                                                                      |                                  |
|    default timing hookflash-in                                                                         | pwf.DIAL_PEER_NO - returns the   |
|    default description                                                                                 | dial peer number we use to       |
|    no signal                                                                                           | generate dial peer. It starts    |
|    default ring frequency                                                                              | from 4 for the first dial peer,  |
|    shutdown                                                                                            | and increase by 1 for the next   |
|    exit                                                                                                | one.                             |
|    no dial-peer voice {{ pwf.DIAL_PEER_NO }} pots                                                      |                                  |
|    end                                                                                                 |                                  |
|                                                                                                        |                                  |
+--------------------------------------------------------------------------------------------------------+----------------------------------+

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

+--------------------------------------------------------------------------------------------------------+----------------------------------+
| Default IOS Commands                                                                                   | Available Variables              |
+========================================================================================================+==================================+
| **HcsUpdateAnalogGatewayEVT** Updates the Analog MGCP Gateway.                                         |                                  |
+--------------------------------------------------------------------------------------------------------+----------------------------------+
|                                                                                                        |                                  |
| ::                                                                                                     |                                  |
|                                                                                                        |                                  |
|    conf t                                                                                              | pwf.GatewayDAT.networkInterface  |
|    hostname {{pwf.GatewayDAT.domainName}}                                                              | - This is the physical device    |
|    no mgcp bind control source-int {{ pwf.previousGatewayDAT.networkInterface }}                       | network interface (Ethernet      |
|    mgcp bind control source-int {{ pwf.GatewayDAT.networkInterface }}                                  | Port) for the analog gateway.    |
|    no mgcp bind media source-int {{ pwf.previousGatewayDAT.networkInterface }}                         |                                  |
|    mgcp bind media source-int {{ pwf.GatewayDAT.networkInterface }}                                    |                                  |
|    end                                                                                                 |                                  |
|                                                                                                        |                                  |
+--------------------------------------------------------------------------------------------------------+----------------------------------+

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

+--------------------------------------------------------------------------------------------------------+----------------------------------+
| Default IOS Commands                                                                                   | Available Variables              |
+========================================================================================================+==================================+
| **HcsUpdateAnalogGatewayEndpointEVT** Updates the Endpoint for the Analog MGCP Gateway.                |                                  |
+--------------------------------------------------------------------------------------------------------+----------------------------------+
|                                                                                                        |                                  |
| ::                                                                                                     |                                  |
|                                                                                                        |                                  |
|    conf t                                                                                              | pwf.PORT_NUM - This is the FXS   |
|    voice-port {{ pwf.PORT_NUM }}                                                                       | port number of the analog        |
|    no signal                                                                                           | gateway device.                  |
|    signal {{macro.HcsIosCmdAnalogGwSignalMCR}}                                                         |                                  |
|    no timeouts call-disconnect                                                                         | pwf.GatewayDAT.disconnectTimeout |
|    timeouts call-disconnect {{ fn.as_string pwf.GatewayDAT.disconnectTimeout }}                        | - Time in seconds for which a    |
|    no cptone                                                                                           | connection is maintained after   |
|    cptone {{ pwf.GatewayDAT.cpTone }}                                                                  | the completion of a              |
|    no shutdown                                                                                         | communication exchange.          |
|    end                                                                                                 |                                  |
|                                                                                                        | pwf.GatewayDAT.cpTone - This is  |
|                                                                                                        | the call progress tone of the    |
|                                                                                                        | country that supports each       |
|                                                                                                        | analog device in the gateway.    |
+--------------------------------------------------------------------------------------------------------+----------------------------------+