Analog gateways and ports

What it is for

Analog endpoints such as fax machines, door intercoms or simple phones are connected to FXS ports of a Cisco gateway. In the CUCM, every port in use is a device of its own with a line. EasyUC creates this device from a template and assigns the phone number, label and description in the process.

The Manage Analog page lists the gateways from the CUCM with status and IP address. Via Ports you see all ports per slot and subunit. Free ports are green, ports in use are red. A click on a free port opens the Create Port Endpoint dialog.

For operating the gateway itself, that is SSH access, voice port configuration, certificates and active calls, there is the Gateways → Analog GWs page. It is described in the chapter “Administering CUBE and analog gateways”.

Prerequisites

• License module cucm and an active CUCM connection.
• Menu item Devices → Analog: role ROLE_APP_VIEW_ANALOG_PAGE.
• Ports button: one of the roles ROLE_APP_LIST_GATEWAY_PORT, ROLE_APP_CREATE_GATEWAY_PORT, ROLE_APP_UPDATE_GATEWAY_PORT, ROLE_APP_DELETE_GATEWAY_PORT.
• Creating, importing and exporting ports: ROLE_APP_CREATE_GATEWAY_PORT. Editing: ROLE_APP_UPDATE_GATEWAY_PORT. Deleting: ROLE_APP_DELETE_GATEWAY_PORT.
• The server loads the gateway list only with the permission for the Gateways area, Analog section (ROLE_APP_GATEWAYS together with ROLE_APP_GATEWAYS_ANALOG), or as an administrator.
• The gateway is created in the CUCM with slot, subunit and module. EasyUC does not create gateways.
• A gateway template exists for the location. For MGCP gateways it must match the selected port type.
• The location has a number range with free phone numbers.

Step by step: creating an analog line on a free port

1. Open EasyUC Cisco → Devices → Analog. The Manage Analog page shows product, Name, Protocol, description, Status and IP for each gateway.
2. Find the gateway using the search field in the Gateway column.
3. Click Ports in the Actions column. The Analog dialog shows the module for each Slot and Subunit and, below it, one card per port.
4. Click a green card with the text No Endpoints. The Create Port Endpoint dialog opens.
5. Select the Location.
6. For an MGCP gateway, select the Port Type. For SCCP this field does not apply.
7. If required, select a Package and then the Template.
8. Enter the Phone number or click Get Free phone number. EasyUC inserts the next free number of the location.
9. Fill in Description on analog Port, Label, Alerting Name and Description on line.
10. Click Save. EasyUC creates the analog device and the line in the CUCM.
11. Open Ports again. The card is now red and shows the device name, the phone number and the label.

Step by step: exporting and importing ports via CSV

1. Open Devices → Analog and Ports on the gateway.
2. On the slot, click Export all free Ports or Export all Ports.
3. In the dialog, select Location, Port Type (MGCP only) and Template if required. These values are prefilled in the CSV file.
4. Click Save. The CSV file contains the columns port number, location name, port type (MGCP*), template name, phone number, description on the analog port, description on the line, label and alerting name.
5. Add the missing values for each port in the file. The column order must be kept. The port type column is mandatory but is only filled for MGCP.
6. On the same slot, click Import. The Import NEW CSV File dialog opens.
7. Select the CSV file. Under Ports to Import you see every row. Ports in use are skipped.
8. Correct the marked rows and click Save.
9. Then check the port cards.

Step by step: editing, opening or deleting a port

1. Open Devices → Analog and Ports on the gateway.
2. On a red card, click the pencil icon. In the Modify Port Endpoint dialog, change Label and Description and click Save.
3. Click the red card itself to open the device in the phone profile. This requires ROLE_APP_VIEW_PHONE_PROFILE.
4. Click the delete icon to remove the port endpoint. Confirm the delete dialog. The card then turns green again.

Fields and options

Check the result and troubleshoot

• Success: the port card is red and shows device name, phone number, Label and Alerting. The device exists in the CUCM.
• A created port does not yet confirm a working line. Test with a real call or fax.
• The Save button stays gray as long as Location, Template or Phone number is missing.
• The Template field does not appear: first select the location and, for MGCP, the port type. If there is no matching gateway template, create one under Templates.
• A click on a green card has no effect: you lack ROLE_APP_CREATE_GATEWAY_PORT.
• The gateway list stays empty although gateways exist in the CUCM: check the active CUCM connection and the permission for the Gateways area, Analog section.
• Mandatory details are missing in the CSV import: the dialog points out that ports without the required data are not imported. Add location, template and phone number.
• If a port was deleted in the CUCM by mistake, you find it under Restore Config → Gateway ports, provided the CUCM backup is switched on.