Skip to end of metadata
Go to start of metadata

Download PDF Document

2018-08-16

For all Mediatrix units

v. 43.0.1125


1 Administrative State of Unit

The administrator can disable the use of specific endpoints or all endpoints of a unit through the administrative state configuration. It is also possible to select the initial endpoint state to be applied on unit start-up.

Disabling endpoints of a unit can be useful for example:

  • in a multi-tenant environment, if a tenant stops its service subscription, the administrator can lock the unit so the FXS port can give either a fast busy tone or no tone to signal the line is decommissioned. Then later the administrator can send a technician on site to re-wire and make the port available to another tenant.
  • if a user does not pay his service, the administrator can simply lock the endpoint.
  • to prevent calls during unit maintenance

Note

Locking an endpoint also removes SIP registration from the endpoint prohibiting calls from and to the endpoint.


2 Basic Tasks


2.1 Locking All Unit Endpoints - Gracefully

Before You Start

If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will be displayed.

Steps

  1. Go to System/Endpoints.
  2. In the Unit States table, from the Action selection list, choose Lock.

Result

New calls can no longer be sent or received.
  • If the state of the unit is Idle or Idle Unusable, the unit is locked right away.
  • If the unit is either Busy or Active, the unit will be locked only when it will become Idle.

2.2 Locking All Unit Endpoints - Immediately

Before You Start

If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will be displayed.

Steps

  1. Go to System/Endpoints.
  2. In the Unit States table, from the Action selection list, choose Force Lock.

Result

All telephone lines of the unit are locked immediately even if there are calls in progress, in which case the call will be immediately terminated (BYE sent to the SIP peer and end-of-call tone played to the endpoint). Locking all unit endpoints prevents any call activities.

2.3 Unlocking All Unit Endpoints

Before You Start

If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will be displayed.

Steps

  1. Go to System/Endpoints.
  2. In the Unit States table, from the Action selection list, choose Unlock.

Result

The unit becomes available for use.

2.4 Locking an Endpoint - Gracefully

Before You Start

If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will be displayed.

Steps

  1. Go to System/Endpoints.
  2. In the Endpoint States table, from the Action selection list of an endpoint, choose Lock.

Result

The endpoint will no longer be able to send or receive a call.
  • If the state of the endpoint is Idle or Idle Unusable, the endpoint is locked right away.
  • If the endpoint is either Busy or Active, the endpoint will be locked only when the unit will become in Idle.

2.5 Locking an Endpoint- Immediately

Before You Start

If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will be displayed.

Steps

  1. Go to System/Endpoints.
  2. In the Endpoint States table, from the Action selection list of an endpoint, choose Force Lock.

Result

All activities of the endpoint are stopped immediately, even if there are calls in progress, in which case the call will be immediately terminated (BYE sent to the SIP peer and end-of-call tone played to the endpoint).

2.6 Unlocking an Endpoint

Before You Start

If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will be displayed.

Steps

  1. Go to System/Endpoints.
  2. In the Endpoint States table, from the Action selection list of an endpoint, choose Unlock.

Result

The endpoint becomes available for use.

2.7 Setting the Endpoint Behavior after a Unit Restart

Before You Start

If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will be displayed.

Steps

  1. Go to System/Endpoints.
  2. In the Endpoint States table, from the Initial Administrative selection list of an endpoint, choose Lock or Unlock.

Result

  • If the Initial Administrative selection list is set to Lock, when the unit restarts, the endpoint will remain locked, therefore unusable.
  • If the Initial Administrative selection list is set to Unlocked, when the unit restarts, the endpoint will become usable.
.

2.8 Disabling the Unit Endpoints when No Gateways are Ready

Before You Start

If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will be displayed.

Steps

  1. Go to System/Endpoints.
  2. In the Administration table, select Enable next to Disable Unit (All Endpoints) when No Gateways Are In State Ready .

Result

The unit will be disabled, i.e. unusable, if none of the SIP gateways are ready to be used. As soon as a SIP gateway becomes ready, the unit will be enabled.

2.9 Shutting Down Endpoint if in Idle-Unusable State

Before You Start

If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will be displayed.

Steps

  1. Go to System/Endpoints.
  2. In the Administration table, select Enable next to Shutdown Endpoint When Operational State is Disable And Its Usage State is idle-unusable .

    Note

    The Shutdown Endpoint When Operational State is Disable And Its Usage State is idle-unusable parameter is always interpreted as disabled unless it has been specifically set to enable.

Result

When an endpoint usage state becomes Idle-unusable whatever the value of its operational state, the endpoint remains physically up but the calls are denied.

2.10 Disabling All Gateways when Trunk Lines are Down

Before You Start

If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will be displayed.

Steps

  1. Go to System/Endpoints.
  2. In the Administration table, select Disable next to Disable Unit (All Endpoints) when No Gateways Are In State Ready .

    Note

    This applies only to E1 or T1 telephony lines.

Result

When all E1 or T1 telephony lines are down, all SIP gateways will be stopped. All SIP gateways will be started when at least one E1T1 line is up.

3 Advanced Parameters


3.1 System-Endpoints Parameters

Although the services can be configured in great part in the Web browser, some aspects of the configuration can only be completed with the Configuration parameters by :

  • using a MIB browser
  • using the CLI
  • creating a configuration script containing the configuration parameters

For more details on the following advanced parameters, refer to the Reference Guide published on the Media5 documentation portal.

Setting the toggle delay to disable the SIP gateways when trunk lines are down

EpAdm.DisableSipGatewaysWhenTrunkLinesDownToggleDelay

Setting the Behavior of the unit While in Shutting Down State

EpAdm.BehaviorWhileInUnitShuttingDownState