Call Agent RTP Port

The Call Agent RTP Port object is a child of the Trunk / Access Gateway object. It represents the Call Agent's view of the RTP Port object under the Media Gateway.

In general, the Call Agent RTP Port object for MetaSwitch gateways is included as part of the delivered configuration. If you modify the configuration of RTP Ports below the Media Gateway, you will need to update the equivalent configuration below the corresponding Trunk / Access Gateway, but you may find it easier to use the "shadow object" actions on the Trunk / Access Gateway to make this update rather than changing the objects explicitly.

To create the Call Agent RTP Port for a third-party gateway, you can use MetaSwitch-supplied configuration files, which are available from the MetaSwitch Customer Portal (http://support.metaswitch.com), and you can use the EMS's Import function on the parent Trunk / Access Gateway object to import them into your configuration. A user name and password are required to access the portal; contact your MetaSwitch account representative to obtain these if necessary.


Parameter

Access

Description
Port name Change A unique identifier for this port among all other devices on the Call Agent. This identifier is used by other objects that need to reference this port. If the RTP Port is a child of a MetaSwitch Trunk / Access Gateway, this field must be set to RTP. If it is a child of a third-party gateway, you can use any text string that does not match the port name of another object on the same gateway. This string must not contain spaces or any of the characters @ * /.
Description Change A text string used in the EMS System Explorer to identify this port. Specify a string of up to 40 characters.
Provider status Read only The availability status of the Call Agent RTP Port, indicating whether the Call Agent can communicate with it. Values:
  • Unavailable
  • Available
  • Inactive
  • Active
  • Out of service
  • Quiescing
  • Unconfigured
  • Pending available
Deactivation mode Read only Specifies how child objects should be deactivated when deactivating this object. Values:
  • Normal
    Shut down child objects normally before deactivating the object.
  • Quiesce
    Deactivating the RTP Port in quiesce mode will wait for all existing child objects using the port to be completed before deactivation. No new child objects using this port will be accepted during this deactivation period.
  • Abort
    Deactivate the object and all its child objects immediately. (This may result in errors at remote systems.)
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 - 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 the alarm count 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.
Alarm log correlator - Attend To Dependent Read only Identifier of the log message for the event that caused the last Attend To Dependent alarm state for this object. This field is reset when the Attend To Dependent alarm events field is reset to zero.
Attend To Dependent alarm events Read only / Reset Number of times (since the alarm count was reset) that this object's alarm state has gone to Attend To Dependent.
Attend To Dependent alarm events reset timestamp Read only The time at which the Attend To Dependent alarm events was last reset to zero.
Alarm state changed timestamp Read only The time at which the Alarm state last changed.
Export - number of objects exported Read only The total number of objects (including child objects) written to the export file so far in the current or most recent export operation.
Export - status Read only The status of the current or most recent export operation, if any. Values:
  • None
    No export has been attempted. Use the export pushbutton to start it.
  • In progress
    Export is in progress. Do not attempt to access the export file until the status has changed to Succeeded.
  • Succeeded
    Export completed successfully.
  • Failed
    Export failed. Check the Export - log correlator field for more details.
  • Partially failed
    A field in the configuration of the exported object or one of its child objects was not valid. Typically this is because a referenced object has been deleted. Either check and correct the configuration before retrying the export, or correct the error in the exported file before attempting to re-import it.
Export - file Change The name of the text file (in the EMS User's home directory on the EMS Server) to which configuration information for this object will be exported. The maximum length of the filename is 32 characters.
Export - log correlator Read only If the export 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.
Export - correlator metaswitch Read only If the export 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 enable the RTP port. 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 RTP port. 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.