Call Agent

The Call Agent object is a child of the MetaSwitch object, and is used to group together a number of related areas of MetaSwitch connectivity configuration, as follows.

There is only a single Call Agent object, which is created before delivery of MetaSwitch NE. This object cannot be destroyed. The Call Agent object does not have any configurable parameters, but provides status information for the Call Agent component of the MetaSwitch NE and overall status information for its child objects.

Object-Specific Actions
Statistics Opens the Statistics viewer, which allows you to view historical statistics data for this object.

Parameter

Access

Description
Timezone Read only Specifies the timezone used by the Call Agent function of the NE. This is configured using the CRAFT menus. Values:
  • Unknown (default)
  • EEST (+2)
  • CET (+1)
  • GMT (+0)
  • WET (-1)
  • GMT-2 (-2)
  • GMT-3 (-3)
  • AST (-4)
  • EST (-5)
  • CST (-6)
  • MST (-7)
  • PST (-8)
  • ALST (-9)
  • HST (-10)
  • SST (-11)
Adjust for Daylight Savings Read only This specifies whether the timezone (configured using the CRAFT menus) for the Call Agent uses Daylight Savings adjustments. Values:
  • True
  • False (default)
Daylight Savings in force Read only Specifies whether or not Daylight Savings adjustments have been made to the time.
Maximum number of Line Traffic Studies Change Specifies the maximum number of line traffic studies that can be configured on this Call Agent. A line traffic study is used to record call data for a subscriber or a voicemail system: originating and terminating call attempts, whether the terminating calls were answered or rejected, and call usage. Line traffic studies are configured on the objects representing each subscriber or voicemail system line group. Default: 200.
Current number of monitored Subscriber Gateways Read only The number of Subscriber Gateway children of this Call Agent for which monitoring options are enabled. These options are specified in the Remote Media Gateway Model that each Subscriber Gateway uses. You are recommended not to enable monitoring options on more than 1000 gateways, to avoid excessive resource usage, but the EMS does not enforce a limit.
T.38 globally supported Change Specifies whether the Call Agent supports transmitting fax data over IP networks using T.38 encoding (as an alternative to G.711 encoding). The use of T.38 encoding to or from specific devices is determined by fix bits on the Remote Media Gateway Model used by these devices. Note that T.38 will not be used for calls involving a BLES access device, for calls that do not use direct media, or for calls between V.34 faxes. For more information about T.38 settings, refer to the Knowledge Base on the MetaSwitch Customer Portal (http://support.metaswitch.com). Values:
  • True
    If fax tones are detected on a call, and the call uses a Remote MG Model that supports T.38, the fax data will be transmitted using T.38; otherwise it will be transmitted using G.711.
  • False (default)
    Fax data will always be transmitted using G.711, regardless of the Remote MG Model settings.
Default announcement locale Change The default language variant used for voice announcements played by the NE. Values:
  • English (US)
  • English (UK)
  • English (Canadian)
  • French (Canadian)
  • Spanish (Latin America)
  • English (Canadian) + French (Canadian)
    Bilingual Canadian, with English announcements followed by French announcements
  • French (Canadian) + English (Canadian)
    Bilingual Canadian, with French announcements followed by English announcements
  • User Defined 1
  • User Defined 2
Multi Line Hunt Group statistics - Business Groups with statistics enabled Read only The number of Business Groups for which statistics are being collected in the statistics database.
Multi Line Hunt Group statistics - MLHGs with statistics enabled Read only The number of Multi Line Hunt Groups for which statistics are being collected in the statistics database.
Multi Line Hunt Group statistics - MLHG memberships with statistics enabled Read only The number of MLHG Members for which statistics are being collected in the statistics database.
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.
  • Attend To Dependent
    Attention Required elsewhere - another object on which this object depends is not operating normally.
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 the Attention Required alarm events field 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 the Attention Required alarm events was last reset to zero.
Controlled Networks Attention Required alarms Read only The total number of Controlled Networks child objects associated with this Call Agent that are in Attention Required state.
Controlled Networks Attention Required alarm events Read only / Reset The total number of times that the alarm state for a Controlled Networks child object has gone to Attention Required.
Controlled Networks Attend To Dependent alarms Read only The total number of Controlled Networks child objects associated with this Call Agent that are in Attend To Dependent state.
Controlled Networks Attend To Dependent alarm events Read only / Reset The total number of times that the alarm state for a Controlled Networks child object has gone to Attend To Dependent.
Signaling Attention Required alarms Read only The number of Attention Required alarms for the Signaling object (or its child objects) associated with this Call Agent.
Signaling Attention Required alarm events Read only / Reset The number of times an Attention Required alarm has been raised for the Signaling object (or its child objects).
Signaling Attend To Dependent alarms Read only The number of Attend To Dependent alarms for the Signaling object (or its child objects) associated with this Call Agent.
Signaling Attend To Dependent alarm events Read only / Reset The number of times an Attend To Dependent alarm has been raised for the Signaling object (or its child objects).
Billing Attention Required alarms Read only The number of Attention Required alarms for the Billing child objects associated with this Call Agent.
Billing Attention Required alarm events Read only / Reset The number of times an Attention Required alarm has been raised for one of the Billing child objects.
Call Services Attention Required alarms Read only The number of Attention Required alarms for the Call Services object (and its child objects) associated with this Call Agent.
Call Services Attention Required alarm events Read only / Reset The number of times an Attention Required alarm has been raised for the Call Services object (or its child objects).
Call Services Attend To Dependent alarms Read only The number of Attend To Dependent alarms for the Call Services object (and its child objects) associated with this Call Agent.
Call Services Attend To Dependent alarm events Read only / Reset The number of times an Attend To Dependent alarm has been raised for the Call Services object (or its child objects).
Trunk Routing and Policy Services Attention Required alarms Read only The number of Attention Required alarms for the Trunk Routing and Policy Services object (and its child objects) associated with this Call Agent.
Trunk Routing and Policy Services Attention Required alarm events Read only / Reset The number of times an Attention Required alarm has been raised for the Trunk Routing and Policy Services object (or one of its child objects).
Trunk Routing and Policy Services Attend To Dependent alarms Read only The number of Attend To Dependent alarms for the Trunk Routing and Policy Services object (and its child objects) associated with this Call Agent.
Trunk Routing and Policy Services Attend To Dependent alarm events Read only / Reset The number of times an Attend To Dependent alarm has been raised for the Trunk Routing and Policy Services object (or one of its child objects)
Subscriber Configuration Attention Required alarms Read only The number of Attention Required alarms for the Subscriber Configuration object (or its child objects) associated with this Call Agent.
Subscriber Configuration Attention Required alarm events Read only / Reset The total number of times that the alarm state for the Subscriber Configuration object (or one of its child objects) has gone to Attention Required.
Subscriber Configuration Attend To Dependent alarms Read only The number of Attend To Dependent alarms for the Subscriber Configuration object (or its child objects) associated with this Call Agent.
Subscriber Configuration Attend To Dependent alarm events Read only / Reset The total number of times that the alarm state for the Subscriber Configuration object (or one of its child objects) has gone to Attend To Dependent.
Total child Attention Required alarms Read only The total number of children of this object that are in Attention Required state.
Total child Attention Required alarm events Read only The total number of times that the alarm state for any child object of the Call Agent has gone to Attention Required.
Total child Attend To Dependent alarms Read only The total number of children of this object that are in Attend To Dependent state.
Total child Attend To Dependent alarm events Read only The total number of times that the alarm state for any child object of the Call Agent has gone to Attend To Dependent.
Summary child alarm state Read only Summarizes the alarm status for all children of this object. Values:
  • Clear
    No alarms are currently raised.
  • Attention Required
    Attention Required - one or more child objects are not operating normally, and need operator intervention.
  • Attend To Dependent
    Attention Required elsewhere - another object on which one or more child objects depend is not operating normally.
Import - number of objects imported Read only The total number of objects (including child objects) read from the import file so far in the current or most recent import operation.
Import - status Read only The status of the current or most recent import operation, if any. Values:
  • None
  • In progress
  • Succeeded
  • Failed
Import - mode Change Whether the imported information is to replace existing EMS objects or to add new ones. This field provides additional checking on the import operation if required. Values:
  • Do not overwrite
    The imported information is to add new objects. If the file contains objects that already exist in the EMS, the import operation will fail and will not overwrite them.
  • Do not create
    The imported information is to update existing objects. If the file contains objects that do not already exist in the EMS, the import operation will fail and will not create them.
  • Overwrite or create
    No checking. The import operation will create or update objects as required.
Import - file Change The name of the text file (in the EMS User's home directory on the EMS Server) from which configuration information for this object will be imported.
Import - log correlator Read only If the import status is Failed, this field contains a correlator for the log message that contains details of the failure. Click on the 'go to log' button next to this field to jump to this message in the EMS log viewer window.
Import - correlator metaswitch Read only If the import status is Failed, this field contains the name of the EMS Server or MetaSwitch Network Element that generated the failure log. You may need this information to find the log in the EMS log viewer window.
Requested status Read only Specifies whether an administrator has attempted to activate the Call Agent. Values:
  • Active
    The object has been activated.
  • Inactive
    The object has not been activated or has been deactivated.
  • Disabled
    The object has been disabled.
Actual status Read only Specifies the current status of the Call Agent. 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.