Alcatel 5020 SoftSwitch - Oracle 5020_1_0_0.pdf · Alcatel 5020 SoftSwitch 1 1 Cartridge Overview...

Alcatel 5020 SoftSwitchSeventh Edition

July 2008

Oracle Communications® ASAP™ Cartridge 1.0 for Alcatel 5020 SoftSwitch

Copyright and Trademark Information

Copyright © 1992, 2008, Oracle and/or its affiliates. All rights reserved.Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications.

This software and documentation may provide access to or information on content, products and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third party content, products and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third party content, products or services.

Alcatel 5020 SoftSwitch 1

ContentsCartridge Overview .......................................................................................... 1

Cartridge content ................................................................................................................... 2Prerequisites ......................................................................................................................... 2About this guide .................................................................................................................... 2Services, features, and options ............................................................................................. 3Hardware and software requirements ................................................................................... 4

Network element (NE) interface ...................................................................................... 4ASAP version ................................................................................................................. 4

Connecting to the NE ............................................................................................................ 4

Installing and Testing the Cartridge ............................................................... 5Downloading the cartridge .................................................................................................... 5Starting ASAP ....................................................................................................................... 6Installing the cartridge ........................................................................................................... 7Uninstalling the cartridge ....................................................................................................... 7Testing the cartridge installation ........................................................................................... 8

Configuring loopback and live mode parameters ........................................................... 8Communication Parameters (tbl_comm_param) .......................................................... 10Modifying Alcatel_voip_3-01_ne_config.xml ................................................................. 11Testing the installation .................................................................................................. 13

Atomic Service Description Layer (ASDL) Commands .............................. 15Call Control Engine (CCE) Services ................................................................................... 17

A_A5020-VOIP_3-01_ADD_CCE ................................................................................. 17A_A5020-VOIP_3-01_ADD_NRE ................................................................................. 18A_A5020-VOIP_3-01_ADD_POP ................................................................................. 19A_A5020-VOIP_3-01_ADD_RAN ................................................................................. 20A_A5020-VOIP_3-01_DEL_POP ................................................................................. 25A_A5020-VOIP_3-01_DEL_RAN ................................................................................. 27A_A5020-VOIP_3-01_MOD_POP ................................................................................ 28A_A5020-VOIP_3-01_MOD_POP-RB .......................................................................... 29A_A5020-VOIP_3-01_MOD_RAN ................................................................................ 31A_A5020-VOIP_3-01_MOD_RAN-RB .......................................................................... 36A_A5020-VOIP_3-01_QRY_ALL-RANS ...................................................................... 40A_A5020-VOIP_3-01_QRY_POP ................................................................................ 42A_A5020-VOIP_3-01_QRY_RAN ................................................................................ 44

NRE services ...................................................................................................................... 46A_A5020-VOIP_3-01_ADD_AAA-GROUP ................................................................... 47A_A5020-VOIP_3-01_ADD_AAA-SELECTION-RULE ................................................. 59A_A5020-VOIP_3-01_ADD_AAA-SELECTION-RULE-RB ........................................... 66A_A5020-VOIP_3-01_ADD_ROUTE ............................................................................ 69A_A5020-VOIP_3-01_ADD_ROUTE-BLOCK .............................................................. 71A_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-PREFIX ................................................ 74A_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-SUFFIX ................................................ 76

2 Oracle Corporation

A_A5020-VOIP_3-01_ADD_ROUTE-CONFIG ............................................................. 78A_A5020-VOIP_3-01_ADD_VPN ................................................................................. 79A_A5020-VOIP_3-01_DEL_AAA-GROUP ................................................................... 86A_A5020-VOIP_3-01_DEL_AAA-SELECTION-RULE ................................................. 88A_A5020-VOIP_3-01_DEL_ROUTE ............................................................................ 90A_A5020-VOIP_3-01_DEL_ROUTE-BLOCK ............................................................... 92A_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-PREFIX ................................................. 95A_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-SUFFIX ................................................. 97A_A5020-VOIP_3-01_DEL_ROUTE-CONFIG ............................................................. 98A_A5020-VOIP_3-01_DEL_VPN ............................................................................... 100A_A5020-VOIP_3-01_MOD_AAA-GROUP ................................................................ 101A_A5020-VOIP_3-01_MOD_AAA-GROUP-RB .......................................................... 111A_A5020-VOIP_3-01_MOD_AAA-SELECTION-RULE .............................................. 121A_A5020-VOIP_3-01_MOD_AAA-SELECTION-RULE-RB ........................................ 126A_A5020-VOIP_3-01_MOD_ROUTE ......................................................................... 131A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK ............................................................ 134A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-PREFIX ............................................. 140A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-PREFIX-RB ....................................... 142A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-RB ..................................................... 144A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-SUFFIX .............................................. 148A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-SUFFIX-RB ....................................... 149A_A5020-VOIP_3-01_MOD_ROUTE-CONFIG .......................................................... 151A_A5020-VOIP_3-01_MOD_ROUTE-CONFIG-ATTACH-VPN .................................. 152A_A5020-VOIP_3-01_MOD_ROUTE-CONFIG-DETACH-VPN ................................. 154A_A5020-VOIP_3-01_MOD_ROUTE-RB ................................................................... 155A_A5020-VOIP_3-01_MOD_VPN .............................................................................. 159A_A5020-VOIP_3-01_MOD_VPN-RB ........................................................................ 163A_A5020-VOIP_3-01_QRY_AAA-GROUP ................................................................. 171A_A5020-VOIP_3-01_QRY_AAA-SELECTION-RULE ............................................... 174A_A5020-VOIP_3-01_QRY_ROUTE ......................................................................... 180A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK ............................................................ 181A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-ALL ..................................................... 184A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIX .............................................. 187A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIX-ALL ...................................... 189A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-SUFFIX .............................................. 192A_A5020-VOIP_3-01_QRY_ROUTE-CONFIG .......................................................... 194A_A5020-VOIP_3-01_QRY_VPN ............................................................................... 196

Customizing error handling ............................................................................................... 198

Service Definitions ....................................................................................... 201CCE Service Pack ............................................................................................................. 203

C_A5020-VOIP_3-01_ADD_CCE .............................................................................. 203C_A5020-VOIP_3-01_ADD_NRE .............................................................................. 204C_A5020-VOIP_3-01_ADD_POP .............................................................................. 205C_A5020-VOIP_3-01_ADD_RAN .............................................................................. 206C_A5020-VOIP_3-01_DEL_POP ............................................................................... 210C_A5020-VOIP_3-01_DEL_RAN ............................................................................... 211C_A5020-VOIP_3-01_MOD_POP .............................................................................. 213


C_A5020-VOIP_3-01_MOD_RAN .............................................................................. 214C_A5020-VOIP_3-01_QRY_ALL-RANS .................................................................... 219C_A5020-VOIP_3-01_QRY_POP .............................................................................. 220C_A5020-VOIP_3-01_QRY_RAN .............................................................................. 220

NRE Service Pack ............................................................................................................. 222C_A5020-VOIP_3-01_ADD_AAA-GROUP ................................................................. 223C_A5020-VOIP_3-01_ADD_AAA-SELECTION-RULE ............................................... 231C_A5020-VOIP_3-01_ADD_ROUTE .......................................................................... 233C_A5020-VOIP_3-01_ADD_ROUTE-BLOCK ............................................................ 234C_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-PREFIX .............................................. 236C_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-SUFFIX .............................................. 238C_A5020-VOIP_3-01_ADD_ROUTE-CONFIG .......................................................... 239C_A5020-VOIP_3-01_ADD_VPN ............................................................................... 239C_A5020-VOIP_3-01_DEL_AAA-GROUP ................................................................. 242C_A5020-VOIP_3-01_DEL_AAA-SELECTION-RULE ............................................... 243C_A5020-VOIP_3-01_DEL_ROUTE .......................................................................... 246C_A5020-VOIP_3-01_DEL_ROUTE-BLOCK ............................................................. 247C_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-PREFIX ............................................... 248C_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-SUFFIX ............................................... 249C_A5020-VOIP_3-01_DEL_ROUTE-CONFIG ........................................................... 250C_A5020-VOIP_3-01_DEL_VPN ............................................................................... 250C_A5020-VOIP_3-01_MOD_AAA-GROUP ................................................................ 251C_A5020-VOIP_3-01_MOD_AAA-SELECTION-RULE .............................................. 258C_A5020-VOIP_3-01_MOD_ROUTE ......................................................................... 261C_A5020-VOIP_3-01_MOD_ROUTE-BLOCK ........................................................... 262C_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-PREFIX ............................................. 264C_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-SUFFIX ............................................. 266C_A5020-VOIP_3-01_MOD_ROUTE-CONFIG .......................................................... 267C_A5020-VOIP_3-01_MOD_VPN .............................................................................. 268C_A5020-VOIP_3-01_QRY_AAA-GROUP ................................................................ 271C_A5020-VOIP_3-01_QRY_AAA-SELECTION-RULE .............................................. 271C_A5020-VOIP_3-01_QRY_ROUTE ......................................................................... 274C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK ............................................................ 275C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-ALL .................................................... 276C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIX .............................................. 276C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-SUFFIX .............................................. 277C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIX-ALL ...................................... 278C_A5020-VOIP_3-01_QRY_ROUTE-CONFIG .......................................................... 279C_A5020-VOIP_3-01_QRY_VPN .............................................................................. 279

Configuring ASAP to Support Additional NE Instances .......................... 281Extracting source files ....................................................................................................... 284

Loading a new XML file .............................................................................................. 284


1

Cartridge Overview

ASAP cartridges are discrete software components that are developed for the ASAP product. An ASAP cartridge offers specific domain behavior on top of the core ASAP software, and provides the configuration that supports a set of services on a network element (NE).

An ASAP cartridge is not a stand-alone component, but operates in conjunction with the ASAP core product. ASAP cartridges offer the following benefits:

Reduced Time to Market—time to market of new services is reduced through simplified development, implementation, and extension of cartridges on customer sites.Extendable—cartridges can be extended to include additional services and components that deliver business value, without requiring changes to the original cartridge.Simplified Effort—the effort and technical knowledge that is required to perform customizations is reduced.Ease of Installation—cartridges can be installed into an ASAP environment without interfering with the existing install base.

An ASAP cartridge can be used to configure ASAP to provision the following:

NEs from a specific vendor, such as Nortel or Lucent.Technologies, such as Asynchronous Transfer Mode (ATM) and Frame Relay switches, or Internet Protocol (IP) routers.Services that are supported on the NE, such as ATM, IP Virtual Private Networks (VPN), Wireless, or Optical.

An ASAP cartridge supports a particular set of services on an NE. These services are independent of customer-specific service definitions. Professional Services or systems integrators can perform extensions to the cartridge to support customer-specific requirements.

For more information on extending a cartridge, refer to the ASAP Cartridge Development Guide for Service Activation.

Cartridges are designed for a specific technology, software load, and service.

Chapter 1: Cartridge Overview


Cartridge contentAn ASAP cartridge contains the following:

An interface to the NEA set of scripts, such as State Tables or Java methodsA set of atomic actions in the form of Atomic Service Description Layer (ASDL) commandsA set of Common Service Description Layer (CSDL) commands that form meaningful servicesSample work ordersInstallation scripts

PrerequisitesSystem integrators such as managers, designers, programmers, and testers who are responsible for the adaptation and integration of ASAP-based solutions should use this manual as a reference. It assumes that readers possess the following skills:

A knowledge of ASAP programming conceptsA good working knowledge of the UNIX operating systemA thorough understanding of service and network provisioningFamiliarity with telecommunications

About this guideThis guide provides a detailed description of the Alcatel A5020 Softswitch cartridge. It contains overview and technical information to assist with extending and integrating the cartridge into a customer environment.

The scope of this guide includes ASAP as it pertains to this cartridge. It is not a complete ASAP reference guide.

For additional ASAP information when using this cartridge, refer to the following supporting documentation:

ASAP documentation set—for detailed information on the ASAP core product.ASAP Cartridge Development Guide for Service Activation—for information on how to extend a cartridge.

The Alcatel A5020 Softswitch cartridge provides the ASAP service configuration and network element (NE) interface to activate Call Control Engine and Network Routing Engine (CCE and NRE) services on Alcatel A5020 Softswitch NEs.

Services, features, and options


Services, features, and optionsThis cartridge supports the following services to support Call Control and Network Routing actions.

Call Control Engine Services Add Call Control Engine -- Add a reference of the SoftSwitch Call Control Engine to the A5020. Note that the notion of CCE is currently a component module of the A5020, but is not restricted to this scenario. The CCE may be a separate distributed network entity.Add Network Routing Engine – Add a reference of the Network Routing Engine to the A5020. Note that the notion of NRE is currently a component module of the A5020, but is not restricted to this scenario. The NRE may be a separate distributed network entity.Add, modify, delete, and query Point of Presence (POP)Add, modify, delete, and query Remote Access Node – Add a Remote Access Node, which represents a Border Element. This may be any of CCE, NRE, PSTN, IP Gateways, ASQuery All Remote Access Node in a given POP

Network Routing Engine Services Add, modify, delete, and query AAA GroupsAdd, modify, delete, and query AAA Selection Criteria RulesAdd, modify, delete, and query VPNsAdd, modify, delete, and query VoIP Route ConfigurationsAdd, modify, delete, and query VoIP Route Blocks – can group up to 10 priority routes, or 5 weighted routes. The routes must be of the same type onlyAdd, modify, delete, and query VoIP Route Block Prefix Ranges – used for additional criteria for selecting the best route block. This table is used when E.164 numbers are used to identify the destinationAdd, modify, delete, and query VoIP Route Block Suffixes – used for additional criteria for selecting the best route block. This table is used when SIP URLs are used to identify the destination. The suffix identifies part of the domain that follows the "@".Add, modify, delete, and query VoIP Routes – added as a possible path to a particular gateway. Routes are accessed when the route blocks are determined and the routes are selected (based on priority/weight). The contents of this table are used to fill the contact header field (in the SIP API message)

Some of these services may be able to combine actions.

Chapter 1: Cartridge Overview


Hardware and software requirementsThe following sections contain the high-level software and hardware environment requirements for provisioning Call Control Engine and Network Routing Engine services using this cartridge, including:

Network element (NE) interfaceASAP version

Network element (NE) interfaceThis cartridge operates with the following:

NE—Alcatel A5020 SoftswitchNE Software Load—3.0.1

ASAP versionThis cartridge was developed and tested using ASAP 4.6.4

For more information on the operating environment of this version of ASAP, refer to the ASAP 4.6.4 Release Record.

Connecting to the NEThis cartridge connects to the Alcatel A5020 Softswitch R3.0.1 using CORBA, as specified by Alcatel.


2

Installing and Testing the Cartridge

This chapter describes the following procedures related to installing and testing the cartridge:

Downloading the cartridgeInstalling the cartridgeUninstalling the cartridgeTesting the cartridge installation

Downloading the cartridgeBefore you can install the cartridge, you must use the internet to download the cartridge’s TAR file from Oracle’s Customer Portal.

Use the following instructions to download, then unTAR the TAR file.

To download the TAR file

1. Login to Oracle MetaLink internet home page (http://www.metalink.oracle.com).

2. Download the cartridge patch to your workstation.

To unTAR the TAR file

1. On you workstation, create a repository directory—the naming of which is your choice.mkdir <repository dir>

2. Untar A5020_VOIP_3_01.tar.tar xvf A5020_VOIP_3_01.tar

3. Copy the resulting /Alcatel_VOIP_3-01 directory and its contents to the repository directory.

cp -rf /Alcatel_VOIP_3-01 <repository_dir>

The directory structure in the repository directory should look like the following illustration. (this illustration describes the minimum required structure; you can enhance this directory structure with additional directories based on your requirements and deliverables). <repository_directory>

Alcatel_VOIP_3-01/README/installCartridge

Chapter 2: Installing and Testing the Cartridge


/uninstallCartridge/A5020_VOIP_3_01.sar

Starting ASAPBefore downloading the cartridge, ensure that ASAP is running.

To start ASAP

1. To start ASAP, execute the following script:start_asap_sys

2. Ensure the ASAP Daemon (DAM_$ENV_ID) is running by checking the ASAP status using the ASAP script “status”.

3. Check whether the WebLogic instance for this ASAP environment is running. If not, start the WebLogic instance.

The ASAP System Configuration and Management Guide contains more information on starting ASAP, the ASAP Daemon, and WebLogic.

Installing the cartridge


Installing the cartridgeRun the installation script installCartridge to install the cartridge. You will find this script under /Alcatel_VOIP_3-01. The script executes the following tasks:

Configures the Alcatel A5020 Softswitch-specific NE using the SACT. Deploys the Alcatel A5020 Softswitch cartridge service model (only if the Alcatel A5020 Softswitch service model is not yet deployed) using the Service Activation Deployment Tool (SADT).Copies the Alcatel A5020 Softswitch-specific jar files and the cpp library file to the ASAP environment.Loads the sample work orders to the SRP database.

For information on the SACT and the SADT, refer to the ASAP System Configuration and Management Guide.

To install the cartridge

1. Run the installCartridge script from /Alcatel_VOIP_3-01. At the prompt, type:installCartridge A5020_VOIP_3_01

2. The script prompts you for the values of the following WebLogic login parameters:

WebLogic HostnameWebLogic http PortWebLogic Login User IDWebLogic Login Password

The script loads the NEP-NE configuration and the CSDL-ASDL configuration to the SARM database, and loads sample work orders to the SRP database. The script also copies the cartridge-specific jar files and cpp library file to the ASAP environment.

3. Restart ASAP to upload the cartridge configuration into ASAP.

Uninstalling the cartridgeRun the uninstallation script uninstallCartridge to uninstall the Alcatel A5020 Softswitch cartridge. This script is located under Alcatel_VOIP_3-01. The script executes the following tasks:

Unconfigures Alcatel A5020 Softswitch-specific NEs using the SACT. Undeploys the Alcatel A5020 Softswitch cartridge service model (only if the Alcatel A5020 Softswitch service model is already deployed) using the Service Activation Deployment Tool (SADT). Removes the Alcatel A5020 Softswitch-specific jar files and cpp library file from the ASAP environment.



For more information on the SACT and the SADT, refer to the ASAP System Configuration and Management Guide.

To uninstall the cartridge

1. Run the uninstallCartridge script from /Alcatel_VOIP_3-01. At the prompt, type uninstallCartridge A5020_VOIP_3_01.sar

2. The script prompts you for the values of the following parameters:

WebLogic HostnameWebLogic HTTP PortWebLogic Login User IDWebLogic Login Password

The script unloads the NEP-NE configuration and CSDL-ASDL configuration from SARM database. It also removes the cartridge specific jar files and cpp library file from the ASAP environment.

Testing the cartridge installationTo test this cartridge installation, you need to know about the network element (NE), services, and basic ASAP configuration. You may need to perform adjustments to provision a service for a specific NE, network, or connectivity configuration.

You can test the cartridge installation using one of the following methods:

Loopback mode—does not actually connect to or send commands to the NE.Live mode—connects to and sends commands to a live NE.

Configuring loopback and live mode parametersThe following sections tell you which variables you must configure in to use the loopback and live testing modes.

Loopback mode

The following table details the parameters that you must set to test the cartridge in loopback mode.

Table 1: LOOPBACK_ON Parameter Settings for Loopback Testing

Configuration Variable Parameter Settings Location

LOOPBACK_ON 1 (default setting) Global or NEP

Testing the cartridge installation


The following is a list of parameters for the sample NE configuration XML that are used by the SACT for loopback testing.

Live mode

The following table details the parameters that you must set in ASAP.cfg to test the cartridge in live mode.

Table 2: Loopback Testing Parameters for the Sample NE Configuration XML

Parameters Default Value Description

NE_ID_NRE A5020-VOIP-HOST Logical NE Name

PORT 7003 Port number to connect on remote NE host

IOR A5020.ior Server’s CORBA IOR file name

USER_ERROR_TYPES_FILE /config/A5020-VOIP_3-01_UserExitTypes.cfg The user exit types file. This file is relative to ASAP_BASE directory.

RESPONSE_LOG YES Flag to turn On or Off Response logging

Table 3: LOOPBACK_ON Parameter Settings for Live Testing

Configuration Variable Parameter Settings Location

LOOPBACK_ON 0 Global or NEP



Communication Parameters (tbl_comm_param)This static database table contains the communication parameters required to communicate with various external systems. The table consists of the following fields:

dev_type – the protocol used to connect to the device.host – the host NE to which the configured parameter value applies.device – the device for which this parameter value applies.param_label – the label of the communication parameter.param_value – the value of the communication parameter.param_desc – a description of the communication parameter

The following table lists the contents of tbl_comm_param:

Table 4: tbl_comm_param

TYPE HOST DEVICEPARAM_LABEL

PARAM_VALUE

PARAM_DESC

C A5020-HOST COMMON_DEVICE_CFG

HOST_IPADDR 10.9.3.16 The host name or IP Address of the remote NE.


PORT 8080 Port number to connect on remote NE host.


A5020_IOR Services/IOR.txt The remote NE service IOR.


READ_TIMEOUT

5000 The read timeout in milliseconds.


USER_ERROR_TYPES_FILE

/config/A5020-VOIP_3_01_UserExitTypes.cfg

The User Exit types file. This file is relative to ASAP_BASE directory.


RESPONSE_LOG

YES Flag to enable of disable response logging.


HOST_USER SYSTEM User name.



Modifying Alcatel_voip_3-01_ne_config.xmlUse the following procedure to modify Alcatel_voip_3-01_ne_config.xml.

To modify Alcatel_voip_3-01_ne_config.xml

1. Create a new source directory under /Alcatel_VOIP_3-01. You can give this directory any appropriate, meaningful name you want to.

mkdir <new_source_directory>

2. Copy A5020_VOIP_3_01.sar to this new source directory.

cp A5020_VOIP_3_01.sar ./<new_source_directory>

3. Change directory to <new_source_directory>.cd <new_source_directory>

4. Un-jar A5020_VOIP_3_01.sar This extracts the contents of the sar file.

jar xvf A5020_VOIP_3_01.sar


HOST_PASSWORD

User Password Password.


FTP_USER User FTP user name.


FTP_PASSWORD

Password FTP password.


FTP_ACTION Enable Enable or disable FTP of IOR file from server prior to each connection.


SERVER_IOR_FILE

/server/IOR.txt Relative path on the server where the IOR file resides for FTP.


SESSION_ACTION

Enable Allow the Alcatel server to use transactional capability.

Table 4: tbl_comm_param

TYPE HOST DEVICEPARAM_LABEL

PARAM_VALUE

PARAM_DESC



5. Edit Alcatel_voip_3-01_ne_config.xml in with the appropriate changes.

6. Create a new sar file at the <new_source_directory> level. CreateSar $PWD

7. Uninstall the cartridge using A5020_VOIP_3_01.sar in /Alcatel_VOIP_3-01 (That is, use the original sar file that you copied in Step 2 above—see “Uninstalling the cartridge” on page 7 for uninstallation instructions).

8. After you uninstall the cartridge, rename the sar file in /Alcatel_VOIP_3-01 so you have a backup copy of it.

9. Copy the new sar file from <new_source_directory> to /Alcatel_VOIP_3-01.

10. Reinstall the cartridge (see “Installing the cartridge” on page 7 for installation instructions).

Figure 1: Structure of the Un-Jared .sar File



Testing the installationThe following procedure describes the steps required to test the cartridge installation in loopback mode. We recommend that you perform the initial cartridge installation test in loopback mode.

To test in loopback mode

1. Stop ASAP by typing the following command at the UNIX prompt:stop_asap_sys

2. Ensure loop back mode is on. See “Loopback mode” on page 8 for a description of how to set the loop back parameter to “On”.

3. Start ASAP by typing:start_asap_sys

4. Send the sample work orders through the SRP Emulator by typing:run_suite $SRP <ctrl_password> <suite name>

You can locate the suite names in /Alcatel_VOIP_3-01/sample_wo by typing:grep SUITE * | grep -v END

A list of all available suites appears.

To see the sample work orders, refer to Viewing the sample work orders, below.

For more information on the SRP Emulator, refer to the ASAP System Configuration and Management Guide.

5. Verify the status of the sample work orders by typing:asap_utils l

All successful work orders return the 104 state.

To view the sample work orders provided with this cartridge, refer to the Alcatel A5020 Softswitch cartridge source.

Viewing the sample work orders

You find the sample work orders under the sample_wo directory in the sar file. The following procedure describes how to view the sample work orders.

To view the sample work orders

1. If necessary, create a repository directory under /Alcatel_VOIP_3-01, copy the sar file to the new directory and un-jar the sar file, as described by Step 1 through Step 4 in “Modifying Alcatel_voip_3-01_ne_config.xml” on page 11.

2. Locate and view the sample work order files under /Alcatel_VOIP_3-01/CCE or NRE.


3

Atomic Service Description Layer (ASDL) Commands

ASDL commands represent a set of atomic actions that ASAP can perform on a network element (NE). ASAP can combine ASDLs to create meaningful services (CSDLs) within a cartridge.

This chapter presents detailed information on the ASDL parameters that we provide with this cartridge. The following table lists and describes the type of parameter information that is included.

Table 5: ASDL parameter information

Item Description

Parameter Name Identifies the parameter that is configured for the stated service.

Description Describes the parameter.

Range Describes or lists the range of values that can be used to satisfy this parameter.

Default Value Configures a default value for the parameter so that it is not mandatory for the upstream system to provide a value.

Chapter 3: Atomic Service Description Layer (ASDL) Commands


For a detailed description of the Required and Optional parameter classifications, refer to the ASAP System Configuration and Management Guide.

Type Indicates one of the following parameter types:

S—Scalar, specifies the parameter label transmitted on the ASDL command. Scalar parameters are conventional name-value pair parameters.C—Compound, specifies the base name of the compound parameter transmitted on the ASDL command. A compound parameter contains structures or arrays of information that are represented by a particular structure name or compound parameter name. Each compound parameter can contain a large number of elements. If you use compound parameters, you only require a single entry in the ASAP translation tables to call the compound parameter and all its associated parameter elements.I—Indexed, identifies a parameter that contains a sequential numerical index value to tell the SARM that it should execute the same operation (for example, an ASDL command) for all occurrences of that index. Consequently, if there are several options on a particular CSDL command (OPT1, OPT2, OPT3, etc.), you can specify the OPT parameter as an indexed parameter. When you specify the OPT parameter as an indexed parameter, the SARM generates several occurrences of that same ASDL command and each command has a different value for the option being transmitted to the NEP.

For more information on parameter types, refer to the ASAP Developer’s Reference.

Class Indicates one of the following parameter classifications:

R—Required scalar parameterO—Optional scalar parameterC—Required compound parameterN—Optional compound parameterM—Mandatory indexed parameterI—Optional indexed parameterS—Parameter count

Table 5: ASDL parameter information

Item Description

Call Control Engine (CCE) Services


Call Control Engine (CCE) ServicesThis cartridge provides the following ASDL commands:

A_A5020-VOIP_3-01_ADD_CCEA_A5020-VOIP_3-01_ADD_NREA_A5020-VOIP_3-01_ADD_POPA_A5020-VOIP_3-01_ADD_RANA_A5020-VOIP_3-01_DEL_POPA_A5020-VOIP_3-01_DEL_RANA_A5020-VOIP_3-01_MOD_POPA_A5020-VOIP_3-01_MOD_POP-RBA_A5020-VOIP_3-01_MOD_RANA_A5020-VOIP_3-01_MOD_RAN-RBA_A5020-VOIP_3-01_QRY_ALL-RANSA_A5020-VOIP_3-01_QRY_POPA_A5020-VOIP_3-01_QRY_RAN

A_A5020-VOIP_3-01_ADD_CCEAdds a Call Control Engine (CCE) to the system. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.CCEProvisioning.addCCE.

MML commands/API calls

Not implemented in this phase.

Output parameters

If the work order is not successful, the method returns:

Table 6: A_A5020-VOIP_3-01_ADD_CCE

Parameter Name Description RangeDefault Value

Type Class

MCLI The A5020 instance identifier, or the CCE instance.

S R

CCE_ID The CCE instance identifier.

S R



ALCATEL_ADD_CCE_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_ADD_CCE_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

A_A5020-VOIP_3-01_ADD_NREAdds a Network Routing Engine (NRE) to the system. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.CCEProvisioning.addNRE.


Not implemented for this phase.

Output parameters


ALCATEL_ADD_NRE_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_ADD_NRE_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

Table 7: A_A5020-VOIP_3-01_ADD_NRE


Type Class

MCLI The A5020 instance identifier.

S R

NRE_ID The NRE instance identifier.

S R



A_A5020-VOIP_3-01_ADD_POPAdds a Point of Presence (POP). It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.CCEProvisioning.addPop.

MML commands/API callsPop globalPop = telcoVpn.GetGlobalPop();Pop pop = globalPop.NewPop();pop.Set(setPopFlag, popName);

Output parameters


Table 8: A_A5020-VOIP_3-01_ADD_POP


Type Class


S R

POP_NAME The POP name. Valid characters are alphanumeric capitals.

S R

POP_TYPE The POP type. PopTypePOP, PopTypeGLOBALPOP, PopTypeVIRUTALPOP, or PopTypeVIRTUALGLOBALPOP

PopTypeVIRTUALPOP

S R

VPN_ID The VPN instance identifier. Either VPN_ID or VPN_NAME must be used to identify the VPN.

S O

VPN_NAME The VPN name identifier. Either VPN_ID or VPN_NAME must be used to identify the VPN.

S O



ALCATEL_CCE_ADD_POP_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_CCE_ADD_POP_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

For a successful ASDL, POP_ID and POP_PARENT_ID are populated as CSDL parameters to the SARM table TBL_SRQ_PARM.

A_A5020-VOIP_3-01_ADD_RANAdds a Remote Area Node. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.CCEProvisioning.addRan.

Table 9: A_A5020-VOIP_3-01_ADD_RAN


Type Class


S R

VPN_NAME The VPN name identifier. Either VPN ID or VPN Name may be used as a key. VPN will default to MANAGER if not specified.

S O

VPN_ID The VPN instance identifier. Either VPN ID or VPN Name may be used as a key. VPN will default to MANAGER if not specified.

S O

POP_ID The POP primary identifier. Either POP_ID or POP_NAME must be used as a key.

S O



POP_NAME The POP name. Either POP_ID or POP_NAME must be used as a key.

S O

RAN_NAME The Remote Area Node name.

S R

RAN_TYPE The RAN type. RanTypeMAX4000, RanTypeMAXINT, RanTypeSHIVA, RanTypePM, RanTypeCISCO, RanTypeDANA2100, RanTypeTUNNELSERVER, RanTypeREDBACK, RanTypeAssured, RanTypeMAX6000, RanTypeSHASTA5000, RanType3COM, RanTypeUNISPHERE, and RanTypeVIRTUALRAN

RanTypeVIRTUALRAN

S O

RAN_ENABLE Enables or disables the GW.

Enable S O

RAN_PORTS The number of ports the GW has.

5 S O

RAN_REGIONID Selects the region using the Region Iterator.

S O

RAN_FLAG_TRUSTED

The RAN trusted flag. S O

RAN_FLAG_DOWNLOAD_IP_POOLS

The RAN download IP pools flag

S O



Type Class



RAN_FLAG_DOWNLOAD_IP_ROUTES

The RAN download IP routes flag.

S O

RAN_FLAG_DOWNLOAD_IPX_ROUTES

The RAN download IPX routes flag.

S O

RAN_FLAG_DOWNLOAD_PERM_CONNECTIONS

The RAN download permanent connection flag.

S O

RAN_FLAG_DOWNLOAD_FRAMED_PROFILES

The RAN download framed profile flag.

S O

RAN_FLAG_HEARTBEAT_SUPPORT

The RAN heartbeat support flag.

S O

RAN_COMMAND_PORT

This port is used if there is a disconnect in some of the GWs.

S O

RAN_PROTOCOL_TYPE

Indicates the RADIUS protocol used.

S O

RAN_ITF_IP_ADDRESS

The IP address used if the GW has more than one physical interface with the NE.

For more information, see Table 10 on page 25.

C O

RAN_ITF_IP_NETMASK

Sets the netmask. S O

RAN_ITF_SECRET Sets the shared secret that is used to encrypt all communication between the GW and the proxy.

S O



Type Class



RAN_ITF_FLAGS Enables the IPNG protocol.

RanITFFlagIPING

S O

RAN_VOICE_PROTOCOL

Selects between the H323 and SIP protocols.

S O

RAN_VOICE_PREGRANTED_ARQ_MAKECALL

Sets these options when protocol is H323.

CallOff (no pre-granted ARQ), CallH323GKRoutedMode (only if H.323 GK in routed mode), CallH323GKDirectMode (only if H.323 GK in direct mode), CallAlways (pre-granted ARQ regardless of GK mode)

S O

RAN_VOICE_PREGRANTED_ARQ_ANSWERCALL



S O

RAN_VOICE_GATEWAY_REGISTERS

Enables the register, if necessary.

S O



Type Class



MML commands/API callsRan ran = pop.NewRan();ran.Set (true, ranName, true, popIdValue, true, ranTypeOption, true, protocolTypeValue, true, ranFlagType, true, ranEnableOption, true, ranPortValue, true, ranCommandPortValue, true, regionIdValue);

RAN_VOICE_REGISTRATION_PORT

A specific signaling port number used by the gateway for registration. If given, the gateway can only use the IP address defined in the identifier or Interface address fields with this signalling port. If empty, registrations from any port are accepted.

S O

RAN_VOICE_TRUSTED

Indicates that voice trusted is used.

Enable, Disable, True, False, 1, 0

S O

RAN_VOICE_SUPPORT_ISUP_MIME

Indicates that voice support ISUP time is used.


S O

RAN_LRQ_ENDPOINT_TYPE

If you are using a:Real gateway, the value needs to be NotLRQEndPoint; H323 gatekeeper with no token, use the LRQEndPointNoToken; H323 gatekeeper with token, use the LRQEndPointToken.

S O

RAN_LRQ_ENDPPOINT_PORT

The RAS port used in case of an LRQ endpoint.

S O



Type Class



ran.SetITF ( true, ranITFIPAddress, true, ranITFIPNetMask, true, ranItfSecret, true, ranITFFlags );ran.SetVoice( true, ranVoiceProtocol, true, ranVoiceMakeCall, true, ranVoiceAnswerCall, true, ranVoiceGatewayRegister, true, ranVoiceRegPort, true, ranLrqEndpointType, true, ranLrqEndpointPort, true, ranVoiceTrustedOption, true, ranVoiceSupportIsupTimeOption);

Output parameters


ALCATEL_CCE_ADD_RAN_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_CCE_ADD_RAN_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

For a successful ASDL, RAN_ID is added as a CSDL parameter to the SARM table TBL_SRQ_PARM

Compound parameter "IPADDRESS"

The compound parameter IPADDRESS will contain an indefinite number of IP Address and Port values.

A_A5020-VOIP_3-01_DEL_POPDeletes the POP. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.CCEProvisioning.delPop.

Table 10: Compound Parameter "IPADDRESS"

PARAMETER LABEL PARAMETER TYPEELEMENT

ATTRIBUTE TYPEDESCRIPTION

IP_ADDRESS.(n) O STRING IP address of format nnn.nnn.nnn.nnn

Table 11: A_A5020-VOIP_3-01_DEL_POP


Type Class


S R



MML commands/API callsPop globalPop = telcoVpn.GetGlobalPop();Pop pop = globalPop.OpenPop(popID);Pop.Delete();

Output parameters


ALCATEL_CCE_DELETE_POP_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_CCE_DELETE_POP_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM


S O


S O

VPN_ID The VPN instance identifier.

S O

VPN_NAME The VPN name identifier.

S O

Table 11: A_A5020-VOIP_3-01_DEL_POP


Type Class



A_A5020-VOIP_3-01_DEL_RANDeletes the Remote Area Node. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.CCEProvisioning.delRan.

MML commands/API callsRan ran = telcoVpn.OpenRan(ranIdValue);

Table 12: A_A5020-VOIP_3-01_DEL_RAN


Type Class


S R

VPN_NAME The VPN name identifier. Either VPN_ID or VPN_NAME may be used as a key. VPN will default to MANAGER if not specified.

S O

VPN_ID The VPN instance identifier. Either VPN_ID or VPN_NAME may be used as a key. VPN will default to MANAGER if not specified.

S O

RAN_ID The Remote Area Node primary identifier. Either RAN_ID or RAN_NAME must be used as a key.

S O

RAN_NAME The Remote Area Node name. Either RAN_ID or RAN_NAME must be used as a key.

S O



ran.Delete();

Output parameters


ALCATEL_CCE_DELETE_RAN_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_CCE_DELETE_RAN_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM

A_A5020-VOIP_3-01_MOD_POPModifies the POP. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.CCEProvisioning.modPop.

Table 13: A_A5020-VOIP_3-01_MOD_POP


Type Class


S R


S O


S O

NEW_POP_NAME The new POP name. S O


S O





Output parameters


ALCATEL_CCE_MODIFY_POP_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_CCE_MODIFY_POP_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM

A_A5020-VOIP_3-01_MOD_POP-RBRolls back a modified POP. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.CCEProvisioning.modPopRB.


S O


S O

Table 14: A_A5020-VOIP_3-01_MOD_POP-RB


Type Class


S R

Table 13: A_A5020-VOIP_3-01_MOD_POP


Type Class





Output parameters


ALCATEL_CCE_MODIFY_POP_RB_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_CCE_MODIFY_POP_RB_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM


S O


S O

OLD_POP_NAME The old POP name. S O

OLD_POP_TYPE The old POP type. S O


S O


S O

Table 14: A_A5020-VOIP_3-01_MOD_POP-RB


Type Class



A_A5020-VOIP_3-01_MOD_RANModifies the Remote Area Node. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.CCEProvisioning.modRan.

Table 15: A_A5020-VOIP_3-01_MOD_RAN


Type Class


S R


S O


S O

POP_ID The POP primary identifier.

S O

POP_NAME The POP name. S O


S O


S O



RAN_TYPE The RAN type. RanTypeMAX4000, RanTypeMAXINT, RanTypeSHIVA, RanTypePM, RanTypeCISCO, RanTypeDANA2100, R100, RanTypeTUNNELSERVER, RanTypeREDBACK, RanTypeAssured, RanTypeMAX6000, RanTypeSHASTA5000, RanType3COM, RanTypeUNISPHERE, RanTypeVIRTUALRAN

S O


S O


S O


S O

RAN_FLAG_TRUSTED

The RAN trusted flag. S O



S O



S O



S O



S O



Type Class





S O



S O

RAN_COMMAND_PORT


S O

RAN_PROTOCOL_TYPE


S O

RAN_ITF_IP_ADDRESS



C O

RAN_ITF_IP_NETMASK



S O


RanITFFlagIPING

S O

RAN_VOICE_PROTOCOL


S O



Type Class






S O




S O



S O



S O

RAN_VOICE_TRUSTED


Enable, Disable, True, False, 1, 0.

S O



Type Class



MML commands/API callsRan ran = pop.NewRan();ran.Set (true, ranName, true, popIdValue, true, ranTypeOption, true, protocolTypeValue, true, ranFlagType, true, ranEnableOption, true, ranPortValue, true, ranCommandPortValue, true, regionIdValue);ran.SetITF ( true, ranITFIPAddress, true, ranITFIPNetMask, true, ranItfSecret, true, ranITFFlags );ran.SetVoice( true, ranVoiceProtocol, true, ranVoiceMakeCall, true, ranVoiceAnswerCall, true, ranVoiceGatewayRegister, true, ranVoiceRegPort, true, ranLrqEndpointType, true, ranLrqEndpointPort, true, ranVoiceTrustedOption, true, ranVoiceSupportIsupTimeOption);

Output parameters


ALCATEL_CCE_MODIFY_RAN_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_CCE_MODIFY_RAN_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM




S O



S O

RAN_LRQ_ENDPPOINT_PORT


S O



Type Class



A_A5020-VOIP_3-01_MOD_RAN-RBRolls back a modified Remote Area Node. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.CCEProvisioning.modRanRB.

Table 16: A_A5020-VOIP_3-01_MOD_RAN-RB


Type Class


S R


S O


S O


S O


S O


S O



RAN_NAME The Remote Area Node name. Either RAND or RAN_NAME must be used as a key.

S O

OLD_RAN_TYPE The former RAN type. RanTypeMAX4000, RanTypeMAXINT, RanTypeSHIVA, RanTypePM, RanTypeCISCO, RanTypeDANA2100, R100, RanTypeTUNNELSERVER, RanTypeREDBACK, RanTypeAssured, RanTypeMAX6000, RanTypeSHASTA5000, RanType3COM, RanTypeUNISPHERE, RanTypeVIRTUALRAN

S O

OLD_RAN_ENABLE This parameter enabled or disabled the GW.

S O

OLD_RAN_PORTS The previous number of ports the GW had.

S O

OLD_RAN_REGIONID

The previous region that used the Region Iterator.

S O

OLD_RAN_FLAG_TRUSTED

The previous RAN trusted flag.

S O

OLD_RAN_FLAG_DOWNLOAD_IP_POOLS

The previous RAN download IP pools flag.

S O

OLD_RAN_FLAG_DOWNLOAD_IP_ROUTES

The previous RAN download IP routes flag.

S O



Type Class



OLD_RAN_FLAG_DOWNLOAD_IPX_ROUTES

The previous RAN download IPX routes flag.

S O

OLD_RAN_FLAG_DOWNLOAD_PERM_CONNECTIONS

The previous RAN download permanent connection flag.

S O

OLD_RAN_FLAG_DOWNLOAD_FRAMED_PROFILES

The previous RAN download framed profile flag.

S O

OLD_RAN_FLAG_HEARTBEAT_SUPPORT

The previous RAN heartbeat support flag.

S O

OLD_RAN_COMMAND_PORT

The previous port used if there was a disconnect in some of the GWs.

S O

OLD_RAN_PROTOCOL_TYPE

The previous RADIUS protocol used.

S O

OLD_RAN_ITF_IP_ADDRESS

The previous IP address used if the GW had more than one physical interface with the NE.


C O

OLD_RAN_ITF_IP_NETMASK

The previous netmask. S O

OLD_RAN_ITF_SECRET

The previous shared secret used to encrypt all communication between the GW and the proxy.

S O

OLD_RAN_ITF_FLAGS

The previous IPNG protocol flag.

S O



Type Class



OLD_RAN_VOICE_PROTOCOL

The previous protocol, either H323 and SIP protocols.

S O

OLD_RAN_VOICE_PREGRANTED_ARQ_MAKECALL

The previous pregranted options when the protocol was set to H323.

S O

OLD_RAN_VOICE_PREGRANTED_ARQ_ANSWERCALL

The previous pregranted options when the protocol was set to H323.

S O

OLD_RAN_VOICE_GATEWAY_REGISTERS

Enabled the register, if necessary.

S O

OLD_RAN_VOICE_REGISTRATION_PORT

The previous signalling port number.

S O

OLD_RAN_VOICE_TRUSTED

The previous voice trusted usage flag.

S O

OLD_RAN_VOICE_SUPPORT_ISUP_MIME

The previous voice support ISUP time flag.

S O

OLD_RAN_LRQ_ENDPOINT_TYPE

The previous RAN_LRQ_ENDPOINT_TYPE value. If using a:Real gateway, the value needs to be NotLRQEndPoint; H323 gatekeeper with no token, use the LRQEndPointNoToken; H323 gatekeeper with token, use the LRQEndPointToken.

S O



Type Class



MML commands/API callsRan ran = pop.NewRan();ran.Set (true, ranName, true, popIdValue, true, ranTypeOption, true, protocolTypeValue, true, ranFlagType, true, ranEnableOption, true, ranPortValue, true, ranCommandPortValue, true, regionIdValue);ran.SetITF ( true, ranITFIPAddress, true, ranITFIPNetMask, true, ranItfSecret, true, ranITFFlags );ran.SetVoice( true, ranVoiceProtocol, true, ranVoiceMakeCall, true, ranVoiceAnswerCall, true, ranVoiceGatewayRegister, true, ranVoiceRegPort, true, ranLrqEndpointType, true, ranLrqEndpointPort, true, ranVoiceTrustedOption, true, ranVoiceSupportIsupTimeOption);

Output parameters


ALCATEL_CCE_ADD_RAN_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_CCE_ADD_RAN_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

For a successful ASDL, RAN_ID is added as CSDL parameters to the SARM table TBL_SRQ_PARM.

A_A5020-VOIP_3-01_QRY_ALL-RANSQueries all RANS related to a particular POP. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.CCEProvisioning.qryAllRans.

OLD_RAN_LRQ_ENDPPOINT_PORT

The previous RAS port used in case of an LRQ endpoint.

S O

Table 17: A_A5020-VOIP_3-01_QRY_ALL-RANS


Type Class


S R



Type Class



MML commands/API callsPop pop = telcoVpn.GetGlobalPop();RanIterator ranIterator = pop.GetRans();BaseListItem ranList[] = ranIterator.ListItems();for ( int count=0; count<ranList.length; count++ ) { Ran ran = telcoVpn.OpenRan(ranIdValue); IntHolder ranIdHolder = new IntHolder(); StringHolder ranNameHolder = new StringHolder(); IntHolder popIdHolder = new IntHolder(); enumRanTypeHolder ranTypeHolder = new enumRanTypeHolder(); IntHolder protocolTypeHolder = new IntHolder(); RanFlagsSeqHolder ranFlagsHolder = new RanFlagsSeqHolder(); BooleanHolder ranEnableHolder = new BooleanHolder(); IntHolder ranPortsHolder = new IntHolder(); IntHolder ranCommandPortHolder = new IntHolder(); IntHolder regionIdHolder = new IntHolder(); ran.Get(ranIdHolder, ranNameHolder, popIdHolder, ranTypeHolder, protocolTypeHolder, ranFlagsHolder, ranEnableHolder, ranPortsHolder, ranCommandPortHolder, regionIdHolder);}}

Output parameters


ALCATEL_CCE_QUERY_ALL_RANS_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_CCE_QUERY_ALL_RANS_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

Upon a successful query with a record found, the following is returned as an INFO parameter into TBL_INFO_PARM:


S O


S O

Table 17: A_A5020-VOIP_3-01_QRY_ALL-RANS


Type Class



RAN.(n).RAN_IDRAN.(n).RAN _NAMERAN.(n).RAN_TYPERAN.(n).RAN_ENABLERAN.(n).RAN_PORTSRAN.(n).RAN_REGIONIDRAN.(n).RAN_DOWNLOAD_IP_POOLSRAN.(n).RAN.DOWNLOAD_IP_ROUTESRAN.(n).RAN_DOWNLOAD_IPX_ROUTESRAN.(n).RAN_DOWNLOAD_PERM_CONNECTIONSRAN.(n).RAN_DOWNLOAD_FRAMED_PROFILESRAN.(n).RAN_HEARTBEAT_SUPPORTRAN.(n).RAN_NOT_REQUIRED_TO_REGISTERRAN.(n).RAN_TRUSTEDRAN.(n).RAN_COMMAND_PORTRAN.(n).RAN_PROTOCOL_TYPERAN.(n).RAN_ITF_IP_ADDRESSRAN.(n).RAN_ITF_IP_NETMASKRAN.(n).RAN_ITF_SECRETRAN.(n).RAN_ITF_FLAGS_IPNGRAN.(n).RAN_VOICE_PROTOCOLRAN.(n).RAN_VOICE_PREGRANTED_ARQ_MAKECALLRAN.(n).RAN_VOICE_PREGRANTED_ARQ_ANSWERCALLRAN.(n).RAN_VOICE_GATEWAY_REGISTERSRAN.(n).RAN_VOICE_REGISTRATION_PORTRAN.(n).RAN_LRQ_ENDPOINT_TYPERAN.(n).RAN_LRQ_ENDPOINT_PORT

A_A5020-VOIP_3-01_QRY_POPModifies the POP. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.CCEProvisioning.qryPop.

Table 18: A_A5020-VOIP_3-01_QRY_POP


Type Class


S R


S O



MML commands/API callsPop globalPop = telcoVpn.GetGlobalPop(); Pop pop = globalPop.OpenPop(popID); IntHolder popIdHolder = new IntHolder();

StringHolder popNameHolder = new StringHolder(); IntHolder popParentIdHolder = new IntHolder(); enumPopTypeHolder popTypeHolder = new enumPopTypeHolder();

pop.Get ( popIdHolder, popNameHolder, popParentIdHolder, popTypeHolder );

Output parameters

If the work order is not successful or no records are returned by the query, the method returns:

ALCATEL_CCE_QUERY_POP_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_CCE_QUERY_POP_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

Upon a successful query with a record found, the following is returned as an INFO parameter into TBL_INFO_PARM and SARM table:POP_IDPOP_NAMEPOP_TYPEPOP_PARENT_POP_ID


S O

Table 18: A_A5020-VOIP_3-01_QRY_POP


Type Class



A_A5020-VOIP_3-01_QRY_RANQueries the Remote Area Node. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.CCEProvisioning.qryRan.

MML commands/API callsRan ran = telcoVpn.OpenRan(ranIdValue); IntHolder ranIdHolder = new IntHolder(); StringHolder ranNameHolder = new StringHolder(); IntHolder popIdHolder = new IntHolder(); enumRanTypeHolder ranTypeHolder = new enumRanTypeHolder();

Table 19: A_A5020-VOIP_3-01_QRY_RAN


Type Class


S R


S O


S O


S O


S O



IntHolder protocolTypeHolder = new IntHolder(); RanFlagsSeqHolder ranFlagsHolder = new RanFlagsSeqHolder(); BooleanHolder ranEnableHolder = new BooleanHolder(); IntHolder ranPortsHolder = new IntHolder(); IntHolder ranCommandPortHolder = new IntHolder(); IntHolder regionIdHolder = new IntHolder(); ran.Get(ranIdHolder, ranNameHolder, popIdHolder, ranTypeHolder, protocolTypeHolder, ranFlagsHolder, ranEnableHolder, ranPortsHolder, ranCommandPortHolder, regionIdHolder);}

Output parameters


ALCATEL_CCE_QUERY_RAN_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.

ALCATEL_CCE_QUERY_RAN_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

Upon a successful query with a record found, the following is returned as an INFO parameter into TBL_INFO_PARM:RAN_IDRAN _NAMERAN_TYPERAN_ENABLERAN_PORTSRAN_REGIONIDRAN_DOWNLOAD_IP_POOLSRAN_DOWNLOAD_IP_ROUTESRAN_DOWNLOAD_IPX_ROUTESRAN_DOWNLOAD_PERM_CONNECTIONSRAN_DOWNLOAD_FRAMED_PROFILESRAN_HEARTBEAT_SUPPORTRAN_TRUSTEDRAN_SUPPORTED_ISUP_MIMERAN_COMMAND_PORTRAN_PROTOCOL_TYPERAN_ITF_IP_ADDRESS.(n)RAN_ITF_IP_NETMASKRAN_ITF_SECRETRAN_ITF_FLAGS_IPNGRAN_VOICE_PROTOCOLRAN_VOICE_PREGRANTED_ARQ_MAKECALLRAN_VOICE_PREGRANTED_ARQ_ANSWERCALLRAN_VOICE_GATEWAY_REGISTERSRAN_VOICE_REGISTRATION_PORTRAN_LRQ_ENDPOINT_TYPERAN_LRQ_ENDPOINT_PORT



NRE servicesThis cartridge provides the following ASDL commands:

A_A5020-VOIP_3-01_ADD_AAA-GROUPA_A5020-VOIP_3-01_ADD_AAA-SELECTION-RULEA_A5020-VOIP_3-01_ADD_AAA-SELECTION-RULE-RBA_A5020-VOIP_3-01_ADD_ROUTEA_A5020-VOIP_3-01_ADD_ROUTE-BLOCKA_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-PREFIXA_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-SUFFIXA_A5020-VOIP_3-01_ADD_ROUTE-CONFIGA_A5020-VOIP_3-01_ADD_VPNA_A5020-VOIP_3-01_DEL_AAA-GROUPA_A5020-VOIP_3-01_DEL_AAA-SELECTION-RULEA_A5020-VOIP_3-01_DEL_ROUTEA_A5020-VOIP_3-01_DEL_ROUTE-BLOCKA_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-PREFIXA_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-SUFFIXA_A5020-VOIP_3-01_DEL_ROUTE-CONFIGA_A5020-VOIP_3-01_DEL_VPNA_A5020-VOIP_3-01_MOD_AAA-GROUPA_A5020-VOIP_3-01_MOD_AAA-GROUP-RBA_A5020-VOIP_3-01_MOD_AAA-SELECTION-RULEA_A5020-VOIP_3-01_MOD_AAA-SELECTION-RULE-RBA_A5020-VOIP_3-01_MOD_ROUTEA_A5020-VOIP_3-01_MOD_ROUTE-BLOCKA_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-PREFIXA_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-PREFIX-RBA_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-RBA_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-SUFFIXA_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-SUFFIX-RBA_A5020-VOIP_3-01_MOD_ROUTE-CONFIGA_A5020-VOIP_3-01_MOD_ROUTE-CONFIG-ATTACH-VPNA_A5020-VOIP_3-01_MOD_ROUTE-CONFIG-DETACH-VPNA_A5020-VOIP_3-01_MOD_ROUTE-RBA_A5020-VOIP_3-01_MOD_VPN

NRE services


A_A5020-VOIP_3-01_MOD_VPN-RBA_A5020-VOIP_3-01_QRY_AAA-GROUPA_A5020-VOIP_3-01_QRY_AAA-SELECTION-RULEA_A5020-VOIP_3-01_QRY_ROUTEA_A5020-VOIP_3-01_QRY_ROUTE-BLOCKA_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-ALLA_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIXA_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIX-ALLA_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-SUFFIXA_A5020-VOIP_3-01_QRY_ROUTE-CONFIGA_A5020-VOIP_3-01_QRY_VPN

A_A5020-VOIP_3-01_ADD_AAA-GROUPAdds an AAA group. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.addAAAGroup.

Table 20: A_A5020-VOIP_3-01_ADD_AAA-GROUP


Type Class

MCLI The A5020 instance identifier, or NRE instance.

S R

VPN_NAME The VPN name identifier. Either VPN_ID or VPN_NAME must be used as a key.

S O

VPN_ID The VPN instance identifier. Either VPN_ID or VPN_NAME must be used as a key.

S O

AAA_GROUP_NAME The AAA group's name configuration.

S R



AAA_GROUP_ENABLE_ON_HOLD

The AAA group's mode, either "enabled" or "hold".

Enabled (default operation), OnHold (a user trying to access a VoIP AAA group that is on hold is rejected), Disabled (the selection criteria will not lead to this VoIP AAA group)

ENABLED

S O

AAA_GROUP_MAX_USER_SESSIONS

The maximum number of users per session. The default value is 0 (and means no per-user restrictions).

S O

AAA_GROUP_MAX_ACCOUNTING_RETRIES

The maximum number of retries available to an accounting request.

S O

AAA_GROUP_EXTERNAL

The type of connection to the A5020X server, either Internal (0) or External (1).

S O

AAA_GROUP_FAILURE_TO_START_SUPPORT_FLAG

This flag controls the group's failure to start message.

S O

AAA_GROUP_UNIDENTIFIED_ACCESS_FLAG

Enables or disables the flag that indicates support for this group's unidentified access.

S O

AAA_GROUP_PRE_AUTHENTICATION_ACCESS_ONLY_FLAG

Controls whether the group performs access checks.

S O

AAA_GROUP_INTERACTION_SUPPORT_FLAG

Enables the interaction support.

S O



Type Class

NRE services


AAA_GROUP_SUPPORT_ACCOUNTING_INTERIM_UPDATES_FLAG

Enables the radius to process interim updates.

S O

AAA_GROUP_SUPPORT_ACCESS_FAILED_TICKETS_FLAG

Enables proxy generated messages to be generated by access fail tickets that cause radius accounting stop packets. This feature can be enabled per VoIP AAA group.

S O

AAA_GROUP_SUPPORT_EAP_MESSAGE_START_FLAG

Enables EAP messages. S O

AAA_GROUP_MANDATORY_PORTSET_FLAG

Enables the call to be rejected when no port is defined in the POP or RAN.

S O

AAA_GROUP_STAGE2_AUTHENTICATION_FLAG

Enables two-stage authentication.

S O

AAA_GROUP_STAGE2_ACCOUNTING_FLAG

Enables two-stage accounting.

S O

AAA_GROUP_ACCOUNTING_ONLY_FLAG

Enables accounting validation.

S O

AAA_GROUP_AUTHENTICATION_PROTOCOL_TYPE

The protocol type, which is based on the AAA server currently in use.

S O

AAA_GROUP_AUTHENTICATION_RETRIES

The number of retries allowed during a connection timeout.

S O



Type Class



AAA_GROUP_ACCOUNTING_PROTOCOL_TYPE

The protocol type in use, based on the prevailing AAA server.

S O

AAA_GROUP_ACCOUNTING_RETRIES

The number of retries allowed during the connection timeout.

S O

AAA_GROUP_AUTHORISATION_DEFAULT_PORT_TYPE

The VoIP AAA group default port.

S O

AAA_GROUP_AUTHORISATION_PORT_TYPES

A list of the authorization port types.


C O

AAA_GROUP_BARRING_CLASS

The barring class used by the call screening server.

S O

AAA_GROUP_MAXIMUM_CONCURRENT_CALLS

The maximum concurrent calls per endpoint.

S O

AAA_GROUP_DIAL_IP_ADDRESS_PREFIX

This prefix value indicates that the dialed number is an IP address.

S O

AAA_GROUP_DIAL_UNREGISTERED_ENDPOINTS

Allows (1) or prevents (0) the dialing of unregistered endpoints by their IP address (only for terminal-to-terminal calls). By default this is allowed.

S O



Type Class

NRE services


AAA_GROUP_CALL_TRANSFER

Allows (1) or prevents (0) the call transfer service. By default this service is not allowed.

S O

AAA_GROUP_ALLOW_UNCONDITIONAL_FORWARDING_ACTIVATION

Allows (0) or prevents (1) unconditional forward activation

S O

AAA_GROUP_ALLOW_BUSY_FORWARD_ACTIVATION

Allows (0) or prevents (1) busy forward activation.

S O

AAA_GROUP_ALLOW_NOREPLY_FORWARD_ACTIVATION

Allows (0) or prevents (1) no reply forward activation.

S O

AAA_GROUP_TRIGGER_DESTINATION_AS_FOR_UNREGISTERED_USERS_METHOD

The AAA group's trigger destination method.

Register, Unregister, Admission

S O

AAA_GROUP_TRIGGER_DESTINATION_AS_FOR_UNREGISTERED_USERS_METHOD_TYPE

The AAA group's trigger destination method type.

NotAllowed (no authentication), Allowed (authenticate), CHAP login

S O

AAA_GROUP_H323_MAKE_CALL_PREGRANTED_ARQ

The value for making calls.

CallOff (No pre-granted ARQ), CallH323GKRoutedMode (only if H.323 GK in routed mode), CallH323GKDirectMode (only if H.323 GK in direct mode), CallAlways (pre-granted ARQ regardless of GK mode)

S O



Type Class



AAA_GROUP_H323_ANSWER_CALL_PREGRANTED_ARQ

The value for answering calls.


S O

AAA_GROUP_H323_CHECK_LOCATION_TOKEN

Determines whether the location token should be checked-in (1) or not (0). By default the location token is not checked.

S O

AAA_GROUP_H323_RIP_REGISTRATION

Identifies which H323 RIP message is sent to the server. By default no RIP messages are sent.

S O

AAA_GROUP_H323_RIP_UNREGISTRATION

The H323 RIP unregistration timeout in seconds.

S O

AAA_GROUP_H323_RIP_CALL_ADMISSION

The H323 RIP call admission timeout in seconds.

S O

AAA_GROUP_H323_TERMINAL_AUTHENTICATION_METHOD

The method of terminal authentication interface.


S O

AAA_GROUP_H323_TERMINAL_AUTHENTICATION_METHOD_TYPE

The type for terminal authentication interface.


S O



Type Class

NRE services


AAA_GROUP_H323_GATEWAY_AUTHENTICATION_METHOD

The method for gateway authentication interface.

S O

AAA_GROUP_H323_GATEWAY_AUTHENTICATION_METHOD_TYPE

The type for authentication interface.

NotAllowed, Allowed (authenticate)

S O

AAA_GROUP_H323_UPDATE_SETUP_ORIGIN

The H323 update setup origin.

S O

AAA_GROUP_H323_UPDATE_SETUP_DESTINATION

Determines whether to update the H323 setup.

S O

AAA_GROUP_H323_UPDATE_DISPLAY

Determines whether to update the H323 display.

S O

AAA_GROUP_TRIGGER_SIP_APPLICATION_SERVER

The value of trigger SIP application server.

S O

AAA_GROUP_SIP_ORIGIN_APPLICATION_SERVER

The server method, type, and service information for the application server.


C O



Type Class



AAA_GROUP_SIP_DESTINATION_APPLICATION_SERVER

The AAA group's SIP destination AS. It contains the server method, type, and service information about the application server.


C O

AAA_GROUP_SIP_CALL_APPLICATION_SERVER

Contains information on the AAA group's SIP call application server.


C O

AAA_GROUP_SIP_PROXY_LOCAL_DESTINATION

The SIP proxy local destination, either: stateful, stateless, or redirect.

S O

AAA_GROUP_SIP_PROXY_NON_LOCAL_DESTINATION

The proxy non local destination.

stateful or stateless S O

AAA_GROUP_SIP_TERMINAL_AUTHENTICATION_METHOD

The SIP terminal authentication method.

register, invite, subscribe, message, options, refer, and unknown

S O

AAA_GROUP_SIP_TERMINAL_AUTHENTICATION_METHOD_TYPE

The type of SIP terminal authentication method.

NotAllowed, AllowedNoAuthentication, AllowedWithAuthentication, CHAPLogin, HTTPDigest

S O



Type Class

NRE services


AAA_GROUP_SIP_HTTP_DIGEST_REALM

The realm string, which is used for the HTTP digest.

S O

AAA_GROUP_SIP_HTTP_DIGEST_TIMEOUT

The length of time this one-time instance stays valid.

S O

AAA_GROUP_SIP_GATEWAY_AUTHENTICATION_METHOD

The gateway authentication method.

invite or unknown S O

AAA_GROUP_SIP_GATEWAY_AUTHENTICATION_METHOD_TYPE

The gateway authentication method type.


S O

AAA_GROUP_CFA_ENABLE

Enables the service for this group.

S O

AAA_GROUP_CFA_PREFIX

Enables the service for this type.

S O

AAA_GROUP_CFA_LANGUAGE_INDICATOR

A number indicating the language.

S O

AAA_GROUP_CFA_DEFAULT_ANNOUNCEMENT

The default announcement code.

S O

AAA_GROUP_IVR_IP_ADDRESS

The IVR's IP address. S O

AAA_GROUP_IVR_PORT

The IVR's port value. S O

AAA_GROUP_AAA_SERVER_NAME_1

The AAA server name. S O

AAA_GROUP_AAA_SERVER_ID_1

The AAA server ID. S O



Type Class



MML commands/API callsVoIPAAAGroup aaaGroup = telcoVpn.NewVoIPAAAGroup ();aaaGroup.Set ( setName, groupName, setEnableOnHold, enableOnHoldType, setMaxUsers, maxUserSessionsValue, setdubiousTimeout, dubiousSessionTimeout, setMaxAccountRetries, maxAccountRetryValue, setAAAFlags, realAAAGroupFlags );aaaGroup.SetAuthentication ( setAuthProtocolType, authProtocolTypeValue, setAuthRetries, authRetriesValue );aaaGroup.SetAccounting ( setAccountProtocolType, accountProtocolTypeValue, setAccountRetries, accountRetriesValue );aaaGroup.SetPortAuthorisation (setAuthDefaultPortType,authDefaultPortTypeValue , setAuthPortTypes,portTypes );aaaGroup.SetVoIPCFA ( setCfaEnable, cfaEnableOption, setIvrIpAddress, ivrAddressList, setIvrPort, ivrPortValue,setCfaPrefix,cfaPrefix,setCfaLangIndicator,cfaLangIndicatorValue, setCfaDefaultAnnouncement, cfaDefaultAnnouncement );

AAA_GROUP_AAA_SERVER_TYPE_1

The AAA server type. Authentication, Accounting

S O

AAA_GROUP_AAA_SERVER_PRIORITY_1

The AAA server priority.

S O

AAA_GROUP_AAA_SERVER_STAGE_1

The AAA server stage. S O


The AAA server name. S O


The AAA server ID. S O


The AAA server type. Authentication, Accounting

S O


The AAA server priority.

S O


The AAA server stage. S O



Type Class

NRE services


Output parameters


ALCATEL_NRE_ADD_AAA_GROUP_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_ADD_AAA_GROUP_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

For a successful ASDL, AAA_GROUP_ID, is added as a CSDL parameter to the SARM table TBL_SRQ_PARM.

Compound parameter "PORTTYPES"

The compound parameter PORTTYPES will contain an indefinite number of port type values.

Compound parameter "AAA_APPLICATION_SERVER"

The compound parameter AAA_APPLICATION_SERVER will contain a method, server name or server ID, and service information element parameter attributes.

Table 21: Compound Parameter "PORTTYPES"



PORT_TYPE.(n) O NUMBER Port Type, must be unique across the list.



In a modify context, to delete a particular instance, the method needs to be "UNSET_VALUE" and Server ID or Server Name is required.

Table 22: Compound Parameter "AAA_APPLICATION_SERVER"



AAA_APPLICATION_SERVER.METHOD

R STRING For normal Application Server the values allowed are: Register, Invite, Subscribe, Message, Options, Refer and Unknown.

For Terminal, the values allowed are: Register, Invite, Subscribe, Message, Options, Refer and Unknown.

For Gateway, the values allowed are Invite and Unknown.

Default is Unknown.

AAA_APPLICATION_SERVER.SERVER_NAME

O STRING Application Server Name.

Either Application Server Name or Application Server ID is required.

AAA_APPLICATION_SERVER.SERVER_ID

O STRING Application Server ID.

Either Application Server Name or Application Server ID is required.

AAA_APPLICATION_SERVER.SERVICEINFO

O STRING

NRE services


A_A5020-VOIP_3-01_ADD_AAA-SELECTION-RULEAdds an AAA selection rule. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.addAAASelectionRule.

Table 23: A_A5020-VOIP_3-01_ADD_AAA-SELECTION-RULE


Type Class


S R

USE_QUERY Flag to determine whether to use results of the query.

S O

AAA_SELECTION_VPN_ID

The VPN identifier. Either AAA_SELECTION_VPN_ID or AAA_SELECTION_VPN_NAME must be used as a key.

S O

AAA_SELECTION_VPN_NAME

The VPN name. Either AAA_SELECTION_VPN_ID or AAA_SELECTION_VPN_NAME must be used as a key.

S O

AAA_SELECTION_AAA_GROUP_NAME

The AAA group name. Either AAA_SELECTION_AAA_GROUP_ID or AAA_SELECTION_AAA_GROUP_ID must be used as a key.

S O

AAA_SELECTION_RULE_NUMBER

The name of the subject AAA group. The value of 1 means place at start of rules. This rule number is not relative to the AAA group.

S O



AAA_SELECTION_ENABLE_FLAG

Enables or disables this rule. A disabled rule is not considered in AAA selection.

S O

AAA_SELECTION_AAA_GROUP_ID

The AAA group identification. Either AAA_SELECTION_AAA_GROUP_ID or AAA_SELECTION_AAA_GROUP_ID must be used as a key.

S O

AAA_SELECTION_METHOD

The AAA group selection method.

Any, H323Any, H323Registration, H323Admission, SipAny, SipInvite, SipSubscribe, SipMessage, SipOptions, SipRefer

S O

AAA_SELECTION_ORIGIN_MASK

Describes the mask in which the origin must fit so that it can select the correct AAA group. This mask can be based on the user name or calling party E.164 number

S O

AAA_SELECTION_ORIGIN_START_ADDRESS

Enter the lowest IP address in the range you are defining. Either Address, RAN, POP or Gatekeeper will be used as the ORIGIN selector, the other parameters should not be set otherwise.

S O

AAA_SELECTION_ORIGIN_END_ADDRESS

Enter the highest IP address in the range you are defining.

S O



Type Class

NRE services


AAA_SELECTION_ORIGIN_RAN_ID

The AAA selection originating RAN ID. Either AAA_SELECTION_ORIGIN_RAN_ID or AAA_SELECTION_ORIGIN_RAN_NAME must be used as a key.

S O

AAA_SELECTION_ORIGIN_RAN_NAME

The AAA selection originating RAN name. Either AAA_SELECTION_ORIGIN_RAN_ID or AAA_SELECTION_ORIGIN_RAN_NAME must be used as a key.

S O

AAA_SELECTION_ORIGIN_POP_ID

The AAA selection originating POP ID. Either AAA_SELECTION_ORIGIN_POP_ID or AAA_SELECTION_ORIGIN_POP_NAME must be used as a key.

S O

AAA_SELECTION_ORIGIN_POP_NAME

The AAA selection originating POP name. Either AAA_SELECTION_ORIGIN_POP_ID or AAA_SELECTION_ORIGIN_POP_NAME must be used as a key.

S O



Type Class



AAA_SELECTION_ORIGIN_EXTERNAL_GATEKEEPER_NAME

The AAA selection originating external gatekeeper name. Either _GATEKEEPER_NAME or _GATEKEEPER_ID must be used as a key. Either Address, RAN, POP or Gatekeeper will be used as the ORIGIN selector, the other parameters should not be set otherwise.

S O

AAA_SELECTION_ORIGIN_EXTERNAL_GATEKEEPER_ID

The AAA selection originating external gatekeeper ID. Either _GATEKEEPER_NAME or _GATEKEEPER_ID must be used as a key. Either Address, RAN, POP or Gatekeeper will be used as the ORIGIN selector, the other parameters should not be set otherwise.

S O

AAA_SELECTION_DESTINATION_MASK

The mask in which the destination must fit to correctly select the AAA group. This mask can be based on the user name or called party E.164 number.

S O

AAA_SELECTION_DESTINATION_START_ADDRESS

The lowest IP address in the range that you are defining for the called IP address.

S O



Type Class

NRE services


MML command/API callsVoIPAAASelectionRule selectionRule = sessionTelco.NewVoIPAAASelectionRule();selectionRule.Set (setRuleNumber, ruleNumberValue, setEnableFlag, enableFlagOption, setaaaGroupId, aaGroupIdValue, setSelectionMethod, ruleMethod, setOriginMask, originMask, setOriginAddress, originAddress, setDestMask, destinationMask, setDestStartAddress, startIpAddress, setDestEndAddress, endIpAddress);

Output parameters


ALCATEL_NRE_ADD_AAA_SELECTION_RULE_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_ADD_AAA_SELECTION_RULE_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

For a successful ASDL, AAA_GROUP_ID and SELECTION_RULE_ID, are saved as CSDL parameters to the SARM table TBL_SRQ_PARM.

AAA_SELECTION_DESTINATION_END_ADDRESS

The highest IP address in the range that you are defining for the called IP address.

S O

AAA_SELECTION Multiple instances of AAA selections can be used here. This compound parameter takes precedence over the scalar parameter.


C O

OLD_AAA_SELECTION

Multiple instances of AAA selections can be used here.


C O



Type Class



Compound parameter "AAA_SELECTION"

The compound parameter AAA_SELECTION_RULE will contain attributes associated with the AAA Selection Rules.

Table 24: Compound Parameter "AAA_SELECTION"



AAA_SELECTION.(n).AAA_GROUP_NAME

O STRING Name of the AAA group.

AAA_SELECTION.(n).AAA_GROUP_ID

O NUMBER The AAA group instance ID.

AAA_SELECTION.(n).VPN_NAME

O STRING VPN Name.

AAA_SELECTION.(n).VPN_ID

O NUMBER VPN ID.

AAA_SELECTION.(n).RULE_NUMBER

O NUMBER Priority sequence of this rule.

AAA_SELECTION.(n).RULE_ID

O NUMBER Selection rule database ID.

AAA_SELECTION.(n).ENABLE_FLAG

O STRING Enable or disable the rule. A disabled rule is not considered in AAA selection.

AAA_SELECTION.(n).METHOD

O STRING Method of the AAA selection.

AAA_SELECTION.(n).ORIGIN_MASK

O STRING Origin mask can be based on the user name or calling party E.164 number.

AAA_SELECTION.(n).ORIGIN_START_ADDRESS

O STRING Start IP address to define a range that must contain the calling IP address.

AAA_SELECTION.(n).ORIGIN_END_ADDRESS

O STRING End IP address to define a range that must contain the calling IP address.

NRE services


AAA_SELECTION.(n).ORIGIN_RAN_NAME

O STRING Name of the RAN used to filter as the ORIGIN.

AAA_SELECTION.(n).ORIGIN_RAN_ID

O NUMBER ID of the RAN used to filter as the ORIGIN.

AAA_SELECTION.(n).ORIGIN_ POP_NAME

O STRING Name of the RAN used to filter as the ORIGIN.

AAA_SELECTION.(n).ORIGIN_ POP_ID

O NUMBER ID of the RAN used to filter as the ORIGIN.

AAA_SELECTION.(n).ORIGIN_EXTERNAL_GATEKEEPER_NAME

O STRING Name of the External Gatekeeper used to filter as the ORIGIN.

AAA_SELECTION.(n).ORIGIN_EXTERNAL_GATEKEEPER_ID

O NUMBER ID of the External Gatekeeper used to filter as the ORIGIN.

AAA_SELECTION.(n).DESTINATION_MASK

O STRING Mask in which the destination must fit to select this VoIP AAA group. This mask can be based on the user name or called party E.164 number.

AAA_SELECTION.(n).DESTINATION_START_ADDRESS

O STRING Lower IP address to define a range that must contain the called IP address.

AAA_SELECTION.(n).DESTINATION_END_ADDRESS

O STRING Upper IP address to define a range that must contain the called IP address.

Table 24: Compound Parameter "AAA_SELECTION"





A_A5020-VOIP_3-01_ADD_AAA-SELECTION-RULE-RBRolls back the addition of an AAA selection rule. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.addAAASelectionRuleRB.

Table 25: A_A5020-VOIP_3-01_ADD_AAA-SELECTION-RULE-RB


Type Class


S R

OLD_AAA_SELECTION_VPN_ID

The previous VPN identifier.

S O

OLD_AAA_SELECTION_VPN_NAME

The previous VPN name.

S O

OLD_AAA_SELECTION_AAA_GROUP_NAME

The previous AAA group name.

S O

OLD_AAA_SELECTION_RULE_NUMBER

The previous name of the subject AAA group.

S O

OLD_AAA_SELECTION_ENABLE_FLAG

The previous flag to enable or disable this rule.

S O

OLD_AAA_SELECTION_AAA_GROUP_ID

The previous AAA group identification.

S O

OLD_AAA_SELECTION_METHOD

The previous AAA group selection method.

S O

OLD_AAA_SELECTION_ORIGIN_MASK

The previous mask in which the origin must fit so that it can select the correct AAA group.

S O

OLD_AAA_SELECTION_ORIGIN_START_ADDRESS

The previous lowest IP address in the range you are defining.

S O

NRE services


OLD_AAA_SELECTION_ORIGIN_END_ADDRESS

The previous highest IP address in the range you are defining.

S O

OLD_AAA_SELECTION_ORIGIN_RAN_ID

The previous AAA selection originating RAN ID.

S O

OLD_AAA_SELECTION_ORIGIN_RAN_NAME

The previous AAA selection originating RAN name.

S O

OLD_AAA_SELECTION_ORIGIN_POP_ID

The previous AAA selection originating POP ID.

S O

OLD_AAA_SELECTION_ORIGIN_POP_NAME

The previous AAA selection originating POP name.

S O

OLD_AAA_SELECTION_ORIGIN_EXTERNAL_GATEKEEPER_NAME

The previous AAA selection originating external gatekeeper name.

S O

OLD_AAA_SELECTION_ORIGIN_EXTERNAL_GATEKEEPER_ID

The previous AAA selection originating external gatekeeper ID.

S O

OLD_AAA_SELECTION_DESTINATION_MASK

The previous mask in which the destination must fit to correctly select the AAA group.

S O

OLD_AAA_SELECTION_DESTINATION_START_ADDRESS

The previous lowest IP address in the range that you are defining for the called IP address.

S O



Type Class




Output parameters


ALCATEL_NRE_ADD_AAA_SELECTION_RULE_RB_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_ADD_AAA_SELECTION_RULE_RB_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

For a successful ASDL, AAA_GROUP_ID and SELECTION_RULE_ID are saved as CSDL parameters to the SARM table TBL_SRQ_PARM.

OLD_AAA_SELECTION_DESTINATION_END_ADDRESS

The previous highest IP address in the range that you are defining for the called IP address.

S O

OLD_AAA_SELECTION

The previous multiple instances of AAA selections.


C O



Type Class

NRE services


A_A5020-VOIP_3-01_ADD_ROUTEAdds a route. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.addRoute.

Table 26: A_A5020-VOIP_3-01_ADD_ROUTE


Type Class


S R

ROUTE_NAME The route's name. S R

ROUTE_TYPE The type of routing algorithm.

Carrier via GW (VoIPRouteCarrierViaGW), External Gateway (VoIPRouteITSP), Route to EP (VoIPRouteToEP)

S R

ROUTE_CARRIER_PREFIX

The prefix that identifies the route's carrier. Valid only if ROUTE_TYPE is Carrier via GW.

S O

ROUTE_ITSPLD The parameter that identifies the multiple GateKeeper. Valid only if ROUTE_TYPE is External Gateway.

S O

ROUTE_ENDPOINT_ADDRESS

The IP address for the route's endpoint. Valid only if ROUTE_TYPE is Endpoint.

S O

ROUTE_ENDPOINT_PORT

The IP port for the route's endpoint. Valid only if ROUTE_TYPE is Endpoint.

S O



MML command/API callsenumVoIPRouteType voIPType;

VoIPRouteHolder voIPRouteHolder = new VoIPRouteHolder(); VoIPRoute voipRoute = VoIPRouteHelper.narrow(voIPRouteHolder.value);

voipRoute = sessiontelco.NewVoIPRoute(); RouteDetail routeDetail = new RouteDetail();

int routeItspldValue;

if ( routeType.equalsIgnoreCase("VoIPRouteCarrierViaGW") ) { voIPType = enumVoIPRouteType.VoIPRouteCarrierViaGW; routeDetail.carrierPrefix(routeCarrierPrefix); voipRoute.Set(addParam,routeName, true, routeOdp, true, routeGwPopValue, true, routeDetail );

} else if ( routeType.equalsIgnoreCase ("VoIPRouteITSP" ) ) {

routeItspldValue = getIntValue ( routeItspld ); voIPType = enumVoIPRouteType.VoIPRouteITSP; routeDetail.externalGkPxId (routeItspldValue );

ROUTE_ENDPOINT_TYPE

The route's endpoint type. Valid only if ROUTE_TYPE is Endpoint.

S O

ROUTE_ODP The route's Output Digit Preparation.

S O

ROUTE_GW_POP_RAN_NAME

The Gateway POP or RAN name to which this route is associated. It references the NE table that is populated in the CCE. Either ROUTE_GW_POP_RAN_ID or NAME is accepted, ID takes precedence.

S O

Table 26: A_A5020-VOIP_3-01_ADD_ROUTE


Type Class

NRE services


voipRoute.Set(addParam,routeName, true, routeOdp, true, routeGwPopValue, true, routeDetail);

} else if ( routeType.equalsIgnoreCase("VoIPRouteToEP") ) {

voIPType = enumVoIPRouteType.VoIPRouteToEP; enumEndpointType endPointType = null;

if ( routeEndpointType.equalsIgnoreCase("EndpointTypeH323" ) ) { endPointType = enumEndpointType.EndpointTypeH323; } else if ( routeEndpointType.equalsIgnoreCase("EndpointTypeSIP" ) ) { endPointType = enumEndpointType.EndpointTypeSIP; }

RouteDetailEndPoint endpointDetail = new RouteDetailEndPoint(endPointType, ipAddress, routeEndpointPortValue ); routeDetail.endPoint( endpointDetail ); voipRoute.Set(addParam,routeName, true, routeOdp, true, routeGwPopValue, true, routeDetail); }

Output parameters


ALCATEL_NRE_ADD_ROUTE_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_ADD_ROUTE_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

For a successful ASDL, ROUTE_ID is saved as a CSDL parameter to the SARM table TBL_SRQ_PARM

A_A5020-VOIP_3-01_ADD_ROUTE-BLOCKAdds a route block. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.addRouteBlock.

Table 27: A_A5020-VOIP_3-01_ADD_ROUTE-BLOCK


Type Class


S R



ROUTE_BLOCK_NAME

The route block name. S R

ROUTE_CONFIG_ID The primary key identifier of the routing configuration. Either ROUTE_CONFIG_ID or ROUTE_CONFIG_NAME must be used as a key.

S O

ROUTE_CONFIG_NAME

The routing configuration name. Either ROUTE_CONFIG_ID or ROUTE_CONFIG_NAME must be used as a key.

S O

ROUTING_TYPE The routing type. Types include Priority or Weight. Up to 10 Priority type routings, or 5 Weight type routings can be defined.

S R

ROUTE_ID_1 The name, or identity, of route 1.

S O

ROUTE_WEIGHT_1 The probability that this route will be used.

S O


S O


S O


S O


S O



Type Class

NRE services


MML command/API callsVoIPRoutingConfigHolder voIPRoutingConfig = new VoIPRoutingConfigHolder();VoIPRoutingConfig voIPRouteConfig = VoIPRoutingConfigHelper.narrow(voIPRoutingConfig.value);

voIPRouteConfig = sessiontelco.OpenVoIPRoutingConfig(routeConfigId);voIPRouteBlock = voIPRouteConfig.NewVoIPRouteBlock();RouteBlockType routeBlockType;RouteBlockRoutes routeBlockRoutes = new RouteBlockRoutes();

if (routingType.equalsIgnoreCase("RouteBlockPriority" ) ) { routeBlockType = RouteBlockType.RouteBlockPriority; int[] routeIdValue = {Integer.parseInt(routeId)}; routeBlockRoutes.priorityRoutes(routeIdValue); } else if ( routingType.equalsIgnoreCase("RouteBlockWeighted" ) ) { routeBlockType = RouteBlockType.RouteBlockWeighted;


S O


S O


S O


S O


S O


S O


S O


S O


S O



Type Class



int routeIdValue = Integer.parseInt(routeId); short routeWeightValue = Short.parseShort(routeWeight); WeightedRoute[] weightRoute = {new WeightedRoute(routeIdValue,routeWeightValue) }; WeightedRouteListHolder weightRouteHolder = new WeightedRouteListHolder(weightRoute); routeBlockRoutes.weightedRoutes(weightRouteHolder.value); } enumRouteFallback routeFallbackString = enumRouteFallback.RouteFallbackNone; int clearingHouseId = 0;

voIPRouteBlock.Set(addParam, routeBlockName, addParam, routeFallbackString, addParam, clearingHouseId, addParam, routeBlockRoutes );

Output parameters


ALCATEL_NRE_ADD_ROUTEBLOCK_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.

ALCATEL_NRE_ADD_ROUTEBLOCK_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.\

For a successful ASDL, ROUTE_BLOCK_ID is saved as a CSDL parameter to the SARM table TBL_SRQ_PARM

A_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-PREFIXAdds a route block prefix. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.addRouteBlockPrefix.

Table 28: A_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-PREFIX


Type Class


S R

NRE services



S O

ROUTE_CONFIG_NAME

The name of the routing configuration. Either ROUTE_CONFIG_ID or ROUTE_CONFIG_NAME must be used as a key.

S O

ROUTE_BLOCK_ID The route block identifier's primary key. Either ROUTE_BLOCK_ID or ROUTE_BLOCK_NAME must be used as a key.

S O

ROUTE_BLOCK_NAME

The route block name. Either ROUTE_BLOCK_ID or ROUTE_BLOCK_NAME must be used as a key.

S O

ROUTE_BLOCK_START_PREFIX

The route block starting prefix mask. It can also be the entire number when there is an exact match.

S O

ROUTE_BLOCK_END_PREFIX

The route block end prefix mask. This is the end of the prefix for matching range.

S O

Table 28: A_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-PREFIX


Type Class



MML command/API callsVoIPRoutingConfig voIPRoutingConfig = sessiontelco.OpenVoIPRoutingConfig(routeConfigId );

int routeBlockIdValue = getIntValue ( routeBlockId );

VoIPRouteBlock voipRouteBlock = voIPRoutingConfig.OpenVoIPRouteBlock(routeBlockIdValue ); enumVoIPRoutingMatchType enumType = enumVoIPRoutingMatchType.VoIPRoutingMatchTypeE164Range; VoIPRoutingMatchE164Range voipRoutingE164Range = new VoIPRoutingMatchE164Range ( routeBlockStartPrefix, routeBlockEndPrefix );

VoIPRoutingMatch voipRoutingMatch = new VoIPRoutingMatch();

voipRoutingMatch.E164Range(voipRoutingE164Range ); voipRouteBlock.AddMatch ( voipRoutingMatch );

Output parameters


ALCATEL_NRE_ADD_ROUTEBLOCKPREFIX_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_ADD_ROUTEBLOCKPREFIX_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

A_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-SUFFIXAdds a route block suffix. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.addRouteBlockSuffix.

Table 29: A_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-SUFFIX


Type Class


S R

NRE services


MML command/API callsVoIPRoutingConfig voIPRoutingConfig = sessiontelco.OpenVoIPRoutingConfig(routeConfigId ); int routeBlockIdValue = getIntValue ( routeBlockId );


S O

ROUTE_CONFIG_NAME


S O


S O

ROUTE_BLOCK_NAME


S O

ROUTE_BLOCK_SUFFIX

The suffix mask used for this route block. The suffix identifies part of the domain that follows the @ character.

S O

Table 29: A_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-SUFFIX


Type Class



VoIPRouteBlock voipRouteBlock = voIPRoutingConfig.OpenVoIPRouteBlock(routeBlockIdValue ); enumVoIPRoutingMatchType enumType = numVoIPRoutingMatchType.VoIPRoutingMatchTypeUsernameSuffix; VoIPRoutingMatch voipRoutingMatch = new VoIPRoutingMatch(); voipRoutingMatch.UsernameSuffix(routeBlockSuffix ); voipRouteBlock.AddMatch ( voipRoutingMatch );

Output parameters


ALCATEL_NRE_ADD_ROUTEBLOCKSUFFIX_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_ADD_ROUTEBLOCKSUFFIX_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

A_A5020-VOIP_3-01_ADD_ROUTE-CONFIGAdds a route configuration. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.addRouteConfig.

Table 30: A_A5020-VOIP_3-01_ADD_ROUTE-CONFIG


Type Class


S R

ROUTE_CONFIG_NAME

The name of the routing configuration.

S R

VPN_ID Links the VPN_ID with the particular routing configuration. Either VPN_ID or VPN_NAME must be specified.

S O

VPN_NAME Links the VPN_NAME with the particular routing configuration. Either VPN_ID or VPN_NAME must be specified.

S O

NRE services


MML command/API callsVoIPRoutingConfigHolder voIPRouteHolder = new VoIPRoutingConfigHolder();VoIPRoutingConfig routeConfig = VoIPRoutingConfigHelper.narrow(voIPRouteHolder.value);

routeConfig = sessiontelco.NewVoIPRoutingConfig();routeconfig.Set(true, routeName);

Output parameters


ALCATEL_NRE_ADD_ROUTECONFIG_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_ADD_ROUTECONFIG_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

For a successful ASDL, ROUTE_CONFIG_ID is saved as a CSDL parameter to the SARM table TBL_SRQ_PARM

A_A5020-VOIP_3-01_ADD_VPNAdds a VPN. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.addVPN.

Table 31: A_A5020-VOIP_3-01_ADD_VPN


Type Class


S R

VPN_NAME The VPN name. S R

MAX_USERS The maximum number of users.

S O

ADMIN_ID The admin identification.

S O

MAX_SESSIONS The maximum number of sessions.

S O

DBLOG_STARTEXTSESS

The DB log proxy start external session.

None, Failed, All S O



DBLOG_ENDEXTSESS

The DB log proxy end external session.


DBLOG_STARTINTSESS

The DB log proxy start internal session.


DBLOG_ENDINTSESS

The DB log end internal session.


DBLOG_INTERIM_EXT

The DB proxy log interim external.


DBLOG_INTERIM_INT

The DB proxy log interim internal.


DBLOG_TUNNEL_EXT

The DB log tunnel external.


DBLOG_TUNNEL_INT

The DB log tunnel internal.


DBLOG_VENDOR_SPECIFIC

The DB log vendor specific.

True, False S O

CSVLOG_STARTEXTSESS

The CSV log proxy start external session.


CSVLOG_ENDEXTSESS

The CSV log end external session.


CSVLOG_STARTINTSESS

The CSV log start internal session.


CSVLOG_ENDINTSESS

The CSV log end internal session.


CSVLOG_INTERIM_EXT

The CSV log interim external.


CSVLOG_INTERIM_INT

The CSV log interim internal.


CSVLOG_TUNNEL_EXT

The CSV log tunnel external.




Type Class

NRE services


CSVLOG_TUNNEL_INT

The CSV log tunnel internal.


CSVLOG_VENDOR_SPECIFIC

The CSV vendor specific.

True, False S O

HOLIDAY Holiday.


C O

ACTIVATIONTIME_YEAR

Activation time year. S O

ACTIVATIONTIME_MONTH

Activation time month. S O

ACTIVATIONTIME_DAY

Activation time - day. S O

ACTIVATIONTIME_HOUR

Activation time - hour. S O

ACTIVATIONTIME_MINUTE

Activation time - minute.

S O

ACTIVATIONTIME_SECOND

Deactivation time - second.

S O

DEACTIVATIONTIME_YEAR

Deactivation time - year.

S O

DEACTIVATIONTIME_MONTH

Deactivation time - month.

S O

DEACTIVATIONTIME_DAY

Deactivation time - day. S O

DEACTIVATIONTIME_HOUR

Deactivation time - hour.

S O

DEACTIVATIONTIME_MINUTE

Deactivation time - minute.

S O



Type Class



MML command/API callsTelcoVPN telcoVpn = sessionTelco.NewTelcoVPN();

telcoVpn.SetGeneral( setVpnName, vpnName, true, currency, setMaxUsers, maxUsersValue, setMaxSessions, maxSessionsValue, false, dubiousIPTimeout, false, privatePools, false, HSPPools, setAdminId, adminIdValue, addParamFlag, payingAdminId );

telcoVpn.SetAccount(true, activationTime, false, deactivationTime, false, loginAllowedTimeId, false, specialPeriodId, true, onHold );

// DB Logging boolean setRadiusLogging = true; enumRadiusLogItem radiusLogging[] = {}; boolean setProxyLogStartSessionInternal = true; enumProxyLogType proxyLogStartSessionInternal = enumProxyLogType.ProxyLogNone; boolean setProxyLogStartSessionExternal = true; enumProxyLogType proxyLogStartSessionExternal = enumProxyLogType.ProxyLogNone; boolean setProxyLogEndSessionInternal = true; enumProxyLogType proxyLogEndSessionInternal = enumProxyLogType.ProxyLogNone; boolean setProxyLogEndSessionExternal = true; enumProxyLogType proxyLogEndSessionExternal = enumProxyLogType.ProxyLogNone;

DEACTIVATIONTIME_SECOND

Deactivation time - seconds.

S O

LOGIN_ALLOWED_TIMES

Login allowed times.


C O

SPECIAL_PERIODS Special periods.


C O

ONHOLD On hold. True, False S O



Type Class

NRE services


boolean setProxyLogInterimInternal = true; enumProxyLogType proxyLogInterimInternal = enumProxyLogType.ProxyLogFailed; boolean setProxyLogInterimExternal = true; enumProxyLogType proxyLogInterimExternal = enumProxyLogType.ProxyLogFailed; boolean setProxyLogTunnelInternal = true; enumProxyLogType proxyLogTunnelInternal = enumProxyLogType.ProxyLogAll; boolean setProxyLogTunnelExternal = true; enumProxyLogType proxyLogTunnelExternal = enumProxyLogType.ProxyLogAll; boolean setProxyLogVendorSpecific = false; boolean proxyLogVendorSpecific = false;

telcoVpn.SetDbLogging(setRadiusLogging, radiusLogging, setProxyLogStartSessionInternal, proxyLogStartSessionInternal, setProxyLogStartSessionExternal, proxyLogStartSessionExternal, setProxyLogEndSessionInternal, proxyLogEndSessionInternal, setProxyLogEndSessionExternal, proxyLogEndSessionExternal, setProxyLogInterimInternal, proxyLogInterimInternal, setProxyLogInterimExternal, proxyLogInterimExternal, setProxyLogTunnelInternal, proxyLogTunnelInternal, setProxyLogTunnelExternal, proxyLogTunnelExternal, setProxyLogVendorSpecific, proxyLogVendorSpecific);

// CSV Logging telcoVpn.SetCsvLogging(setRadiusLogging, radiusLogging, setProxyLogStartSessionInternal, proxyLogStartSessionInternal, setProxyLogStartSessionExternal, proxyLogStartSessionExternal, setProxyLogEndSessionInternal, proxyLogEndSessionInternal, setProxyLogEndSessionExternal, proxyLogEndSessionExternal, setProxyLogInterimInternal, proxyLogInterimInternal, setProxyLogInterimExternal, proxyLogInterimExternal, setProxyLogTunnelInternal, proxyLogTunnelInternal, setProxyLogTunnelExternal, proxyLogTunnelExternal, setProxyLogVendorSpecific, proxyLogVendorSpecific);

Output parameters


ALCATEL_NRE_ADD_VPN_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_ADD_VPN_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

For a successful ASDL, VPN_ID is saved as a CSDL parameter to the SARM table TBL_SRQ_PARM.



Compound parameter "HOLIDAY"

The compound parameter HOLIDAY will contain an indefinite number of dates.

Compound parameter "LOGIN_ALLOWED_TIMES"

The compound parameter LOGIN_ALLOWED_TIMES will contain an indefinite number of entries.

Table 32: Compound Parameter "HOLIDAY"



HOLIDAY.(n).YEAR O STRING Year format yyyy

HOLIDAY.(n).MONTH O STRING Month format mm

HOLIDAY.(n).DAY O STRING Day format dd

HOLIDAY.(n).HOUR O STRING Hour format hh

HOLIDAY.(n).MINUTE O STRING Minute format mm

HOLIDAY.(n).SECOND O STRING Second format ss

Table 33: Compound Parameter "LOGIN_ALLOWED_TIMES"



LOGIN_ALLOWED_TIMES.(n).NAME

O STRING Name for this special period.

Either Login Allowed Times Name or ID is required.

LOGIN_ALLOWED_TIMES.(n).ID

O NUMBER Identifier for this special period.


NRE services


Compound parameter "SPECIAL_PERIODS"

The compound parameter SPECIAL_PERIODS is used to provide special login periods. A unique name or ID is required per entry. Up to n entries are allowed per VPN.

LOGIN_ALLOWED_TIMES.(n).DAY.(m)

O STRING Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.

LOGIN_ALLOWED_TIMES.(n).START_HOUR

O STRING Hour format hh.

LOGIN_ALLOWED_TIMES.(n).START_MINUTE

O STRING Minute format mm.

LOGIN_ALLOWED_TIMES.(n).STOP_HOUR


LOGIN_ALLOWED_TIMES.(n).STOP_MINUTE


Table 34: Compound Parameter "SPECIAL_PERIODS"



SPECIAL_PERIODS.(n).NAME


Either Special Period Name or ID is required.

SPECIAL_PERIODS.(n).ID








A_A5020-VOIP_3-01_DEL_AAA-GROUPDeletes an AAA group. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.delAAAGroup.

SPECIAL_PERIODS.(n).START_DAY


SPECIAL_PERIODS.(n).END_DAY


SPECIAL_PERIODS.(n).MONTH

O NUMBER Valid values: 1-12.

SPECIAL_PERIODS.(n).YEAR

O NUMBER Year format xxxx.

SPECIAL_PERIODS.(n).LOGINTIMESNAME

O STRING Name of associated Login Times.

Either Login Times Name or ID is required.

SPECIAL_PERIODS.(n).LOGINTIMESID



Table 35: A_A5020-VOIP_3-01_DEL_AAA-GROUP


Type Class


S R




NRE services


MML command/API callsVoIPAAAGroup aaaGroup = telcoVpn.OpenVoIPAAAGroup (AAAGroupID);AaaGroup.Delete();

Output parameters


ALCATEL_NRE_DELETE_AAA_GROUP_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_DELETE_AAA_GROUP_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM


S O


S O

AAA_GROUP_NAME The AAA group name. Either AAA_GROUP_ID or AAA_GROUP_NAME must be used as a key.

S O

AAA_GROUP_ID The AAA group identification. Either AAA_GROUP_ID or AAA_GROUP_NAME must be used as a key.

S O

Table 35: A_A5020-VOIP_3-01_DEL_AAA-GROUP


Type Class



A_A5020-VOIP_3-01_DEL_AAA-SELECTION-RULEDeletes an AAA selection rule. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.delAAASelectionRule.

Table 36: A_A5020-VOIP_3-01_DEL_AAA-SELECTION-RULE


Type Class


S R


S O


The AAA group ID. Either GROUP_ID or GROUP_NAME and the SELECTION_RULE_NUMBER, must be used as a key. The SELECTION_RULE_ID can be used as a key by itself.

S O


The AAA group name. Either GROUP_ID or GROUP_NAME and the SELECTION_RULE_NUMBER, must be used as a key. The SELECTION_RULE_ID can be used as a key by itself.

S O


The VPN identifier. Either VPN_ID or VPN_NAME must be used as a key.

S O

NRE services



The VPN name. Either VPN_ID or VPN_NAME must be used as a key. If using RAN or POP or External Gatekeeper Names, then VPN is required.

S O

AAA_SELECTION_RULE_ID

The AAA selection rule identification. Either AAA_GROUP_ID or NAME, and the SELECTION_RULE_NUMBER must be used as a key; SELECTION_RULE_ID can be used by itself. If both RULE_ID and RULE_NAME are used, an error results.

S O


Priority sequence of the rule within an AAA group. Either AAA_GROUP_ID or NAME, and the SELECTION_RULE_NUMBER must be used as a key; SELECTION_RULE_ID can be used by itself. If not set, rule is placed at start of sequence of rules.

S O

AAA_SELECTION Multiple instances of AAA selections can be used here.


C O



Type Class



MML command/API callsVoIPAAASelectionRule selectionRule = sessionTelco.OpenVoIPAAASelectionRule(selectionRuleId); selectionRule.Delete();

Output parameters


ALCATEL_DELETE_AAA_SELECTION_RULE_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_DELETE_AAA_SELECTION_RULE_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

A_A5020-VOIP_3-01_DEL_ROUTERemoves an existing route. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.deleteRoute.

OLD_AAA_SELECTION

Multiple instances of AAA selections can be used here. This compound parameter takes precedence over the scalar parameter.


C O

Table 37: A_A5020-VOIP_3-01_DEL_ROUTE


Type Class


S R



Type Class

NRE services












ROUTE_ID The route's primary identification key. Either ROUTE_ID or ROUTE_NAME must be used as a key.

S O

ROUTE_NAME The route's name. Either ROUTE_ID or ROUTE_NAME must be used as a key.

S O

Table 37: A_A5020-VOIP_3-01_DEL_ROUTE


Type Class





Once voipRoute entity is accessed, it is to be deleted via VoipRoute.delete()

Output parameters


ALCATEL_NRE_DELETE_ROUTE_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_DELETE_ROUTE_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM

A_A5020-VOIP_3-01_DEL_ROUTE-BLOCKRemoves the route block. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.deleteRouteBlock.

Table 38: A_A5020-VOIP_3-01_DEL_ROUTE-BLOCK


Type Class


S R


S O

NRE services








ROUTE_BLOCK_NAME


S O


S O

ROUTE_CONFIG_NAME

The the routing configuration name. Either ROUTE_CONFIG_ID or ROUTE_CONFIG_NAME must be used as a key.

S O

Table 38: A_A5020-VOIP_3-01_DEL_ROUTE-BLOCK


Type Class









Once route block object is retrieved, call delete() on it, instead of set().voIPRouteBlock.Delete();

Output parameters


ALCATEL_NRE_DELETE_ROUTEBLOCK_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_DELETE_ROUTEBLOCK_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

NRE services


A_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-PREFIXRemoves the route block prefix. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.deleteRouteBlockPrefix.

Table 39: A_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-PREFIX


Type Class


S R

ROUTE_CONFIG_ID The primary key identifier of the routing configuration. Either ROUTE_CONFIG_ID or ROUTE_BLOCK_NAME must be used as a key.

S O

ROUTE_CONFIG_NAME


S O


S O

ROUTE_BLOCK_NAME


S O



MML command/API callsVoIPRoutingConfig voIPRoutingConfig = sessiontelco.OpenVoIPRoutingConfig(routeConfigId ); int routeBlockIdValue = getIntValue ( routeBlockId ); VoIPRouteBlock voipRouteBlock = voIPRoutingConfig.OpenVoIPRouteBlock(routeBlockIdValue ); voipRouteBlock.RemoveMatch ( voipRoutingMatch );

Output parameters


ALCATEL_NRE_DELETE_ROUTEBLOCKPREFIX_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_DELETE_ROUTEBLOCKPREFIX_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM



S O



S O

Table 39: A_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-PREFIX


Type Class

NRE services


A_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-SUFFIXRemoves the route block suffix. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.deleteRouteBlockSuffix.

Table 40: A_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-SUFFIX


Type Class


S R


S O

ROUTE_CONFIG_NAME


S O


S O

ROUTE_BLOCK_NAME


S O




int routeBlockIdValue = getIntValue ( routeBlockId ); VoIPRouteBlock voipRouteBlock = voIPRoutingConfig.OpenVoIPRouteBlock(routeBlockIdValue );; voipRouteBlock.RemoveMatch ( origVoipRoutingMatch ); VoIPRoutingMatch voipRoutingMatch = new VoIPRoutingMatch(); voipRoutingMatch.UsernameSuffix(routeBlockSuffix ); voipRouteBlock.RemoveMatch ( voipRoutingMatch );

Output parameters


ALCATEL_NRE_DELETE_ROUTEBLOCKSUFFIX_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_DELETE_ROUTEBLOCKSUFFIX_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

A_A5020-VOIP_3-01_DEL_ROUTE-CONFIGRemoves the route configuration. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.deleteRouteConfig.

ROUTE_BLOCK_SUFFIX

The suffix mask used for this route block. The suffix identifies part of the domain that follows the @ symbol.

S O

Table 41: A_A5020-VOIP_3-01_DEL_ROUTE-CONFIG


Type Class


S R

Table 40: A_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-SUFFIX


Type Class

NRE services


MML command/API callsVoIPRoutingConfigHolder voIPRouteHolder = new VoIPRoutingConfigHolder();VoIPRoutingConfig routeConfig = VoIPRoutingConfigHelper.narrow(voIPRouteHolder.value); routeConfig = sessiontelco.OpenVoIPRoutingConfig(routeConfigID); routeConfig.Delete();

Output parameters


ALCATEL_NRE_DELETE_ROUTECONFIG_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_DELETE_ROUTECONFIG_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

ROUTE_CONFIG_ID The primary key identifier of the routing configuration. Either ROUTE_CONFIG_ID or ROUTE_CONFIG_NAME must be used as a key

S O

ROUTE_CONFIG_NAME

The name of the routing configuration. Either ROUTE_CONFIG_ID or ROUTE_CONFIG_NAME must be used as a key

S O

Table 41: A_A5020-VOIP_3-01_DEL_ROUTE-CONFIG


Type Class



A_A5020-VOIP_3-01_DEL_VPNDeletes a VPN. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.delVPN.

MML command/API callsTelcoVPN telcoVpn = sessionTelco.OpenTelcoVPN(vpnId);telcoVpn.Delete();

Output parameters


ALCATEL_NRE_DELETE_VPN_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_DELETE_VPN_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

Table 42: A_A5020-VOIP_3-01_DEL_VPN


Type Class


S R

VPN_ID The VPN's ID. Either VPN_ID or VPN_NAME must be used as a key.

S O

VPN_NAME The VPN's name. Either VPN_ID or VPN_NAME must be used as a key.

S O

NRE services


A_A5020-VOIP_3-01_MOD_AAA-GROUPModifies the AAA group. AAA Group VOIP attributes may be removed/unset by setting the value to UNSET_VALUE. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.modAAAGroup.

Table 43: A_A5020-VOIP_3-01_MOD_AAA-GROUP


Type Class


S R


S O


S O

AAA_GROUP_NAME The AAA group's name. Either AAA_GROUP_NAME or AAA_GROUP_ID must be used as a primary key.

S O

AAA_GROUP_ID The AAA group identification. Either AAA_GROUP_NAME or AAA_GROUP_ID must be used as a primary key.

S O




The AAA group's mode.

Enabled (the default operation), OnHold (a user trying to access a VoIP AAA group that is put on hold is rejected), Disabled (the selection criteria will never lead to this VoIP AAA group)

S O


The maximum number of users per session. The default value is 0.

S O



S O

AAA_GROUP_EXTERNAL

The type of connection to the A5020X server, either "internal" or "external".

S O


Enable or disable this flag enable or disable support for Failure-to-Start messages for this VoIP AAA group.

S O


Enables or disables the flag that indicates support for this group's unidentified access.

S O


Controls whether the group performs the access checks.

S O


Enables the interaction support.

S O



Type Class

NRE services



Enable or disable this flag to specify whether the Radius process supports Interim Updates or not.

S O


Enables proxy generated messages to be generated by access fail tickets that cause radius accounting stop packets. This feature can be enabled per VoIP AAA group.

S O


Enables EAP messages. S O


Enables the call to be rejected when no port is defined in the POP or RAN.

S O


Enables two-stage authentication. Enable if you want a call to be rejected if no port availability setting is defined on RAN or POP level.

S O


Enables two-stage accounting.

S O


Enables accounting validation.

S O



Type Class





S O



S O



S O



S O



S O




C O



S O



S O



S O



Type Class

NRE services



Allows (0) or prevents (1) the dialing of unregistered endpoints by their IP address (only for terminal-to-terminal calls). By default this is allowed.

S O


Allows (1) or prevents (0) the call transfer service. By default this service is not allowed.

S O


Allows (0) or prevents (1) unconditional forward activation.

S O


Allows (0) or prevents (1) busy forward activation.

S O


Allows (0) or prevents (1) no reply forward activation.

S O




S O




S O



Type Class




The appropriate value for making calls.


S O


The appropriate value for answering calls.


S O


Determines whether the location token should be checked-in (1) or not (0). By default the location token is not checked.

S O


Identifies which H323 RIP message is sent to the server. By default no RIP messages are sent.

S O


Indicates the H323 RIP unregistration timeout in seconds.

S O



Type Class

NRE services



Indicates the H323 RIP call admission timeout in seconds.

S O


The method of terminal authentication interface.


S O


The type for terminal authentication interface.


S O


The method for gateway authentication interface.

S O


The type for authentication interface.


S O



S O


Determines whether to update the H323 setup destination.

S O


Determines whether to update the H323 setup display.

S O


The value of trigger SIP application server. If Server Name equals UNSET_VALUE or Server ID = -1 in a modify context, then the SIP Application Server is to be deleted.

S O



Type Class




The server method, type, and service information for the application server. If Server Name equals UNSET_VALUE or Server ID = -1 in a modify context, then the SIP Application Server is to be deleted.


C O


The AAA group's SIP destination AS. It contains the server method, type, and service information about the application server. If Server Name equals UNSET_VALUE or Server ID = -1 in a modify context, then the SIP Application Server is to be deleted.


C O



Type Class

NRE services



Contains information on the AAA group's SIP call application server. If Server Name equals UNSET_VALUE or Server ID = -1 in a modify context, then the SIP Application Server is to be deleted.


C O


The SIP proxy local destination.

stateful, stateless, or redirect

S O


The proxy non-local destination.





S O



NotAllowed, AllowedNoAuthentication, AllowedWithAuthentication,CHAPLogin, HTTPDigest

S O



S O



S O



Type Class



MML command/API callsVoIPAAAGroup aaaGroup = telcoVpn.NewVoIPAAAGroup ();aaaGroup.Set ( setName, groupName, setEnableOnHold, enableOnHoldType, setMaxUsers, maxUserSessionsValue, setdubiousTimeout, dubiousSessionTimeout, setMaxAccountRetries, maxAccountRetryValue, setAAAFlags, realAAAGroupFlags );aaaGroup.SetAuthentication ( setAuthProtocolType, authProtocolTypeValue, setAuthRetries, authRetriesValue );aaaGroup.SetAccounting ( setAccountProtocolType, accountProtocolTypeValue, setAccountRetries, accountRetriesValue );aaaGroup.SetPortAuthorisation (setAuthDefaultPortType,authDefaultPortTypeValue , setAuthPortTypes,portTypes );



Invite or Unknown S O



Invite or Unknown S O



S O



S O



S O



S O



AAA_GROUP_IVR_PORT




Type Class

NRE services


aaaGroup.SetVoIPCFA ( setCfaEnable, cfaEnableOption, setIvrIpAddress, ivrAddressList, setIvrPort, ivrPortValue,setCfaPrefix,cfaPrefix,setCfaLangIndicator,cfaLangIndicatorValue, setCfaDefaultAnnouncement, cfaDefaultAnnouncement );

Output parameters


ALCATEL_NRE_MODIFY_AAA_GROUP_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_MODIFY_AAA_GROUP_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

A_A5020-VOIP_3-01_MOD_AAA-GROUP-RBRolls back modifications to AAA groups. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.modAAAGroupRB.

Table 44: A_A5020-VOIP_3-01_MOD_AAA-GROUP-RB


Type Class


S R


S O


S O

AAA_GROUP_NAME The AAA group's name. Either the AAA_GROUP_ID or AAA_GROUP_NAME must be used as a key.

S O



AAA_GROUP_ID The AAA group identification. Either the AAA_GROUP_ID or AAA_GROUP_NAME must be used as a key.

S O

OLD_AAA_GROUP_ENABLE_ON_HOLD

The previous AAA group's mode.

Enabled (the default operation), OnHold (a user trying to access a VoIP AAA group that is on hold is rejected)

S O

OLD_AAA_GROUP_MAX_USER_SESSIONS

The previous maximum number of users per session. The default value is 0 and means no per-user restrictions.

S O

OLD_AAA_GROUP_MAX_ACCOUNTING_RETRIES

The previous maximum number of retries available to an accounting request.

S O

OLD_AAA_GROUP_EXTERNAL

The previous type of connection to the A5020X server, either internal (0) or external (1).

S O

OLD_AAA_GROUP_FAILURE_TO_START_SUPPORT_FLAG

The previous flag that controls the group's failure to start message.

S O

OLD_AAA_GROUP_UNIDENTIFIED_ACCESS_FLAG

The previous flag that controls the group's old unidentified access.

S O

OLD_AAA_GROUP_PRE_AUTHENTICATION_ACCESS_ONLY_FLAG

The previous flag that controls whether the group performs the access checks.

S O



Type Class

NRE services


OLD_AAA_GROUP_INTOLD_ERACTION_SUPPORT_FLAG

The previous flag that enables or disables the interaction support.

S O

OLD_AAA_GROUP_SUPPORT_ACCOUNTING_INTERIM_UPDATES_FLAG

The previous flag that enables or disables the radius process interim updates.

S O

OLD_AAA_GROUP_SUPPORT_ACCESS_FAILED_TICKETS_FLAG

The previous flag that controls whether or not the system enables proxy generated messages that are caused by access fail tickets.

S O

OLD_AAA_GROUP_SUPPORT_EAP_MESSAGE_START_FLAG

The previous flag that enables or disables EAP messages.

S O

OLD_AAA_GROUP_MANDATORY_PORTSET_FLAG

The previous flag that enables or disables the call to be rejected when no port is defined in the POP or RAN.

S O

OLD_AAA_GROUP_STAGE2_AUTHENTICATION_FLAG

The previous flag that enables or disables two-stage authentication.

S O

OLD_AAA_GROUP_STAGE2_ACCOUNTING_FLAG

The previous flag that enables or disables two-stage accounting.

S O

OLD_AAA_GROUP_ACCOUNTING_ONLY_FLAG

The previous flag that enables or disables accounting validation.

S O

OLD_AAA_GROUP_AUTHENTICATION_PROTOCOL_TYPE

The previous protocol type, which is based on the AAA server currently in use.

S O



Type Class



OLD_AAA_GROUP_AUTHENTICATION_RETRIES

The previous number of retries allowed during a connection timeout.

S O

OLD_AAA_GROUP_ACCOUNTING_PROTOCOL_TYPE

The previous protocol type in use, based on the prevailing AAA server.

S O

OLD_AAA_GROUP_ACCOUNTING_RETRIES

The previous number of retries allowed during the connection timeout.

S O

OLD_AAA_GROUP_AUTHORISATION_DEFAULT_PORT_TYPE

The previous VoIP AAA group default port.

S O

OLD_AAA_GROUP_AUTHORISATION_PORT_TYPES

A previous list of the authorization port types.


C O

OLD_AAA_GROUP_BARRING_CLASS

The previous barring class used by the call screening server.

S O

OLD_AAA_GROUP_MAXIMUM_CONCURRENT_CALLS

The previous maximum concurrent calls per endpoint.

S O

OLD_AAA_GROUP_DIAL_IP_ADDRESS_PREFIX

The previous prefix value that indicated that the dialed number is an IP address.

S O



Type Class

NRE services


OLD_AAA_GROUP_DIAL_UNREGISTERED_ENDPOINTS

The previous flag that allowed (0) or prevented (1) the dialing of unregistered endpoints by their IP address (only for terminal-to-terminal calls). By default this is allowed.

S O

OLD_AAA_GROUP_CALL_TRANSFER

The previous flag that allowed (1) or prevented (0) the call transfer service. By default this service is not allowed.

S O

OLD_AAA_GROUP_ALLOW_UNCONDITIONAL_FORWARDING_ACTIVATION

The previous flag that controls unconditional forward activation.

S O

OLD_AAA_GROUP_ALLOW_BUSY_FORWARD_ACTIVATION

The previous flag that controls busy forward activation.

S O

OLD_AAA_GROUP_ALLOW_NOREPLY_FORWARD_ACTIVATION

The previous flag that controls no reply forward activation.

S O

OLD_AAA_GROUP_TRIGGER_DESTINATION_AS_FOR_UNREGISTERED_USERS_METHOD

The AAA group's previous trigger destination method.


S O

OLD_AAA_GROUP_TRIGGER_DESTINATION_AS_FOR_UNREGISTERED_USERS_METHOD_TYPE

The AAA group's previous trigger destination method type.


S O



Type Class



OLD_AAA_GROUP_H323_MAKE_CALL_PREGRANTED_ARQ

The previous value for making calls.


S O

OLD_AAA_GROUP_H323_ANSWER_CALL_PREGRANTED_ARQ

The previous value for answering calls.


S O

OLD_AAA_GROUP_H323_CHECK_LOCATION_TOKEN

Determines whether the location token should be checked (1) or not (0). By default the location token is not checked.

S O

OLD_AAA_GROUP_H323_RIP_REGISTRATION

The previous H323 RIP message sent to the server. By default no RIP messages are sent.

S O

OLD_AAA_GROUP_H323_RIP_UNREGISTRATION

The previous H323 RIP unregistration timeout in seconds.

S O

OLD_AAA_GROUP_H323_RIP_CALL_ADMISSION

The previous H323 RIP call admission timeout in seconds.

S O



Type Class

NRE services


OLD_AAA_GROUP_H323_TERMINAL_AUTHENTICATION_METHOD

The previous method of terminal authentication interface.


S O

OLD_AAA_GROUP_H323_TERMINAL_AUTHENTICATION_METHOD_TYPE

The previous type for terminal authentication interface.


S O

OLD_AAA_GROUP_H323_GATEWAY_AUTHENTICATION_METHOD

The previous method for gateway authentication interface.

S O

OLD_AAA_GROUP_H323_GATEWAY_AUTHENTICATION_METHOD_TYPE

The previous type for authentication interface.


S O

OLD_AAA_GROUP_H323_UPDATE_SETUP_ORIGIN

The previous H323 update setup origin.

S O

OLD_AAA_GROUP_H323_UPDATE_SETUP_DESTINATION

Specifies whether to update H323 setup destination.

S O

OLD_AAA_GROUP_H323_UPDATE_DISPLAY

Specifies whether to update H323 display.

S O

OLD_AAA_GROUP_TRIGGER_SIP_APPLICATION_SERVER

The previous value of the SIP application server. If Server Name equals UNSET_VALUE or Server ID = -1 in a Modify Context, then the SIP Application Server is to be deleted.

S O



Type Class



OLD_AAA_GROUP_SIP_ORIGIN_APPLICATION_SERVER

The previous server method, type, and service information for the application server. If Server Name equals UNSET_VALUE or Server ID = -1 in a Modify Context, then the SIP Application Server is to be deleted.


C O

OLD_AAA_GROUP_SIP_DESTINATION_APPLICATION_SERVER

The previous AAA group's SIP destination AS. If Server Name equals UNSET_VALUE or Server ID = -1 in a Modify Context, then the SIP Application Server is to be deleted.


C O

OLD_AAA_GROUP_SIP_CALL_APPLICATION_SERVER

Contains previous information on the AAA group's SIP call application server. If Server Name equals UNSET_VALUE or Server ID = -1 in a Modify Context, then the SIP Application Server is to be deleted.


C O



Type Class

NRE services


OLD_AAA_GROUP_SIP_PROXY_LOCAL_DESTINATION

The previous SIP proxy local destination.

stateful, stateless, or redirect

S O

OLD_AAA_GROUP_SIP_PROXY_NON_LOCAL_DESTINATION

The previous Proxy non local destination.


OLD_AAA_GROUP_SIP_TERMINAL_AUTHENTICATION_METHOD

The previous SIP terminal authentication method.


S O

OLD_AAA_GROUP_SIP_TERMINAL_AUTHENTICATION_METHOD_TYPE

The previous type of SIP terminal authentication method.

NotAllowed, AllowedNoAuthentication, AllowedWithAuthentication,CHAPLogin, HTTPDigest

S O

OLD_AAA_GROUP_SIP_HTTP_DIGEST_REALM

The previous realm string, which is used for the HTTP digest.

S O

OLD_AAA_GROUP_SIP_HTTP_DIGEST_TIMEOUT

The previous length of time this one-time instance stays valid.

S O

OLD_AAA_GROUP_SIP_GATEWAY_AUTHENTICATION_METHOD

The previous gateway authentication method.

invite or unknown S O

OLD_AAA_GROUP_SIP_GATEWAY_AUTHENTICATION_METHOD_TYPE

The previous gateway authentication method type.


S O

OLD_AAA_GROUP_CFA_ENABLE


S O

OLD_AAA_GROUP_CFA_PREFIX


S O



Type Class



MML command/API callsVoIPAAAGroup aaaGroup = telcoVpn.NewVoIPAAAGroup ();aaaGroup.Set ( setName, groupName, setEnableOnHold, enableOnHoldType, setMaxUsers, maxUserSessionsValue, setdubiousTimeout, dubiousSessionTimeout, setMaxAccountRetries, maxAccountRetryValue, setAAAFlags, realAAAGroupFlags );aaaGroup.SetAuthentication ( setAuthProtocolType, authProtocolTypeValue, setAuthRetries, authRetriesValue );aaaGroup.SetAccounting ( setAccountProtocolType, accountProtocolTypeValue, setAccountRetries, accountRetriesValue );aaaGroup.SetPortAuthorisation (setAuthDefaultPortType,authDefaultPortTypeValue , setAuthPortTypes,portTypes );aaaGroup.SetVoIPCFA ( setCfaEnable, cfaEnableOption, setIvrIpAddress, ivrAddressList, setIvrPort, ivrPortValue,setCfaPrefix,cfaPrefix,setCfaLangIndicator,cfaLangIndicatorValue, setCfaDefaultAnnouncement, cfaDefaultAnnouncement );

Output parameters


OLD_AAA_GROUP_CFA_LANGUAGE_INDICATOR

The previous number indicating the language.

S O

OLD_AAA_GROUP_CFA_DEFAULT_ANNOUNCEMENT

The previous default announcement code.

S O

OLD_AAA_GROUP_IVR_IP_ADDRESS

The IVR's previous IP address.

S O

OLD_AAA_GROUP_IVR_PORT

The IVR's previous port value.

S O

OLD_AAA_GROUP_AAA_SERVER

The previous AAA server.


C O



Type Class

NRE services


ALCATEL_NRE_MODIFY_AAA_GROUP_RB_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_MODIFY_AAA_GROUP_RB_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

A_A5020-VOIP_3-01_MOD_AAA-SELECTION-RULEModifies an AAA selection rule. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.modAAASelectionRule.

Table 45: A_A5020-VOIP_3-01_MOD_AAA-SELECTION-RULE


Type Class


S R


S O


The VPN identifier. S O


The VPN name. S O


The AAA group name. Either _AAA_GROUP_ID or _AAA_GROUP_NAME and the SELECTION_RULE_NUMBER, must be used as a key. The SELECTION_RULE_ID can be used as a key by itself.

S O




The AAA group identification. Either _AAA_GROUP_ID or _AAA_GROUP_NAME and the SELECTION_RULE_NUMBER, must be used as a key. The SELECTION_RULE_ID can be used as a key by itself.

S O


The AAA selection rule identification, assigned by the NE when the rule is created. Either _AAA_GROUP_ID or _AAA_GROUP_NAME and the SELECTION_RULE_NUMBER, must be used as a key. The SELECTION_RULE_ID can be used as a key by itself.

S O


Priority sequence of rule in AAA group. VPN_ID or NAME, GROUP_ID or NAME and SELECTION_RULE_NUMBER can be used as key. SELECTION_RULE_ID can be used as key alone. 1 = query first rule for an AAA group. If not set, rule is placed at start of rule sequence.

S O



Type Class

NRE services




S O




S O


The mask in which the origin must fit so that it can select the correct AAA group. This mask can be based on the user name or calling party E.164 number.

S O


The lowest IP address in the range you are defining. Either Address, RAN, POP or Gatekeeper will be used as the ORIGIN selector.

S O


The highest IP address in the range you are defining.

S O


The AAA selection originating RAN ID. Either RAN_ID or RAN_NAME must be used as a key.

S O


The AAA selection originating RAN name. Either RAN_ID or RAN_NAME must be used as a key.

S O



Type Class




The AAA selection originating POP ID. Either POP_ID or POP_NAME must be used as a key.

S O


The AAA selection originating POP name. Either POP_ID or POP_NAME must be used as a key.

S O


The AAA selection originating external gatekeeper name. Either GATEKEEPER_ID or GATEKEEPER_NAME must be used as a key. Either Address, RAN, POP or Gatekeeper will be used as the ORIGIN selector.

S O


The AAA selection originating external gatekeeper ID. Either GATEKEEPER_ID or GATEKEEPER_NAME must be used as a key. Either Address, RAN, POP or Gatekeeper will be used as the ORIGIN selector.

S O


The mask in which the destination must fit to correctly select the AAA group. This mask can be based on the user name or called party E.164 number.

S O



Type Class

NRE services



Output parameters


ALCATEL_MODIFY_AAA_SELECTION_RULE_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_MODIFY_AAA_SELECTION_RULE_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.


The lowest IP address in the range that you are defining for the called IP address.

S O


The highest IP address in the range that you are defining for the called IP address.

S O



C O

OLD_AAA_SELECTION



C O



Type Class



A_A5020-VOIP_3-01_MOD_AAA-SELECTION-RULE-RBRolls back the modification of an AAA selection rule. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.modAAASelectionRuleRB.

Table 46: A_A5020-VOIP_3-01_MOD_AAA-SELECTION-RULE-RB


Type Class


S R

OLD_AAA_SELECTION_VPN_ID

The previous VPN identifier.

S O

OLD_AAA_SELECTION_VPN_NAME

The previous VPN name.

S O

OLD_AAA_SELECTION_AAA_GROUP_NAME

The previous AAA group name. Either _AAA_GROUP_ID or _AAA_GROUP_NAME and the SELECTION_RULE_NUMBER, must be used as a key. The SELECTION_RULE_ID can be used as a key by itself.

S O

OLD_AAA_SELECTION_AAA_GROUP_ID

The previous AAA group identification. Either _AAA_GROUP_ID or _AAA_GROUP_NAME and the SELECTION_RULE_NUMBER, must be used as a key. The SELECTION_RULE_ID can be used as a key by itself.

S O

NRE services


OLD_AAA_SELECTION_RULE_ID

The previous AAA selection rule identification, assigned by the NE when the rule is created. Either AAA_GROUP_ID or NAME, and the SELECTION_RULE_NUMBER must be used as a key; SELECTION_RULE_ID can be used by itself.

S O

OLD_AAA_SELECTION_RULE_NUMBER

The previous name of the subject AAA group. Either AAA_GROUP_ID or NAME, and the SELECTION_RULE_NUMBER must be used as a key; SELECTION_RULE_ID can be used by itself. If not set, rule is placed at start of sequence of rules.

S O

OLD_AAA_SELECTION_ENABLE_FLAG

The previous flag to enable or disable this rule.

S O

OLD_AAA_SELECTION_METHOD

The previous AAA group selection method.


S O



Type Class



OLD_AAA_SELECTION_ORIGIN_MASK

The previous mask in which the origin must fit so that it can select the correct AAA group. This mask can be based on the user name or calling party E.164 number

S O

OLD_AAA_SELECTION_ORIGIN_START_ADDRESS

The previous lowest IP address in the range you are defining. Either Address, RAN, POP or Gatekeeper will be used as the ORIGIN selector.

S O

OLD_AAA_SELECTION_ORIGIN_END_ADDRESS

The previous highest IP address in the range you are defining.

S O

OLD_AAA_SELECTION_ORIGIN_RAN_ID

The previous AAA selection originating RAN ID. Either RAN_ID or RAN_NAME must be used as a key.

S O

OLD_AAA_SELECTION_ORIGIN_RAN_NAME

The previous AAA selection originating RAN name.

S O

OLD_AAA_SELECTION_ORIGIN_POP_ID

The previous AAA selection originating POP ID.

S O



Type Class

NRE services


OLD_AAA_SELECTION_ORIGIN_POP_NAME

The previous AAA selection originating POP name. Either POP_ID or POP_NAME must be used as a key. Either Address, RAN, POP or Gatekeeper will be used as the ORIGIN selector.

S O

OLD_AAA_SELECTION_ORIGIN_EXTERNAL_GATEKEEPER_NAME

The previous AAA selection originating external gatekeeper name. Either EXTERNAL_GATEKEEPER_ID or NAME must be used as a key. Either Address, RAN, POP or Gatekeeper will be used as the ORIGIN selector.

S O

OLD_AAA_SELECTION_ORIGIN_EXTERNAL_GATEKEEPER_ID

The previous AAA selection originating external gatekeeper ID. Either EXTERNAL_GATEKEEPER_ID or NAME must be used as a key.

S O

OLD_AAA_SELECTION_DESTINATION_MASK

The previous mask in which the destination must fit to correctly select the AAA group.

S O

OLD_AAA_SELECTION_DESTINATION_START_ADDRESS

The previous lowest IP address in the range that you are defining for the called IP address. This mask can be based on the user name or called party E.164 number.

S O



Type Class




Output parameters


ALCATEL_MODIFY_AAA_SELECTION_RULE_RB_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_MODIFY_AAA_SELECTION_RULE_RB_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

OLD_AAA_SELECTION_DESTINATION_END_ADDRESS

The previous highest IP address in the range that you are defining for the called IP address.

S O

OLD_AAA_SELECTION

The previous multiple instances of AAA selections. This compound parameter takes precedence over the scalar parameter.


C O



Type Class

NRE services


A_A5020-VOIP_3-01_MOD_ROUTEModifies a route. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.modifyRoute.

Table 47: A_A5020-VOIP_3-01_MOD_ROUTE


Type Class


S R


S O


S O

ROUTE_TYPE The route type. Carrier via GW (VoIPRouteCarrierViaGW), External Gateway (VoIPRouteITSP), Route to EP (VoIPRouteToEP)

S O


The prefix that identifies the route's carrier. Valid only if ROUTE_TYPE is Carrier via GW. A value of UNSET_VALUE sets this parameter to an empty value.

S O



ROUTE_ITSPLD The parameter that identifies the multiple GateKeeper. Valid only if ROUTE_TYPE is External Gateway. A value of UNSET_VALUE sets this parameter to an empty value.

S O


The IP address for the route's endpoint. Valid only if ROUTE_TYPE is Endpoint. A value of UNSET_VALUE sets this parameter to an empty value.

S O

ROUTE_ENDPOINT_PORT

The IP port for the route's endpoint. Valid only if ROUTE_TYPE is Endpoint. A value of UNSET_VALUE sets this parameter to an empty value.

S O

ROUTE_ENDPOINT_TYPE

The route's endpoint type. Valid only if ROUTE_TYPE is Endpoint. A value of UNSET_VALUE sets this parameter to an empty value.

S O

ROUTE_ODP The route's Output Digit Preparation. A value of UNSET_VALUE sets this parameter to an empty value.

S O



Type Class

NRE services









The Gateway POP or RAN name to which this route is associated. It references the NE table that is populated in the CCE. A value of UNSET_VALUE sets this parameter to an empty value. Use either ROUTE_GW_POP_RAN_ID or NAME; ID takes precedence.

S O

ROUTE_GW_POP_RAN_ID

The Gateway POP or RAN ID to which this route is associated. It references the NE table that is populated in the CCE. Use either ROUTE_GW_POP_RAN_ID or NAME; ID takes precedence.

S O



Type Class









Output parameters


ALCATEL_NRE_MODIFY_ROUTE_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_MODIFY_ROUTE_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

A_A5020-VOIP_3-01_MOD_ROUTE-BLOCKModifies a route block. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.modifyRouteBlock.

Table 48: A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK


Type Class


S R

NRE services



S O

ROUTE_BLOCK_NAME


S O

ROUTE_CONFIG_ID The primary key identifier of the routing configuration. Either ROUTE_BLOCK_ID or ROUTE_BLOCK_NAME must be used as a key.

S O

ROUTE_CONFIG_NAME


S O

ROUTING_TYPE The routing type. Types include Priority or Weight. Up to 10 Priority type routings, or 5 Weight type routings can be defined. This parameter is not valid/used in this release. The routing type will be queried from the switch.

S R



Type Class



ROUTE_ID_1 The name, or identity, of route 1. A value of UNSET_VALUE indicates that the route ID is set to an empty value.

S O

ROUTE_WEIGHT_1 The probability that this route will be used. A value of UNSET_VALUE indicates that the route ID is set to an empty value.

S O


S O


S O


S O



Type Class

NRE services



S O


S O


S O


S O


S O



Type Class




voIPRouteConfig = sessiontelco.OpenVoIPRoutingConfig(routeConfigId);voIPRouteBlock = voIPRouteConfig.NewVoIPRouteBlock();


S O


S O


S O


S O


S O



Type Class

NRE services


RouteBlockType routeBlockType;RouteBlockRoutes routeBlockRoutes = new RouteBlockRoutes();

if (routingType.equalsIgnoreCase("RouteBlockPriority" ) ) { routeBlockType = RouteBlockType.RouteBlockPriority; int[] routeIdValue = {Integer.parseInt(routeId)}; routeBlockRoutes.priorityRoutes(routeIdValue); } else if ( routingType.equalsIgnoreCase("RouteBlockWeighted" ) ) { routeBlockType = RouteBlockType.RouteBlockWeighted; int routeIdValue = Integer.parseInt(routeId); short routeWeightValue = Short.parseShort(routeWeight); WeightedRoute[] weightRoute = {new WeightedRoute(routeIdValue,routeWeightValue) }; WeightedRouteListHolder weightRouteHolder = new WeightedRouteListHolder(weightRoute); routeBlockRoutes.weightedRoutes(weightRouteHolder.value); } enumRouteFallback routeFallbackString = enumRouteFallback.RouteFallbackNone; int clearingHouseId = 0;


Output parameters


ALCATEL_NRE_MODIFY_ROUTEBLOCK_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_MODIFY_ROUTEBLOCK_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

For a successful ASDL:

ORIG_ROUTE_BLOCK_ID is deleted route block (if deemed necessary by the modification) as a CSDL parameter to the SARM table TBL_SRQ_PARM.ROUTE_BLOCK_ID is the newly created route block (if deemed necessary by the modification, otherwise will be the same route block being modified) as a CSDL and a ROLLBACK parameter to the SARM table TBL_SRQ_PARM.



A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-PREFIXModifies a route block prefix. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.modifyRouteBlockPrefix.

Table 49: A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-PREFIX


Type Class


S R


S O

ROUTE_CONFIG_NAME


S O


S O

ROUTE_BLOCK_NAME


S O

NRE services




VoIPRouteBlock voipRouteBlock = voIPRoutingConfig.OpenVoIPRouteBlock(routeBlockIdValue ); enumVoIPRoutingMatchType enumType = enumVoIPRoutingMatchType.VoIPRoutingMatchTypeE164Range;

VoIPRoutingMatchE164Range voipRoutingE164Range = new VoIPRoutingMatchE164Range (routeBlockStartPrefix, routeBlockEndPrefix );

VoIPRoutingMatch voipRoutingMatch = new VoIPRoutingMatch(); voipRoutingMatch.E164Range(voipRoutingE164Range );

voipRouteBlock.RemoveMatch ( origVoipRoutingMatch );

voipRouteBlock.AddMatch ( voipRoutingMatch );



S O



S O

NEW_ROUTE_BLOCK_START_PREFIX

The new route block starting prefix mask. It can also be the entire number when there is an exact match.

S O

NEW_ROUTE_BLOCK_END_PREFIX

The new route block end prefix mask. This is the end of the prefix for matching range.

S O

Table 49: A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-PREFIX


Type Class



Output parameters


ALCATEL_NRE_MODIFY_ROUTEBLOCKPREFIX_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_MODIFY_ROUTEBLOCKPREFIX_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-PREFIX-RBRolls back a modified route block prefix. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.modifyRouteBlockPrefixRB.

Table 50: A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-PREFIX-RB


Type Class


S R


S O

ROUTE_CONFIG_NAME


S O


S O

NRE services




VoIPRouteBlock voipRouteBlock = voIPRoutingConfig.OpenVoIPRouteBlock(routeBlockIdValue ); enumVoIPRoutingMatchType enumType = enumVoIPRoutingMatchType.VoIPRoutingMatchTypeE164Range;

VoIPRoutingMatchE164Range voipRoutingE164Range = new VoIPRoutingMatchE164Range (routeBlockStartPrefix, routeBlockEndPrefix );

ROUTE_BLOCK_NAME


S O

OLD_ROUTE_BLOCK_START_PREFIX

The previous route block starting prefix mask. It can also be the entire number when there is an exact match.

S O

OLD_ROUTE_BLOCK_END_PREFIX

The pervious route block end prefix mask. This is the end of the prefix for matching range.

S O



S O



S O

Table 50: A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-PREFIX-RB


Type Class



VoIPRoutingMatch voipRoutingMatch = new VoIPRoutingMatch(); voipRoutingMatch.E164Range(voipRoutingE164Range );

voipRouteBlock.RemoveMatch ( origVoipRoutingMatch );

voipRouteBlock.AddMatch ( voipRoutingMatch );

Output parameters


ALCATEL_NRE_MODIFY_ROUTEBLOCKPREFIX_RB_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_MODIFY_ROUTEBLOCKPREFIX_RB_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-RBRolls back modifications to a route block. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.modifyRouteBlockRB.

Table 51: A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-RB


Type Class


S R


S O

ROUTE_BLOCK_NAME


S O

NRE services



S O

ROUTE_CONFIG_NAME

The route configuration name. Either ROUTE_CONFIG_ID or ROUTE_CONFIG_NAME must be used as a key.

S O

OLD_ROUTING_TYPE

The previous routing type. Types include Priority or Weight. Up to 10 Priority type routings, or 5 Weight type routings can be defined. This parameter is not valid/used in this release. The routing type will be queried from the switch.

S R

OLD_ROUTE_ID_1 The name, or identity, of route 1.

S O

OLD_ROUTE_WEIGHT_1

The probability that this route will be used.

S O


S O

OLD_ROUTE_WEIGHT_2


S O


S O



Type Class





if (routingType.equalsIgnoreCase("RouteBlockPriority" ) ) { routeBlockType = RouteBlockType.RouteBlockPriority; int[] routeIdValue = {Integer.parseInt(routeId)}; routeBlockRoutes.priorityRoutes(routeIdValue);

OLD_ROUTE_WEIGHT_3


S O


S O

OLD_ROUTE_WEIGHT_4


S O


S O

OLD_ROUTE_WEIGHT_5


S O


S O


S O


S O


S O


S O



Type Class

NRE services


} else if ( routingType.equalsIgnoreCase("RouteBlockWeighted" ) ) { routeBlockType = RouteBlockType.RouteBlockWeighted; int routeIdValue = Integer.parseInt(routeId); short routeWeightValue = Short.parseShort(routeWeight); WeightedRoute[] weightRoute = {new WeightedRoute(routeIdValue,routeWeightValue) }; WeightedRouteListHolder weightRouteHolder = new WeightedRouteListHolder(weightRoute); routeBlockRoutes.weightedRoutes(weightRouteHolder.value); } enumRouteFallback routeFallbackString = enumRouteFallback.RouteFallbackNone; int clearingHouseId = 0;


Output parameters


ALCATEL_NRE_MODIFY_ROUTEBLOCK_RB_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_MODIFY_ROUTEBLOCK_RB_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

For a successful ASDL:

ORIG_ROUTE_BLOCK_ID is deleted route block (if deemed necessary by the modification) as a CSDL parameter to the SARM table TBL_SRQ_PARM.ROUTE_BLOCK_ID is the newly created route block (if deemed necessary by the modification, otherwise will be the same route block being modified) as a CSDL and a ROLLBACK parameter to the SARM table TBL_SRQ_PARM.



A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-SUFFIXModifies a route block suffix. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.modRouteBlockSuffix.

Table 52: A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-SUFFIX


Type Class


S R


S O

ROUTE_CONFIG_NAME


S O


S O

ROUTE_BLOCK_NAME


S O

NRE services


MML command/API calls

See “A_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-SUFFIX” on page 76 and “A_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-SUFFIX” on page 97 as modify uses delete, then add.

Output parameters


ALCATEL_NRE_MODIFY_ROUTEBLOCKSUFFIX_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_MODIFY_ROUTEBLOCKSUFFIX_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM

A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-SUFFIX-RBRolls back a modified route block suffix. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.modRouteBlockSuffixRB.

ROUTE_BLOCK_SUFFIX


S O

NEW_ROUTE_BLOCK_SUFFIX

The new suffix mask used for this route block. The suffix identifies part of the domain that follows the @ symbol.

S O

Table 53: A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-SUFFIX-RB


Type Class


S R

Table 52: A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-SUFFIX


Type Class




S O

ROUTE_CONFIG_NAME


S O


S O

ROUTE_BLOCK_NAME


S O

OLD_ROUTE_BLOCK_SUFFIX

The previous suffix mask used for this route block. The suffix identifies part of the domain that follows the @ symbol.

S O



S O

Table 53: A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-SUFFIX-RB


Type Class

NRE services



See “A_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-SUFFIX” on page 76 and “A_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-SUFFIX” on page 97 as modify uses delete, then add.

Output parameters


ALCATEL_NRE_MODIFY_ROUTEBLOCKSUFFIX_RB_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_MODIFY_ROUTEBLOCKSUFFIX_RB_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

A_A5020-VOIP_3-01_MOD_ROUTE-CONFIGModifies the route configuration. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.modifyRouteConfig.

Table 54: A_A5020-VOIP_3-01_MOD_ROUTE-CONFIG


Type Class


S R


S O

ROUTE_CONFIG_NAME


S O

NEW_ROUTE_CONFIG_NAME

The new name of the routing configuration.

S O



MML command/API callsVoIPRoutingConfigHolder voIPRouteHolder = new VoIPRoutingConfigHolder();VoIPRoutingConfig routeConfig = VoIPRoutingConfigHelper.narrow(voIPRouteHolder.value);routeConfig = sessiontelco.OpenVoIPRoutingConfig(routeConfigID );routeConfig.Set (true, routeConfigName );

Output parameters


ALCATEL_NRE_MODIFY_ROUTECONFIG_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_MODIFY_ROUTECONFIG_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

A_A5020-VOIP_3-01_MOD_ROUTE-CONFIG-ATTACH-VPNModifies the routing configuration and the attached VPN. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.modifyRouteConfigAttachVPN.

Table 55: A_A5020-VOIP_3-01_MOD_ROUTE-CONFIG-ATTACH-VPN


Type Class


S R


S O

ROUTE_CONFIG_NAME


S O

NRE services


MML command/API callsVoIPRoutingConfigHolder voIPRouteHolder = new VoIPRoutingConfigHolder();VoIPRoutingConfig routeConfig = VoIPRoutingConfigHelper.narrow(voIPRouteHolder.value);routeConfig = sessiontelco.OpenVoIPRoutingConfig(routeConfigID );routeConfig.Set (true, routeConfigName );routeConfig.AttachVPN(vpiID);

Output parameters


ALCATEL_NRE_MODIFY_ROUTECONFIGATTACHVPN_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_MODIFY_ROUTECONFIGATTACHVPN_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

VPN_ID Links the VPN_ID with a routing configuration. Either VPN_ID or VPN_NAME must be specified.

S O

VPN_NAME Links the VPN_NAME with a routing configuration. Either VPN_ID or VPN_NAME must be specified.

S O

Table 55: A_A5020-VOIP_3-01_MOD_ROUTE-CONFIG-ATTACH-VPN


Type Class



A_A5020-VOIP_3-01_MOD_ROUTE-CONFIG-DETACH-VPNLinks the VPN_NAME with the particular route. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.modifyRouteConfigDetachVPN.

MML command/API callsVoIPRoutingConfigHolder voIPRouteHolder = new VoIPRoutingConfigHolder();

Table 56: A_A5020-VOIP_3-01_MOD_ROUTE-CONFIG-DETACH-VPN


Type Class


S R


S O

ROUTE_CONFIG_NAME


S O

VPN_ID Links the VPN_ID with the particular routing configuration. Either VPN_ID or VPN_NAME must be specified.

S O

VPN_NAME Links the VPN_NAME with the particular routing configuration. Either VPN_ID or VPN_NAME must be specified.

S O

NRE services


VoIPRoutingConfig routeConfig = VoIPRoutingConfigHelper.narrow(voIPRouteHolder.value);routeConfig = sessiontelco.OpenVoIPRoutingConfig(routeConfigID );routeConfig.Set (true, routeConfigName );routeConfig.DetachVPN(vpiID);

Output parameters


ALCATEL_NRE_MODIFY_ROUTECONFIGDETACHVPN_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_MODIFY_ROUTECONFIGDETACHVPN_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

A_A5020-VOIP_3-01_MOD_ROUTE-RBRolls back a modified route. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.modifyRouteRB.

Table 57: A_A5020-VOIP_3-01_MOD_ROUTE-RB


Type Class


S R


S O


S O

OLD_ROUTE_TYPE The route type. Carrier via GW (VoIPRouteCarrierViaGW), External Gateway (VoIPRouteITSP), Route to EP (VoIPRouteToEP)

S O



OLD_ROUTE_CARRIER_PREFIX

The old prefix that identifies the route's carrier. Valid only if ROUTE_TYPE is Carrier via GW. A value of UNSET_VALUE sets this parameter to an empty value.

S O

OLD_ROUTE_ITSPLD

The old parameter that identifies the multiple GateKeeper. Valid only if Route type is External Gateway. A value of UNSET_VALUE sets this parameter to an empty value.

S O

OLD_ROUTE_ENDPOINT_ADDRESS

The old IP address for the route's endpoint. Valid only if Route type is Endpoint. A value of UNSET_VALUE sets this parameter to an empty value.

S O

OLD_ROUTE_ENDPOINT_PORT

The old IP port for the route's endpoint. Valid only if Route type is Endpoint. A value of UNSET_VALUE sets this parameter to an empty value.

S O

OLD_ROUTE_ENDPOINT_TYPE

The old route's endpoint type. Valid only if route type is Endpoint. A value of UNSET_VALUE sets this parameter to an empty value.

S O



Type Class

NRE services










OLD_ROUTE_ODP The old route's Output Digit Preparation.

S O

OLD_ROUTE_GW_POP_RAN_NAME

The old Gateway POP or RAN name to which this route is associated. It references the NE table that is populated in the CCE.

S O

OLD_ROUTE_GW_POP_RAN_ID

The old Gateway POP or RAN ID to which this route is associated. It references the NE table that is populated in the CCE.

S O



Type Class







Output parameters


ALCATEL_NRE_MODIFY_ROUTE_RB_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_MODIFY_ROUTE_RB_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

A_A5020-VOIP_3-01_MOD_VPNModifies the VPN. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.modVPN.

Table 58: A_A5020-VOIP_3-01_MOD_VPN


Type Class


S R


S O

NRE services



S O


S O


S O


S O

DBLOG_STARTEXTSESS



DBLOG_ENDEXTSESS



DBLOG_STARTINTSESS



DBLOG_ENDINTSESS



DBLOG_INTERIM_EXT



DBLOG_INTERIM_INT



DBLOG_TUNNEL_EXT



DBLOG_TUNNEL_INT





True, False S O

CSVLOG_STARTEXTSESS





Type Class



CSVLOG_ENDEXTSESS



CSVLOG_STARTINTSESS



CSVLOG_ENDINTSESS



CSVLOG_INTERIM_EXT



CSVLOG_INTERIM_INT



CSVLOG_TUNNEL_EXT



CSVLOG_TUNNEL_INT






HOLIDAY Holiday.


C O

ACTIVATIONTIME_YEAR

Activation time - year. S O


Activation time - month.

S O

ACTIVATIONTIME_DAY

Activation time - day. S O

ACTIVATIONTIME_HOUR

Activation time - hour. S O


Activation time - minute.

S O



Type Class

NRE services





Activation time - second.

S O


Deactivation time - year.

S O


Deactivation time - month.

S O


Deactivation time - day. S O


Deactivation time - hour.

S O


Deactivation time - minute.

S O


Deactivation time - second.

S O

LOGIN_ALLOWED_TIMES

Login allowed times.


C O

SPECIAL_PERIODS Special periods.


C O

ONHOLD On hold. True, False S O



Type Class




// DB Logging boolean setRadiusLogging = true; enumRadiusLogItem radiusLogging[] = {}; boolean setProxyLogStartSessionInternal = true; enumProxyLogType proxyLogStartSessionInternal = enumProxyLogType.ProxyLogNone; boolean setProxyLogStartSessionExternal = true; enumProxyLogType proxyLogStartSessionExternal = enumProxyLogType.ProxyLogNone; boolean setProxyLogEndSessionInternal = true; enumProxyLogType proxyLogEndSessionInternal = enumProxyLogType.ProxyLogNone; boolean setProxyLogEndSessionExternal = true; enumProxyLogType proxyLogEndSessionExternal = enumProxyLogType.ProxyLogNone; boolean setProxyLogInterimInternal = true; enumProxyLogType proxyLogInterimInternal = enumProxyLogType.ProxyLogFailed; boolean setProxyLogInterimExternal = true; enumProxyLogType proxyLogInterimExternal = enumProxyLogType.ProxyLogFailed; boolean setProxyLogTunnelInternal = true; enumProxyLogType proxyLogTunnelInternal = enumProxyLogType.ProxyLogAll; boolean setProxyLogTunnelExternal = true; enumProxyLogType proxyLogTunnelExternal = enumProxyLogType.ProxyLogAll; boolean setProxyLogVendorSpecific = false; boolean proxyLogVendorSpecific = false;


// CSV Logging telcoVpn.SetCsvLogging(setRadiusLogging, radiusLogging, setProxyLogStartSessionInternal, proxyLogStartSessionInternal, setProxyLogStartSessionExternal, proxyLogStartSessionExternal, setProxyLogEndSessionInternal, proxyLogEndSessionInternal, setProxyLogEndSessionExternal, proxyLogEndSessionExternal, setProxyLogInterimInternal, proxyLogInterimInternal, setProxyLogInterimExte

NRE services


rnal, proxyLogInterimExternal, setProxyLogTunnelInternal, proxyLogTunnelInternal, setProxyLogTunnelExternal, proxyLogTunnelExternal, setProxyLogVendorSpecific, proxyLogVendorSpecific);

Output parameters


ALCATEL_NRE_MODIFY_VPN_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_MODIFY_VPN_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

A_A5020-VOIP_3-01_MOD_VPN-RBRolls back the modified VPN. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.modVPNRB.

Table 59: A_A5020-VOIP_3-01_MOD_VPN-RB


Type Class


S R


S O


S O

OLD_MAX_USERS The previous maximum number of users.

S O

OLD_ADMIN_ID The previous admin identification.

S O

OLD_MAX_SESSIONS

The previous maximum number of sessions.

S O



OLD_DBLOG_STARTEXTSESS

The previous DB log proxy start external session value.


OLD_DBLOG_ENDEXTSESS

The previous DB log proxy end external session value.


OLD_DBLOG_STARTINTSESS

The previous DB log proxy start internal session value.


OLD_DBLOG_ENDINTSESS

The previous DB log end internal session value.


OLD_DBLOG_INTERIM_EXT

The previous DB proxy log interim external value.


OLD_DBLOG_INTERIM_INT

The previous DB proxy log interim internal value.


OLD_DBLOG_TUNNEL_EXT

The previous DB log tunnel external value.


OLD_DBLOG_TUNNEL_INT

The previous DB log tunnel internal value.


OLD_DBLOG_VENDOR_SPECIFIC

The previous DB log vendor-specific value.

True, False S O

OLD_CSVLOG_STARTEXTSESS

The previous CSV log proxy start external session value.


OLD_CSVLOG_ENDEXTSESS

The previous CSV log end external session value.


OLD_CSVLOG_STARTINTSESS

The previous CSV log start internal session value.




Type Class

NRE services


OLD_CSVLOG_ENDINTSESS

The previous CSV log end internal session value.


OLD_CSVLOG_INTERIM_EXT

The previous CSV log interim external value.


OLD_CSVLOG_INTERIM_INT

The previous CSV log interim internal value.


OLD_CSVLOG_TUNNEL_EXT

The previous CSV log tunnel external value.


OLD_CSVLOG_TUNNEL_INT

The previous CSV log tunnel internal value.


OLD_CSVLOG_VENDOR_SPECIFIC

The previous CSV vendor-specific value.

True, False S O

OLD_HOLIDAY The previous holiday year value.


C O

OLD_ACTIVATIONTIME_YEAR

The previous activation time - year value.

S O

OLD_ACTIVATIONTIME_MONTH

The previous activation time - month value.

S O

OLD_ACTIVATIONTIME_DAY

The previous activation time - day value.

S O

OLD_ACTIVATIONTIME_HOUR

The previous activation time - hour value.

S O

OLD_ACTIVATIONTIME_MINUTE

The previous activation time - minute value.

S O

OLD_ACTIVATIONTIME_SECOND

The previous activation time - second value.

S O



Type Class




OLD_DEACTIVATIONTIME_YEAR

The previous deactivation time - year value.

S O

OLD_DEACTIVATIONTIME_MONTH

The previous deactivation time - month value.

S O

OLD_DEACTIVATIONTIME_DAY

The previous deactivation time - day value.

S O

OLD_DEACTIVATIONTIME_HOUR

The previous deactivation time - hour value.

S O

OLD_DEACTIVATIONTIME_MINUTE

The previous deactivation time - minute value.

S O

OLD_DEACTIVATIONTIME_SECOND

The previous deactivation time - second value.

S O

OLD_LOGIN_ALLOWED_TIMES

The previous login allowed times value.


C O

OLD_SPECIAL_PERIODS

The previous special periods value.


C O

OLD_ONHOLD The previous on hold value.

True, False S O



Type Class

NRE services




// DB Logging boolean setRadiusLogging = true; enumRadiusLogItem radiusLogging[] = {}; boolean setProxyLogStartSessionInternal = true; enumProxyLogType proxyLogStartSessionInternal = enumProxyLogType.ProxyLogNone; boolean setProxyLogStartSessionExternal = true; enumProxyLogType proxyLogStartSessionExternal = enumProxyLogType.ProxyLogNone; boolean setProxyLogEndSessionInternal = true; enumProxyLogType proxyLogEndSessionInternal = enumProxyLogType.ProxyLogNone; boolean setProxyLogEndSessionExternal = true; enumProxyLogType proxyLogEndSessionExternal = enumProxyLogType.ProxyLogNone; boolean setProxyLogInterimInternal = true; enumProxyLogType proxyLogInterimInternal = enumProxyLogType.ProxyLogFailed; boolean setProxyLogInterimExternal = true; enumProxyLogType proxyLogInterimExternal = enumProxyLogType.ProxyLogFailed; boolean setProxyLogTunnelInternal = true; enumProxyLogType proxyLogTunnelInternal = enumProxyLogType.ProxyLogAll; boolean setProxyLogTunnelExternal = true; enumProxyLogType proxyLogTunnelExternal = enumProxyLogType.ProxyLogAll; boolean setProxyLogVendorSpecific = false; boolean proxyLogVendorSpecific = false;


// CSV Logging



telcoVpn.SetCsvLogging(setRadiusLogging, radiusLogging, setProxyLogStartSessionInternal, proxyLogStartSessionInternal, setProxyLogStartSessionExternal, proxyLogStartSessionExternal, setProxyLogEndSessionInternal, proxyLogEndSessionInternal, setProxyLogEndSessionExternal, proxyLogEndSessionExternal, setProxyLogInterimInternal, proxyLogInterimInternal, setProxyLogInterimExternal, proxyLogInterimExternal, setProxyLogTunnelInternal, proxyLogTunnelInternal, setProxyLogTunnelExternal, proxyLogTunnelExternal, setProxyLogVendorSpecific, proxyLogVendorSpecific);

Output parameters


ALCATEL_NRE_MODIFY_VPN_RB_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_MODIFY_VPN_RB_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

Compound parameter "LOGIN_ALLOWED_TIMES"

The compound parameter LOGIN_ALLOWED_TIMES will contain an indefinite number of entries.




LOGIN_ALLOWED_TIMES.(n).NAME



LOGIN_ALLOWED_TIMES.(n).ID



LOGIN_ALLOWED_TIMES.(n).DAY.(m)


NRE services


Compound parameter "SPECIAL_PERIODS"

The compound parameter SPECIAL_PERIODS is used to provide special login periods. A unique name or ID is required per entry. Up to n entries are allowed per VPN.

LOGIN_ALLOWED_TIMES.(n).START_HOUR


LOGIN_ALLOWED_TIMES.(n).START_MINUTE


LOGIN_ALLOWED_TIMES.(n).STOP_HOUR


LOGIN_ALLOWED_TIMES.(n).STOP_MINUTE





SPECIAL_PERIODS.(n).NAME



SPECIAL_PERIODS.(n).ID



SPECIAL_PERIODS.(n).START_DAY







A_A5020-VOIP_3-01_QRY_AAA-GROUPRetrieves an AAA group. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.qryAAAGroup.

SPECIAL_PERIODS.(n).END_DAY


SPECIAL_PERIODS.(n).MONTH

O NUMBER Valid values: 1-12.

SPECIAL_PERIODS.(n).YEAR

O NUMBER Year format xxxx.

SPECIAL_PERIODS.(n).LOGINTIMESNAME



SPECIAL_PERIODS.(n).LOGINTIMESID



Table 62: A_A5020-VOIP_3-01_QRY_AAA-GROUP


Type Class


S R


S O




NRE services


MML command/API callsaaaGroup = aaaGroupIterator.OpenVoIPAAAGroup( tempGroupId );

IntHolder aaaGroupIdHolder = new IntHolder();StringHolder aaaGroupNameHolder = new StringHolder();enumEnableOnholdHolder enableOnHoldHolder= new enumEnableOnholdHolder();IntHolder maxUserSessionHolder = new IntHolder();IntHolder dubiousSessionTimeoutHolder = new IntHolder();ShortHolder maxAccountRetriesHolder = new ShortHolder();AAAGroupFlagsHolder aaaGroupFlagsHolder = new AAAGroupFlagsHolder();

aaaGroup.Get(aaaGroupIdHolder, aaaGroupNameHolder, enableOnHoldHolder, maxUserSessionHolder, dubiousSessionTimeoutHolder, maxAccountRetriesHolder, aaaGroupFlagsHolder);

enumAAAGroupFlags aaaGroupFlags[] = aaaGroupFlagsHolder.value;enumAAAGroupFlags aaaGroupFlag = null;

for ( int j=0; j<aaaGroupFlags.length; j++ ) { val = aaaGroupFlags[j].value(); aaaGroupFlag = enumAAAGroupFlags.from_int(val);}

IntHolder authProtocolTypeHolder = new IntHolder();ShortHolder authRetriesHolder = new ShortHolder();


S O

AAA_GROUP_NAME The AAA group's name. Either AAA_GROUP_ID or AAA_GROUP_NAME must be used as a key.

S O

AAA_GROUP_ID The AAA group identification. Either AAA_GROUP_ID or AAA_GROUP_NAME must be used as a key.

S O

Table 62: A_A5020-VOIP_3-01_QRY_AAA-GROUP


Type Class



aaaGroup.GetAuthentication(authProtocolTypeHolder, authRetriesHolder);

IntHolder accountProtocolTypeHolder = new IntHolder();ShortHolder accountRetriesHolder = new ShortHolder();

aaaGroup.GetAccounting ( accountProtocolTypeHolder, accountRetriesHolder );

IntHolder defaultPortTypeHolder = new IntHolder();PortTypesHolder portTypes = new PortTypesHolder();

aaaGroup.GetPortAuthorisation( defaultPortTypeHolder, portTypes);

int[] portTypesValues = new int[10];portTypesValues = portTypes.value;Integer portType;String tempString = "PORT_TYPE";

BooleanHolder cfaEnableHolder = new BooleanHolder();tIpAddressHolder cfaIpAddressHolder = new tIpAddressHolder();IntHolder cfaPortHolder = new IntHolder();StringHolder cfaPrefixHolder = new StringHolder();ShortHolder cfaLanguageIndicatorHolder = new ShortHolder();StringHolder cfaDefaultAnnHolder = new StringHolder();

aaaGroup.GetVoIPCFA ( cfaEnableHolder, cfaIpAddressHolder, cfaPortHolder, cfaPrefixHolder, cfaLanguageIndicatorHolder, cfaDefaultAnnHolder);

Output parameters


ALCATEL_NRE_QUERY_AAA_GROUP_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_QUERY_AAA_GROUP_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

Upon a successful query with a record found, the following is returned as an INFO parameter into TBL_INFO_PARM:AAA_GROUP_IDAAA_GROUP_NAMEAAA_GROUP_ENABLE_ON_HOLDAAA_GROUP_MAX_USER_SESSIONSAAA_GROUP_MAX_ACCOUNTING_RETRIESAAA_GROUP_EXTERNALAAA_GROUP_FAILURE_TO_START_SUPPORT_FLAGAAA_GROUP_UNIDENTIFIED_ACCESS_FLAGAAA_GROUP_PRE_AUTHENTICATION_ACCESS_ONLY_FLAGAAA_GROUP_INTERACTION_SUPPORT_FLAG

NRE services


AAA_GROUP_SUPPORT_ACCOUNTING_INTERIM_UPDATES_FLAGAAA_GROUP_SUPPORT_ACCESS_FAILED_TICKETS_FLAGAAA_GROUP_SUPPORT_EAP_MESSAGE_START_FLAGAAA_GROUP_MANDATORY_PORTSET_FLAGAAA_GROUP_STAGE2_AUTHENTICATION_FLAGAAA_GROUP_STAGE2_ACCOUNTING_FLAGAAA_GROUP_ACCOUNTING_ONLY_FLAGAAA_GROUP_AUTHENTICATION_PROTOCOL_TYPEAAA_GROUP_AUTHENTICATION_RETRIESAAA_GROUP_ACCOUNTING_PROTOCOL_TYPEAAA_GROUP_ACCOUNTING _RETRIESAAA_GROUP_AUTHORISATION_DEFAULT_PORT_TYPEAAA_GROUP_AUTHORISATION_PORT_TYPESAAA_GROUP_BARRING_CLASSAAA_GROUP_MAXIMUM_CONCURRENT_CALLSAAA_GROUP_DIAL_IP_ADDRESS_PREFIXAAA_GROUP_DIAL_UNREGISTERED_ENDPOINTSAAA_GROUP_CALL_TRANSFERAAA_GROUP_UNCONDITIONAL_FORWARDING_ACTIVATIONAAA_GROUP_BUSY_FORWARD_ACTIVATIONAAA_GROUP_NOREPLY_FORWARD_ACTIVATIONAAA_GROUP_TRIGGER_DESTINATION_AS_FOR_UNREGISTERED_USERSAAA_GROUP_H323_PREGRANTED_ARQAAA_GROUP_H323_CHECK_LOCATION_TOKENAAA_GROUP_H323_RIP_REGISTRATIONAAA_GROUP_H323_RIP_UNREGISTRATIONAAA_GROUP_H323_RIP_CALL_ADMISSIONAAA_GROUP_H323_TERMINAL_AUTHENTICATION_METHODAAA_GROUP_H323_GATEWAY_AUTHENTICATION_METHODAAA_GROUP_H323_UPDATE_SETUP_ORIGINAAA_GROUP_H323_UPDATE_SETUP_DESTINATIONAAA_GROUP_H323_UPDATE_DISPLAYAAA_GROUP_TRIGGER_SIP_APPLICATION_SERVERAAA_GROUP_SIP_ORIGIN_APPLICATION_SERVERAAA_GROUP_SIP_DESTINATION_APPLICATION_SERVERAAA_GROUP_SIP_CALL_APPLICATION_SERVERAAA_GROUP_SIP_PROXY_LOCAL_DESTINATIONAAA_GROUP_SIP_PROXY_NON_LOCAL_DESTINATIONAAA_GROUP_SIP_TERMINAL_AUTHENTICATION_METHODAAA_GROUP_SIP_TERMINAL_AUTHENTICATION_METHOD_TYPEAAA_GROUP_SIP_HTTP_DIGESTAAA_GROUP_SIP_GATEWAY_AUTHENTICATION_METHODAAA_GROUP_SIP_GATEWAY_AUTHENTICATION_METHOD_TYPEAAA_GROUP_CFA_ENABLEAAA_GROUP_CFA_PREFIXAAA_GROUP_CFA_LANGUAGE_INDICATORAAA_GROUP_CFA_DEFAULT_ANNOUNCEMENTAAA_GROUP_IVR_IP_ADDRESSAAA_GROUP_IVR_PORTAAA_GROUP_AAA_SERVER_NAME_xAAA_GROUP_AAA_SERVER_ID_xAAA_GROUP_AAA_SERVER_TYPE_x



AAA_GROUP_AAA_SERVER_STAGE_xAAA_GROUP_AAA_SERVER_PRIORITY_x

A_A5020-VOIP_3-01_QRY_AAA-SELECTION-RULEQueries an AAA selection rule. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.qryAAASelectionRule.

Table 63: A_A5020-VOIP_3-01_QRY_AAA-SELECTION-RULE


Type Class


S R


The AAA group ID. Either GROUP_ID or GROUP_NAME and the SELECTION_RULE_NUMBER, must be used as a key. The SELECTION_RULE_ID can be used as a key by itself.

S O


The AAA group name. Either GROUP_ID or GROUP_NAME and the SELECTION_RULE_NUMBER, must be used as a key. The SELECTION_RULE_ID can be used as a key by itself.

S O




The VPN name. S O

NRE services



The AAA selection rule identification. Either AAA_GROUP_ID or NAME, and the SELECTION_RULE_NUMBER must be used as a key; SELECTION_RULE_ID can be used by itself. If not set, rule is placed at start of sequence of rules.

S O


Priority sequence of the rule within an AAA group. Either AAA_GROUP_ID or NAME, and the SELECTION_RULE_NUMBER must be used as a key; SELECTION_RULE_ID can be used by itself. If not set, rule is placed at start of sequence of rules.

S O



S O




S O



Type Class




Describes the mask in which the origin must fit so that it can select the correct AAA group. This mask can be based on the user name or calling party E.164 number.

S O


The lowest IP address in the range you are defining. Either Address, RAN, POP or Gatekeeper will be used as the ORIGIN selector.

S O


The end IP address in the range you are defining.

S O


The AAA selection originating RAN ID. Either the RAN_ID or RAN_NAME must be used as a key.

S O


The AAA selection originating RAN name. Either RAN_ID or RAN_NAME must be used as a key. Either Address, RAN, POP or Gatekeeper will be used as the ORIGIN selector.

S O


The AAA selection originating POP ID. Either POP_ID or POP_NAME must be used as a key.

S O



Type Class

NRE services



The AAA selection originating POP name. Either POP_ID or POP_NAME must be used as a key. Either RAN, POP or Gatekeeper will be used as the ORIGIN selector.

S O


The AAA selection originating external gatekeeper name. Either GATEKEEPER_ID or GATEKEEPER_NAME must be used as a key. Either Address, RAN, POP or Gatekeeper will be used as the ORIGIN selector.

S O


The AAA selection originating external gatekeeper ID. Either GATEKEEPER_ID or GATEKEEPER_NAME must be used as a key.

S O


Define the mask in which the destination must fit to correctly select the AAA group. This mask can be based on the user name or called party E.164 number.

S O


Enter the lowest IP address in the range that you are defining for the called IP address.

S O



Type Class



MML command/API callsselectionRule = selectionIterator.OpenVoIPAAASelectionRule( selectionRuleList[count].Id);IntHolder ruleIdHolder = new IntHolder();IntHolder ruleNumberHolder = new IntHolder();BooleanHolder enableFlagHolder = new BooleanHolder();IntHolder aaaGroupIdHolder = new IntHolder();enumAAARulesMethodHolder selectionMethodHolder = new enumAAARulesMethodHolder();StringHolder originMaskHolder = new StringHolder();OriginAddressHolder originAddHolder = new OriginAddressHolder();StringHolder destMaskHolder = new StringHolder();tIpAddressHolder destStartIPaddrHolder = new tIpAddressHolder();tIpAddressHolder destEndIPaddrHolder = new tIpAddressHolder();selectionRule.Get ( ruleIdHolder, ruleNumberHolder, enableFlagHolder, aaaGroupIdHolder, selectionMethodHolder, originMaskHolder, originAddHolder, destMaskHolder, destStartIPaddrHolder, destEndIPaddrHolder );


Enter the highest IP address in the range that you are defining for the called IP address.

S O



C O

OLD_AAA_SELECTION



C O



Type Class

NRE services


Output parameters


ALCATEL_QUERY_AAA_SELECTION_RULE_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_QUERY_AAA_SELECTION_RULE_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

Upon a successful query with a record found, the following is returned as an INFO parameter into TBL_INFO_PARM and CSDL parameters into TBL_SRQ_SARM (Note that some ORIGIN parameters are mutually exclusive).

If only one row is retrieved, then this set of scalar parameters are returned:AAA_SELECTION_AAA_GROUP_NAMEAAA_SELECTION_AAA_GROUP_IDAAA_SELECTION_RULE_IDAAA_SELECTION_RULE_NUMBERAAA_SELECTION_VPN_NAMEAAA_SELECTION_VPN_IDAAA_SELECTION_ENABLE_FLAGAAA_SELECTION_METHODAAA_SELECTION_ORIGIN_MASKAAA_SELECTION_ORIGIN_START_ADDRESSAAA_SELECTION_ORIGIN_END_ADDRESSAAA_SELECTION_ORIGIN_POP_NAMEAAA_SELECTION_ORIGIN_POP_IDAAA_SELECTION_ORIGIN_RAN_NAMEAAA_SELECTION_ORIGIN_RAN_IDAAA_SELECTION_ORIGIN_EXTERNAL_GATEKEEPER_NAMEAAA_SELECTION_ORIGIN_EXTERNAL_GATEKEEPER_IDAAA_SELECTION_DESTINATION_MASKAAA_SELECTION_DESTINATION_START_ADDRESSAAA_SELECTION_DESTINATION_END_ADDRESS

If only one row is retrieved then both the SCALAR and COMPOUND parameters are populated, if more than one row is retrieved, then only the AAA_SELECTION_RULE compound parameter is populated.

It is up to the upstream system to interpret how to use which set of returned data for its own purposes.



A_A5020-VOIP_3-01_QRY_ROUTEQueries an existing route. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.queryRoute.

MML command/API callsVoIPRoutingConfig routeConfig = VoIPRoutingConfigHelper.narrow(voIPRouteHolder.value);

routeConfig = sessiontelco.OpenVoIPRoutingConfig(routeConfigID ); routeConfig.Get(routeConfigIDHolder, routeConfigNameHolder); routeIDValue = new Integer(routeConfigIDHolder.value); VoIPRoutingConfigIterator routingConfigIterator = sessiontelco.GetVoIPRoutingConfigs ();;

BaseListItem configList[] = routingConfigIterator.ListItems(); for ( int count=0; count< configList.length; count++ ) { String configName = configList[count].Name; int configId = configList[count].Id ;

routeConfig = routingConfigIterator.OpenVoIPRoutingConfig( configId ); routeConfig.Get( routeConfigIDHolder, routeConfigNameHolder ); routeIDValue = new Integer( routeConfigIDHolder.value ); }

Table 64: A_A5020-VOIP_3-01_QRY_ROUTE


Type Class


S R


S O


S O

NRE services


Output parameters


ALCATEL_NRE_QUERY_ROUTE_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_QUERY_ROUTE_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

Upon a successful query with a record found, the following is returned as an INFO parameter into TBL_INFO_PARM:ROUTE_IDROUTE_NAMEROUTE_TYPEROUTE_CARRIER_PREFIXROUTE_ITSPLDROUTE_ENDPOINT_ADDRESSROUTE_ENDPOINT_PORTROUTE_ENDPOINT_TYPEROUTE_ODPROUTE_GW_POP

A_A5020-VOIP_3-01_QRY_ROUTE-BLOCKQueries a route block. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.queryRouteBlock.

Table 65: A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK


Type Class


S R

ROUTE_BLOCK_ID The route block identifier. This is a primary key. Either ROUTE_BLOCK_ID or ROUTE_BLOCK_NAME must be used as a key.

S O





if (routingType.equalsIgnoreCase("RouteBlockPriority" ) ) { routeBlockType = RouteBlockType.RouteBlockPriority; int[] routeIdValue = {Integer.parseInt(routeId)}; routeBlockRoutes.priorityRoutes(routeIdValue); } else if ( routingType.equalsIgnoreCase("RouteBlockWeighted" ) ) { routeBlockType = RouteBlockType.RouteBlockWeighted; int routeIdValue = Integer.parseInt(routeId); short routeWeightValue = Short.parseShort(routeWeight);

ROUTE_BLOCK_NAME


S O


S O

ROUTE_CONFIG_NAME


S O

Table 65: A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK


Type Class

NRE services


WeightedRoute[] weightRoute = {new WeightedRoute(routeIdValue,routeWeightValue) }; WeightedRouteListHolder weightRouteHolder = new WeightedRouteListHolder(weightRoute); routeBlockRoutes.weightedRoutes(weightRouteHolder.value); } enumRouteFallback routeFallbackString = enumRouteFallback.RouteFallbackNone; int clearingHouseId = 0;


Output parameters


ALCATEL_NRE_QUERY_ROUTEBLOCK_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_QUERY_ROUTEBLOCK_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

Upon a successful query with a record found, the following is returned as an INFO parameter into TBL_INFO_PARM:ROUTE_BLOCK_IDROUTE_BLOCK_NAMEROUTE_BLOCK_ROUTE_CONFIG_IDROUTING_TYPEROUTE_ID_1ROUTE_ID_2ROUTE_ID_3ROUTE_ID_4ROUTE_ID_5ROUTE_ID_6ROUTE_ID_7ROUTE_ID_8ROUTE_ID_9ROUTE_ID_10ROUTE_WEIGHT_1ROUTE_WEIGHT_2ROUTE_WEIGHT_3ROUTE_WEIGHT_4ROUTE_WEIGHT_5



A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-ALLQueries route blocks on the NE. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.queryRouteBlockAll.


Get RoutingConfig VoIPRoutingConfig routeConfig = VoIPRoutingConfigHelper.narrow(voIPRouteHolder.value);




Get RouteBlock

VoIPRouteBlockIterator routeBlockIterator = null;

routeBlockIterator = voipRouteConfig.GetVoIPRouteBlocks();

Table 66: A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-ALL


Type Class


S R

NRE services


if ( routeBlockIterator == null ) { throw new ProvCartridgeException ( SAConstants.NOENTITY_EXIT_MSG + "RouteBlock Iterator object is not created" ); }

BaseListItem routeBlockList[] = routeBlockIterator.ListItems();

String tempRouteName; int tempRouteBlockId;

for ( int count = 0; count < routeBlockList.length; count++ ) {

tempRouteName = routeBlockList[count].Name; tempRouteBlockId = routeBlockList[count].Id;

if ( tempRouteName.equalsIgnoreCase(routeBlockName ) ) {

routeBlockId = tempRouteBlockId; break; } }

VoIPRouteIterator routeIterator = null;

routeIterator = sessionTelco.GetVoIPRoutes ();

if ( routeIterator == null ) { throw new ProvCartridgeException ( SAConstants.NOENTITY_EXIT_MSG + " GetVoIPRoutes method return NULL"); }

BaseListItem routeList[] = routeIterator.ListItems();

String tempRouteName; int tempRouteId;

for ( int count=0; count< routeList.length; count++ ) {

tempRouteName = routeList[count].Name; tempRouteId = routeList[count].Id ;

if ( tempRouteName.equalsIgnoreCase(routeName) ) { routeId = tempRouteId; break;



} }

Output parameters


ALCATEL_NRE_QUERY_ROUTE_BLOCK_ALL_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_QUERY_ROUTE_BLOCK_ALL_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

Upon a successful query with a record found, the following is returned as an INFO parameter into TBL_INFO_PARM:ROUTE_CONFIG.(n).ROUTE_CONFIG_NAMEROUTE_CONFIG.(n).ROUTE_CONFIG_IDROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_BLOCK_NAMEROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_BLOCK_IDROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTING_TYPE

ROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_1.ROUTE_NAMEROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_1.ROUTE_IDROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_1.ROUTE_ODPROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_1.ROUTE_GW_POP_RAN_ID

… (All of the parameters listed above for ROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_1 may also be returned for ROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_2 through ROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_10.)

ROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_WEIGHT_1ROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_WEIGHT_2ROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_WEIGHT_3ROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_WEIGHT_4ROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_WEIGHT_5

NRE services


A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIXQueries a route block prefix. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.queryRouteBlockPrefix.

Table 67: A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIX


Type Class


S R


S O

ROUTE_CONFIG_NAME


S O


S O

ROUTE_BLOCK_NAME


S O



MML command/API callsVoIPRoutingConfig voIPRoutingConfig = sessiontelco.OpenVoIPRoutingConfig(routeConfigID );

if (routeBlockIdValue!=null) voipRouteBlock = voIPRoutingConfig.OpenVoIPRouteBlock(routeBlockIdValue );

} else if ( ( routeBlockName != null ) && ( routeBlockId == null ) ) { VoIPRouteBlockIterator routeBlockIterator = voIPRoutingConfig.GetVoIPRouteBlocks();; BaseListItem routeBlockList[] = routeBlockIterator.ListItems();

for ( int count = 0; count < routeBlockList.length; count++ ) { String tempRouteName = routeBlockList[count].Name; int tempRouteBlockId = routeBlockList[count].Id;

if ( tempRouteName.equalsIgnoreCase(routeBlockName ) ) { voipRouteBlock = routeBlockIterator.OpenVoIPRouteBlock(tempRouteBlockId ); } } }

VoIPRoutingMatch routingMatch[] = voipRouteBlock.GetMatchList();

for ( int count = 0; count < routingMatch.length; count++ ) { VoIPRoutingMatch routeMatch = (VoIPRoutingMatch)routingMatch[count]; enumVoIPRoutingMatchType routeMatchType = routeMatch.discriminator();

String routeMatchString = routeMatchType.toString(); if ( routeMatchString.equals("VoIPRoutingMatchTypeE164Range" ) ) {

VoIPRoutingMatchE164Range matchRange = routeMatch.E164Range(); String startPrefix = matchRange.start; String endPrefix = matchRange.end;

returnInfoParam ( "Start Prefix Value" , startPrefix ); returnInfoParam ( "End Prefix value" , endPrefix ); } }

NRE services


Output parameters


ALCATEL_NRE_QUERY_ROUTEBLOCKPREFIX_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_QUERY_ROUTEBLOCKPREFIX_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

Upon a successful query with a record found, the following is returned as an INFO parameter into TBL_INFO_PARM:ROUTE_BLOCK_NAMEROUTE_BLOCK_IDROUTE_BLOCK_START_PREFIX.(n)ROUTE_BLOCK END_PREFIX.(n)

A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIX-ALLQueries a route prefix on the NE. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.queryRouteBlockPrefixAll.


Get RoutingConfig VoIPRoutingConfig routeConfig = VoIPRoutingConfigHelper.narrow(voIPRouteHolder.value);


Table 68: A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIX-ALL


Type Class


S R


Route block start prefix.

S R





Get RouteBlock

VoIPRouteBlockIterator routeBlockIterator = null;

routeBlockIterator = voipRouteConfig.GetVoIPRouteBlocks();

if ( routeBlockIterator == null ) { throw new ProvCartridgeException ( SAConstants.NOENTITY_EXIT_MSG + "RouteBlock Iterator object is not created" ); }

BaseListItem routeBlockList[] = routeBlockIterator.ListItems();

String tempRouteName; int tempRouteBlockId;

for ( int count = 0; count < routeBlockList.length; count++ ) {

tempRouteName = routeBlockList[count].Name; tempRouteBlockId = routeBlockList[count].Id;

if ( tempRouteName.equalsIgnoreCase(routeBlockName ) ) {

routeBlockId = tempRouteBlockId; break; } }

VoIPRouteIterator routeIterator = null;

routeIterator = sessionTelco.GetVoIPRoutes ();

NRE services


if ( routeIterator == null ) { throw new ProvCartridgeException ( SAConstants.NOENTITY_EXIT_MSG + " GetVoIPRoutes method return NULL"); }

BaseListItem routeList[] = routeIterator.ListItems();

String tempRouteName; int tempRouteId;

for ( int count=0; count< routeList.length; count++ ) {

tempRouteName = routeList[count].Name; tempRouteId = routeList[count].Id ;

if ( tempRouteName.equalsIgnoreCase(routeName) ) { routeId = tempRouteId; break; } }

Output parameters


ALCATEL_NRE_QUERY_ROUTE_BLOCK_PREFIX_ALL_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_QUERY_ROUTE_ BLOCK_PREFIX_ALL_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

Upon a successful query with a record found, the following is returned as an INFO parameter into TBL_INFO_PARM:ROUTE_CONFIG.(n).ROUTE_CONFIG_IDROUTE_CONFIG.(n).ROUTE_CONFIG_NAMEROUTE_CONFIG.(n).ROUTE_BLOCK_START_PREFIXROUTE_CONFIG.(n).ROUTE_BLOCK_END_PREFIX

ROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_BLOCK_NAMEROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_BLOCK_IDROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTING_TYPEROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_1.ROUTE_NAMEROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_1.ROUTE_IDROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_1.ROUTE_ODPROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_1.ROUTE_GW_POP_RAN_ID

… (All of the parameters listed above for ROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_1 may also be returned for



ROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_2 through ROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_10.)

ROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_WEIGHT_1ROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_WEIGHT_2ROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_WEIGHT_3ROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_WEIGHT_4ROUTE_CONFIG.(n).ROUTE_BLOCK.(m).ROUTE_WEIGHT_5

A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-SUFFIXQueries a route block suffix. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.queryRouteBlockSuffix.

Table 69: A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-SUFFIX


Type Class


S R


S O

ROUTE_CONFIG_NAME


S O


S O

NRE services


MML command/API callsVoIPRoutingConfig voIPRoutingConfig = sessiontelco.OpenVoIPRoutingConfig(routeConfigID );

if (routeBlockIdValue!=null) voipRouteBlock = voIPRoutingConfig.OpenVoIPRouteBlock(routeBlockIdValue );

} else if ( ( routeBlockName != null ) && ( routeBlockId == null ) ) { VoIPRouteBlockIterator routeBlockIterator = voIPRoutingConfig.GetVoIPRouteBlocks();; BaseListItem routeBlockList[] = routeBlockIterator.ListItems();

for ( int count = 0; count < routeBlockList.length; count++ ) { String tempRouteName = routeBlockList[count].Name; int tempRouteBlockId = routeBlockList[count].Id;

if ( tempRouteName.equalsIgnoreCase(routeBlockName ) ) { voipRouteBlock = routeBlockIterator.OpenVoIPRouteBlock(tempRouteBlockId ); } } }

VoIPRoutingMatch routingMatch[] = voipRouteBlock.GetMatchList();

for ( int count = 0; count < routingMatch.length; count++ ) { VoIPRoutingMatch routeMatch = (VoIPRoutingMatch)routingMatch[count]; enumVoIPRoutingMatchType routeMatchType = routeMatch.discriminator();

String routeMatchString = routeMatchType.toString(); if ( routeMatchString.equals("VoIPRoutingMatchTypeE164Range" ) ) {

ROUTE_BLOCK_NAME


S O

Table 69: A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-SUFFIX


Type Class



VoIPRoutingMatchE164Range matchRange = routeMatch.E164Range(); String startPrefix = matchRange.start; String endPrefix = matchRange.end;

returnInfoParam ( "Start Prefix Value" , startPrefix ); returnInfoParam ( "End Prefix value" , endPrefix ); } }

Output parameters


ALCATEL_NRE_QUERY_ROUTEBLOCKSUFFIX_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_QUERY_ROUTEBLOCKSUFFIX_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

Upon a successful query with a record found, the following is returned as an INFO parameter into TBL_INFO_PARM:ROUTE_BLOCK_NAMEROUTE_BLOCK_IDROUTE-BLOCK-SUFFIX.(n)

A_A5020-VOIP_3-01_QRY_ROUTE-CONFIGQueries the route configuration. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.queryRouteConfig.

Table 70: A_A5020-VOIP_3-01_QRY_ROUTE-CONFIG


Type Class


S R


S O

NRE services


MML command/API callsVoIPRoutingConfigIterator routingConfigIterator = sessiontelco.GetVoIPRoutingConfigs();

routingConfigIterator BaseListItem configList[] = routingConfigIterator.ListItems();

for ( int count=0; count< configList.length; count++ ){ String configName = configList[count].Name; int configId = configList[count].Id ;

if ( configName.equals(routeConfigName) ) { routeConfig = routingConfigIterator.OpenVoIPRoutingConfig( configId ); routeConfig.Get( routeConfigIDHolder, routeConfigNameHolder ); routeIDValue = new Integer( routeConfigIDHolder.value ); }}

Output parameters


ALCATEL_NRE_QUERY_ROUTECONFIG_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_QUERY_ROUTECONFIG_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

Upon a successful query with a record found, the following is returned as an INFO parameter into TBL_INFO_PARM:ROUTE_CONFIG_IDROUTE_CONFIG_NAME

ROUTE_CONFIG_NAME


S O

Table 70: A_A5020-VOIP_3-01_QRY_ROUTE-CONFIG


Type Class



ROUTE_BLOCK.(n).ROUTE_BLOCK_NAMEROUTE_BLOCK.(n).ROUTE_BLOCK_ROUTE_CONFIG_IDROUTE_BLOCK.(n).ROUTING_TYPEROUTE_BLOCK.(n).ROUTE_ID_1ROUTE_BLOCK.(n).ROUTE_ID_2ROUTE_BLOCK.(n).ROUTE_ID_3ROUTE_BLOCK.(n).ROUTE_ID_4ROUTE_BLOCK.(n).ROUTE_ID_5ROUTE_BLOCK.(n).ROUTE_ID_6ROUTE_BLOCK.(n).ROUTE_ID_7ROUTE_BLOCK.(n).ROUTE_ID_8ROUTE_BLOCK.(n).ROUTE_ID_9ROUTE_BLOCK.(n).ROUTE_ID_10ROUTE_BLOCK.(n).ROUTE_WEIGHT_1ROUTE_BLOCK.(n).ROUTE_WEIGHT_2ROUTE_BLOCK.(n).ROUTE_WEIGHT_3ROUTE_BLOCK.(n).ROUTE_WEIGHT_4ROUTE_BLOCK.(n).ROUTE_WEIGHT_5VPN_ID.(n)

A_A5020-VOIP_3-01_QRY_VPNQueries a VPN. It is implemented by the Java method com.metasolv.cartridge.oss.ala5020_voip_3_01.prov.NREProvisioning.qryVPN.

MML command/API callsTelcoVPN telcoVpn = vpnIt.OpenTelcoVPN(vpnList[i].Id);tDateTimeHolder activationTime = new tDateTimeHolder();tDateTimeHolder deActivationTime = new tDateTimeHolder();

Table 71: A_A5020-VOIP_3-01_QRY_VPN


Type Class


S R


S O


S O

NRE services


IntHolder loginAllowedTimeId = new IntHolder();IntHolder specialLoginPeriodId = new IntHolder();BooleanHolder onHold = new BooleanHolder();telcoVpn.GetAccount(activationTime,deActivationTime,loginAllowedTimeId,specialLoginPeriodId,onHold);

Output parameters


ALCATEL_NRE_QUERY_VPN_ERRCODE as INFO parameter to the SARM table TBL_INFO_PARM.ALCATEL_NRE_QUERY_VPN_ERRCODE as CSDL parameter to the SARM table TBL_SRQ_PARM.

Upon a successful query with a record found, the following is returned as an INFO parameter into TBL_INFO_PARM:VPN_IDVPN_NAMECURRENCYMAX_USERSMAX_SESSIONSADMIN_IDPAYING_ADMIN_IDPRIVATE_POOLSHSP_POOLSDUBIOUS_IP_TIMEOUTDBLOG_STARTEXTSESSDBLOG_ENDEXTSESSDBLOG_STARTINTSESSDBLOG_ENDINTSESSDBLOG_INTERIM_EXTDBLOG_INTERIM_INTDBLOG_TUNNEL_EXTDBLOG_TUNNEL_INTDBLOG_VENDOR_SPECIFICCSVLOG_STARTEXTSESSCSVLOG_ENDEXTSESSCSVLOG_STARTINTSESSCSVLOG_ENDINTSESSCSVLOG_INTERIM_EXTCSVLOG_INTERIM_INTCSVLOG_TUNNEL_EXTCSVLOG_TUNNEL_INTCSVLOG_VENDOR_SPECIFICHOLIDAY.(n).YEARHOLIDAY.(n).MONTHHOLIDAY.(n).DAYHOLIDAY.(n).HOURHOLIDAY.(n).MINUTE



HOLIDAY.(n).SECONDACTIVATIONTIME_YEARACTIVATIONTIME_MONTHACTIVATIONTIME_DAYACTIVATIONTIME_HOURACTIVATIONTIME_MINUTEACTIVATIONTIME_SECONDDEACTIVATIONTIME_YEARDEACTIVATIONTIME_MONTHDEACTIVATIONTIME_DAYDEACTIVATIONTIME_HOURDEACTIVATIONTIME_MINUTEDEACTIVATIONTIME_SECONDLOGIN_ALLOWED_TIMES.(n).NAMELOGIN_ALLOWED_TIMES.(n).IDLOGIN_ALLOWED_TIMES.(n).DAY.(m)LOGIN_ALLOWED_TIMES.(n).START_HOUR(m)LOGIN_ALLOWED_TIMES.(n).START_MINUTE(m)LOGIN_ALLOWED_TIMES.(n).STOP_HOUR(m)LOGIN_ALLOWED_TIMES.(n). STOP_ MINUTE (m)SPECIAL_PERIODS.(n).NAMESPECIAL_PERIODS.(n).IDSPECIAL_PERIODS.(n).START_DAYSPECIAL_PERIODS.(n).END_DAYSPECIAL_PERIODS.(n).MONTHSPECIAL_PERIODS.(n).YEARSPECIAL_PERIODS.(n).LOGINTIMESIDONHOLD

Customizing error handlingYou can customize the cartridge’s error handling behavior by updating the following file:

tbl_user_err.sql

From this file, you can remap any user-type exit code (USER_TYPE) to a different base exit type (BASE_TYPE). For example, if on a given NE you want a particular ASDL to return a SOFT_FAIL instead of FAIL (which is a hard fail) when it detects a specific error, you change the BASE_TYPE associated with the appropriate USER_TYPE from FAIL to SOFT_FAIL (the ASDL state table or Java method’s exit type is mapped to the USER_TYPE).

Before

USER_TYPE BASE_TYPE DESCRIPTION

A5020_SYS_FAIL FAIL System Failure

Customizing error handling


After

ASAP base exit types

SUCCEED — successful ASDL execution.FAIL — hard error.SOFT_FAIL — a soft error occurred, but processing will be allowed to continue.RETRY — the ASDL was not provisioned, but will be retried again.MAINTENANCE — the ASDL detected the NE is in maintenance mode.DELAYED_FAIL — the ASDL failed; but processing will continue.

For a complete description of the ASAP base-error types, refer to Chapter 3 of the ASAP Developer’s Guide.

The Alcatel A5020 Softswitch User Error Types

The user defined error / exit types are in A5020_VOIP_3_01_UserExitTypes.cfg.

The following table lists the contents of this file. You have full control of this file. For example, you can add additional error codes to this file as discovered. If you add an additional error code, ensure the corresponding user exit type and ASAP exit type in tbl_user_err.

USER_TYPE BASE_TYPE DESCRIPTION

A5020_SYS_FAIL SOFT_FAIL System Failure

If this file is removed or its path is incorrect, the user exit type defaults to A5020_NO_MATCH and maps to ASAP exit type FAIL.

Table 72: User Exit Type Descriptions

USER EXIT TYPE DESCRIPTION

ALA_SUCCESS Successful Status

ALA_FAIL System/Generic failure

ALA_DATABASE_ERROR Database Failure

ALA_INVALID_VALUE Any number of server validation errors, or ASDL/CSDL parameter values that are invalid

ALA_INVALID_PARAM An ASDL/CSDL or entity parameter is invalid

ALA_BASE_EXCEPTION Add fails due to object previously existing



ALA_ENTITY_EXIST Delete fails due to object not previously existing

ALA_MISSING_PARAM A required parameter is missing

ALA_NO_ENTITY No Such Entity exists on a lookup of a parent entity, or associated entity, or current entity

ALA_NOT_IMPLEMENTED This particular feature/functionality not yet implemented

ALA_UNEXPECTED Unknown internal error

ALA_TELCO_VPN_ERROR The Telco VPN could not be obtained

ALA_BASE_ERROR Error with Base CORBA entity

ALA_AAA_GROUP_ERROR Error in AAA Group

ALA_ROUTEBLOCK_ERROR Error in route block entity

ALA_TELCO_ERROR The Telco object could not be obtained

ALA_SMC_ROOT_ERROR The main server entity object could not be obtained

ALA_RAN_ERROR Error in Remote access node entity

ALA_POP_ERROR Error in Point of Presence entity

ALA_ATTRIBUTE_ERROR Error in AAA Group attributes

ALA_SELECT_RULE_ERROR Error in AAA Selection rule entity

ALA_ROUTE_ERROR Error in route entity

ALA_ROUTECONFIG_ERROR Error in route config entity

ALA_VPN_ERROR Error in obtaining Virtual Private Network entity

A5020_NO_MATCH Unknown generic exit type

Table 72: User Exit Type Descriptions

USER EXIT TYPE DESCRIPTION


4

Service Definitions

The Alcatel A5020 Softswitch cartridge contains a set of CSDLs that map to one or more ASDL commands. You can also create additional CSDLs that map to existing and newly-created ASDLs. An upstream system can assemble any of these CSDL commands onto a work order for provisioning.

This chapter presents detailed information on the CSDL parameters that we provide in this cartridge. The following table lists and describes the type of parameter information that is included.

Table 73: CSDL parameter information

Information Type Description


Description Describes the parameter.

Range Describes or lists the range of values that can be used to satisfy this parameter.

Default Value Configures a default value for the parameter so that it is not mandatory for the upstream system to provide a value.

Chapter 4: Service Definitions


Type Indicates one of the following parameter types:

S—Scalar, specifies the parameter label transmitted on the ASDL command. Scalar parameters are conventional name-value pair parameters.C—Compound, specifies the base name of the compound parameter transmitted on the ASDL command. A compound parameter contains structures or arrays of information that are represented by a particular structure name or compound parameter name. Each compound parameter can contain a large number of elements. If you use compound parameters, you only require a single entry in the ASAP translation tables to call the compound parameter and all its associated parameter elements.I—Indexed, identifies a parameter that contains a sequential numerical index value to tell the SARM that it should execute the same operation (for example, an ASDL command) for all occurrences of that index. Consequently, if there are several options on a particular CSDL command (OPT1, OPT2, OPT3, etc.), you can specify the OPT parameter as an indexed parameter. When you specify the OPT parameter as an indexed parameter, the SARM generates several occurrences of that same ASDL command and each command has a different value for the option being transmitted to the NEP.

For more information on parameter types, refer to the ASAP Developer’s Reference.

Class Indicates one of the following parameter classifications:

R—Required scalar parameterO—Optional scalar parameterC—Required compound parameterN—Optional compound parameterM—Mandatory indexed parameterI—Optional indexed parameterS—Parameter count


Table 73: CSDL parameter information

Information Type Description

CCE Service Pack


For a detailed description of the Required and Optional parameter classifications, refer to the ASAP System Configuration and Management Guide.

CCE Service PackThis cartridge provides the following CSDL commands:

C_A5020-VOIP_3-01_ADD_CCEC_A5020-VOIP_3-01_ADD_NREC_A5020-VOIP_3-01_ADD_POPC_A5020-VOIP_3-01_ADD_RANC_A5020-VOIP_3-01_DEL_POPC_A5020-VOIP_3-01_DEL_RANC_A5020-VOIP_3-01_MOD_POPC_A5020-VOIP_3-01_MOD_RANC_A5020-VOIP_3-01_QRY_ALL-RANSC_A5020-VOIP_3-01_QRY_POPC_A5020-VOIP_3-01_QRY_RAN

C_A5020-VOIP_3-01_ADD_CCEAdds a Call Control Engine.

Table 74: C_A5020-VOIP_3-01_ADD_CCE


Type Class

CCE_ID The CCE instance identifier.

S R

NE_ID_CCE The A5020 instance identifier, or the CCE instance.

S R



Mapping to ASDLs

The following table illustrates the CSDL to ASDL mapping for this service.

C_A5020-VOIP_3-01_ADD_NREAdds a Network Routing Engine.

Mapping to ASDLs


Table 75: CSDL to ASDL Mapping

CSDL ASDL

C_A5020-VOIP_3-01_ADD_CCE A_A5020-VOIP_3-01_ADD_CCE

Table 76: C_A5020-VOIP_3-01_ADD_NRE


Type Class

NE_ID_CCE The A5020 instance identifier.

S R

NRE_ID The NRE instance identifier.

S R


CSDL ASDL

C_A5020-VOIP_3-01_ADD_NRE A_A5020-VOIP_3-01_ADD_NRE

CCE Service Pack


C_A5020-VOIP_3-01_ADD_POPAdds a Point of Presence (POP).

Mapping to ASDLs


Table 78: C_A5020-VOIP_3-01_ADD_POP


Type Class


S R

POP_NAME The POP name. Valid characters are alphanumeric capitals.

S R


PopTypeVIRTUALPOP

S R


S O


S O


CSDL ASDL

C_A5020-VOIP_3-01_ADD_POP A_A5020-VOIP_3-01_ADD_POP



C_A5020-VOIP_3-01_ADD_RANAdds a Remote Area Node.

Table 80: C_A5020-VOIP_3-01_ADD_RAN


Type Class


S R


S O


S O

RAN_COMMAND_PORT


S O


Enable S O



S O



S O



S O



S O



S O

CCE Service Pack




S O

RAN_FLAG_TRUSTED

The RAN Trusted flag. S O


RanITFFlagIPING

S O

RAN_ITF_IP_ADDRESS


C O

RAN_ITF_IP_NETMASK



S O

RAN_LRQ_ENDPOINT_PORT


S O



S O

RAN_NAME The Remote Area Node name.

S R


5 S O



Type Class



RAN_PROTOCOL_TYPE


S O


S O

RAN_TYPE The RAN type. RanTypeMAX4000, RanTypeMAXINT, RanTypeSHIVA, RanTypePM, RanTypeCISCO, RanTypeDANA2100, RanTypeTUNNELSERVER, RanTypeREDBACK, RanTypeAssured, RanTypeMAX6000, RanTypeSHASTA5000, RanType3COM, RanTypeUNISPHERE, and RanTypeVIRTUALRAN.

RanTypeVIRTUALRAN

S O



S O




S O



Type Class

CCE Service Pack





S O

RAN_VOICE_PROTOCOL


S O



S O




S O

RAN_VOICE_TRUSTED



S O



Type Class



Mapping to ASDLs


C_A5020-VOIP_3-01_DEL_POPDeletes a POP.

VPN_ID The VPN instance identifier. Either VPN ID or VPN Name may be used as a key. VPN will default to MANAGER if not specified.

S O

VPN_NAME The VPN name identifier. Either VPN ID or VPN Name may be used as a key. VPN will default to MANAGER if not specified.

S O


CSDL ASDL

C_A5020-VOIP_3-01_ADD_RAN A_A5020-VOIP_3-01_ADD_RAN

Table 82: C_A5020-VOIP_3-01_DEL_POP


Type Class


S R



Type Class

CCE Service Pack


Mapping to ASDLs


C_A5020-VOIP_3-01_DEL_RANDeletes the Remote Area Node.


S O


S O


S O


S O


CSDL ASDL

C_A5020-VOIP_3-01_DEL_POP A_A5020-VOIP_3-01_DEL_POP

Table 84: C_A5020-VOIP_3-01_DEL_RAN


Type Class


S R

Table 82: C_A5020-VOIP_3-01_DEL_POP


Type Class



Mapping to ASDLs



S O


S O


S O


S O


CSDL ASDL

C_A5020-VOIP_3-01_DEL_RAN A_A5020-VOIP_3-01_DEL_RAN

Table 84: C_A5020-VOIP_3-01_DEL_RAN


Type Class

CCE Service Pack


C_A5020-VOIP_3-01_MOD_POPModifies a Point of Presence.

Table 86: C_A5020-VOIP_3-01_MOD_POP


Type Class

NEW_POP_NAME The new POP name. S O


S R


S O


S O


S O


S O


S O



Mapping to ASDLs


C_A5020-VOIP_3-01_MOD_RANModifies a Remote Area Node.


CSDL ASDL

C_A5020-VOIP_3-01_MOD_POP A_A5020-VOIP_3-01_MOD_POP

Table 88: C_A5020-VOIP_3-01_MOD_RAN


Type Class


S R

POP_ID The POP primary identifier.

S O

POP_NAME The POP name. S O

RAN_COMMAND_PORT


S O


S O



S O



S O



S O



S O

CCE Service Pack




S O



S O

RAN_FLAG_TRUSTED

The RAN Trusted flag. S O


S O


RanITFFlagIPING

S O

RAN_ITF_IP_ADDRESS


C O

RAN_ITF_IP_NETMASK



S O

RAN_LRQ_ENDPOINT_PORT


S O



Type Class





S O


S O


S O

RAN_PROTOCOL_TYPE


S O


S O

RAN_TYPE The RAN type. RanTypeMAX4000, RanTypeMAXINT, RanTypeSHIVA, RanTypePM, RanTypeCISCO, RanTypeDANA2100, R100, RanTypeTUNNELSERVER, RanTypeREDBACK, RanTypeAssured, RanTypeMAX6000, RanTypeSHASTA5000, RanType3COM, RanTypeUNISPHERE, RanTypeVIRTUALRAN

S O



Type Class

CCE Service Pack




S O




S O




S O

RAN_VOICE_PROTOCOL


S O



Type Class





S O




S O

RAN_VOICE_TRUSTED



S O


S O


S O



Type Class

CCE Service Pack


Mapping to ASDLs


C_A5020-VOIP_3-01_QRY_ALL-RANSGets information about all Remote Access Nodes on a given POP.

Mapping to ASDLs



CSDL ASDL

C_A5020-VOIP_3-01_MOD_RAN A_A5020-VOIP_3-01_MOD_RAN

Table 90: C_A5020-VOIP_3-01_QRY_ALL-RANS


Type Class


S R


S O


S O


CSDL ASDL

C_A5020-VOIP_3-01_QRY_ALL-RANS A_A5020-VOIP_3-01_QRY_ALL-RANS



C_A5020-VOIP_3-01_QRY_POPGets information about the Point of Presence.

Mapping to ASDLs


C_A5020-VOIP_3-01_QRY_RANGets information about a Remote Area Node.

Table 92: C_A5020-VOIP_3-01_QRY_POP


Type Class


S R


S O


S O


CSDL ASDL

C_A5020-VOIP_3-01_QRY_POP A_A5020-VOIP_3-01_QRY_POP

Table 94: C_A5020-VOIP_3-01_QRY_RAN


Type Class


S R

CCE Service Pack


Mapping to ASDLs



S O


S O


S O


S O


CSDL ASDL

C_A5020-VOIP_3-01_QRY_RAN A_A5020-VOIP_3-01_QRY_RAN

Table 94: C_A5020-VOIP_3-01_QRY_RAN


Type Class



NRE Service PackThis cartridge provides the following CSDL commands:

C_A5020-VOIP_3-01_ADD_AAA-GROUPC_A5020-VOIP_3-01_ADD_AAA-SELECTION-RULEC_A5020-VOIP_3-01_ADD_ROUTEC_A5020-VOIP_3-01_ADD_ROUTE-BLOCKC_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-PREFIXC_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-SUFFIXC_A5020-VOIP_3-01_ADD_ROUTE-CONFIGC_A5020-VOIP_3-01_ADD_VPNC_A5020-VOIP_3-01_DEL_AAA-GROUPC_A5020-VOIP_3-01_DEL_AAA-SELECTION-RULEC_A5020-VOIP_3-01_DEL_ROUTEC_A5020-VOIP_3-01_DEL_ROUTE-BLOCKC_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-PREFIXC_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-SUFFIXC_A5020-VOIP_3-01_DEL_ROUTE-CONFIGC_A5020-VOIP_3-01_DEL_VPNC_A5020-VOIP_3-01_MOD_AAA-GROUPC_A5020-VOIP_3-01_MOD_AAA-SELECTION-RULEC_A5020-VOIP_3-01_MOD_ROUTEC_A5020-VOIP_3-01_MOD_ROUTE-BLOCKC_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-PREFIXC_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-SUFFIXC_A5020-VOIP_3-01_MOD_ROUTE-CONFIGC_A5020-VOIP_3-01_MOD_VPNC_A5020-VOIP_3-01_QRY_AAA-GROUPC_A5020-VOIP_3-01_QRY_AAA-SELECTION-RULEC_A5020-VOIP_3-01_QRY_ROUTEC_A5020-VOIP_3-01_QRY_ROUTE-BLOCKC_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-ALLC_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIXC_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIX-ALLC_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-SUFFIXC_A5020-VOIP_3-01_QRY_ROUTE-CONFIG

NRE Service Pack


C_A5020-VOIP_3-01_QRY_VPN

C_A5020-VOIP_3-01_ADD_AAA-GROUPAdds an AAA group.

Table 96: C_A5020-VOIP_3-01_ADD_AAA-GROUP


Type Class


The AAA Server ID. S O


The AAA Server ID. S O


The AAA Server Name.

S O


The AAA Server Name.

S O


The AAA Server Priority.

S O


The AAA Server Priority.

S O


The AAA Server Stage. S O


The AAA Server Stage. S O


The AAA Server Type. S O


The AAA Server Type. S O


This flag enables accounting validation.

S O





S O



S O


This flag controls busy forward activation.

S O


This flag controls no reply forward activation.

S O


This flag controls unconditional forward activation.

S O



S O



S O



S O



C O



S O


This flag controls the call transfer service.

S O



Type Class

NRE Service Pack




S O



S O



S O


Enables the service for this type

S O



S O


This flag controls the dialing of unregistered endpoints.

S O



ENABLED, HOLD ENABLED S O

AAA_GROUP_EXTERNAL

Specifies the type of connection to the A5020X server.

internal, external S O



S O


This parameter selects the appropriate value for answering calls.

S O


Determines whether the location token should be checked-in.

S O



Type Class




Selects the method for gateway authentication interface.

S O


Selects the type for authentication interface.

S O


This parameter selects the appropriate value for making calls.

S O



S O


Selects which H323 RIP message is sent to the server.

S O



S O


Selects the method of terminal authentication interface.

S O


Selects the type for terminal authentication interface.

S O


Determines whether to update the H323 display

S O


Determines whether to update H323 setup

S O



Type Class

NRE Service Pack




S O


This flag enables the interaction support.

S O



AAA_GROUP_IVR_PORT



This flag enables the call to be rejected when no port is defined in the POP or RAN.

S O



S O



S O


The maximum number of users. per session. The default value is 0.

S O

AAA_GROUP_NAME The AAA group's name.

S R


This flag controls whether the group performs the access checks.

S O


Contain's information on the AAA group's SIP call application server.

C O



Type Class





C O


The gateway authentication method, either: invite or unknown.

S O



S O



S O



S O


This parameter contains the server method, type, and service information for the application server.

C O


Indicates the SIP proxy local destination, either: stateful, stateless, or redirect.

S O


Indicates the Proxy non local destination, either: stateful or stateless.

S O



Type Class

NRE Service Pack




register, invite, subscribe, message, options, refer, unknown

S O



S O


This flag enables two-stage accounting.

S O


This flag enables two-stage authentication.

S O


Enables proxy generated messages to be generated by access fail tickets that cause radius accounting stop packets.

S O


This flag enables the radius process interim updates.

S O


This flag enables EAP messages.

S O


The AAA group's trigger destination method

S O



Type Class



Mapping to ASDLs




S O


This parameter contains the value of trigger sip application server.

S O


Either enables or disables the flag that indicates support for this group's unidentified access.

S O

NE_ID_NRE The A5020 instance identifier, or NRE instance.

S R

VPN_ID The VPN instance identifier

S O

VPN_NAME The VPN name identifier

S O


CSDL ASDL

C_A5020-VOIP_3-01_ADD_AAA-GROUP A_A5020-VOIP_3-01_ADD_AAA-GROUP



Type Class

NRE Service Pack


C_A5020-VOIP_3-01_ADD_AAA-SELECTION-RULEAdds an AAA selection rule.

Table 98: C_A5020-VOIP_3-01_ADD_AAA-SELECTION-RULE


Type Class

AAA_SELECTION Multiple instances of AAA selections can be used here

C O


The AAA group identification.

S O


The AAA group name. S O



S O


Defines the mask in which the destination must fit to correctly select the AAA group.

S O



S O


Enables or disables this rule.

S O



S O



S O


The AAA selection originating external gatekeeper ID.

S O




The AAA selection originating external gatekeeper Name.

S O


Describes the mask in which the origin must fit so that it can select the correct AAA group.

S O


The AAA selection originating POP ID.

S O


The AAA selection originating POP Name.

S O


The AAA selection originating RAN ID.

S O


The AAA selection originating RAN name.

S O


Enter the lowest IP address in the range you are defining.

S O


The name of the subject AAA group.

S O




The VPN name. S O


S R

OLD_AAA_SELECTION

Multiple instances of AAA Selections can be used here.

C O



Type Class

NRE Service Pack


Mapping to ASDLs


C_A5020-VOIP_3-01_ADD_ROUTEAdds a route.


S O


CSDL ASDL

C_A5020-VOIP_3-01_ADD_AAA-SELECTION-RULE

A_A5020-VOIP_3-01_ADD_AAA-SELECTION-RULE

Table 100: C_A5020-VOIP_3-01_ADD_ROUTE


Type Class


S R


The prefix that identifies the route's carrier.

S O


The IP Address for the route's endpoint.

S O

ROUTE_ENDPOINT_PORT

The IP port for the route's endpoint.

S O

ROUTE_ENDPOINT_TYPE

The route's endpoint type.

S O



Type Class



Mapping to ASDLs


C_A5020-VOIP_3-01_ADD_ROUTE-BLOCKAdds a route block.


The Gateway POP or RAN Name to which this route is associated. It references the NE table that is populated in the CCE.

S O

ROUTE_ITSPLD The parameter that identifies the multiple Gatekeeper.

S O

ROUTE_NAME The route's name. S R


S O

ROUTE_TYPE Indicates the type of routing algorithm.

weight, priority S R


CSDL ASDL

C_A5020-VOIP_3-01_ADD_ROUTE A_A5020-VOIP_3-01_ADD_ROUTE

Table 102: C_A5020-VOIP_3-01_ADD_ROUTE-BLOCK


Type Class


S R

Table 100: C_A5020-VOIP_3-01_ADD_ROUTE


Type Class

NRE Service Pack


ROUTE_BLOCK_NAME

The route block name. S R

ROUTE_CONFIG_ID The primary key identifier of the routing configuration.

S O

ROUTE_CONFIG_NAME

The route configuration name.

S O

ROUTE_ID_1 The name, or identity, of Route 1.

S O


S O


S O


S O


S O


S O


S O


S O


S O


S O


S O



Type Class



Mapping to ASDLs


C_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-PREFIXAdds a route block prefix.


S O


S O


S O


S O

ROUTING_TYPE The routing type, either "weight" or "priority".

S R


CSDL ASDL

C_A5020-VOIP_3-01_ADD_ROUTE-BLOCK A_A5020-VOIP_3-01_ADD_ROUTE-BLOCK

Table 104: C_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-PREFIX


Type Class


S R



S O



Type Class

NRE Service Pack


Mapping to ASDLs


ROUTE_BLOCK_ID The route block identifier's primary key.

S O

ROUTE_BLOCK_NAME

The route block name. S O



S O


S O

ROUTE_CONFIG_NAME


S O


CSDL ASDL

C_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-PREFIX

A_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-PREFIX

Table 104: C_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-PREFIX


Type Class



C_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-SUFFIXAdds a route block suffix.

Mapping to ASDLs


Table 106: C_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-SUFFIX


Type Class


S R


S O

ROUTE_BLOCK_NAME


ROUTE_BLOCK_SUFFIX


S O


S O

ROUTE_CONFIG_NAME


S O


CSDL ASDL

C_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-SUFFIX

A_A5020-VOIP_3-01_ADD_ROUTE-BLOCK-SUFFIX

NRE Service Pack


C_A5020-VOIP_3-01_ADD_ROUTE-CONFIGAdds a route configuration.

Mapping to ASDLs


C_A5020-VOIP_3-01_ADD_VPNAdds a VPN.

Table 108: C_A5020-VOIP_3-01_ADD_ROUTE-CONFIG


Type Class


S R

ROUTE_CONFIG_NAME


S R

VPN_ID Links the VPN_ID with the particular route configuration.

S O

VPN_NAME Links the VPN_NAME with the particular route configuration.

S O


CSDL ASDL

C_A5020-VOIP_3-01_ADD_ROUTE-CONFIG A_A5020-VOIP_3-01_ADD_ROUTE-CONFIG

Table 110: C_A5020-VOIP_3-01_ADD_VPN


Type Class

ACTIVATIONTIME_DAY

Activation time day. S O



ACTIVATIONTIME_HOUR

Activation time hour. S O


Activation time minute. S O




Activation time second. S O

ACTIVATIONTIME_YEAR



S O

CSVLOG_ENDEXTSESS


S O

CSVLOG_ENDINTSESS


S O

CSVLOG_INTERIM_EXT


S O

CSVLOG_INTERIM_INT


S O

CSVLOG_STARTEXTSESS

The CSV Log Proxy Start external session.

S O

CSVLOG_STARTINTSESS


S O

CSVLOG_TUNNEL_EXT


S O

CSVLOG_TUNNEL_INT

The CSV log tunnel internal

S O


The CSV Vendor specific.

S O



Type Class

NRE Service Pack


DBLOG_ENDEXTSESS


S O

DBLOG_ENDINTSESS


S O

DBLOG_INTERIM_EXT


S O

DBLOG_INTERIM_INT


S O

DBLOG_STARTEXTSESS


S O

DBLOG_STARTINTSESS


S O

DBLOG_TUNNEL_EXT


S O

DBLOG_TUNNEL_INT


S O



S O















Type Class



Mapping to ASDLs


C_A5020-VOIP_3-01_DEL_AAA-GROUPDeletes an AAA group.

HOLIDAY Holiday. C O

LOGIN_ALLOWED_TIMES

Login allowed times. C O


S O


S O


S R

ONHOLD On hold. S O

SPECIAL_PERIODS Special periods. C O

VPN_NAME The VPN's name. S R


CSDL ASDL

C_A5020-VOIP_3-01_ADD_VPN A_A5020-VOIP_3-01_ADD_VPN

Table 112: C_A5020-VOIP_3-01_DEL_AAA-GROUP


Type Class

AAA_GROUP_ID The AAA group identification.

S O



Type Class

NRE Service Pack


Mapping to ASDLs


C_A5020-VOIP_3-01_DEL_AAA-SELECTION-RULEDeletes an AAA selection rule.


S O


S R


S O


S O


CSDL ASDL

C_A5020-VOIP_3-01_DEL_AAA-GROUP A_A5020-VOIP_3-01_DEL_AAA-GROUP

Table 114: C_A5020-VOIP_3-01_DEL_AAA-SELECTION-RULE


Type Class


C O


The AAA group ID. S O



Table 112: C_A5020-VOIP_3-01_DEL_AAA-GROUP


Type Class





S O


Define the mask in which the destination must fit to correctly select the AAA group.

S O



S O



S O



S O



S O



S O


The AAA selection originating external gatekeeper Name.

S O



S O



S O



Type Class

NRE Service Pack




S O



S O



S O



S O


The AAA selection rule identification.

S O



S O




The VPN name. S O


S R

OLD_AAA_SELECTION

Multiple instances of AAA selections can be used here

C O

USE_QUERY Flag to determine whether to use results of the query

S O



Type Class



Mapping to ASDLs


C_A5020-VOIP_3-01_DEL_ROUTERemove's an existing route.

Mapping to ASDLs



CSDL ASDL

C_A5020-VOIP_3-01_DEL_AAA-SELECTION-RULE

A_A5020-VOIP_3-01_QRY_AAA-SELECTION-RULE

C_A5020-VOIP_3-01_DEL_AAA-SELECTION-RULE

A_A5020-VOIP_3-01_DEL_AAA-SELECTION-RULE

Table 116: C_A5020-VOIP_3-01_DEL_ROUTE


Type Class


S R

ROUTE_ID The route's primary identification key.

S O

ROUTE_NAME The route's name. S O


CSDL ASDL

C_A5020-VOIP_3-01_DEL_ROUTE A_A5020-VOIP_3-01_DEL_ROUTE

NRE Service Pack


C_A5020-VOIP_3-01_DEL_ROUTE-BLOCKRemoves the route block.

Mapping to ASDLs


Table 118: C_A5020-VOIP_3-01_DEL_ROUTE-BLOCK


Type Class


S R


S O

ROUTE_BLOCK_NAME



S O

ROUTE_CONFIG_NAME

The the routing configuration name.

S O


CSDL ASDL

C_A5020-VOIP_3-01_DEL_ROUTE-BLOCK A_A5020-VOIP_3-01_DEL_ROUTE-BLOCK



C_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-PREFIXRemoves the route block prefix.

Mapping to ASDLs


Table 120: C_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-PREFIX


Type Class


S R



S O


S O

ROUTE_BLOCK_NAME




S O


S O

ROUTE_CONFIG_NAME


S O


CSDL ASDL

C_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-PREFIX

A_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-PREFIX

NRE Service Pack


C_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-SUFFIXRemoves the route block suffix.

Mapping to ASDLs


Table 122: C_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-SUFFIX


Type Class


S R


S O

ROUTE_BLOCK_NAME


ROUTE_BLOCK_SUFFIX


S O


S O

ROUTE_CONFIG_NAME


S O


CSDL ASDL

C_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-SUFFIX

A_A5020-VOIP_3-01_DEL_ROUTE-BLOCK-SUFFIX



C_A5020-VOIP_3-01_DEL_ROUTE-CONFIGRemoves the route configuration.

Mapping to ASDLs


C_A5020-VOIP_3-01_DEL_VPNDeletes a VPN.

Table 124: C_A5020-VOIP_3-01_DEL_ROUTE-CONFIG


Type Class


S R


S O

ROUTE_CONFIG_NAME


S O


CSDL ASDL

C_A5020-VOIP_3-01_DEL_ROUTE-CONFIG A_A5020-VOIP_3-01_DEL_ROUTE-CONFIG

Table 126: C_A5020-VOIP_3-01_DEL_VPN


Type Class


S R

VPN_ID The VPN's ID. S O

VPN_NAME The VPN's name. S O

NRE Service Pack


Mapping to ASDLs


C_A5020-VOIP_3-01_MOD_AAA-GROUPModifies the AAA group.


CSDL ASDL

C_A5020-VOIP_3-01_DEL_VPN A_A5020-VOIP_3-01_DEL_VPN

Table 128: C_A5020-VOIP_3-01_MOD_AAA-GROUP


Type Class


This flag enables accounting validation.

S O



S O



S O


This flag controls busy forward activation.

S O


This flag controls no reply forward activation.

S O


This flag controls unconditional forward activation.

S O



S O





S O



S O



C O



S O


This flag controls the call transfer service.

S O



S O



S O



S O



S O



S O


This flag controls the dialing of unregistered endpoints.

S O



enabled, hold S O



Type Class

NRE Service Pack


AAA_GROUP_EXTERNAL

Specifies the type of connection to the A5020X server.

internal, external S O



S O


This parameter selects the appropriate value for answering calls.

S O


Determines whether the location token should be checked-in.

S O


Selects the method for gateway authentication interface.

S O


Selects the type for authentication interface.

S O


This parameter selects the appropriate value for making calls.

S O



S O


Selects which H323 RIP message is sent to the server.

S O



S O



Type Class




Selects the method of terminal authentication interface.

S O


Selects the type for terminal authentication interface.

S O


Determines whether to update the H323 setup display

S O


Determines whether to update the H323 setup destination

S O



S O


S O


This flag enables the interaction support.

S O



AAA_GROUP_IVR_PORT



This flag enables the call to be rejected when no port is defined in the POP or RAN.

S O



S O



Type Class

NRE Service Pack




S O


The maximum number of users per session.

0 S O


S O


This flag controls whether the group performs the access checks.

S O


Contain's information on the AAA group's SIP call application server.

C O



C O



invite, unknown S O



S O



S O



S O



Type Class




This parameter contains the server method, type, and service information for the application server.

C O


Indicates the SIP proxy local destination, either: stateful, stateless, or redirect.

S O


Indicates the Proxy non local destination, either: stateful or stateless.

S O


The SIP terminal authentication method, either: register, invite, subscribe, message, options, refer, and unknown.

S O



S O


This flag enables two-stage accounting.

S O


This flag enables two-stage authentication.

S O


Enables proxy generated messages to be generated by access fail tickets that cause radius accounting stop packets.

S O



Type Class

NRE Service Pack



This flag enables the radius process interim updates.

S O


This flag enables EAP messages.

S O



S O



S O


This parameter contains the value of trigger sip application server.

S O


Either enables or disables the flag that indicates support for this group's unidentified access.

S O


S R


S O


S O



Type Class



Mapping to ASDLs


C_A5020-VOIP_3-01_MOD_AAA-SELECTION-RULEModifies an AAA selection rule.


CSDL ASDL

C_A5020-VOIP_3-01_MOD_AAA-GROUP A_A5020-VOIP_3-01_MOD_AAA-GROUP

Table 130: C_A5020-VOIP_3-01_MOD_AAA-SELECTION-RULE


Type Class


C O







S O



S O



S O



S O

NRE Service Pack




S O



S O



S O


The AAA selection originating external gatekeeper name.

S O



S O



S O



S O



S O



S O



S O



S O



S O



Type Class



Mapping to ASDLs





The VPN name. S O


S R

OLD_AAA_SELECTION

Multiple instances of AAA Selections can be used here

C O


S O


CSDL ASDL

C_A5020-VOIP_3-01_MOD_AAA-SELECTION-RULE


A_A5020-VOIP_3-01_MOD_AAA-SELECTION-RULE



Type Class

NRE Service Pack


C_A5020-VOIP_3-01_MOD_ROUTEModifies the route.

Table 132: C_A5020-VOIP_3-01_MOD_ROUTE


Type Class


S R


The prefix that identifies the route's carrier.

S O


The IP Address for the route's endpoint.

S O

ROUTE_ENDPOINT_PORT

The IP port for the route's endpoint.

S O

ROUTE_ENDPOINT_TYPE

The route's endpoint type.

S O


The Gateway POP or RAN Name to which this route is associated. It references the NE table that is populated in the CCE.

S O


The Gateway POP or RAN ID to which this route is associated. It references the NE table that is populated in the CCE.

S O


S O

ROUTE_ITSPLD The parameter that identifies the multiple Gatekeeper.

S O




Mapping to ASDLs


C_A5020-VOIP_3-01_MOD_ROUTE-BLOCKModifies a route block.


S O

ROUTE_TYPE The type of routing algorithm used.

weight, priority S O


CSDL ASDL

C_A5020-VOIP_3-01_MOD_ROUTE A_A5020-VOIP_3-01_MOD_ROUTE

Table 134: C_A5020-VOIP_3-01_MOD_ROUTE-BLOCK


Type Class


S R


S O

ROUTE_BLOCK_NAME



S O

ROUTE_CONFIG_NAME

The route configuration name.

S O

Table 132: C_A5020-VOIP_3-01_MOD_ROUTE


Type Class

NRE Service Pack



S O


S O


S O


S O


S O


S O


S O


S O


S O


S O


S O


S O


S O


S O


S O



Type Class



Mapping to ASDLs


C_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-PREFIXModifies a route block prefix.

ROUTING_TYPE The routing type. weight, priority S R


CSDL ASDL

C_A5020-VOIP_3-01_MOD_ROUTE-BLOCK A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK

Table 136: C_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-PREFIX


Type Class



S O



S O


S R



S O



Type Class

NRE Service Pack


Mapping to ASDLs



S O

ROUTE_BLOCK_NAME




S O


S O

ROUTE_CONFIG_NAME


S O


CSDL ASDL

C_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-PREFIX

A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-PREFIX

Table 136: C_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-PREFIX


Type Class



C_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-SUFFIXModifies a route block suffix.

Table 138: C_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-SUFFIX


Type Class



S O


S R


S O

ROUTE_BLOCK_NAME


ROUTE_BLOCK_SUFFIX


S O


S O

ROUTE_CONFIG_NAME


S O

NRE Service Pack


Mapping to ASDLs


C_A5020-VOIP_3-01_MOD_ROUTE-CONFIGModifies the route configuration.

Mapping to ASDLs



CSDL ASDL

C_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-SUFFIX

A_A5020-VOIP_3-01_MOD_ROUTE-BLOCK-SUFFIX

Table 140: C_A5020-VOIP_3-01_MOD_ROUTE-CONFIG


Type Class

NEW_ROUTE_CONFIG_NAME

The new name of the routing configuration.

S O


S R


S O

ROUTE_CONFIG_NAME


S O


CSDL ASDL

C_A5020-VOIP_3-01_MOD_ROUTE-CONFIG A_A5020-VOIP_3-01_MOD_ROUTE-CONFIG



C_A5020-VOIP_3-01_MOD_VPNModifies the VPN.

Table 142: C_A5020-VOIP_3-01_MOD_VPN


Type Class

ACTIVATIONTIME_DAY


ACTIVATIONTIME_HOUR








ACTIVATIONTIME_YEAR



S O

CSVLOG_ENDEXTSESS


S O

CSVLOG_ENDINTSESS


S O

CSVLOG_INTERIM_EXT


S O

CSVLOG_INTERIM_INT


S O

CSVLOG_STARTEXTSESS


S O

CSVLOG_STARTINTSESS


S O

CSVLOG_TUNNEL_EXT


S O

NRE Service Pack


CSVLOG_TUNNEL_INT


S O



S O

DBLOG_ENDEXTSESS


S O

DBLOG_ENDINTSESS


S O

DBLOG_INTERIM_EXT

The DB proxy Log Interim External.

S O

DBLOG_INTERIM_INT


S O

DBLOG_STARTEXTSESS


S O

DBLOG_STARTINTSESS


S O

DBLOG_TUNNEL_EXT

The DB log tunnel External.

S O

DBLOG_TUNNEL_INT

The DB log tunnel Internal.

S O



S O











Type Class



Mapping to ASDLs






HOLIDAY Holiday. C O

LOGIN_ALLOWED_TIMES

Login allowed times. C O


S O


S O


S R

ONHOLD On hold. S O

SPECIAL_PERIODS Special periods. C O




CSDL ASDL

C_A5020-VOIP_3-01_MOD_VPN A_A5020-VOIP_3-01_MOD_VPN



Type Class

NRE Service Pack


C_A5020-VOIP_3-01_QRY_AAA-GROUPQueries an AAA group.

Mapping to ASDLs


C_A5020-VOIP_3-01_QRY_AAA-SELECTION-RULEQueries an AAA selection rule.

Table 144: C_A5020-VOIP_3-01_QRY_AAA-GROUP


Type Class


S O


S O


S R


S O


S O


CSDL ASDL

C_A5020-VOIP_3-01_QRY_AAA-GROUP A_A5020-VOIP_3-01_QRY_AAA-GROUP

Table 146: C_A5020-VOIP_3-01_QRY_AAA-SELECTION-RULE


Type Class


C O









S O



S O



S O



S O



S O



S O



S O


The AAA selection originating external gatekeeper name.

S O



Type Class

NRE Service Pack




S O



S O


The AAA selection originating POP name.

S O



S O



S O



S O



S O



S O




The VPN name. S O


S R

OLD_AAA_SELECTION


C O



Type Class



Mapping to ASDLs


C_A5020-VOIP_3-01_QRY_ROUTEQueries an existing route.

Mapping to ASDLs



CSDL ASDL

C_A5020-VOIP_3-01_QRY_AAA-SELECTION-RULE


Table 148: C_A5020-VOIP_3-01_QRY_ROUTE


Type Class


S R


S O



CSDL ASDL

C_A5020-VOIP_3-01_QRY_ROUTE A_A5020-VOIP_3-01_QRY_ROUTE

NRE Service Pack


C_A5020-VOIP_3-01_QRY_ROUTE-BLOCKQueries a route block.

Mapping to ASDLs


Table 150: C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK


Type Class


S R

ROUTE_BLOCK_ID The route block identifier. This is a primary key.

S O

ROUTE_BLOCK_NAME



S O

ROUTE_CONFIG_NAME

The the routing configuration name.

S O


CSDL ASDL

C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK



C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-ALLQueries an NE.

Mapping to ASDLs


C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIXQueries a route block prefix.

Table 152: C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-ALL


Type Class


S R


CSDL ASDL

C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-ALL A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-ALL

Table 154: C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIX


Type Class


S R


S O

ROUTE_BLOCK_NAME



S O

NRE Service Pack


Mapping to ASDLs


C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-SUFFIXQueries a route block suffix.

ROUTE_CONFIG_NAME


S O


CSDL ASDL

C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIX

A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIX

Table 156: C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-SUFFIX


Type Class


S R


S O

ROUTE_BLOCK_NAME



S O

ROUTE_CONFIG_NAME


S O

Table 154: C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIX


Type Class



Mapping to ASDLs


C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIX-ALLQueries an NE.

Mapping to ASDLs



CSDL ASDL

C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-SUFFIX

A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-SUFFIX

Table 158: C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIX-ALL


Type Class


S R


Route Block Start Prefix.

S R


CSDL ASDL

C_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIX-ALL

A_A5020-VOIP_3-01_QRY_ROUTE-BLOCK-PREFIX-ALL

NRE Service Pack


C_A5020-VOIP_3-01_QRY_ROUTE-CONFIGQueries the route configuration.

Mapping to ASDLs


C_A5020-VOIP_3-01_QRY_VPNQueries a VPN.

Table 160: C_A5020-VOIP_3-01_QRY_ROUTE-CONFIG


Type Class


S R


S O

ROUTE_CONFIG_NAME


S O


CSDL ASDL

C_A5020-VOIP_3-01_QRY_ROUTE-CONFIG A_A5020-VOIP_3-01_QRY_ROUTE-CONFIG

Table 162: C_A5020-VOIP_3-01_QRY_VPN


Type Class


S R





Mapping to ASDLs



CSDL ASDL

C_A5020-VOIP_3-01_QRY_VPN A_A5020-VOIP_3-01_QRY_VPN


5

Configuring ASAP to Support Additional NE Instances

You can configure ASAP to support the Alcatel A5020 Softswitch - NEP configuration using the Service Activation Configuration Tool (SACT). Refer to the ASAP System Configuration and Management Guide fore more information.

Below is an example of the Activation.Configuration.XML file for the Alcatel A5020 Softswitch cartridge.<?xml version="1.0" encoding="UTF-8"?><activationConfig xmlns="http://www.metasolv.com/ServiceActivation/2003/ActivationConfig" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.metasolv.com/ServiceActivation/2003/ActivationConfigC:\data\ASAP\4.6\xsd\ActivationConfig.xsd">

<connectionPool name="Ala_Pool"><device name="A5020_corba_dev1">

<environment>MY_ASAP_SYS</environment><lineType>CORBA_CONNECTION</lineType>

</device></connectionPool>

<element name="A5020-REMOTEHOST"><technology>A5020-voip</technology><softwareLoad>3-01</softwareLoad><nepServerName>$NEP</nepServerName><primaryPool>Ala_Pool</primaryPool><maximumConnections>1</maximumConnections><dropTimeout>2</dropTimeout><spawnThreshold>10</spawnThreshold><killThreshold>8</killThreshold><routingElement name="A5020-HOST">

<atomicService/></routingElement><communicationParameter>

<label>A5020_IOR</label><value>

<value>/tmp/IOR.txt</value></value><description>The IOR file name</description><deviceName>COMMON_DEVICE_CFG</deviceName><lineType>CORBA_CONNECTION</lineType>

Chapter 5: Configuring ASAP to Support Additional NE Instances


</communicationParameter><communicationParameter>

<label>FTP_ACTION</label><value>

<value>Enable</value></value><description>Enalbe or disable the flag to support FTP action</

description><deviceName>COMMON_DEVICE_CFG</deviceName><lineType>CORBA_CONNECTION</lineType>


<label>SERVER_IOR_FILE</label><value>

<value>/usr/smc30/smc301/cod/smcroot.ior</value></value><description>The server IOR file name</description><deviceName>COMMON_DEVICE_CFG</deviceName><lineType>CORBA_CONNECTION</lineType>


<label>HOST_IPADDR</label><value>

<value>192.160.5.71</value></value><description>The host name or IP address of the remote NE</



<label>HOST_USER</label><value>

<value>SYSTEM</value></value><description>The user name used to connect the remote NE</



<label>HOST_PASSWORD</label><value>

<value>system</value></value><description>The user password used to connect the remote NE</



<label>FTP_USER</label>


<value><value>smc30</value>

</value><description>The user name used to connect the remote NE for FTP

session</description><deviceName>COMMON_DEVICE_CFG</deviceName><lineType>CORBA_CONNECTION</lineType>


<label>FTP_PASSWORD</label><value>

<value>12345678</value></value><description>The user password used to connect the remote NE for

FTP session</description><deviceName>COMMON_DEVICE_CFG</deviceName><lineType>CORBA_CONNECTION</lineType>


<label>PORT</label><value>

<value>2000</value></value><description>Port number to connect on remote NE host</description><deviceName>COMMON_DEVICE_CFG</deviceName><lineType>CORBA_CONNECTION</lineType>


<label>READ_TIMEOUT</label><value>

<value>5000</value></value><description>The read timeout in milliseconds</description><deviceName>COMMON_DEVICE_CFG</deviceName><lineType>CORBA_CONNECTION</lineType>


<label>USER_ERROR_TYPES_FILE</label><value>

<value>/config/A5020_VOIP_3_01_UserExitTypes.cfg</value></value><description>The user exit type file. This file is relative to

ASAP_BASE directory</description><deviceName>COMMON_DEVICE_CFG</deviceName><lineType>CORBA_CONNECTION</lineType>


<label>RESPONSELOG</label><value>

<value>TRUE</value></value><description>Flag to turn on or off response logging</description>

Chapter 5: Configuring ASAP to Support Additional NE Instances


<deviceName>COMMON_DEVICE_CFG</deviceName><lineType>CORBA_CONNECTION</lineType>


<label>SESSION_ACTION</label><value>

<value>ENABLE</value></value><description>Flag to enable or disable session transaction</


</communicationParameter></element>

</activationConfig>

Extracting source filesBefore you can access an XML file to modify it, you must extract it from the sar file. Use the following procedure to extract source files from the sar file.

To extract source files

1. If necessary, create a repository directory under /Alcatel_VOIP_3-01, copy the .sar file to the new directory and un-jar the sar file, as described by Step 1 through Step 4 in “Modifying Alcatel_voip_3-01_ne_config.xml” on page 11.

2. After you un-jar the sar file, you can access the XML files.

Loading a new XML fileWhen you finish modifying an XML, you must create a new sar file, then restart the cartridge using the new file.

Follow the instructions in “Modifying Alcatel_voip_3-01_ne_config.xml” on page 11 for directions on how to load a new XML file.

Alcatel 5020 SoftSwitch - Oracle 5020_1_0_0.pdf · Alcatel 5020 SoftSwitch 1 1 Cartridge Overview...

Documents

Transcript of Alcatel 5020 SoftSwitch - Oracle 5020_1_0_0.pdf · Alcatel 5020 SoftSwitch 1 1 Cartridge Overview...