Element Management System

The Element Management System object is a top-level element in the EMS structure, corresponding to the EMS Server. There is a single Element Management System which is created before delivery and which you cannot destroy. It controls access to the EMS Server, provides facilities for collecting diagnostics, and displays status information.

Object-Specific Actions
Close active audit file This action applies if the Auditing enabled field is set to True. When this action is run, the currently active audit file is closed and a new one is created. For details of the audit files, see the Ancillary Servers Guide.

If the security settings on the EMS Server and Clients are not compatible, you will not be able to manage the EMS. For example, if you configure the server to accept only secure connections and the client to connect in insecure mode, the client's connection to the server will be rejected. To correct this, change the client's security setting using the menu bar option in the client before connecting to the server, so that it matches the server's setting. If you configure the EMS Server to accept only insecure connections, CORBA clients will be prevented from accessing the EMS because they are required to use secure connections. If you modify the port numbers used for connections between the EMS Server and EMS Clients, the EMS Client user will need to specify the new port number when connecting to the server.



To change the configuration of SNMP Alarm notifications, set the appropriate values in the SNMP Alarm notifications at next restart fields, and then stop and restart the EMS using the CRAFT scripts as described in the Ancillary Servers Guide. Enabling alarm monitoring has an impact on the performance of the EMS Server, so that EMS operations may take longer to complete if this feature is enabled. In particular, if you are using an EM3000 Series server (rather than a high-performance EM4000 Series server), please discuss your EMS usage with your MetaSwitch support contact to ensure that the server's performance will be sufficient for your requirements.


Parameter

Access

Description
EMS name Read only The name of the EMS Server.
EMS unique identifier Read only An internal identifier for the EMS Server.
Time Read only The EMS Server's current system time, used in timestamps for billing and diagnostics. This field is updated approximately once every minute.
Version Level Read only The version level of the core software running on the EMS. This is in the format MM.mm.CC representing the major, minor and compatibility levels of the software, for example 4.02.01.
Service Level Read only The service level of the core software running on the EMS. This is in the format SUN PT.LL representing the service update number, patch track number and patch level of the software, for example SU5 P1.03.
Boot Level Read only The boot level of the core software running on the EMS. This is in the format EMSN PT.LL representing the boot level number, patch track number and patch level of the software, for example EMS13 P1.03.
Min logging severity level for storage Change The minimum severity level that a log must have for that log to be stored. Range: 0 - 70
Current security mode Read only Indicates whether the EMS Server accepts secure and/or insecure connections from EMS Clients. Values:
  • Secure only
  • Secure and insecure
  • Insecure only
Current secure port Read only The IP port number currently used for secure connections between the EMS Server and Client. (This port is also used for communications between the Web Server and EMS Server.)
Current firewall compatible insecure port Read only The IP port number currently used for firewall compatible insecure connections between the EMS Server and Client.
Current insecure port Read only The IP port number currently used for insecure connections between the EMS Server and Client.
Security mode on next restart Change Indicates whether the EMS Server should accept secure and/or insecure connections from EMS Clients. If you change this option, the new configuration will take effect next time you restart the EMS Server. Values:
  • Secure only (default)
  • Secure and insecure
  • Insecure only
Secure port on next restart Change The IP port number used for secure connections between the EMS Server and Client. (This port is also used for communications between the Web Server and EMS Server.) The default is 8006. If you need to use a different port number (for example to connect through a firewall that restricts the range of port numbers available to you), specify it here. The port numbers for the three different types of connections (secure, firewall compatible insecure, and insecure) must be different; you cannot configure two of these to use the same port number.
Firewall compatible insecure port on next restart Change The IP port number used for firewall compatible insecure connections between the EMS Server and Client. The default is 8005. If you need to use a different port number, specify it here. The port numbers for the three different types of connections (secure, firewall compatible insecure, and insecure) must be different; you cannot configure two of these to use the same port number.
Insecure port on next restart Change The IP port number used for insecure connections between the EMS Server and Client. The default is 8004. If you need to use a different port number, specify it here. The port numbers for the three different types of connections (secure, firewall compatible insecure, and insecure) must be different; you cannot configure two of these to use the same port number.
Auditing enabled Change Specifies whether audit trails are kept of changes to EMS objects and access to the EMS. Values:
  • True
  • False (default)
Web Services API - enabled Read only Specifies whether the Web Services API (a programming interface to the EMS) is currently enabled. Values:
  • True
  • False
You can enable or disable these functions using the Web Services API at next restart - enabled field.
Web Services API - port number Read only This field is visible only if Web Services API - enabled is True. Specifies the IP port number used to access the Web Services API. Range: 0 - 65535. You can alter the IP port number used by the API using the Web Services API at next restart - port number field.
Web Services API - full back-compatibility enabled Read only This field is visible only if Web Services API - enabled is True. Specifies whether full back-compatibility has been enabled for the Web Services API.
  • True
    When a client identifies itself as a given version, the response to the request will conform to the schema for that version.
  • False
    Responses to the client may contain elements, attributes and/or values that were not specified in the client's version of the schema.
You can configure whether full-back compatibility is enabled using the Web Services API at next restart - full back-compatibility enabled field.
Web Services API at next restart - enabled Change Specifies whether the Web Services API is enabled at the next restart of the EMS Server. Values:
  • True
  • False
Web Services API at next restart - port number Change This field is visible only if Web Services API - enabled is True. Specifies the IP port number used to access the Web Services API at the next restart of the EMS Server. Range: 0 - 65535.
Web Services API at next restart - full back-compatibility enabled Change This field is visible only if Web Services API - enabled is True. Specifies whether full back-compatibility is enabled for the Web Services API at the next restart of the EMS Server.
  • True
    When a client identifies itself as a given version, the response to the request will conform to the schema for that version.
  • False
    Responses to the client may contain elements, attributes and/or values that were not specified in the client's version of the schema.
Alarm monitoring - enabled Read only This field indicates whether the Alarms display and SNMP alarm notifications are enabled. Values:
  • True
  • False
You can enable or disable these functions using the Alarm monitoring at next restart - enabled field. To send SNMP alarm notifications to a management application, you need to configure at least one child SNMP Alarm Notification Destination object to define the destination to which they are sent.
Alarm monitoring - lifespan of cleared alarms Read only The current lifespan of cleared alarms in minutes. This controls how long an alarm marked cleared will remain in the Alarm display before being deleted. (1440 minutes is 24 hours.) You can alter the lifespan for cleared alarms using the Alarm monitoring at next restart - lifespan of cleared alarms field.
Alarm monitoring at next restart - enabled Change Specifies whether the Alarms display and SNMP alarm notifications are enabled at the next restart of the EMS Server. Values:
  • True
    This is the default for an EM4000 Series EMS Server.
  • False
    This is the default for an EM3000 Series EMS Server.
Alarm monitoring at next restart - lifespan of cleared alarms Change Specifies what the lifespan of cleared alarms should be after the next restart of the EMS Server. Range: 0 - 1440 minutes. The default is 10. (1440 minutes is 24 hours.)
Count of logged in users Read only The number of EMS Users who are currently logged in to the EMS Server.
Alarm state Read only Specifies whether any alarms are currently raised for this object. Values:
  • Clear
    No alarms are currently raised.
  • Attention Required
    Attention Required - the object is not operating normally, and needs operator intervention.
Alarm state changed timestamp Read only The time at which the Alarm state last changed.
Alarm log correlator - Attention Required Read only Identifier of the log message for the event that caused the last Attention Required alarm state for this object. This field is reset when the Attention Required alarm events field is reset to zero.
Attention Required alarm events Read only / Reset Number of times (since this field was reset) that this object's alarm state has gone to Attention Required.
Attention Required alarm events reset timestamp Read only The time at which the Attention Required alarm events was last reset to zero.