Sei sulla pagina 1di 76

Unigy 4.

1
Critical Alert Guide

Part Number: B02200615, Release: 00


IPC Systems, Inc., Confidential and Proprietary
August 18, 2017
© Copyright 2017 IPC Systems, Inc. All Rights Reserved.
3

Table of Contents
Revision List for Unigy V4.1......................................................................................................... 5
Preface ............................................................................................................................................7

Chapter 1: Prepare the Enterprise for setting up Critical Alert............................................. 11


1.1 Critical Alert...................................................................................................................................................... 11
1.1.1 Global Service Operations Center ..................................................................................................... 11
1.2 Critical Alert Dependencies ..............................................................................................................................12
1.3 Monitoring and alerts ........................................................................................................................................12
1.4 Unigy monitoring system components.............................................................................................................. 12
1.5 SNMP forwarding to IPC or customer NOC..................................................................................................... 12

Chapter 2: Turning up Critical Alert on a site..........................................................................15


2.1 Configure AFM enterprise and site codes ........................................................................................................ 15
2.2 Trap forwarding................................................................................................................................................. 15
2.3 Create an SNMP forwarding trap destination....................................................................................................16
2.4 Edit an SNMP forwarding trap destination........................................................................................................17
2.5 Disable SNMP forwarding to a trap destination................................................................................................ 19
2.6 Delete an SNMP forwarding configuration....................................................................................................... 21
2.7 Configure SBC SNMP alert forwarding ........................................................................................................... 21
2.7.1 Configure monitoring and create inventory record for an SBC......................................................... 22
2.8 Configure SNMP profiles.................................................................................................................................. 23

Chapter 3: Test Configuration....................................................................................................25


3.1 Run CCM AFM Alerts test................................................................................................................................ 25
3.2 AFM Alerts Test................................................................................................................................................ 26

Chapter 4: Use Critical Alert......................................................................................................29


4.1 Maintenance mode types....................................................................................................................................29
4.1.1 Disable SNMP forwarding for a zone................................................................................................ 30
4.1.2 Reenable SNMP forwarding for a zone..............................................................................................31

Appendix A: Unigy Panels.......................................................................................................... 33


A.1 SNMP Forwarding: Trap Destinations.............................................................................................................. 33
A.2 SNMP Forwarding: Zone Maintenance Status.................................................................................................. 37
A.3 SMTP ................................................................................................................................................................ 40

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
4

A.4 SNMP Profiles................................................................................................................................................... 42


A.5 Pulse: SNMP .....................................................................................................................................................46
A.6 IQ/MAX & Edge: SNMP ................................................................................................................................. 48
A.7 Media Manager: SNMP .................................................................................................................................... 49
A.8 Media Gateway: SNMP..................................................................................................................................... 51
A.9 Prototype Devices: Media Gateway SNMP ......................................................................................................53
A.10 Prototype Devices: Media Manager SNMP ......................................................................................................55
A.11 Prototype Devices: Pulse SNMP ...................................................................................................................... 57
A.12 Prototype Devices: IQ/MAX & Edge: SNMP .................................................................................................. 59
A.13 Location Details ................................................................................................................................................ 61
A.14 Enterprise: Organize System..............................................................................................................................65

Index..............................................................................................................................................73

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


5

Revision List for Unigy V4.1


Advanced Administrator Diagnostics
• Only users with the IPC Certified Tech role can ac...
• VoIP Quality Preconfigured provided for IPC Certif...
• IP Recording Preconfigured provided for IPC Certif...
• Patch Upgrade Preconfigured template provided for ...

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
6

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


7

Preface
About this Guide
This guide explains how to configure and maintain SNMP forwarding to IPC’s Critical Alert (Critical
Alert), which was formerly referred to as the Advanced Fault Management (AFM) service.
For additional information related to alerts, refer to the System Installation and Deployment Guide , the
Advanced Diagnostics and Logging Guide , and the Reports Guide.

Copyright notices
• IPC, the IPC logo, Alliance MX, IQ/MAX, MAXaccess, Nexus Suite, Unigy, Blue Wave, and the
Unigy and Blue Wave logos are trademarks of IPC Systems, Inc.
• Microsoft, Windows, Excel, Outlook, Lync, Microsoft OCS, Microsoft Office Communications
Server, Active Directory, and Internet Explorer are trademarks of Microsoft Corporation.
• Oracle, Java, and MySQL are trademarks of Oracle.
• Red Hat and Enterprise Linux are trademarks of Red Hat, Inc.
• Dell and PowerEdge are trademarks of Dell, Inc.
• Intel and Xeon are trademarks of Intel Corporation in the U.S.
• NICE and the NICE logo are trademarks of NICE Systems Ltd. and/or its subsidiaries.
• Verint is a registered trademark of Verint Systems Inc.
• Radisys is a trademark of Radisys Corporation.
• NetGuardian 832A is a trademark of DPS Telecom.
• ConferenceManager is a trademark of Sonexis Technology Inc.
• Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates.
• All other brand and product names used in this document are trademarks or registered trademarks of
their respective owners.

Document Conventions
This topic describes the typographic conventions used in this manual:
• To indicate a user interface item to select or click:
Click Help. The Help dialog box opens.
Style Note: This is a san-serif bold font.
• To indicate a sequence of UI clicks:
Click File ➤ New ➤ Command.
Style Note: This is a san-serif bold font.
• To indicate window, screen, or panel names:
The Help dialog box opens.
Style Note: This is an italicized font.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
8 Preface

• To indicate text to be typed or entered for user input or command names:


Type install at the prompt and press Enter.
Style Note: This is a Fixed-Width Bold font.
Type ls -al at the prompt and press Enter.
Style Note: This is a Fixed-Width Bold font.
• To indicate variables to be typed or entered:
Type yourpassword and press Enter.
Style Note: This is a Fixed-Width Bold Italic font.
• To indicate screen text such as prompts:
At the Enter your password prompt, type your password.
Style Note: This is a Fixed-Width font.
• To indicate file and directory names:
The error.log file is stored in /var/log.
Style Note: This is a Fixed-Width font.
• For references to other documents:
Refer to the Security Administrator Guide .
Style Note: This is an italicized font.
Space Designator
When the user needs to type a space in a command, a single space is used in the command text.
Key Combinations
Many instructions include key combinations where it is necessary to press two keys simultaneously. For
example, when CTRL+C is specified, it means press and hold down the Control key and press C at the
same time.

Note styles

Note
This is a Note and is used to alert you to important information.

Tip
This is a Tip and is used to provide helpful suggestions or hints.

Caution
This is a Caution and is used to alert you to any procedures in which extreme caution must be used.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


Preface 9

Warning
This is a Warning and is used to alert you to dangerous situations or procedures that must be completed
in a specific manner to prevent a dangerous or damaging situation.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
10 Preface

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


11

1 Prepare the Enterprise for setting up


Critical Alert
1.1 Critical Alert
When an SNMP forwarding trap destination is configured in the UMS as an IPC NOC Type, the
destination is the Critical Alert at the IPC Global Service Operations Center (GSOC). Critical Alert is an
enhanced service offered by GSOC that proactively monitors customers’ equipment and digital circuits.

Critical Alert features secure, real-time monitoring and alert management of IPC Trading
Communications Systems (including Unigy), Voice Recording Systems (NICE Trading Recording,
NICE Interaction Management, or IPC Media Recorder). The service translates alerts into meaningful
business impact information and provides a managed, integrated response to customers. The service also
validates operational readiness before each trading day.
The following Unigy equipment is monitored by Critical Alert:
• CCM or ACCM appliance
• Media Manager
• Media Gateway
• IPC provided SBC
• Turrets and Pulse devices
• Voice recording systems

Forwarding alerts to Critical Alert


The alerts forwarded to Critical Alert are sent in the SNMPv2c packet format. Any SNMPv1 alert
packets trigger IPC to generate a Unigy alert in the SNMPv2c packet format and that will be forwarded
to the Critical Alert (or the customer NOC).
Unigy alerts forwarded to Critical Alert provide unique identification that correlates to a customer’s
physical address. This allows Critical Alert to correlate all alerts coming from a customer’s specific
address so that the GSOC can identify which customer site is having an issue and respond accordingly.
If you are using the Critical Alert service, IPC provides the values for these unique identifiers prior to
the Unigy installation.
For more information, see Configure AFM enterprise and site codes on page 15.

Testing provisioning of Critical Alert


A test alert will be sent to verify the provisioning of the Critical Alert service. The test alert is generated
manually and clearly indicates that it is only a test alert. The alert is sent to every configured NOC. For
more information, refer to Run CCM AFM Alerts test on page 25.

1.1.1 Global Service Operations Center


Global Service Operations Center (GSOC) is the IPC network and operations service center.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
12 1.2: Critical Alert Dependencies

IPC’s GSOC is an enhanced service organization that combines the functions of a Service Center,
Systems Support, and Network Operations to deliver multi-tiered service management to IPC customers.
One of the GSOC services is Critical Alert. GSOCs are regionally co-located with IPC’s current
Network Operations Centers in New York, London, and Singapore.
The GSOC monitors the performance of customers’ systems remotely. This includes monitoring the
performance of SIP messages and RTP packets as well as other network and circuit measures.
Monitoring is accomplished using SNMP.

1.2 Critical Alert Dependencies


The Critical Alert service is part of the Unigy system. Correct installation and configuration of Unigy
and the alerts service is required for Critical Alert.
For information on the deployment and configuration of Unigy, see the System Installation and
Deployment Guide and the Enterprise Guide .
For information about the alerts service, see the Monitoring, Alerts, and Diagnostics Guide.
For information on the monitoring and diagnostics service, see the Advanced Diagnostics and Logging
Guide.
For information about the ports and protocols used by Critical Alert, see the Ports and Protocols Guide .

1.3 Monitoring and alerts


Monitoring and alerts are separate for each enterprise. There is no cross-monitoring between the Unigy
and Alliance MX interop enterprises, including no combined Critical Alert (Critical Alert) view.
Individual Alliance MX sites display alarms in the Red Alarm window and in Critical Alert. The UMS
Monitoring Dashboard displays alerts for the Unigy enterprise. Unigy can also be configured to forward
alerts to Critical Alert. See the Monitoring, Alerts, and Diagnostics Guide for more information.

1.4 Unigy monitoring system components


The Unigy monitoring system consists of the following key components:
• Simple Network Management Protocol (SNMP) - Simple Network Management Protocol v1 and
v2c.
• Java Management Extension (JMX) - Java technology that supplies tools for managing and
monitoring applications.
• Network Elements - Network node that implements an SNMP interface.
• Unigy Management System (UMS) - Monitoring Dashboard client interface for centralized
monitoring of the Unigy enterprise.
• Global Service Operations Center (GSOC) - IPC facilities that offer Critical Alert (Critical Alert),
an enhanced service that customers can purchase to have IPC proactively monitor their equipment
and digital circuits.

1.5 SNMP forwarding to IPC or customer NOC


The UMS SNMP forwarding service allows authorized personnel to forward alerts from the Unigy
system to the IPC Critical Alert (Critical Alert), one or more customer provided Network Management
Systems (NMS), or both.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


1.5: SNMP forwarding to IPC or customer NOC 13

In addition to receiving alerts from Unigy devices, Unigy can also receive alerts from third-party
hardware or software, but only alerts expressed in the IPC MIB and those from third-party vendors that
can be mapped to an alert expressed by the MIB are available for forwarding.
Alerts generated by vendor hardware or software that cannot be mapped to the IPC MIB will be
suppressed, are not saved in the alert history, and are not forwarded. However, the receipt of suppressed
alerts will be logged by the IPC syslog functionality.
The Unigy MIB allows an external NMS to interpret the forwarded alerts.

Unigy is capable of receiving alerts in SNMPv1 or SNMPv2c format and can be configured to forward
the alerts to the destination NMS in SNMPv2c format.
Unigy also provides the ability to filter the alerts forwarded to a customer destination NMS; however,
alerts forwarded to an IPC NOC destination are not filterable.
Although the UMS permits the configuration of multiple SNMP forwarding locations, for optimal
performance, IPC recommends configuring no more than five forwarding destinations.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
14 1.5: SNMP forwarding to IPC or customer NOC

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


15

2 Turning up Critical Alert on a site

2.1 Configure AFM enterprise and site codes


If configuring SNMP forwarding to the Critical Alert service, ensure that the IPC Enterprise Code
(AFM) and IPC Site Code (AFM) are set to the unique values provided to you by IPC.

1. In the UMS menu bar, select Configuration ➤ Enterprise then select System ➤ Enterprise from
the navigation panel.
The Organize System tab is displayed.
2. Enter an IPC provided value in the IPC Enterprise Code (AFM) field.
3. Click Save.
4. Select System ➤ Locations from the navigation panel.
The Location Configuration tab is displayed.
5. Select a Location in the list, for example, Default Back Room.
The Location Detail panel is displayed.
6. Enter an IPC provided value for the IPC Site Code (AFM) field.
7. Click Save.
8. Repeat steps 4 - 7 for all the Locations in the Enterprise.
9. To complete the configuration, see Create an SNMP forwarding trap destination on page 16.

2.2 Trap forwarding


Unigy system log messages are converted to traps and forwarded to a proxy agent using SNMP.
Simple Network Management Protocol (SNMP) is a network management framework standard defined
by the Internet Engineering Task Force (IETF). It is a protocol used to exchange management messages
between the CCM and entities that include communications device interfaces, session recording devices,
Media Manager, Media Gateway and Channel Bank. SNMP has three versions:
• SNMPv1
• SNMPv2c
• SNMPv3
An SNMP trap is a non-solicited (asynchronous) generated packet which indicates an alarm or other
significant event. An SNMP trap packet includes the following information:
• Source address
• Time Stamp (when sent)
• Trap OID (uniquely identifying the trap)
• Trap var-bind
The var-bind is a list of the object OID and value pairs. In an SNMP trap, the values carry information
about the event being notified such as entity ID, severity, status, or text description.
The SNMP trap notifies the monitoring and alarming agent of errors and exceptional conditions in
Unigy entities. The agent records SNMP traps as events and processes SNMP trap data according to pre-
defined rules.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
16 2.3: Create an SNMP forwarding trap destination

SNMP polling and SNMP trap/inform are the main resource of information for obtaining data from
remote entities where no monitoring and alarming agents are deployed. The Unigy monitoring and
alarming agent relies on polling SNMP objects to establish performance metrics, availability and other
data. The polling frequencies for individual resources or objects are configurable. The update frequency
between the alarming agent and entities is also configurable.
SNMP informs are sent to the Unigy monitoring and alarming agent for critical performance
information. The agent sends a response packet to the inform sender as required by the SNMP protocol
to acknowledge the reception. The response packet and process do not impact the alarm processing; an
SNMP inform is processed in the same way as an SNMP trap.

2.3 Create an SNMP forwarding trap destination


Create a new trap destination to forward Unigy SNMP alerts to. The destination can be IPC or a
customer provided NMS.
Although the UMS allows you to configure SNMP forwarding to multiple destinations, for optimal
performance, IPC recommends no more than five forwarding destinations.
If you are configuring SNMP forwarding to IPC, ensure that your IPC Enterprise Code and IPC Site
Code are set to unique values. For more information, refer to Configure AFM enterprise and site codes
on page 15.
You must have the Advanced Administrator, IPC Certified Tech, or IPC Project Manager role to perform
this procedure.
1. In the menu bar, click Configuration ➤ Sites.
2. Click SNMP Forwarding then click Trap Destinations.
3. Click the add icon (plus sign).
The Trap Destination panel is displayed.
4. Enter the following configuration details:
• In the NOC Name field, enter a unique name to identify the NOC in the UMS.
• In the IP Address field, enter the host IP address of the NOC NMS server.
• In the Port field, enter the SNMP port number (the standard is 162). For GSOC, enter 162.
• If the destination is IPC, select the Heart Beat check box.
• In the NOC Type field, select IPC to forward alerts to the GSOC for the Critical Alert service or
select Customer to forward alerts to the customer’s NMS.
For more information about specific fields in this panel, refer to SNMP Forwarding: Trap
Destinations on page 33.

5. Select SNMPv2c as the Version and then enter the Community String.
SNMPv3 is reserved for future use.
6. Drag zone names from the Available to Assign list (right panel) into the Zone Association area
(bottom center panel) for all the zones that you want SNMP forwarding to this destination.
When a zone is associated with a destination, the forwarding status of the zone is enabled by default.
The following illustrates a trap destination configured for SNMPV3.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


2.4: Edit an SNMP forwarding trap destination 17

Figure 1: Trap Destination Configuration tab

7. Click Save Configuration to create the new trap destination configuration.


The NOC name and NOC type of the new trap destination are displayed in the Trap Destination list.

2.4 Edit an SNMP forwarding trap destination


Edit an existing SNMP forwarding trap destination configuration, including adding or removing a zone
association.
You must have the Advanced Administrator, IPC Certified Tech, or IPC Project Manager role to perform
this procedure.
1. In the menu bar, click Configuration ➤ Sites.
2. Click SNMP Forwarding then Trap Destinations.
A list of current trap destinations is displayed in the lower left panel.
3. Select a Trap Destination Name from the list. (Optionally, before making a selection, filter the list by
entering a value in the Name or Noc Type fields.)
The configuration properties of that destination are displayed in the Trap Destination panel.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
18 2.4: Edit an SNMP forwarding trap destination

Figure 2: Trap Destination panel

4. Edit any configuration properties. This could include changing details about the trap destination or
the SNMP configuration, or adding or removing the zones associated with this destination. To remove
a zone association, click the zone then click Remove Zone Association.

Note
The Forwarding Status of a zone is not configurable from this panel. To change a zone’s forwarding
status, use the SNMP Forwarding Maintenance panel.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


2.5: Disable SNMP forwarding to a trap destination 19

Figure 3: Trap Destination panel

5. Click Save Configuration to save your changes.

2.5 Disable SNMP forwarding to a trap destination


Disable forwarding of Unigy alerts to a trap destination (NOC) by disabling the forwarding for one or
more zone associations in the trap destination configuration. Other configured trap destinations will
continue to receive traps from those zones, if they are associated with them.

Note
When a zone is first associated with an SNMP forwarding trap destination configuration, the zone’s
forwarding status is set to Enable by default.

You can use the Zone Maintenance Status panel in one of two ways: to reveal (but not select) all the
destinations associated with a zone, click on the Zone Name or within the row. This action does not
check any of the check boxes and therefore does not select any zone or destination. Alternatively, you
can reveal and select all the destinations associated with zone by clicking the check box next to a Zone.
The following procedure uses the first method.
1. In the menu bar, click Configuration ➤ Sites.
2. Click SNMP Forwarding, then Maintenance.
The Zone Maintenance Status panel is displayed.
3. Select a Zone name or elsewhere in the row of a zone you know is associated with the trap destination
you want to disable.
The Trap Destination grid is displayed in the lower portion of the panel. All the trap destinations that
the zone is associated with are listed but they are not selected.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
20 2.5: Disable SNMP forwarding to a trap destination

Figure 4: Zone Maintenance Status panel

4. Select the trap destination that you want to disable forwarding to by clicking the check box next to
the trap destination as illustrated in the following figure.
5. Click Disable.
Figure 5: Zone Maintenance Status panel

The Forwarding Status for the trap destinations changes to Disable and a red X also displays next to
that destination to indicate that forwarding is now disabled.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


2.6: Delete an SNMP forwarding configuration 21

Figure 6: Zone Maintenance Status panel

6. Repeat steps 3 - 5 if you wish to disable the forwarding for other zones associated with this trap
destination.

Note
The SNMP Forwarding can be reenabled for a trap destination by following these procedures and
choosing Enable in step 5.

2.6 Delete an SNMP forwarding configuration


Delete an SNMP forwarding trap destination configuration for all zones.
1. In the menu bar, click Configuration ➤ Sites.
2. Select SNMP Forwarding.
The list of existing trap destinations displays in the lower left panel.
3. Select the trap destination you wish to delete.
The Trap Destination panel is displayed.
4. Click Delete Trap Destination.
5. Click Yes to confirm the deletion.
The trap destination configuration is deleted for all zones in the enterprise.

2.7 Configure SBC SNMP alert forwarding


Configure the SNMP alert settings to allow the IPC SBC to send SNMP traps to Unigy so that Unigy
can then generate alerts corresponding to them. Unigy will also forward these alerts to Critical Alert if
Unigy is configured to do so.
1. From the IPC SBC Web UI interface (not UMS), confirm the community string and trap parameters
are set correctly:
a) Click Configuration ➤ System ➤ Management ➤ SNMP ➤ Community Settings.
b) Ensure that isbc01Admin is set as the first Read/Write Community String and as the Trap
Community String.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
22 2.7: Configure SBC SNMP alert forwarding

c) If the settings are not there, add them.


2. Click Submit.
3. Click Burn then click OK.
4. Set the Trap Destination as the Unigy zone VIP:
a) Click Configuration ➤ System ➤ Management ➤ SNMP ➤ SNMP Trap Destinations.
b) Select the SNMP Manager 1 check box.
c) In the IP Address column, enter the Unigy zone VIP.
d) Leave the Trap Port as 162.
e) Click Submit.
f) Click Burn then click OK.

Note
This step will allow alarms (alerts) from the SBC to be sent to Unigy. If configured for Critical Alert,
Unigy will also forward the alerts to Critical Alert.

2.7.1 Configure monitoring and create inventory record for an SBC


Perform this task to configure a Session Border Controller to be monitored by Unigy. This also adds an
SBC inventory record to the Unigy database for potential use by a third-party tool or application. This
panel can also be used to edit or delete an existing SBC inventory record.
UMS user accounts with one of the following roles can make changes to fields in this panel: Basic
Administrator, Advanced Administrator, IPC Project Manager, or IPC Certified Tech. Users with the
Auditor role can view, but not modify, the properties in this panel.
The information entered in this panel is saved in the SessionBorderController database entity.
The inventory information can be retrieved by the Blue Wave APIs for use by a third-party tool or
application.
When an inventory record exists for an SBC device, Unigy is able to correlate alerts to the device (even
though SBC devices are considered to be passively monitored). If an inventory record is not created and
the device generates an alert, the alert displays in the Alerts panel of the Monitoring Dashboard
Summary view but the device is not identified. Instead, the alert shows the device as an Unknown Device
and the alert does not contain a hyperlink to navigate to more information.
1. In the UMS menu bar, click Configuration ➤ Enterprise.
2. In the left panel, click Session Border Controller.
The Session Border Controllers list displays the Session Border Controllers that currently have
inventory records in the system.
3. In the Session Border Controllers list, click the Add button (+).
The SBC Configuration panel displays in the center.
4. Enter the Name of the SBC device.
5. Enter the IP Address of the SBC device.
6. Enter the Vendor name of the SBC device.

Note
If this is an IPC SBC, select Audio Codes as the vendor.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


2.8: Configure SNMP profiles 23

7. In the Monitoring Zone field, enter the Unigy zone that you want to use to monitor the device. The
zone must be Unigy V3.1.0.2 or higher.
8. In the Use SNMP Profile field, select the SBC SNMP Profile.
9. Optionally, enter a Description.
Figure 9: SBC Configuration panel

10. Click Save.


Monitoring starts immediately. No reboot is necessary.

2.8 Configure SNMP profiles


Both the network management entity and any associated network elements must be configured for
monitoring. For actively monitored devices, this configuration initially occurs during UMS system
deployment. However port settings can be modified through the UMS using Configuration ➤
Enterprise ➤ SNMP Profiles.

IPC provides five preconfigured default SNMP profiles, one each for turrets, Media Gateways, Media
Managers, voice recorders, and Session Border Controller. Other devices such as channel banks require
that you consult third-party vendor documentation for SNMP configuration. SNMP configuration
generally includes the following steps:
1. Obtain all the SNMP details found in IPC and or third party vendor manuals.
2. Set up the profiles and shared profiles (for sets of devices) in the UMS.
3. Assign the profiles or device specific settings.
4. Use the assigned or default SNMP settings to connect to the network elements.
For more information on SNMP configuration see SNMP Profiles on page 42.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
24 2.8: Configure SNMP profiles

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


25

3 Test Configuration

3.1 Run CCM AFM Alerts test


Generates an SNMP test trap to port 162 for manual verification that the event is logged. The test alert
will be sent to all configured NOCs.
Duration: Less than 10 seconds.
Usage: Perform this test to ensure that the Critical Alert is receiving alerts from the Unigy system.
This test is not intrusive.
You must be logged in to the Unigy Management System and be authorized to generate and view this
test.
1. Select Tools ➤ Diagnostic.
2. Click Create New Test.
3. Expand CCM in the Available tests panel.
All CCM diagnostics tests are displayed.
4. Drag the AFM Alerts Test to the New Diagnostic Test panel.
5. If necessary, select the Zone with the CCM you want to run the test on.
6. Do any of the following:
• From the Available Devices panel, drag one or more CCMs or ACCMs to the CCM tab.
• From the Device List panel, drag a device list (group of CCMs) to the CCM tab.
7. Click Perform Test.
8. View the status of the tests in the Diagnostic Status area.
When the test is complete, the value in the Progress column in the Diagnostics Status Details panel is
100.
9. Click to View results in the Output column.
Figure 10: CCM AFM Alerts Test Output panel

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
26 3.2: AFM Alerts Test

For information about the CCM AFM Alerts Test panel, see: AFM Alerts Test on page 26.

3.2 AFM Alerts Test


Use this panel to test if the particular Advanced Fault Management server is active, inactive, or disabled.
Only users with the IPC Certified Tech role can access, create, schedule, and run this diagnostic test.
To access this panel, click Tools ➤ Diagnostic. Click Create New Test then select CCM ➤ AFM Alerts
Test and drag it into the New Diagnostic Test panel.

For information about test duration, usage, sample output, next steps, and reasons for failure, see Run
CCM AFM Alerts test on page 25.

Table 1: Selected Devices

Name Descriptions Values Notes


Device Name Names of CCMs and Selected CCMs,
ACCMs dragged from ACCMs, or both to run
the Available Devices or this test on.
Device List panels.

Table 2: Available Devices

Name Description Values Notes


Name CCM and ACCM List of registered CCMs To filter the list, enter
names. and ACCMs for the search criteria. To
selected zone. remove the filter, click
the x icon in the search
field.

Table 3: Device List

Name Description Values Notes


Device List Name Names of CCM device String. Maximum of 255 To filter the list, enter
lists. The list can include characters. device list name search
ACCMs criteria. To remove the
filter, click the x icon in
the search field. To
delete a device list, click
the minus icon next to
the device list name.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


3.2: AFM Alerts Test 27

Table 4: Available Tests

Name Description Values Notes


Zone Filter field for specifying List of available zones. Test can only be
the devices to display Select the zone that executed in one zone at
based on the zone you contains the devices you a time.
select. want to create the
diagnostic test for.
Search Topic... Text field for entering
search criteria to locate
a test.

Table 5: Available Templates

Name Description Values Notes


Name Names of available Up to 64 alphanumeric Long names do not
diagnostic templates. characters. wrap and may require
resizing the panel to
view them.
To filter the list, enter
template name search
criteria. To remove the
filter, click the x icon in
the search field. To
select a template, drag it
to the New Diagnostic
Test tab. To delete a
template, click the minus
icon next to the template
name.
VoIP Quality Preconfigured provided
for IPC Certified Techs
that contains all tests
and commands related
to VoIP Quality.
IP Recording Preconfigured provided
for IPC Certified Techs
that contains all tests
and commands related
to IP recording.
Patch Upgrade Preconfigured template
provided for IPC Note
Certified Techs that
contains all tests and Informational
commands used to diagnostics cannot be
verify all Unigy added to this template.
components are However, it is possible
operational after a patch to create a custom
upgrade. template containing any
combination of individual
walk the floor tests and
informational tests.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
28 3.2: AFM Alerts Test

Table 6: Buttons

Name Description
Search Search the available tests for the text entered in the Search
Topic... field. Filters the list on the basis of this text.

Reset Reset the available tests tree to its original state.


Expand All ( + ) Expand all nodes of the available tests tree.
Collapse All ( - ) Collapse all nodes of the available tests tree.
Save as Template Save the selected tests and values as a diagnostic template
for future use.
Save Device List Save the list of devices for future use.
Schedule Test Schedule selected diagnostic test to be run on selected
devices.
Cancel Cancel diagnostic test(s) currently being configured.
Perform Test Perform diagnostic test(s) on selected device(s).
Remove Remove the selected device.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


29

4 Use Critical Alert

4.1 Maintenance mode types


Maintenance mode changes the normal behavior of a Unigy zone or hardware device to prevent a failure
response during maintenance operations such as upgrades, hardware replacement, and PKI certificate
changes. It performs different functions according to the type of maintenance mode enabled.
Maintenance mode can be set for a zone, HA cluster, Converged Communications Manager (CCM),
Media Manager (MM), Aggregated Converged Communications Manager (ACCM), or Media Gateway
(MG).

Note
When possible, perform maintenance operations after business hours to avoid system impacts.

Zones
Enabling maintenance mode for a zone by setting the BCP Status field to Maintenance at
Configuration ➤ Enterprise ➤ System ➤ Zones prevents automatic BCP plan activation. It also
prevents Unigy Soft Client end users from logging in to the zone. This is the default value when you
deploy a zone.
If a BCP plan is manually activated while a zone within the plan is in maintenance mode, the system
does not redirect the CDIs registered with the zone because the zone is not in a failed state. The
redirected CDIs from a failed zone can register with a zone that is in maintenance mode if it is a backup
zone specified in the BCP plan. If the OCCAS services are running and another type of maintenance
mode does not prevent it, turret and Pulse end users can log in to the zone while it is in maintenance
mode and make and receive calls. However, when a zone is placed into this type of maintenance mode,
the session for any Soft Client that is logged in to the zone is terminated and the end users cannot log
back in until the BCP Status field is returned to Active. Soft Client users cannot log in to another zone
while the home zone is in maintenance mode unless the Soft Client is removed from the database and
the home zone is changed to a different zone through the Unigy Client Configuration Tool.
After initial zone deployment or after a maintenance procedure is complete, change the BCP Status
field to Active to enable normal operation.

HA clusters
Maintenance mode for a cluster prevents an HA failover due to a hardware, software, or network failure
during a maintenance operation; however, it does not prevent a forced failover. Maintenance mode is
supported by a Web service call to the administration interface that causes the following to occur:
• Status reports from HA monitoring are ignored.
• OCCAS monitoring is stopped, but the OCCAS and Orchestrator services continue to run.
• Firewall is raised to block communication between the cluster appliances.
• Database replication between the appliances is turned off.
• State of the Active appliance changes to MAINTENANCE_AVAILABLE and the state of the Standby
appliance changes to MAINTENANCE_UNAVAILABLE.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
30 4.1: Maintenance mode types

To prevent the system from sending cluster or appliance failure alerts to the NOCs, disable SNMP
Forwarding for the zone or destination prior to placing the cluster into maintenance mode. Use the UMS
menu: Configuration ➤ Sites ➤ SNMP Forwarding ➤ Maintenance.
When the cluster is in maintenance mode, services can be stopped and started and hardware removed
without causing appliance state changes. Within maintenance mode, you generally perform maintenance
operations only on the Standby appliance. The Active appliance continues to process calls and
configuration requests.
In addition to placing the cluster into maintenance mode, you also place the Standby appliance into
maintenance mode. After the maintenance is complete, take the appliance out of maintenance mode,
indicate that the maintenance is complete, then if applicable, force an HA failover and perform the
maintenance on the second appliance in the cluster. After all maintenance is done, take the cluster out of
maintenance mode.
If the Active appliance fails while the Standby appliance is in maintenance mode, the Standby appliance
cannot assume the Active role. If a BCP plan is configured and you are performing the maintenance
operation during business hours, you can minimize impacts on call processing in this situation by
activating the BCP plan before placing the cluster into maintenance mode. This redirects the registered
CDIs to their backup zones.
Place a cluster in to or take it out of maintenance mode on the Members tab at Configuration ➤
Sites ➤ Servers ➤ Clusters.

Appliances
Placing a CCM, MM, or ACCM into maintenance mode informs the system that a maintenance
operation is being performed on the appliance. In an HA cluster, only the Standby appliance can be
placed into maintenance mode. Perform this procedure within the Servers tab at Tools ➤
Deployment ➤ Hardware Deployment. After maintenance on the appliance is complete, take the
appliance out of maintenance mode.

Media Gateways
Placing a Media Gateway into maintenance mode prevents it from accepting new call traffic. Perform
the maintenance operation after the gateway is no longer processing calls. You can determine this by
checking Trunk Utilization in the MG Admin Console.
Place the Media Gateway into maintenance mode and access the Admin Console through the Media
Gateways tab at Tools ➤ Deployment ➤ Hardware Deployment.

4.1.1 Disable SNMP forwarding for a zone


Use the SNMP Forwarding Maintenance panel to disable SNMP forwarding for a zone. When a zone’s
SNMP forwarding is disabled, alerts from that zone are not forwarded to any of the SNMP trap
destinations that the zone is associated with.

Note
When a zone or trap destination’s forwarding status is set to Disable, alerts continue to be sent to the
UMS Monitoring Dashboard, which allows technicians on site to continue to view alerts while SNMP
forwarding is disabled.

You must have the Advanced Administrator, IPC Project Manager, or IPC Certified Tech role to perform
this procedure.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


4.1: Maintenance mode types 31

1. In the menu bar, click Configuration ➤ Sites.


2. Click SNMP Forwarding then Maintenance.
The Zone Maintenance Status panel is displayed.
3. Select the Zone Maintenance check box next to the zone whose forwarding you want to disable.
If the zone is associated with trap destinations, they are listed in the Trap Destination grid that is
displayed in the lower portion of the panel and all are selected.
Figure 11: SNMP Forwarding Maintenance - Zone Maintenance

4. Click Disable.
The zone’s forwarding status and all trap destinations that are listed in the lower portion of the panel
are changed to Disable as illustrated in the following figure.
Figure 12: SNMP Forwarding Maintenance - Zone Maintenance

5. Repeat steps 3 and 4 for each zone where you want to disable SNMP forwarding.

4.1.2 Reenable SNMP forwarding for a zone


Use the SNMP Forwarding Maintenance panel to reenable SNMP forwarding for a zone. When a zone’s
SNMP forwarding is reenabled, forwarding from Unigy is automatically resumed for the zone and alerts
start to be sent again to all configured trap destinations associated with the zone.
A zone’s forwarding status can also be set to Mix. Mix means that the zone is associated with multiple
trap destinations and at least one of the destinations has a forwarding status of Disable. In this case,
you can enable forwarding to all of the trap destinations for the zone by changing the zone's forwarding
status from Mix to Enable. To do this, simply select the Zone with the Mix status (all the Trap

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
32 4.1: Maintenance mode types

Destinations associated with it become selected in the lower portion of the panel) and click Disable. The
status of all the destinations are then changed to Disable.

Note
When a zone or trap destination’s forwarding status is set to Disable, alerts continue to be sent to the
UMS Monitoring Dashboard, which allows technicians on site to continue to view alerts while SNMP
forwarding is disabled.

You must have the Advanced Administrator, IPC Project Manager, or IPC Certified Tech role to perform
this procedure.
1. In the menu bar, click Configuration ➤ Sites.
2. Click SNMP Forwarding then Maintenance.
The Zone Maintenance Status panel is displayed.
3. Select the Zone Maintenance check box next to the zone whose forwarding you want to reenable.
If the zone is associated with trap destinations, they are listed in the Trap Destination grid that is
displayed in the lower portion of the panel and all are selected.
4. Click Enable.
The zone’s forwarding status and any trap destinations that are listed in the lower portion of the panel
changes to Enable.
5. Repeat steps 3 and 4 for each zone where you want to reenable SNMP forwarding.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


33

A Unigy Panels
A.1 SNMP Forwarding: Trap Destinations
Use this panel to configure Unigy alert forwarding to a Network Operations Center (NOC). Also use this
panel to change or remove the zones associated with the destination or to delete the destination.
To access this panel, click Configuration ➤ Sites in the UMS menu bar, click SNMP Forwarding, then
click Trap Destinations.
You must have one of the following roles to make changes to fields in this panel: Advanced Admin, IPC
Certified Tech, or IPC Project Manager.
You must have one of the following roles to view this panel: Basic Administrator, Advanced
Administrator, IPC Certified Tech, Auditor, or IPC Project Manager.
Click the plus sign to add a new Trap Destination. After entering the NOC name, IP Address, Port,
NOC Type, and SNMP Version information. Then associate the zones to forward the traps from by
dragging and dropping zone names (one at a time) from Available to Assign (right side of panel) to the
Zone Association grid at the bottom of the panel.

The Community String is required for SNMPv2c.

Figure 13: SNMP ForwardingTrap Destination Panel

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
34 A.1: SNMP Forwarding: Trap Destinations

Table 7: Trap Destination Configuration

Name Description Values Notes


Trap Destination
NOC Name Name that identifies the Up to 64 alphanumeric Name must be unique.
NOC in the UMS. characters. Also, name cannot be a
Required. name used as an SNMP
Profile defined in the
system (Configuration ➤
Enterprise ➤ SNMP
Profile).
Supplied by the
customer.
IP Address Host IP address of the IP address in dot- Supplied by the
Critical Alert (if NOC decimal notation customer.
type is IPC) or customer nnn.nnn.nnn.nnn.
NMS server, required for
connection.
Required.
Port SNMP Port number. SNMP uses UDP port Supplied by the
Required. 162 for SNMP trap customer.
messages.
Description Describes the alert Up to 256 characters. Supplied by the
forwarding setup, such customer.
as, NOC or IPC GSOC.
Notification Type Identifies the SNMP Trap System provided. Read
notification type. only.
Heart Beat Indicates if the heart Select the check box to Supplied by the
beat time period enable. customer.
functionality is enabled. Default value is not Recommendation:
When enabled, a heart selected (disabled). enable the heart beat if
beat alert is sent in the the NOC type is IPC
heart beat time period (that is, GSOC).
interval if no other alerts
are generated.
Heart Beat Time Period Interval between beats, 1 to 16385; default is Supplied by the
(sec) in seconds, to determine 300. customer.
if the servers are
functioning.
NOC Type Identifies the type of • IPC Supplied by the
Network Operations customer.
Center. • Customer
Required Default is Customer
SNMP

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


A.1: SNMP Forwarding: Trap Destinations 35

Table 7: Trap Destination Configuration (continued)

Name Description Values Notes


Version Identifies the SNMP • SNMPv2c - (Default) Select the version that is
version that Unigy sends preferred by the NMS at
traps to the NOC. • SNMPv3 the NOC. If traps are
SNMPv3 is reserved for received in a version
future use. other than the one
selected, Unigy converts
them into the selected
version before
forwarding it.
Unigy CDIs, MGs, MMs,
CCMs, ACCMs, and
voice recording devices
do not send traps in
SNMPv3.
Community String Controls SNMPv2c String; up to 256 Only displays when
access. characters. SNMPv2c is the Version
Community strings are Enter the community selected.
defined for read-only, string that is expected Supplied by the
read-write, and notify by the NOC. customer.
access. Default is public.
User Name Controls SNMPv3 Up to 64 alphanumeric Only displays when
access. characters. SNMPv3 is the Version
Reserved for future use. selected.
Authentication Protocol Identifies the SNMPv3 • SHA1 - Secure hash Only displays when
authentication protocol algorithm SNMPv3 is the Version
to be used. selected.
Reserved for future use. • MD5 - (Default)
Message-digest
algorithm

Authentication Identifies the SNMPv3 Up to 64 alphanumeric Only applicable when


Password authentication password characters. SNMPv3 is the Version
to be used. selected.
Reserved for future use.
Privacy Protocol Identifies the SNMPv3 • DES - (Default) Data Only applicable when
privacy protocol to be Encryption Standard SNMPv3 is the Version
used. selected.
Reserved for future use. • 3DES - Triple Data
Encryption Algorithm
• AES128 - Advanced
Encryption Standard
with a key length of
128 bits
• AES192 - Advanced
Encryption Standard
with a key length of
192 bits
• AES256 - Advanced
Encryption Standard
with a key length of
256 bits

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
36 A.1: SNMP Forwarding: Trap Destinations

Table 7: Trap Destination Configuration (continued)

Name Description Values Notes


Privacy Password Identifies the SNMPv3 Up to 64 alphanumeric Only applicable when
privacy password to be characters. There is no SNMPv3 is the Version
used. default value. selected.
Reserved for future use.
Zone Association
Zone Name Zones that the alerts Drag a zone name from Filter fields are available
come from for this NOC the Available to Assign at the top of the
trap destination. area to the Zone Available to Assign area
Association area. and the Zone Name
column of the Zone
Association area. Begin
typing in either of these
fields to filter the list.
When a zone is dragged
in, it’s forwarding status
is enabled by default.
The only way to change
the forwarding status is
to use the SNMP
Forwarding
Maintenance panel.
Forwarding Status Indicates whether or not • Enable - also The forwarding status is
forwarding is enabled for indicated by a green configured from the
the zone. check SNMP Forwarding
Maintenance panel.
• Disable - also
indicated by a red X
Read only.
Available to Assign
Zones Zones currently defined List of zones to choose
for the system. from.
Zone Name Filters the Available to Begin typing in this field
Assign Zones list. to filter the list.

Table 8: Buttons

Name Description
Remove Zone Association Removes the selected zone(s) from the list of
zones associated with this trap destination.
Multiple zones can be selected.
Revert Discards unsaved changes that were made during
this session.
Delete Trap Destination Deletes the displayed trap destination from the
system as well as all the zone associations.
Save Configuration Saves configuration changes that were made
during this session.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


A.2: SNMP Forwarding: Zone Maintenance Status 37

A.2 SNMP Forwarding: Zone Maintenance Status


Use this panel to enable or disable forwarding of SNMP traps and events generated from one or more
Unigy zones or to one or more configured customer NOC trap destination(s).
In the menu bar, click Configuration ➤ Sites in the menu bar, click SNMP Forwarding, then click
Maintenance.

You must have the Advanced Administrator, IPC Certified Technician, or Project Manager role to make
changes to fields in this panel.
Figure 14: SNMP Forwarding - Zone Maintenance Status panel

The panel initially displays a list of all zones and identifies each one’s maintenance status. When a zone
is selected, then all customer trap destinations associated with the zone display in another grid below the
Zone Maintenance Status grid.

Note
IPC NOC types SNMP trap destinations are not displayed in this panel nor can the forwarding status of
such destinations be disabled.

Table 9: SNMP Forwarding - Maintenance

Name Description Values Notes


Zone Maintenance Status
Check box column Zone selection check Click a check box to Selecting a zone
box. select the zone named automatically selects all
in that row. Deselect to the trap destinations that
unselect the zone. the zone is associated
with and displays them
in the Trap Destination
grid. Deselecting it does
the reverse.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
38 A.2: SNMP Forwarding: Zone Maintenance Status

Table 9: SNMP Forwarding - Maintenance (continued)

Name Description Values Notes


Zone Name Names of the zones in Alphanumeric. Read Begin typing a zone
the enterprise that are only. name in the filter field to
associated with filter the display by zone
customer trap or click the little arrow in
destinations. the upper right corner of
the column to reverse
the sort order by zone.
Instance Name Name of the Instance Alphanumeric. Read Begin typing an Instance
where the zone resides. only. name in the filter field to
filter the display by
Instance or click the little
arrow in the upper right
corner of the column to
reverse the sort order by
instance.
Forwarding Status Indicates the forwarding • Enable - alerts are The sort order can be
status of the zone. being forwarded from reversed by clicking the
this zone to the little arrow in the upper
SNMP trap right corner of the
destinations column.
associated with it. When SNMP
Forwarding is disabled
• Disable- alerts are not for a zone or trap
being forwarded from destination, the heart
this zone to the beat continues to be
SNMP trap sent to the trap
destinations destination. Alerts also
associated with it. continue to be sent to
• Mix - alerts are being the UMS Monitoring
forwarded from this Dashboard.
zone to some but not
all of the SNMP trap
destinations
associated with it.
• Not Configured - there
are no configured
forwarders for this
zone

Trap Destination
Check box column Trap destination Click a check box to
selection check box. select the trap
destination named in
that row. Deselect to
unselect the trap
destination.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


A.2: SNMP Forwarding: Zone Maintenance Status 39

Table 9: SNMP Forwarding - Maintenance (continued)

Name Description Values Notes


Trap Destination Name of the trap Alphanumeric. Read Begin typing a
destination. only. destination in the filter
field to filter the display
by destination or click
the little arrow in the
upper right corner of the
column to reverse the
sort order by
destination.
Zone Name Name of the zone. Alphanumeric. Read Begin typing a zone
only. name in the filter field to
filter the display by zone
or click the little arrow in
the upper right corner of
the column to reverse
the sort order by zone.
Forwarding Status Indicates the forwarding • Enable - traps and
status of the trap events are being
destination. forwarded from this
zone to this SNMP
trap destination.
• Disable- traps and
events are not being
forwarded from this
zone to this SNMP
trap destination.

Forwarding Status Visual cue that indicates Green check -


indicators forwarding status of this forwarding status for this
trap destination. destination is enabled.
Red X - forwarding
status for this
destination is disabled.

Table 10: Buttons

Name Description
Enable Enable the forwarding status for the selected
zones and trap destinations. If a selection is
already enabled, no action will be taken for the
selection.
Disable Disable the forwarding status for the selected
zones and trap destinations. If a selection is
already disabled, no action will be taken for the
selection.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
40 A.3: SMTP

A.3 SMTP
Use this panel to configure the SMTP server, which Unigy uses to send e-mail messages whenever the
APP-DS-ds_ha-140025-standbyUnavailable-S alert is generated. Unigy does not host
SMTP servers, so the host must be remote to Unigy and the configuration includes specifying the SMTP
host and setting up authentication.
The following role can make changes to the properties in this panel: IPC Certified Tech.
To access this panel, click Configuration ➤ Enterprise ➤ SMTP.

Important
The information in this panel is persisted to the Unigy database, and can then be selected from the Zone
panel.

Figure 15: SMTP Configuration

Table 11: SMTP Configuration

Name Description Values Notes


Name Name of the SMTP String, 1 to 64 Human-readable display
server. characters; must be name for the SMTP
unique. configuration.
SMTP Host The hostname or IP String, 1 to 128 Customer-provided.
address of the remote characters.
SMTP server.
Required
Port Port for SMTP Numeric value, 1 to 128 Customer-provided.
authentication characters.
connections. Default: 25
Required

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


A.3: SMTP 41

Table 11: SMTP Configuration (continued)

Name Description Values Notes


TLS Authentication Transport Layer Security Select the check box to Customer-provided, if
Certification-band enable. Clear the check using this
authentication. box to disable. authentication.
The mail server might Default: disabled If enabled, the following
require TLS connections additional fields are
for SMTP required: Username,
authentication. Password, Confirm
Password.
Username Login username for the String, 1 to 256 The SMTP server
SMTP server. characters. requires login
Default is SmtpUser credentials to send e-
mail messages.
This is a user on the
customer's e-mail
system from whom the
system sends the
notification messages.
Customer-provided.
Password Login password for the String, 1 to 64 Customer-provided.
user specified in characters.
Username.
Confirm Password Confirm login password String, 1 to 64 Customer-provided.
for the user specified in characters.
Username.
SMTPS Required Enables a secure Select the check box to
transmission to the e- enable. Clear the check
mail server. box to disable.
Default: disabled
From Address The e-mail address that Valid e-mail address; for Each e-mail message
is listed as the sender of example, requires a from address
alert e-mail messages. rdoe@ipc.com. because, for anti-spam
Required reasons, some outgoing
servers refuse to
forward e-mail without a
valid from address.
To Address The e-mail address that Valid e-mail address; for Each e-mail message
is listed as the receiver example, requires a to address
of alert e-mail bjones@ipc.com. because, for anti-spam
messages. reasons, some outgoing
Required. servers refuse to
forward e-mail without a
valid to address.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
42 A.4: SNMP Profiles

Table 12: Buttons

Name Description
Revert Discards your changes.
Save Saves your changes to the hq-server.conf
file of the local zone.

A.4 SNMP Profiles


Use this panel to configure Simple Network Management Protocol (SNMP) profiles. Unigy uses SNMP
for monitoring and managing appliance and device activity, including system fault notifications. An
SNMP profile provides a set of SNMP manager and agent properties, including SNMP version, ports,
and community strings, for use with specific types of devices.
Unigy provides the following SNMP profiles. You can use these profiles or create your own.
• Turret SNMP Profile for turrets and Pulse devices. Assign the SNMP profile for these devices by
doing one of the following:
• For IQ/MAX and IQ/MAX Edge turrets, click Configuration ➤ Sites ➤ Communication
Devices ➤ IQ/MAX & Edge. In the IQ/MAX & Edge list, click a turret then click the SNMP tab.
Select the SNMP profile in Use SNMP Profile.
• For IQ/MAX TOUCH turrets, click Configuration ➤ Sites ➤ Communication Devices ➤
IQ/MAX TOUCH. In the IQ/MAX TOUCH list, click a turret then click the SNMP tab. Select the
SNMP profile in Use SNMP Profile.
• For Pulse devices, click Configuration ➤ Sites ➤ Communication Devices ➤ Pulse. In the
Pulse list, click a Pulse then click the SNMP tab. Select the SNMP profile in Use SNMP Profile.
• MG SNMP Profile for Media Gateways. To assign an SNMP profile for these devices, click
Configuration ➤ Sites ➤ Trunks ➤ Media Gateways. In the Media Gateways list, click a Media
Gateway then in the Media Gateway Details panel, click the SNMP tab. Select the SNMP profile in
Use SNMP Profile.
• MS SNMP Profile for Media Managers. To assign an SNMP profile for these devices, click
Configuration ➤ Sites ➤ Servers ➤ Media Managers. In the Media Managers list, click a Media
Manager then click the SNMP tab. Select the SNMP profile in Use SNMP Profile.
• VR SNMP Profile for voice recording servers. To assign or change an SNMP profile, do one of the
following:
• For a new voice recorder, click Configuration ➤ Enterprise ➤ Voice Recording ➤ Voice
Recorders. In the Voice Recorders list, click the + (Add) button to add a new recorder then in the
Voice Recorder panel, select the SNMP profile in Use SNMP Profile.
• For an existing voice recorder, click Configuration ➤ Enterprise ➤ Voice Recording ➤ Voice
Recorders. In the Voice Recorders list, click the voice recorder then in the Voice Recorder panel,
select the SNMP profile in Use SNMP Profile.
• For an additional server, click Configuration ➤ Enterprise ➤ Voice Recording ➤ Voice
Recorders. In the Voice Recorders list, click an existing voice recorder. In the Additional Servers
panel, click Add to add a server or click an existing server then click Update. In the Add/Update
Additional Server panel, select the SNMP profile in Use SNMP Profile.
• SBC SNMP Profile for Session Border Controllers. To assign an SNMP profile for these devices,
click Configuration ➤ Enterprise ➤ Session Border Controllers. In the Session Border

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


A.4: SNMP Profiles 43

Controllers list, click the + (Add) button to add an SBC or click an existing SBC then within the SBC
Configuration panel, select an SNMP profile in Use SNMP Profile.
The following roles can edit this panel: Advanced Administrator, IPC Project Manager, and IPC
Certified Tech. The Basic Administrator, Auditor, and System Auditor roles provide read-only access.
To access this panel, click Configuration ➤ Enterprise ➤ SNMP Profiles. In the SNMP Profiles list,
click an existing profile or click the + (Add) button to add a profile.
Figure 16: SNMP

Management
These properties apply to SNMP managers.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
44 A.4: SNMP Profiles

Table 13: SNMP: Management

Name Description Values Notes


Name Name that identifies the Up to 64 alphanumeric Human-readable
profile within the UMS. characters. display name for
Required the SNMP profile.
The name must
be unique.
Also, name
cannot be a
name used as a
NOC Name for
an SNMP
Forwarding Trap
Destination
defined in the
system
(Configuration ➤
Sites ➤ SNMP
Forwarding ➤
Trap
Destinations).
IPC or customer
provided.
SNMP Version Indicates the SNMP SNMPv2c Only SNMPv2c
version to use. type traps are
Required supported.
SNMP Mgmt Port Port used for SNMP Range: 0 to 65535 Supplied by the
communication. customer.
• Default for general SNMP
messages: 161
• Default for SNMP trap
messages: 162

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


A.4: SNMP Profiles 45

Table 13: SNMP: Management (continued)

Name Description Values Notes


Read Community String Community string to use String; 0 to 256 characters. Can If you change the
for read operations. This include alpha characters, community string
is the equivalent of a numeric characters, and the for turrets, all
password. underscore (_) special turrets that are
character. No other special assigned the
characters are permitted. SNMP profile you
changed, must
be rebooted
twice.
The first reboot
alert will have the
old community
string, but
subsequent
alerts will contain
the new value.
Supplied by the
customer.
Defaults provided
by IPC.
Write Community String Community string to use String; 0 to 256 characters. Can Supplied by the
for write operations. include alpha characters, customer.
This is the equivalent of numeric characters, and the
a password. underscore (_) special
character. No other special
characters are permitted.
This field is read-only and is
populated by the value from
Read Community String.

Agent
These properties apply to SNMP agents.

Table 14: SNMP: Agent

Name Description Values Notes


Trap Port Port used for the alarm Range: 0 to 65535 Supplied by the
traps. Default is 162. customer.
Trap Community String Trap community string. String; 1 to 256 Supplied by the
This is the equivalent of characters customer.
a password. This field is read-only
and is populated by the
value from Read
Community String.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
46 A.5: Pulse: SNMP

Table 15: Buttons

Name Description
Delete Removes the selected SNMP profile from the
database.
Revert Discards your changes.
Save Saves your changes to the database.

A.5 Pulse: SNMP


Use this panel to select an SNMP profile for use with a device.
To access this panel, click Configuration ➤ Sites in the menu bar and then select an instance, site
configuration, or location from the Instance, Site Configuration, or Locations list. Click
Communication Devices ➤ Pulse and select the name of a device from the Pulse list. Then click the
SNMP tab in the Pulse panel that is displayed.

Select an SNMP profile to use for this Pulse and save the configuration. The SNMP configuration
properties of the selected SNMP Profile can be viewed from this panel but are read-only. You cannot
edit existing profiles from this tab.
You must have one of the following roles to select an SNMP profile in this panel: Advanced
Administrator, IPC Project Manager, or IPC Certified Tech. Users with the Basic Administrator or
Auditor role can view, but not modify, the profile selection in the Pulse panel SNMP tab.
Figure 17: Pulse SNMP tab

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


A.5: Pulse: SNMP 47

Table 16: Pulse SNMP properties

Name Description Value Notes


Management
Use SNMP Profile Set of List of SNMP profiles Unigy provides default
configuration defined in the system. profiles for turrets, Media
properties Default is Turret SNMP Managers, and Media
that specifies Profile. Gateways. Any profile can
SNMP Required. be used. Multiple profiles
behavior of can be created. To edit or
the device. create profiles, click
Configuration ➤
Enterprise ➤ SNMP Profiles
in the UMS menu.
SNMP Version SNMP SNMP v2c Only SNMP v2c is
version used Required supported.
by the Read-only.
device.
SNMP Mgmt Port Port used by Number in the valid port Customer-provided.
the device to range for the system.
accept Default is 161.
incoming Read-only.
SNMP
monitoring
traffic.
Read Community String SNMP Up to 256 characters. Customer-provided.
community Default is Sys01Admin.
string for Read-only.
read
operations.
Write Community String SNMP Up to 256 characters. Customer-provided.
community Default is Sys01Admin.
string for Read-only.
write
operations.
Agent
Trap Port Port used by Number in the valid port Customer-provided.
the device to range for the system.
send SNMP Default is 162.
traps. Read-only.
Trap Community String SNMP Up to 256 characters. Customer-provided.
community Default is Sys01Admin.
string for trap Read-only.
operations.

Table 17: Buttons

Name Description
Revert Cancel the uncommitted changes.
Save Save changes.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
48 A.6: IQ/MAX & Edge: SNMP

A.6 IQ/MAX & Edge: SNMP


Use this panel to select an SNMP profile for use with a turret.
To access this panel, click Configuration ➤ Sites in the menu bar and then select an instance, site
configuration, or location from the Instance, Site Configuration, or Locations list. Click
Communication Devices ➤ IQ/MAX & Edge and select the name of a turret from the IQ/MAX & Edge
list. Then click the SNMP tab in the IQ/MAX & Edge panel that is displayed.
Select an SNMP profile to use for this IQ/MAX & Edge and save the configuration. The SNMP
configuration properties of the selected SNMP Profile can be viewed from this panel but are read-only.
You cannot edit existing profiles from this tab.
You must have one of the following roles to select an SNMP profile in this panel: Advanced
Administrator, IPC Project Manager, or IPC Certified Tech. Users with the Basic Administrator or
Auditor role can view, but not modify, the profile selection in the IQ/MAX & Edge panel SNMP tab.
Figure 18: IQ/MAX & Edge SNMP tab

Table 18: IQ/MAX & Edge properties

Name Description Value Notes


Management
Use SNMP Profile Set of List of SNMP profiles Unigy provides default
configuration defined in the system. profiles for turrets, Media
properties Default is Turret SNMP Managers, and Media
that specifies Profile. Gateways. Any profile can
SNMP be used. Multiple profiles
behavior of can be created. To edit or
the turret. create profiles, click
Configuration ➤
Enterprise ➤ SNMP Profiles
in the UMS menu.
SNMP Version SNMP SNMP v2c. Only SNMP v2c is
version used Read-only. supported.
by the turret.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


A.7: Media Manager: SNMP 49

Table 18: IQ/MAX & Edge properties (continued)

Name Description Value Notes


SNMP Mgmt Port Port used by Number in the valid port Customer-provided.
the device to range for the system.
accept Default is 161.
incoming Read-only.
SNMP
monitoring
traffic.
Read Community String SNMP Up to 256 characters. Customer-provided.
community Default is Sys01Admin.
string for Read-only.
read
operations.
Write Community String SNMP Up to 256 characters. Customer-provided.
community Default is Sys01Admin.
string for Read-only.
write
operations.
Agent
Trap Port Port used by Number in the valid port Customer-provided.
the device to range for the system.
send SNMP Default is 162.
traps. Read-only.
Trap Community String SNMP Up to 256 characters. Customer-provided.
community Default is Sys01Admin.
string for trap Read-only.
operations.

Table 19: Buttons

Name Description
Revert Cancel the uncommitted changes.
Save Save changes.

A.7 Media Manager: SNMP


Use this panel to select an SNMP profile for use with the Media Manager.
To access this panel, click Configuration ➤ Sites in the menu bar and then click Servers ➤ Media
Managers in the left panel. Select the name of a device in the Media Manager list then click the SNMP
tab in the panel that is displayed.
Select an SNMP profile to use for this Media Manager and save the configuration. The SNMP
configuration properties of the selected SNMP Profile can be viewed from this panel but are read-only.
You cannot edit existing profiles from this tab.
You must have one of the following roles to select an SNMP profile in this panel: Advanced
Administrator, IPC Project Manager, or IPC Certified Tech. Users with the Basic Administrator or
Auditor role can view, but not modify, profile select in the Media Manager panel SNMP tab.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
50 A.7: Media Manager: SNMP

Figure 19: Media Manager: SNMP tab

Table 20: Media Manager: SNMP properties

Name Description Values Notes


Management
Use SNMP Profile Select an • Turret SNMP Profile Unigy provides default
existing profiles for turrets, Media
SNMP • MG SNMP Profile Managers, and Media
configuration • MS SNMP Profile Gateways. Any profile can
for the Media be used. Multiple profiles
All existing SNMP Profiles
Manager. can be created. To edit or
display in this list.
create profiles, click
Default is MG SNMP Profile.
Configuration ➤
Required.
Enterprise ➤ SNMP Profiles
in the UMS menu.
SNMP Version SNMP SNMP v2c Only SNMP v2c is
version. Read-only. supported.
Required.
SNMP Mgmt Port Port used by Number in the valid port Customer-provided.
the Media range for the system;
Manager for default is 161.
SNMP Read-only.
communicati
on.
Read Community String Community Up to 256 characters. Customer-provided.
string for Default is imm01Admin.
SNMP GET Read-only.
requests.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


A.8: Media Gateway: SNMP 51

Table 20: Media Manager: SNMP properties (continued)

Name Description Values Notes


Write Community String Community Up to 256 characters. Customer-provided.
string for Default is imm01Admin.
SNMP SET Read-only.
requests.
Agent
Trap port Destination Number in the valid port Customer-provided.
port for traps range for the system;
sent by the default is 162.
Media Read-only.
Gateway.
Trap community string Community Up to 256 characters. Customer-provided.
string for Default is imm01Admin.
SNMP traps. Read-only.

Table 21: Buttons

Name Description
Revert Cancel the uncommitted changes.
Save Save changes to the SNMP properties.

A.8 Media Gateway: SNMP


Use this panel to select an SNMP profile for use with the Media Gateway.
To access this panel, click Configuration ➤ Sites in the menu bar, and then click Trunks ➤ Media
Gateways in the left panel. Click the name of the Media Gateway in the list that is displayed, then click
the SNMP tab in the Media Gateway panel.
Select an SNMP profile to use for this Media Gateway and save the configuration. The SNMP
configuration properties of the selected SNMP Profile can be viewed from this panel but are read-only.
You cannot edit existing profiles from this tab.
You must have one of the following roles to select an SNMP profile in this panel: Advanced
Administrator, IPC Project Manager, or IPC Certified Tech. Users with the Basic Administrator or
Auditor role can view, but not modify, the profile selection in the Media Gateway panel SNMP tab.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
52 A.8: Media Gateway: SNMP

Figure 20: Media Gateway: SNMP panel

Table 22: Media Gateway SNMP

Name Description Value Notes


Use SNMP Select an existing MG • Turret SNMP Profile Unigy provides default profiles for
Profile SNMP profile turrets, Media Managers, and
configuration. • MG SNMP Profile Media Gateways. Any profile can
• MS SNMP Profile be used. Multiple profiles can be
created. To edit or create profiles,
All existing SNMP Profiles
click Configuration ➤ Enterprise ➤
display in this list.
SNMP Profiles in the UMS menu.
Default is MG SNMP
Profile.
Required.
SNMP Version SNMP version. • SNMP v2c Only SNMP v2c is supported.
Customer-provided.
Read-only.
Required.
SNMP Mgmt Port used by the Number in the valid port Customer-provided.
Port Media Gateway for range for the system;
SNMP default is 161.
communication. Read-only.
Read Community string for Up to 256 characters; Can be customer-provided if the
Community SNMP GET requests. default is img01Admin. customer does not want to use the
String Read-only. Unigy default. To change a
community string, you must go to
Configuration ➤ Enterprise ➤
SNMP Profiles path as mentioned
above and you must also change
the string on the Media Gateway
device itself.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


A.9: Prototype Devices: Media Gateway SNMP 53

Table 22: Media Gateway SNMP (continued)

Name Description Value Notes


Write Community string for Up to 256 characters; Can be customer-provided if the
Community SNMP SET requests. default is img01Admin. customer does not want to use the
String Read-only. Unigy default. To change a
community string, you must go to
Configuration ➤ Enterprise ➤
SNMP Profiles path as mentioned
above and you must also change
the string on the Media Gateway
device itself.
Trap port Destination port for Number in the valid port Can be customer-provided.
traps sent by the range for the system;
Media Gateway. default is 162.
Read-only.
Trap Community string for Up to 256 characters; Can be customer-provided.
community SNMP traps. default is img01Admin.
string Read-only.

Table 23: Buttons

Name Description
Revert Cancel the uncommited changes.
Save Save changes to the SNMP properties.

A.9 Prototype Devices: Media Gateway SNMP


Use this panel to select an SNMP profile for use with a Media Gateway.
To access this panel, click Configuration ➤ Sites in the menu bar, then click Prototype Devices ➤
Media Gateway. Click the SNMP tab in the Prototype Media Gateway panel that is displayed.

Select an SNMP profile to use for this Media Gateway and save the configuration. The SNMP
configuration properties of the selected SNMP Profile can be viewed from this panel but are read-only.
You cannot edit existing profiles from this tab.
You must have one of the following roles to select an SNMP profile in this panel: Advanced
Administrator, IPC Project Manager, or IPC Certified Tech. Users with the Basic Administrator or
Auditor role can view, but not modify, the profile selection in the Prototype Media Gateway panel
SNMP tab.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
54 A.9: Prototype Devices: Media Gateway SNMP

Table 24: Prototype Media Gateway: SNMP

Name Description Values Notes


Use SNMP Profile Set of configuration List of SNMP profiles Unigy provides
properties that specifies defined in the system. default profiles for
SNMP behavior of the Default is MG SNMP Profile. turrets, Media
Media Gateway. Required. Managers, and
Media Gateways.
Profiles can be
added or edited at
Configuration ➤
Enterprise ➤ SNMP
Profiles.

SNMP Version SNMP version used by SNMPv2c.


the Media Gateway. Required.
Read-only.
SNMP Mgmt Port Port used for SNMP 0 to 65535 Supplied by the
communication. Default for general SNMP customer.
messages: 161
Default for SNMP trap
messages: 162
Read-only.
Read Community String Community string to use String; 1 to 256 characters Supplied by the
for read operations. The system populates this customer.
field with the value
img01Admin .
Read-only.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


A.10: Prototype Devices: Media Manager SNMP 55

Table 24: Prototype Media Gateway: SNMP (continued)

Name Description Values Notes


Write Community String Community string to use String; 1 to 256 characters Supplied by the
for write operations. The system populates this customer.
field with the value
img01Admin .
Read-only.
Trap Port Port used for the alarm 0 to 65535 Supplied by the
traps. Default is 162. customer.
Read-only.
Trap Community String Stores the trap String; 1 to 256 characters Supplied by the
community string. The system populates this customer.
field with the value
img01Admin .
Read-only.

Table 25: Buttons

Name Description
Revert Discards changes that were made during this
session.
Save Saves changes that were made during this
session.

A.10 Prototype Devices: Media Manager SNMP


Use this panel to select an SNMP profile for use with a Media Manager.
To access this panel, click Configuration ➤ Sites in the menu bar, then click Prototype Devices ➤
Media Manager. Click the SNMP tab in the Prototype Media Manager panel that is displayed.

Select an SNMP profile to use for this Media Manager and save the configuration. The SNMP
configuration properties of the selected SNMP Profile can be viewed from this panel but are read-only.
You cannot edit existing profiles from this panel.
You must have one of the following roles to select an SNMP profile in this panel: Advanced
Administrator, IPC Project Manager, or IPC Certified Tech. Users with the Basic Administrator or
Auditor role can view, but not modify, the profile selection in the Prototype Media Manager panel
SNMP tab.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
56 A.10: Prototype Devices: Media Manager SNMP

Figure 21: Prototype Media Manager SNMP

Table 26: Prototype Media Manager: SNMP

Name Description Values Notes


Management
Use SNMP Profile Set of configuration List of SNMP profiles defined in Unigy provides
properties that specifies the system. default profiles
SNMP behavior of the Default is MG SNMP Profile. for turrets, Media
Media Manager. Required Managers, and
Media Gateways.
Profiles can be
added or edited
at
Configuration ➤
Enterprise ➤
SNMP Profiles.

SNMP Version SNMP version used by SNMPv2c. Only SNMP v2c


the Media Manager Required. is supported.
Required Read-only.
SNMP Mgmt Port Port used for SNMP 0 to 65535 Supplied by the
communication. Default for general SNMP customer.
messages: 161
Default for SNMP trap
messages: 162
Read-only.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


A.11: Prototype Devices: Pulse SNMP 57

Table 26: Prototype Media Manager: SNMP (continued)

Name Description Values Notes


Read Community String Community string to use String; 1 to 256 characters Supplied by the
for read operations. The system automatically customer.
populates this field with the
value imm01Admin .
Read-only.
Write Community String Community string to use String; 1 to 256 characters Supplied by the
for write operations. The system automatically customer.
populates this field with the
value imm01Admin.
Read-only.
Agent
Trap Port Port used for the alarm 0 to 65535 Supplied by the
traps. Default is 162. customer.
Read-only.
Trap Community String Stores the trap String; 1 to 256 characters Supplied by the
community string. The system automatically customer.
populates this field with the
value imm01Admin.
Read-only.

Table 27: Buttons

Name Description
Revert Discards unsaved changes that were made during this session.
Save Saves changes that were made during this session.

A.11 Prototype Devices: Pulse SNMP


Use this panel to select an SNMP profile for use with a Pulse device.
To access this panel, click Configuration ➤ Sites in the menu bar, and then click Prototype
Devices ➤ Pulse. Click the SNMP tab in the Prototype Pulse panel that is displayed.

Select an SNMP profile to use for this Pulse and save the configuration. The SNMP configuration
properties of the selected SNMP Profile can be viewed from this panel but are read-only. You cannot
edit existing profiles from this panel.
You must have one of the following roles to select an SNMP profile in this panel: Advanced
Administrator, IPC Project Manager, or IPC Certified Tech. Users with the Basic Administrator or
Auditor role can view, but not modify, the profile selection in the Prototype Pulse panel SNMP tab.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
58 A.11: Prototype Devices: Pulse SNMP

Figure 22: Prototype Pulse SNMP tab

Table 28: Prototype Pulse: SNMP properties

Name Description Values Notes


Use SNMP Profile Set of configuration List of SNMP profiles defined in Unigy provides
properties that specifies the system. default profiles
SNMP behavior of the Default is Turret SNMP Profile. for turrets, Media
device. Required. Managers, and
Media Gateways.
Profiles can be
added or edited
at
Configuration ➤
Enterprise ➤
SNMP Profiles.

SNMP Version SNMP version used by SNMPv2c


the device. Read-only.
Required.
SNMP Mgmt Port Port used by the device 0 to 65535 Supplied by the
to send SNMP traps. Default for general SNMP customer.
messages: 161
Default for SNMP trap
messages: 162
Read-only.
Read Community String Community string to use String; 1 to 256 characters Supplied by the
for read operations. Default is Sys01Admin customer.
Read-only.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


A.12: Prototype Devices: IQ/MAX & Edge: SNMP 59

Table 28: Prototype Pulse: SNMP properties (continued)

Name Description Values Notes


Write Community String Community string to use String; 1 to 256 characters Supplied by the
for write operations. Default is Sys01Admin customer.
Read-only.
Trap Port Port used for the alarm 0 to 65535 Supplied by the
traps. Default is 162. customer.
Read-only.
Trap Community String Stores the trap String; 1 to 256 characters Supplied by the
community string. Default is Sys01Admin customer.
Read-only.

Note
The default values are same across all zones provided same Country Base is selected for all the zones
at Configuration ➤ Enterprise ➤ System ➤ Zones ➤ Change Countrybase.

Table 29: Buttons

Name Description
Revert Discards changes that were made during this
session.
Save Saves changes that were made during this
session.

A.12 Prototype Devices: IQ/MAX & Edge: SNMP


Use this panel to select an SNMP profile for use with a hard IQ/MAX & Edge device.
To access this panel, click Configuration ➤ Sites in the menu bar, and then click Prototype
Devices ➤ IQ/MAX & Edge. Click the SNMP tab in the Prototype IQ/MAX & Edge panel that is
displayed.

Select an SNMP profile to use for this turret and save the configuration. The SNMP configuration
properties of the selected SNMP Profile can be viewed from this panel but are read-only. You cannot
edit existing profiles from this panel.
You must have one of the following roles to select an SNMP profile in this panel: Advanced
Administrator, IPC Project Manager, or IPC Certified Tech. Users with the Basic Administrator or
Auditor role can view, but not modify, the profile selection in the Prototype IQ/MAX & Edge panel
SNMP tab.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
60 A.12: Prototype Devices: IQ/MAX & Edge: SNMP

Figure 23: Prototype IQ/MAX & Edge SNMP tab

Table 30: Prototype IQ/MAX & Edge SNMP tab properties

Name Description Values Notes


Use SNMP Profile Set of configuration List of SNMP profiles defined in Unigy provides
properties that specifies the system. default profiles
SNMP behavior of the Default is Turret SNMP Profile. for turrets, Media
turret. Managers, and
Required. Media Gateways.
Profiles can be
added or edited
at
Configuration ➤
Enterprise ➤
SNMP Profiles.

SNMP Version SNMP version used by SNMPv2c Read-only.


the turret.
Required.
SNMP Mgmt Port Port used by the device 0 to 65535 Supplied by the
to send SNMP traps. Default for general SNMP customer.
messages: 161 Read-only.
Default for SNMP trap
messages: 162

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


A.13: Location Details 61

Table 30: Prototype IQ/MAX & Edge SNMP tab properties (continued)

Name Description Values Notes


Read Community String Community string to use String; 1 to 256 characters Supplied by the
for read operations. Default is Sys01Admin customer.
Read-only.
Write Community String Community string to use String; 1 to 256 characters Supplied by the
for write operations. Default is Sys01Admin customer.
Read-only.
Trap Port Port used for the alarm 0 to 65535 Supplied by the
traps. Default is 162. customer.
Read-only.
Trap Community String Stores the trap String; 1 to 256 characters Supplied by the
community string. Default is Sys01Admin customer.
Read-only.

Table 31: Buttons

Name Description
Revert Discards changes that were made during this
session.
Save Saves changes that were made during this
session.

A.13 Location Details


Use this panel to add, view, or edit location properties.

Note
Beginning with Unigy v3.0, you can no longer configure addresses within this panel for v3.0 or higher
zones. To add or edit an address, refer to Configuration ➤ Enterprise ➤ System ➤ Addresses. Configure
the addresses before you configure the locations.

Locations identify the physical location of a Unigy front room or backroom. The location consists of the
address of the building where the front room or backroom is located, the type of location, the floor, the
time zone, and the instance associated with the location. Backrooms are where the appliances that
comprise zones are located. Front rooms are where the CDIs are located. Front rooms and backrooms
can be located at the same address.
The following roles can edit this panel: Advanced Administrator, IPC Project Manager, and IPC
Certified Tech. The Basic Administrator, Auditor, and System Auditor roles can view but not change the
configuration.
To access this panel, do one of the following:
• Click Configuration ➤ Enterprise ➤ System ➤ Locations then in the Available Locations for
configuration list, click a location or click Add New.
• Click Tools ➤ Deployment ➤ Configure Location then in the Available Locations for
configuration list, click a location or click Add New. This option requires the IPC Project Manager
or IPC Certified Tech role.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
62 A.13: Location Details

Note
You can define multiple locations and multiple types of locations for an address.

Location Detail
Figure 24: Location Detail panel

Table 32: Location Detail panel

Name Description Values Notes


Name Descriptive name that Up to 50 alphanumeric The name must be
identifies the location. and special characters. unique throughout the
Required enterprise.
You can change the
default location names
(Default Front Room
and Default Back
Room).
Location Type Type of location. • frontroom: location of
Required CDIs.
• backroom: location of
CCM and MM or
ACCM appliances.

Floor Building story identifier. Up to 50 alphanumeric


Required characters.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


A.13: Location Details 63

Table 32: Location Detail panel (continued)

Name Description Values Notes


Time Zone Time zone associated Times zone descriptors If you change the time
with the location. in the following formats zone, you must reboot
Required the zone appliances
• GMT offsets (GMT + associated with the
or - offset number)
location.
• Abbreviated (for
example, EST)
• Olson time zone IDs
(Area/Location)
:
Instance Instance associated with Configured instances. The list is populated by
the location. the system from the
Required values entered at
Configuration ➤
Enterprise ➤ System ➤
Instances.

IPC Site Code (AFM) Unique code that String up to 64 The code must be
identifies a Unigy alphanumeric unique across all Unigy
location to a Critical characters. enterprises.
Alert, Advanced Fault It identifies the location
Management (AFM), from which alerts are
Network Operations being sent.
Center (NOC), or Global
Support Operations
Center (GSOC) facility
that monitors system
health.

Address Detail
Select an address.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
64 A.13: Location Details

Figure 25: Address Detail panel

Table 33: Address Detail panel

Name Description Values Notes


Select Address Address assigned to the List of configured Select an address from
location. addresses. the list.
Required The addresses are
managed at
Configuration ➤
Enterprise ➤ System ➤
Addresses.
You cannot change the
address if the location is
a backroom location, the
zone is a portal zone,
and Multi-tier
Replication is enabled.
Address 1 Primary address entry, Up to 50 alphanumeric Read-only.
usually the street and special characters.
number and name at
which the building is
located.
Address 2 Secondary address, Up to 50 alphanumeric Read-only.
such as apartment, unit, and special characters.
or P.O. Box number.
City City Up to 50 alphanumeric Read-only.
and special characters.
State State or province Up to 50 alphanumeric Read-only.
characters.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


A.14: Enterprise: Organize System 65

Table 33: Address Detail panel (continued)

Name Description Values Notes


Country Country Up to 50 alphanumeric Read-only.
characters.
Postal Code Postal (zip) code Up to 12 alphanumeric Read-only.
characters, including
one hyphen.

Buttons

Table 34: Buttons

Name Description
Revert Discards your changes and redisplays the last
saved values.
Save Saves your changes to the Unigy database.

A.14 Enterprise: Organize System


Use this panel to name the Unigy enterprise and define enterprise-wide turret, intercom, and Microsoft
Office Communications Server (OCS) settings.
The following roles can modify the properties within this panel: IPC Project Manager, and IPC Certified
Tech. The Basic Administrator, Advanced Administrator, and Auditor roles provide read-only access to
the panel.
Access this panel by clicking Configuration ➤ Enterprise ➤ System ➤ Enterprise.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
66 A.14: Enterprise: Organize System

Figure 26: Organize System: Enterprise section

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


A.14: Enterprise: Organize System 67

Enterprise

Table 35: Organize System: Enterprise section

Name Description Values Notes


Enterprise Name Name that Up to 50 alphanumeric The default name is assigned
identifies the Unigy characters and hyphens, when Zone Deployer is run
enterprise. although a hyphen cannot be during initial deployment.
the first or last character. The IPC technician
Default: Enterprise performing the deployment
+build version. will change the name to a
unique value that
distinguishes the enterprise
from other enterprises at the
IPC GSOC or other Critical
Alert system.
If the enterprise name needs
to be changed after initial
deployment, contact IPC for
assistance.
Support for special characters
was removed in Unigy V2
Patch 3. The hyphen was
removed from the default
enterprise name in V2 Patch
5. Hyphens are supported in
V2.0.1.
Domain Name Used internally by Valid domain name up to 255 Customers do not have to
Unigy as the characters; for example enter this value into their DNS
domain name in bank.com. configuration.
end user URIs in Default value is the domain The enterprise domain name
SIP messages, name entered in Network does not need to be included
specifically Configurator during initial as part of zone FQDNs nor
presence URIs. network configuration. instance domain names.
Required For information on changing
the domain name, refer to the
Enterprise Guide.
System or customer provided.
Turret Admin Password that Range: 4 to 20 digits. Override the default
Password provides access to password by typing a new
administrative value. If you do not specify a
features on a turret value, the system uses the
or Pulse. The default password.
password is the Customer provided.
same for all
communication
devices.
Required

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
68 A.14: Enterprise: Organize System

Table 35: Organize System: Enterprise section (continued)

Name Description Values Notes


Number of Digits Number of digits Range: 3 to 20 The Alliance MX intercom
for Intercom Call required to dial an Default: 5 extension range is 3 to 6
intercom extension digits. Alliance MX end users
for a point-to-point will not be able to make point-
intercom call. to-point intercom calls to any
If you change this Unigy end users who have an
number, restart the extension that is greater than
turrets for the 6 digits in length.
change to take Customer provided.
effect.
Number of Digits Number of digits in The following values are This property specifies the
for ICM Group Call an intercom group available. number of digits a Unigy end
extension. user must dial to place an
If you change this
• 2 = 00 – 99 intercom group call. Leading
number, log off the • 3 = 000 – 999 zeroes must be dialed when
turrets and log on appropriate. For example, 01,
• 4 = 0000 – 1499
again for the 001, or 0001 must be dialed
change to take Default: 2 for Group 1.
effect. Also, Alliance MX
interoperability supports
Broadcast group extensions
00 – 99 to interoperate with
Alliance MX users if
interoperability is configured.
Customer provided.
Alliance All Call Broadcast group to Can be any broadcast group This field is populated from
Broadcast Group interoperate with whose members should the broadcast groups defined
the Alliance MX All participate in Alliance MX All through System Designer ➤
Call broadcast Call intercom broadcasts. Broadcast Groups.
group. When See the Alliance MX
interoperability is Interoperability Guide for an
configured, an explanation of how an All Call
Alliance MX All broadcast conference bridge
Call will include is set up. A completed Interop
Unigy members Preparation workbook
from this group as specifies the Unigy All Call
well as the Alliance broadcast group number and
MX All Call its members.
members. If you are implementing
Alliance MX interoperability,
use groups 0 – 99 for groups
that are common between
Alliance MX and Unigy. Use
groups greater than 99 for
Unigy only groups, if group
numbers above 99 are
available. The All Call group
can be any group number.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


A.14: Enterprise: Organize System 69

Table 35: Organize System: Enterprise section (continued)

Name Description Values Notes


IPC Enterprise Unique code that String up to 64 alphanumeric The code must be unique
Code (AFM) identifies a Unigy characters. across all Unigy enterprises.
enterprise to an It identifies the enterprise
Advanced Fault from which alerts are being
Management sent.
(AFM), Network
Operations Center
(NOC), or Global
Support
Operations Center
(GSOC) facility that
monitors system
health.
Fast Speed Dial Determines • Select the check box to Single tones result in shorter
whether a CDI specify single tone. dial times than the dual tones
device plays a of DTMF.
single tone or a • Clear the check box to
DTMF tone for specify DTMF tones.
each number Default: DTMF tones.
dialed in a one
stage line plus
speed dial.
Enable Trace Enables or • Select the check box to If you enable this property,
Route Feature disables the trace enable. you can disable trace route
route feature that for specific devices at
tracks the hops in • Clear the check box to Configuration ➤ Sites ➤
a call route for disable. Communication Devices.
analysis and Default: unchecked If you disable trace route at
troubleshooting the enterprise level, the
purposes. system ignores the properties
set at the device level.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
70 A.14: Enterprise: Organize System

Table 35: Organize System: Enterprise section (continued)

Name Description Values Notes


Disable Alert Enables or • Select the check box to
History Generation disables alert disable.
history from being
populated in the • Clear the check box to
database when enable.
alerts are raised or Default: checked
cleared.
Disable Media Enables or • Select the check box to Report output is available
Manager Metric disables data disable. When selected, only if Media Manager Metric
Collection collection for the data for the Media Collection is disabled.
Media Manager Manager Capacity Report
Capacity Report. is not collected and the
following message will
display in the report, Data
may be partially
or completely
suppressed based
on data range
criteria.
• Clear the check box to
enable. This does not bring
back the data for any time
period in which the data
was not collected.
Default: checked

Microsoft OCS Number Prefixes


The properties in this section identify the prefixes that the Microsoft Office Communications Server
(OCS) client uses to distinguish different types of calls. Unigy uses these values to properly process
calls.

Note
The Microsoft OCS integration feature requires the IQ/MAX Sync for OCS user license.

Table 36: Microsoft OCS Number Prefixes section

Name Description Values Notes


Intercom Prefix Prefix number that Range: 1 to Customer provided.
identifies an intercom 9999999999
OCS call. Default: 92
Private Line Prefix Prefix number that Range: 1 to Customer provided.
identifies a private line 9999999999
OCS call. Default: 96
Group Intercom Prefix Prefix number that Range: 1 to Customer provided.
identifies a personal 9999999999
extension for an OCS Default: 93
group intercom call.

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


A.14: Enterprise: Organize System 71

Table 36: Microsoft OCS Number Prefixes section (continued)

Name Description Values Notes


Group Answer Prefix Prefix number that Range: 1 to Customer provided.
identifies an OCS group 9999999999
answer intercom call. Default: 94
Group Talkback Prefix Prefix number that Range: 1 to Customer provided.
identifies a personal 9999999999
extension for an OCS Default: 95
group talkback intercom
call.
Dialtone Prefix Prefix number that Range: 1 to Customer provided.
identifies an OCS dial 9999999999
tone call. Default: 97

Table 37: Buttons

Name Description
Revert Discards all unsaved changes, and returns to the
last saved values.
Save Saves the current values.

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
72 A.14: Enterprise: Organize System

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


73

Index
A H
add HA clusters
SBC inventory records 22 placing into maintenance mode 29, 30
AFM
alert diagnostics 25 I
enterprise code 15
site code 15 IQ/MAX & Edge
alerts SNMP 48, 59
northbound forwarding 12 IQ/MAX & Edge: SNMP tab 48
reenabling forwarding to trap destinations 31
appliances
J
placing into maintenance mode 29, 30
JMS 12
C
L
CCM AFM Alerts Test panel 26
CCMs locations
generating AFM alerts test 26 configuring 61–63, 65
clusters
placing into maintenance mode 29, 30
community strings 23
M
configuration
maintenance
SMTP 40
placing appliances into maintenance mode 29, 30
Critical Alert
placing Media Gateways into maintenance mode 29, 30
dependencies 12
placing Media Managers into maintenance mode 29, 30
placing zones into maintenance mode 29, 30
D maintenance mode 29, 30
Media Gateways
dependencies
placing into maintenance mode 29, 30
Critical Alert 12
snmp 53
deployment
SNMP 51
location configuration 61–63, 65
devices SNMP profiles 42, 43, 45
SNMP 46, 57 Media Gateways: SNMP tab 51
media manager
SNMP profiles 42, 43, 45
diagnostics snmp 55
generating AFM alerts test 26 Media Manager: SNMP tab 49
Media Managers
placing into maintenance mode 29, 30
E SNMP 49
SNMP profiles 42, 43, 45
edit
SBC inventory record 22
enterprise P
configuration 65, 67, 70
OCS prefixes 65, 67, 70 profiles
SNMP 42, 43, 45
prototype devices
G device SNMP 57
IQ/MAX & Edge SNMP 59
Global Solutions Operations Center 12
Media Gateway snmp 53
GSOC 11, 12

IPC Systems, Inc., Confidential and Proprietary Unigy 4.1


Critical Alert Guide
74

media manager snmp 55 Z


Pulse devices
SNMP profiles 42, 43, 45 zone association
Pulse: SNMP tab 46 removing 17
zones
S maintenance for SNMP forwarding 37
placing into maintenance mode 29, 30
SBC reenabling forwarding to trap destinations 31
adding inventory records 22 SNMP forwarding maintenance 30
configuring for monitoring 22
servers
SMTP 40
Simple Network Management Protocol 12
SMTP
configuration 40
snmp
Media Gateway 53
media manager 55
SNMP
devices 46
forwarding 12
inform 15
IQ/MAX & Edge 48
Media Gateways 51
Media Manager 49
polling 15
profiles 42, 43, 45
properties 23
trap 15
SNMP alert forwarding 21
SNMP forwarding
deleting configuration 21
disabling per zone and destination 19
editing configuration 17
enabling per zone and destination 19
zone maintenance 37

T
trap destination
configuring 16, 33
deleting configuration 21
editing 17
removing a zone association 17
trap forwarding 15
turrets
SNMP profiles 42, 43, 45

U
upgrades
placing appliances into maintenance mode 29, 30

August 18, 2017 IPC Systems, Inc., Confidential and Proprietary


Part Number: B02200615, Release: 00
IPC Systems, Inc.
777 Commerce Drive
Fairfield, CT 06825-5500 USA

Potrebbero piacerti anche