ESA Protection Domain

The ESA Protection Domain object is a child of the ESA Protection Domains object. It represents the Call Agent's view of the Emergency Standalone function provided by the ESA Server on a particular MG3510 or MG2510 Media Gateway, protecting that Media Gateway and optionally one or more MGCP Subscriber Gateways.


If you change the value of the Control status - give up control field to True, control of the ESA Protection Domain will change from the Call Agent to the ESA Server (switchover), if the following conditions are met.
  • The Call Agent is currently in control.
  • The ESA Server is ready to take control (for example, it must have synchronized user records with the Call Agent already).
  • There is connectivity between the Call Agent and ESA Server, so that switchover can be signaled.
Switchover can also happen automatically if the ESA Server loses contact with the Call Agent, if the appropriate conditions on the ESA Server are met. This happens regardless of the setting of Control status - give up control. When switchover occurs, the Media Gateway that runs the ESA Server for this domain will restart, and all calls in progress on the Media Gateway and any other devices in the domain are lost. While Control status - give up control is set to True, control will not change back to the Call Agent automatically (switchback). Switchback occurs when
  • you set the value of Control status - give up control to False
  • the ESA Server is currently in control
  • connectivity between the Call Agent, ESA Server and Media Gateway has been restored (to a level meeting the switchback criteria configuration on the ESA server)
  • there are no emergency calls in progress on the ESA Server.
As for switchover, the Media Gateway restarts and all calls are lost.



You cannot enable, activate, deactivate or disable an ESA Protection Domain while the associated ESA Server is in controlling mode. If you deactivate an ESA Protection Domain while the associated ESA Server is in standby mode, the ESA Server will no longer be able to provide any protection to the Media Gateway and/or Subscriber Gateways in case of a Call Agent connection failure. You may prefer to deactivate the associated ESA Server at the same time.



After creating an ESA Protection Domain, you must configure the Trunk/Access Gateway corresponding to the Media Gateway associated with the ESA Server, assigning it to this ESA Protection Domain. The Trunk / Access Gateway will not be protected by the ESA Server unless you do this. You must also specify the ESA Protection Domain name for any MGCP Subscriber Gateways that are to be protected.



The ESA Server identified by the IP address field must be inactive before you can create a new ESA Protection Domain that references it, or enable and activate an existing ESA Protection Domain that references it. You cannot delete an ESA Protection Domain while it is protecting one or more gateways (while Control status - number of protected gateways is non-zero).

Object-Specific Actions
Force configuration synchronization This action is available only when Status - actual status is Active. It forces the Call Agent to send configuration data for this ESA Protection Domain to the ESA Server immediately, without waiting for the next scheduled update as specified by the Configuration synchronization fields. You may need to use this action if you have made significant changes to the Call Agent's configuration since the last scheduled update and you want to ensure that these changes will be preserved if an Emergency Standalone switchover becomes necessary.
Unprotect all gateways This action removes the reference to this ESA Protection Domain from the Media Gateway and all Subscriber Gateways that use it. You cannot use this action while the associated ESA Server is in controlling mode. If you use this action while the associated ESA Server is in standby mode, the gateways will no longer be protected in the event of a Call Agent connection failure.

Parameter

Access

Description
ESA Protection Domain index Create A unique index value to identify this ESA Protection Domain. If you leave this field blank, the EMS will assign a value.
Name Change A unique name for this ESA Protection Domain in the EMS display. For clarity, you are recommended to give the ESA Protection Domain the same name as the ESA Server that it references (identified by the IP address field).
IP address Change Inactive The IP address of the ESA Server to which this ESA Protection Domain corresponds. This is the same as the IP address of the Media Gateway on which the ESA Server runs. You must specify a standard dotted-decimal IP address (not a hostname or domain name).
Connection security type Change Specifies whether the connection from the Call Agent to the ESA Server is set to use encryption (secure) or not (insecure). This must match the connection type configured for the connection between the Call Agent and the Media Gateway associated with the ESA Server. Values:
  • Secure
    The Call Agent and ESA Server will communicate using an encrypted connection.
  • Insecure
    The Call Agent and ESA Server will communicate using an unencrypted connection.
Connection status Read only This field appears only if Status - actual status is Active. The Call Agent's view of its connection to the ESA Server. Values:
  • Up
    The connection is operating normally.
  • Down
    The Call Agent has been unable to receive valid messages from the ESA Server for 25 seconds, and so considers the connection to be down.
Control status - Call Agent control status Read only This field appears only if Status - actual status is Active. The Call Agent's view of whether it has control of the ESA Protection Domain. Values:
  • Call Agent controlling
    The Call Agent is controlling the ESA Protection Domain.
  • Call Agent not controlling
    The Call Agent is not controlling the ESA Protection Domain.
  • Call Agent cautiously controlling
    Either the Call Agent is controlling the ESA Protection Domain but the ESA Server can take over control if necessary, or the Call Agent is ready to resume control after switchover but switchback has not yet occurred.
Control status - ESA control status Read only This field appears only if Status - actual status is Active. The ESA Server's view of whether it has control of the ESA Protection Domain. Values:
  • Standby
    The ESA Server is not controlling the ESA Protection Domain, but is on standby ready to take over control from the Call Agent if there is a problem.
  • Controlling
    The ESA Server is controlling the ESA Protection Domain.
  • Unknown
    The Call Agent cannot determine the ESA Server's control status.
Control status - give up control Change Specifies whether the Call Agent should allow the ESA server to take control of the ESA Protection Domain. Values:
  • True
  • False (default)
If you set this field to True when the Call Agent is controlling the domain, Control status - Call Agent control status changes to Call Agent cautiously controlling. If the connection to the ESA Server is up, the Call Agent also signals to the ESA Server that it can take control. While this field is set to True, automatic switchback will not take place, but you can force switchback manually if required. When a switchover or switchback occurs, the Media Gateway that runs the ESA Server for this domain will restart, and all calls in progress on the Media Gateway and any other devices in the domain are lost. Switchback occurs when
  • you set the value of this field to False
  • the ESA Server is currently in control
  • connectivity between the Call Agent, ESA Server and Media Gateway has been restored (to a level meeting the switchback criteria configuration on the ESA server)
  • there are no emergency calls in progress on the ESA Server.
Control status - number of protected gateways Read only The number of gateways in this ESA Protection Domain. This count includes the Media Gateway associated with the ESA Server, and any Subscriber Gateways that it protects.
Control status - number of gateways controlled by Call Agent Read only The number of active gateways in this ESA Protection Domain that the Call Agent is currently controlling. This count includes the Media Gateway associated with the ESA Server, and any Subscriber Gateways that it protects.
Configuration synchronization - interval Change The interval in hours between automatic synchronizations of configuration from the Call Agent to the ESA Server. Range: 1 - 72 hours (1 - 3 days). The default is 24 hours (1 day). If you want to control the time of day at which synchronizations occur (for example to ensure that they occur while no configuration updates are in progress), set this field to a multiple of 24 and set Configuration synchronization - time of day to indicate the time.
Configuration synchronization - time of day Change This field appears only if Configuration synchronization - interval is set to a multiple of 24 hours. Specifies the hour of the day (in the Call Agent's local time) at which updates occur. Select from the drop-down list.
Configuration synchronization - last synchronization attempt Read only The status of the most recent synchronization attempt. Values:
  • Succeeded
  • Failed
  • In progress
Configuration synchronization - time of last successful synchronization Read only The date and time at which the last successful synchronization occurred.
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 log correlator 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 Attention Required alarm events is reset to zero.
Attention Required alarm events Read only / Reset Number of times (since the alarm count was reset) that this object's alarm state has gone to Attention Required.
Alarm state changed timestamp Read only The time at which the Alarm state last changed.
Alarm events reset timestamp Read only The time at which Attention Required alarm events was last reset to zero.
Diagnostics - API trace - enabled Change Specifies whether API tracing is enabled for this object. Values:
  • True
  • False (default)
Diagnostics - API trace - trace tag Change An optional diagnostics tag inserted into API tracing and PD logging for this object. This tag may include any ASCII characters. However, if you want to filter on this tag in the craft interface, do not include spaces or any of the characters ^ \ $ * + ? | ( ) , . ` ' " [ ] { }.
Requested status Read only Specifies whether an administrator has attempted to enable the Trunk / Access Gateway. Values:
  • Active
    The object has been activated.
  • Inactive
    The object has not been activated or has been deactivated.
  • Disabled
    The object has not been enabled or has been disabled.
Actual status Read only Specifies the current status of the Trunk / Access Gateway. Values:
  • Active
    The object is active.
  • Activating
    Activation is in progress.
  • Deactivating
    Deactivation is in progress.
  • Inactive
    The object is inactive.
  • Disabled
    The object has been disabled.
  • Activation Failed
    The object is inactive because an activation attempt has failed.
  • Failed
    The object was active but has failed.
  • Quiescing
    The object is preparing for normal deactivation. It is operating normally but will not accept any new users.
  • Waiting For Parent
    The object cannot be used because its parent object is not yet active.
  • Parent Failed
    The object cannot be used because its parent object has failed.