This document was uploaded by user and they confirmed that they have the permission to share
it. If you are author or own the copyright of this book, please report to us by using this DMCA
report form. Report DMCA
Overview
Download & View Ericsson Auc With Complete Hlr Mml Guide as PDF for free.
Contents 1. Cartridge Overview ...................................................................................... 1 Cartridge content ................................................................................................................... 1 Prerequisites ......................................................................................................................... 2 About this guide .................................................................................................................... 2 Services, features, and options ............................................................................................. 3 Hardware and software requirements ................................................................................... 3 Network element (NE) interface ............................................................................................ 3 ASAP version ........................................................................................................................ 4 Connecting to the NE ............................................................................................................ 4 Related documentations ....................................................................................................... 4
2. Installing and Testing the Cartridge ........................................................... 5 Downloading the cartridge .................................................................................................... 5 Starting ASAP ....................................................................................................................... 6 Installing the cartridge using scripts ...................................................................................... 7 Uninstalling the cartridge using scripts .................................................................................. 7 Testing the cartridge installation ........................................................................................... 8 Configuring loopback and live mode parameters ........................................................... 8 Modifying T_ERIC-AUC_R12-0_HOST.xml ................................................................... 9 Testing the installation .................................................................................................. 10 Deployment of the cartridge using Studio ........................................................................... 11 Uninstallation and Undeployment of the cartridge using Studio .......................................... 12
5. Configuring ASAP to Support Additional NE Instances ........................ 63 Extracting source files ......................................................................................................... 66 Loading a new XML file ................................................................................................ 67
iv
Oracle Corporation
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. Cartridges are designed for a specific technology, software load, and service.
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.
Cartridge content An ASAP cartridge contains the following:
Sample NE configuration A set of scripts, such as State Tables or Java methods
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
1
Chapter 1: Cartridge Overview
A set of atomic actions in the form of Atomic Service Description Layer (ASDL) commands A set of Common Service Description Layer (CSDL) commands that form meaningful services Sample work orders Installation scripts
Prerequisites System 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 concepts A good working knowledge of the UNIX operating system A thorough understanding of service and network provisioning Familiarity with telecommunications
About this guide This guide provides a detailed description of the Ericsson AUC 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 the use of this cartridge. It is not intended to be a complete ASAP reference guide. For additional information when using this cartridge, refer to the following supporting documentation:
Activation documentation set—for detailed information on the ASAP component.
The Ericsson AUC cartridge provides the ASAP service configuration and network element (NE) interface to support provisioning of the AUC Subscriptions on NE_ERIC-AUC_R12-0HOST NEs.
2
Oracle Corporation
Services, features, and options
Services, features, and options This cartridge supports the following services: Table 1: Supported services Service
Description
Create AUC Subscriber
This service creates a subscriber in the authentication center.
Delete AUC Subscriber
This service deletes a subscriber in the authentication center.
Get AUC Subscriber
This service queries for a subscriber in the authentication center.
Modify AUC Subscriber
This service modifies a subscriber in the authentication center.
Create AUC Key Data
This service creates the key data in the authentication center.
Delete AUC Key Data
This service deletes the key data in the authentication center.
Get AUC Key Data
This service queries the key data in the authentication center.
Modify AUC Key Data
This service modifies the key data in the authentication center.
Hardware and software requirements The following sections contain the high-level software and hardware environment requirements for provisioning AUC Subscriptions product on authentication center including:
Network element (NE) interface ASAP version
Network element (NE) interface The following database tables in SARM are configured to support the NE configuration:
tbl_host_clli tbl_clli_route tbl_comm_param
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
3
Chapter 1: Cartridge Overview
tbl_resource_pool tbl_ne_config
ASAP version This cartridge was developed and tested using ASAP 5. For more information on the operating environment of this ASAP version, refer to the ASAP 5 Release Record.
Connecting to the NE The cartridge uses the Telnet over TCP/IP protocol.
Related documentations This cartridge was developed according to the following Network Element Provisioning Specifications:
4
None
Oracle Corporation
2
Installing and Testing the Cartridge This chapter describes the following procedures related to installing and testing the cartridge:
Downloading the cartridge Installing the cartridge using scripts Uninstalling the cartridge using scripts Testing the cartridge installation Deployment of the cartridge using Studio Uninstallation and Undeployment of the cartridge using Studio
Downloading the cartridge Before 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 your workstation, create a repository directory—the naming of which is your choice. mkdir
2. Copy the TAR file into the repository directory. 3. Untar EricssonAUC_12_X_X_R1_0_0..tar. tar xvf EricssonAUC_12_X_X_R1_0_0..tar
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). /README /installCartridge /uninstallCartridge
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
5
Chapter 2: Installing and Testing the Cartridge
/EricssonAUC_R12_0.sar
Starting ASAP Before installing the cartridge, ensure that ASAP is running. To start ASAP 1. To start ASAP, execute the following script: start_asap_sys -d
2. Ensure the ASAP Daemon (DAEM$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 Administration Guide contains more information on starting ASAP, the ASAP Daemon, and WebLogic.
6
Oracle Corporation
Installing the cartridge using scripts
Installing the cartridge using scripts Run the installation script installCartridge to install the cartridge. The script executes the following tasks:
Configures the Ericsson AUC-specific NE using the SACT. Deploys the Ericsson AUC cartridge service model (only if the Ericsson AUC service model is not yet deployed) using the Service Activation Deployment Tool (SADT). Copies the Ericsson AUC-specific jar files 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 Administration Guide. To install the cartridge 1. Run the installCartridge script. At the prompt, type: installCartridge EricssonAUC_R12_0.sar
2. The script prompts you for the values of the following WebLogic login parameters:
WebLogic Hostname WebLogic HTTP Port WebLogic Login User ID WebLogic 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. Copy studio_2_6_0.jar file to the $ASAP_BASE/lib directory. 4. Add ${ASAP_BASE}/lib/studio_2_6_0.jar to the CLASSPATH in the JInterpreter file under $ASAP_BASE/programs directory. 5. Restart ASAP to upload the cartridge configuration into ASAP.
Uninstalling the cartridge using scripts Run the uninstallation script uninstallCartridge to uninstall the Ericsson AUC cartridge. The script executes the following tasks:
Unconfigures Ericsson AUC-specific NEs using the SACT. Undeploys the Ericsson AUC cartridge service model (only if the Ericsson AUC service model is already deployed) using the Service Activation Deployment Tool (SADT). Removes the Ericsson AUC-specific jar files and cpp library file from the ASAP environment.
For more information on the SACT and the SADT, refer to the ASAP Administration Guide.
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
7
Chapter 2: Installing and Testing the Cartridge
To uninstall the cartridge 1. Run the uninstallCartridge script. At the prompt, type: uninstallCartridge EricssonAUC_R12_0..sar
2. The script prompts you for the values of the following parameters:
WebLogic Hostname WebLogic HTTP Port WebLogic Login User ID WebLogic 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 installation To test this cartridge installation, you need to know about the network element (NE), services, and basic Activation 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 parameters Set the following variables to test the cartridge in loopback or live testing modes.
Loopback mode Set the following parameter to test the cartridge in loopback mode. Table 2: Loopback Mode Parameter Settings Configuration Variable LOOPBACK_ON
8
Oracle Corporation
Parameter Settings 1 (default setting)
Location ASAP.cfg
Testing the cartridge installation
Live mode Set the following parameter to test the cartridge in live mode. Table 3: Live Mode Parameter Settings Configuration Variable
Parameter Settings
LOOPBACK_ON
Location
0
ASAP.cfg
Communication parameters The following are the list of parameters for the sample NE configuration XML used by SACT. Table 4: Communication parameters param_label
param_value
param_desc
HOST_IPADDR
127.0.0.1
The host name or IP Address of the remote NE.
PORT
5000
Port number to connect on remote NE host.
OPEN_TIMEOUT
20
Connection timeout in seconds.
READ_TIMEOUT
30
Read timeout in seconds.
HOST_USERID
user
Login User Name.
HOST_PASSWORD
password
Password for the User.
PROMPT
<
Provisioning prompt.
LOGIN_PROMPT
USERCODE:
Login prompt from the NE
PASSWORD_PROMPT PASSWORD:
Password prompt from the NE
DOMAIN_PROMPT
Domain prompt from the NE
DOMAIN:
DOMAIN_PASSWORD pthlr1d
Domain password for the NE
RESPONSELOG
TRUE
Flag to turn off or on Response log.
PRINT_REPLY
FALSE
Flag to turn off or on reply in ASCII format.
Modifying T_ERIC-AUC_R12-0_HOST.xml Use the following procedure to modify T_ERIC-AUC_R12-0_HOST.xml.
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
9
Chapter 2: Installing and Testing the Cartridge
To modify T_ERIC-AUC_R12-0_HOST.xml 1. Create a new source directory. You can give this directory any appropriate, meaningful name you want to. mkdir
2. Copy EricssonAUC_R12_0.sar to this new source directory. cp EricssonAUC_R12_0.sar ./
3. Change directory to . cd
4. Un-jar EricssonAUC_R12_0.sar. This extracts the contents of the sar file. jar xvf EricssonAUC_R12_0.sar
5. Edit T_ERIC-AUC_R12-0_HOST.xml in with the appropriate changes. 6. Create a new sar file at the level. CreateSar $PWD
7. Uninstall the cartridge using EricssonAUC_R12_0.sar. (That is, use the original sar file that you copied in Step 2 above—see “Uninstalling the cartridge using scripts” on page 7 for uninstallation instructions). 8. After you uninstall the cartridge, rename the sar file, so you have a backup copy of it. 9. Copy the new sar file from . 10. Reinstall the cartridge (see “Installing the cartridge using scripts” on page 7 for installation instructions).
Testing the installation The 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 -d
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 -d
4. Send the sample work orders through the SRP Emulator by typing:
10
Oracle Corporation
Deployment of the cartridge using Studio
run_suite $SRP <suite name>
You can locate the suite names by typing: grep SUITE * | grep -v END
A list of all available suites appears. For more information on the SRP Emulator, refer to the ASAP Administration Guide. 5. Verify the status of the sample work orders by typing: asap_utils -d l
All successful work orders returns to the 104 state. To view the sample work orders provided with this cartridge, refer to the Ericsson AUC cartridge source.
Viewing the sample work orders You find the sample work orders under the SampleWorkOrders directory in the sar file. The following procedure describes how to view the sample work orders. To view the sample work orders 1. Create a repository directory, copy the sar file to the new directory and un-jar the sar file, as described by Step 1 through Step 4 in “Modifying T_ERIC-AUC_R12-0_HOST.xml” on page 9. 2. Locate and view the sample work order files.
Deployment of the cartridge using Studio Before installing the cartridge, ensure weblogic and ASAP are started and running. The following are the steps involved: 1. Open Studio in design perspective. Choose Import from the File menu and select Activation Archive (SAR) under Studio Wizards to import the sar file. Browse for the path to the sar file and click Finish. 2. Create a new Service Activation Project. 3. Define a new NE Entity, based on the NE Template contained in the cartridge provided by Oracle. 4. Ensure that the primary pool of the newly created NE is different from the NE template primary pool. You can modify it, if necessary. 5. Ensure that the test work order provided with the cartridge targets the newly defined NE. If not, then modify the test work orders file(s).
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
11
Chapter 2: Installing and Testing the Cartridge
6. Create a new Activation Environment Project from the Studio menu. (Use Studio help for more information). 7. Create Activation Environment inside the Activation Environment Project and configure the Connection Details tab with your Environment ID, Activation version and weblogic data. 8. Connect to your environment using the Connect button. 9. Select the Cartridge tab of the Activation Environment and click Add to add your projects to the environment. The cartridge and the newly created Service Activation should appear in the Cartridges list. 10. Deploy the NetworkActivation (NA) cartridge provided by Oracle. (No NE information is to be deployed with this cartridge, therefore it isn’t necessary to deploy the NEP map info). 11. First Deploy the Service Activation (SA) project as follows:
On the Cartridge tab, select the necessary SA cartridge and press the Deploy button. Select the NEP Map tab of the Activation Environment. Choose the necessary NEP server from the drop-down box of the Network Element Processors.(Use Studio help for more information). Select the SA cartridge from the Network Element Processor Map and click the Deploy button.
12. Verify the SADT console to confirm the installation 13. Go to ASAP environment. 14. Copy studio_2_6_0.jar file to the $ASAP_BASE/lib directory. 15. Add ${ASAP_BASE}/lib/studio_2_6_0.jar to the CLASSPATH in the JInterpreter file under $ASAP_BASE/programs directory. 16. Restart ASAP in order to start working with the cartridge.
Uninstallation and Undeployment of the cartridge using Studio The following are the steps involved: 1. Connect to your environment using the Connect button. 2. Select the necessary cartridge from the Environment Cartridge list in Studio and click the Undeploy button. 3. Verify the Environment Cartridge list. The Check Box with the name of the cartridge that is disabled should be unchecked.
12
Oracle Corporation
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.
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
13
Chapter 3: Atomic Service Description Layer (ASDL) Commands
Table 5: ASDL parameter information Item Type
Description 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 Reference. Class
Indicates one of the following parameter classifications:
A_ERIC-AUC_R12-0_CREATE_KEY-DATA This service creates the key data in AUC. It is implemented by the Java method: com.metasolv.cartridge.oss.eric_auc_r12_0.prov.AUCProvisioningKeyData.createKeyD ata Table 6: A_ERIC-AUC_R12-0_CREATE_KEY-DATA Parameter Name
Description
Range
Default Value
Type
Class
MCLI
Remote network element name
S
R
A4KEY
A4 key
S
R
KIND
A4 key indicator.
S
R
A4IND
A4 algorithm indicator
S
O
AKATYPE
Authentication and Key Agreement (AKA) type.
S
O
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
15
Chapter 3: Atomic Service Description Layer (ASDL) Commands
MML commands This method implements the AUC Create Key Data MML Command AGKDI:KIND=%KIND,A4KEY=%A4KEY[,A4IND=%A4IND][,AKATYPE=%AKATYPE]; Where %KIND is A4 key indicator %A4IND is A4 algorithm indicator %A4KEY is A4 Key %AKATYPE is Authentication and Key Agreement (AKA) type
Output parameters Return as CSDL parameter: A_ERIC-AUC_R12-0_CREATE_KEY-DATA_UDET=<user defined exit type> Return as Info parameter: A_ERIC-AUC_R12-0_CREATE_KEY-DATA_RETURN_INFO="Success" or <error_code>:<error_description>
A_ERIC-AUC_R12-0_CREATE_KEY-DATA-RB Rollback service for Delete Key data. It is implemented by the Java method: com.metasolv.cartridge.oss.eric_auc_r12_0.prov.AUCProvisioningKeyData.createKeyD ataRb Table 7: A_ERIC-AUC_R12-0_CREATE_KEY-DATA-RB Parameter Name
Description
Range
Default Value
Type
Class
MCLI
Remote network element name
S
R
OLD_A4KEY
A4 key
S
O
OLD_KIND
A4 key indicator.
S
R
OLD_A4IND
A4 algorithm indicator
S
O
OLD_AKATYPE
Authentication and Key Agreement (AKA) type.
S
O
16
Oracle Corporation
ASDL commands
MML commands This method implements the Rollback service for Delete AUC Key Data MML Command AGKDI:KIND=%OLD_KIND,A4KEY=%OLD_A4KEY[,A4IND=%OLD_A4IND][,AKATYPE=%OLD_A KATYPE]; Where %OLD_KIND is A4 key indicator %OLD_A4IND is A4 algorithm indicator %OLD_A4KEY is A4 Key %OLD_AKATYPE is Authentication and Key Agreement (AKA) type
Output parameters Return as CSDL parameter: A_ERIC-AUC_R12-0_CREATE_KEY-DATA-RB_UDET=<user defined exit type> Return as Info parameter: A_ERIC-AUC_R12-0_CREATE_KEY-DATA-RB_RETURN_INFO="Success" or <error_code>:<error_description>
A_ERIC-AUC_R12-0_CREATE_SUBSCRIBER This service creates a subscriber in the Authentication Center (AUC). The subscriber must be created on the AUC before the subscription is added on the AUC. It is implemented by the Java method: com.metasolv.cartridge.oss.eric_auc_r12_0.prov.AUCProvisioningSub.createSubscriber Table 8: A_ERIC-AUC_R12-0_CREATE_SUBSCRIBER Parameter Name
Description
Range
Default Value
Type
Class
MCLI
Remote network element name
S
R
IMSI
International Mobile Subscriber Identity (IMSI).
S
R
EKI
Encrypted subscriber authentication key (Ki).
S
R
KIND
A4 key indicator.
S
R
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
17
Chapter 3: Atomic Service Description Layer (ASDL) Commands
Table 8: A_ERIC-AUC_R12-0_CREATE_SUBSCRIBER Parameter Name
Description
Range
Default Value
Type
Class
A3A8IND
A3 A8 algorithm indicator.
S
O
FSETIND
Function set indicator.
S
O
A4IND
A4 algorithm indicator.
S
O
MML commands This method implements the Create AUC Subscriber MML Command. AGSUI:IMSI=%IMSI,EKI=%EKI,KIND=%KIND,[A3A8IND=%A3A8IND | FSETIND=%FSETIND][,A4IND=%A4IND]; Where: %IMSI is IMSI %EKI is EKI value %KIND is A4 key indicator %A3A8IND is Algorithm parameter value %FSETIND is Function set indicator, Application System dependent parameter, used only for WCDMA %A4IND is A4 algorithm indicator
Output parameters Return as CSDL parameter: A_ERIC-AUC_R12-0_CREATE_SUBSCRIBER_UDET=<user defined exit type> Return as Info parameter: A_ERIC-AUC_R12-0_CREATE_SUBSCRIBER_RETURN_INFO="Success" or <error_code>:<error_description>
A_ERIC-AUC_R12-0_CREATE_SUBSCRIBER-RB Rollback service for the Delete Subscriber service in the Authentication Center (AUC).
18
Oracle Corporation
ASDL commands
It is implemented by the Java method: com.metasolv.cartridge.oss.eric_auc_r12_0.prov.AUCProvisioningSub.createSubscriber Rb Table 9: A_ERIC-AUC_R12-0_CREATE_SUBSCRIBER-RB Parameter Name
Description
Range
Default Value
Type
Class
MCLI
Remote network element name
S
R
OLD_IMSI
International Mobile Subscriber Identity (IMSI).
S
R
OLD_EKI
Encrypted subscriber authentication key (Ki).
S
R
OLD_KIND
A4 key indicator.
S
R
OLD_A3A8IND
A3 A8 algorithm indicator.
S
O
OLD_FSETIND
Function set indicator.
S
O
OLD_A4IND
A4 algorithm indicator.
S
O
MML commands This method implements the Rollback service for Delete AUC Subscriber. AGSUI:IMSI=%IMSI,EKI=%OLD_EKI,KIND=%OLD_KIND,[A3A8IND=%OLD_A3A8IND | FSETIND=%OLD_FSETIND][,A4IND=%OLD_A4IND]; Where: %OLD_IMSI is IMSI %OLD_EKI is EKI value %OLD_KIND is A4 key indicator %OLD_A3A8IND is Algorithm parameter value %OLD_FSETIND is Function set indicator, Application System dependent parameter, used only for WCDMA %OLD_A4IND is A4 algorithm indicator
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
19
Chapter 3: Atomic Service Description Layer (ASDL) Commands
Output parameters Return as CSDL parameter: A_ERIC-AUC_R12-0_CREATE_SUBSCRIBER-RB_UDET=<user defined exit type> Return as Info parameter: A_ERIC-AUC_R12-0_CREATE_SUBSCRIBER-RB_RETURN_INFO="Success" or <error_code>:<error_description>
A_ERIC-AUC_R12-0_DELETE_KEY-DATA This service deletes the key data in AUC. It is implemented by the Java method: com.metasolv.cartridge.oss.eric_auc_r12_0.prov.AUCProvisioningKeyData.deleteKeyD ata Table 10: A_ERIC-AUC_R12-0_DELETE_KEY-DATA Parameter Name
Description
Range
Default Value
Type
Class
MCLI
Remote network element name
S
R
KIND
A4 key indicator.
S
R
A4IND
A4 algorithm indicator.
S
O
AKATYPE
Authentication and Key Agreement (AKA) type.
S
O
MML commands This method implements the AUC Delete Key Data MML Command AGKDE:KIND=%KIND[,A4IND=%A4IND][,AKATYPE=%AKATYPE]; Where: %KIND is A4 key indicator %A4IND is A4 algorithm indicator %AKATYPE is Authentication and Key Agreement (AKA)type
Output parameters Return as CSDL parameter:
20
Oracle Corporation
ASDL commands
A_ERIC-AUC_R12-0_DELETE_KEY-DATA_UDET=<user defined exit type> Return as Info parameter: A_ERIC-AUC_R12-0_DELETE_KEY-DATA_RETURN_INFO="Success" or <error_code>:<error_description>
A_ERIC-AUC_R12-0_DELETE_SUBSCRIBER This service deletes the subscriber in the Authentication Center (AUC). It is implemented by the Java method: com.metasolv.cartridge.oss.eric_auc_r12_0.prov.AUCProvisioningSub.deleteSubscriber Table 11: A_ERIC-AUC_R12-0_DELETE_SUBSCRIBER Parameter Name
Description
Range
Default Value
Type
Class
MCLI
Remote network element name
S
R
IMSI
International Mobile Subscriber Identity (IMSI).
S
R
MML commands This method implements the Delete AUC Subscriber MML Command. AGSUE:IMSI=%IMSI; Where: %IMSI is IMSI
Output parameters Return as CSDL parameter: A_ERIC-AUC_R12-0_DELETE_SUBSCRIBER_UDET=<user defined exit type> Return as Info parameter: A_ERIC-AUC_R12-0_DELETE_SUBSCRIBER_RETURN_INFO="Success" or <error_code>:<error_description>
A_ERIC-AUC_R12-0_GET_KEY-DATA This service queries the key data in AUC.
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
21
Chapter 3: Atomic Service Description Layer (ASDL) Commands
It is implemented by the Java method: com.metasolv.cartridge.oss.eric_auc_r12_0.prov.AUCProvisioningKeyData.getKeyData Table 12: A_ERIC-AUC_R12-0_GET_KEY-DATA Parameter Name
Description
Range
Default Value
Type
Class
MCLI
Remote network element name
S
R
KIND
A4 key indicator.
S
R
A4IND
A4 algorithm indicator.
S
O
SUBSCH
To display number of subscribers whose Encrypted subscriber authentication key (Ki) has been changed.
S
O
AKATYPE
Authentication and Key Agreement (AKA) type.
S
O
MML commands This method implements the get AUC Key Data MML Command AGKDP:KIND=%KIND[,A4IND=%A4IND][,SUBSCH][,AKATYPE=%AKATYPE]; Where %KIND is A4 key indicator %A4IND is A4 algorithm indicator %AKATYPE is Authentication and Key Agreement (AKA) type %SUBSCH Subscribers changed, this is an Application System dependent parameter, could be restricted to use with KIND parameters defined for GSM
Output parameters Return as CSDL parameter: A_ERIC-AUC_R12-0_GET_KEY-DATA_UDET=<user defined exit type> Return as Info parameter:
22
Oracle Corporation
ASDL commands
A_ERIC-AUC_R12-0_GET_KEY-DATA_RETURN_INFO="Success" or <error_code>:<error_description> RETURN_INFO Data_parameters
A_ERIC-AUC_R12-0_GET_KEY-DATA-RB This service queries the key data in AUC for Rollback Services. It is implemented by the Java method: com.metasolv.cartridge.oss.eric_auc_r12_0.prov.AUCProvisioningKeyData.getKeyData Rb Table 13: A_ERIC-AUC_R12-0_GET_KEY-DATA-RB Parameter Name
Description
Range
Default Value
Type
Class
MCLI
Remote network element name
S
R
KIND
A4 key indicator.
S
R
A4IND
A4 algorithm indicator
S
O
SUBSCH
To display number of subscribers whose encrypted subscriber authentication key (Ki) has been changed.
S
O
AKATYPE
Authentication and Key Agreement (AKA) type.
S
O
MML commands This method implements the get Key Data AUC MML Command for Rollback services. AGKDP:KIND=%KIND[,A4IND=%A4IND][,SUBSCH][,AKATYPE=%AKATYPE]; Where %KIND is A4 key indicator %A4IND is A4 algorithm indicator %AKATYPE is Authentication and Key Agreement (AKA) type %SUBSCH Subscribers changed, this is an Application System dependent parameter, could be restricted to use with
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
23
Chapter 3: Atomic Service Description Layer (ASDL) Commands
KIND parameters defined for GSM
Output parameters Return as CSDL parameter: A_ERIC-AUC_R12-0_GET_KEY-DATA-RB_UDET=<user defined exit type> OLD_ Return as Info parameter: A_ERIC-AUC_R12-0_GET_KEY-DATA-RB_RETURN_INFO="Success" or <error_code>:<error_description>
A_ERIC-AUC_R12-0_GET_SUBSCRIBER This service queries for the subscriber data in the Authentication Center (AUC). It is implemented by the Java method: com.metasolv.cartridge.oss.eric_auc_r12_0.prov.AUCProvisioningSub.getSubscriber Table 14: A_ERIC-AUC_R12-0_GET_SUBSCRIBER Parameter Name
Description
Range
Default Value
Type
Class
MCLI
Remote network element name
S
R
IMSIS
International Mobile Subscriber Identity (IMSI) series.
S
R
AKATYPE
Authentication and Key Agreement (AKA) type
S
O
MML commands This method implements the Get AUC Subscriber data MML Command. AGSUP:IMSIS=%IMSI[,AKATYPE=%AKATYPE]; Where: %IMSI is IMSI %AKATYPE is Authentication and Key Agreement (AKA) type IMSIS "ALL" Value is not supported for this implementation
24
Oracle Corporation
ASDL commands
Output parameters Return as CSDL parameter: A_ERIC-AUC_R12-0_GET_SUBSCRIBER_UDET=<user defined exit type> Return as Info parameter: A_ERIC-AUC_R12-0_GET_SUBSCRIBER_RETURN_INFO="Success" or <error_code>:<error_description> RETURN_INFO_
A_ERIC-AUC_R12-0_GET_SUBSCRIBER-RB Query for Rollback services in the Authentication Center (AUC). It is implemented by the Java method: com.metasolv.cartridge.oss.eric_auc_r12_0.prov.AUCProvisioningSub.getSubscriberRb Table 15: A_ERIC-AUC_R12-0_GET_SUBSCRIBER-RB Parameter Name
Description
Range
Default Value
Type
Class
MCLI
Remote network element name
S
R
IMSIS
International Mobile Subscriber Identity (IMSI) series.
S
O
IMSI
International Mobile Subscriber Identity (IMSI) series.
S
O
AKATYPE
Authentication and Key Agreement (AKA) type
S
O
MML commands This method implements the Get AUC Subscriber data MML Command for Rollback Services. AGSUP:IMSIS=%IMSI; Where: %IMSI is IMSI IMSIS "ALL" value is not supported for this implementation
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
25
Chapter 3: Atomic Service Description Layer (ASDL) Commands
Output parameters Return as CSDL parameter: A_ERIC-AUC_R12-0_GET_SUBSCRIBER-RB_UDET=<user defined exit type> OLD_ Return as Info parameter: A_ERIC-AUC_R12-0_GET_SUBSCRIBER-RB_RETURN_INFO="Success" or <error_code>:<error_description>
A_ERIC-AUC_R12-0_MODIFY_KEY-DATA This service modifies the key data in the AUC. It is implemented by the Java method: com.metasolv.cartridge.oss.eric_auc_r12_0.prov.AUCProvisioningKeyData.modifyKey Data Table 16: A_ERIC-AUC_R12-0_MODIFY_KEY-DATA Parameter Name
Description
Range
Default Value
Type
Class
MCLI
Remote network element name
S
R
A4KEY
A4 key
S
O
KIND
A4 key indicator.
S
R
A4IND
A4 algorithm indicator.
S
O
AKATYPE
Authentication and Key Agreement (AKA) type.
S
O
MML commands This method implements the modify AUC Key Data MML Command AGKDC:KIND=%KIND,A4KEY=%A4KEY[,A4IND=%A4IND][,AKATYPE=%AKATYPE]; Where %KIND is A4 key indicator %A4IND is A4 algorithm indicator %A4KEY is A4 Key
26
Oracle Corporation
ASDL commands
%AKATYPE is Authentication and Key Agreement (AKA) type Note:If user did not provided any values other than KIND parameter,cartridge will send the following MML command AGKDC:CONTINUE;
Output parameters Return as CSDL parameter: A_ERIC-AUC_R12-0_MODIFY_KEY-DATA_UDET=<user defined exit type> Return as Info parameter: A_ERIC-AUC_R12-0_MODIFY_KEY-DATA_RETURN_INFO="Success" or <error_code>:<error_description>
A_ERIC-AUC_R12-0_MODIFY_KEY-DATA-RB Rollback of Modify Key Data service in the AUC. It is implemented by the Java method: com.metasolv.cartridge.oss.eric_auc_r12_0.prov.AUCProvisioningKeyData.modifyKey DataRb Table 17: A_ERIC-AUC_R12-0_MODIFY_KEY-DATA-RB Parameter Name
Description
Range
Default Value
Type
Class
MCLI
Remote network element name
S
R
OLD_A4KEY
A4 key
S
O
OLD_KIND
A4 key indicator.
S
O
OLD_A4IND
A4 algorithm indicator
S
O
OLD_AKATYPE
Authentication and Key Agreement (AKA) type.
S
O
A4KEY
A4 key
S
O
MML commands This method implements the Rollback service for Modify AUC Key Data MML Command
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
27
Chapter 3: Atomic Service Description Layer (ASDL) Commands
AGKDC:KIND=%OLD_KIND,A4KEY=%OLD_A4KEY[,A4IND=%OLD_A4IND][,AKATYPE=%OLD_AKATY PE]; Where %OLD_KIND is A4 key indicator %OLD_A4IND is A4 algorithm indicator %OLD_A4KEY is A4 Key %OLD_AKATYPE is Authentication and Key Agreement (AKA) type
Output parameters Return as CSDL parameter: A_ERIC-AUC_R12-0_MODIFY_KEY-DATA-RB_UDET=<user defined exit type> Return as Info parameter: A_ERIC-AUC_R12-0_MODIFY_KEY-DATA-RB_RETURN_INFO="Success" or <error_code>:<error_description>
A_ERIC-AUC_R12-0_MODIFY_SUBSCRIBER This service modifies the subscriber in the AUC. It is implemented by the Java method: com.metasolv.cartridge.oss.eric_auc_r12_0.prov.AUCProvisioningSub.modifySubscribe r Table 18: A_ERIC-AUC_R12-0_MODIFY_SUBSCRIBER Parameter Name
Description
Range
Default Value
Type
Class
MCLI
Remote network element name
S
R
IMSIS
International Mobile Subscriber Identity (IMSI) series.
S
O
AMF
Authentication management field
S
O
FSETIND
Function set indicator
S
O
MML commands This method implements the Modify AUC Subscriber data MML Command.
28
Oracle Corporation
ASDL commands
AGSUC:IMSIS=%IMSI,AMF=%AMF,FSETIND=%FSETIND; Where: %IMSIS is IMSI %AMF is AMF %FSETIND is Function set indicator, Application System dependen parameter, used for WCDMA
Output parameters Return as CSDL parameter: A_ERIC-AUC_R12-0_MODIFY_SUBSCRIBER_UDET=<user defined exit type> Return as Info parameter: A_ERIC-AUC_R12-0_MODIFY_SUBSCRIBER_RETURN_INFO="Success" or <error_code>:<error_description>
A_ERIC-AUC_R12-0_MODIFY_SUBSCRIBER-RB Rollback modification of the subscriber in the AUC. It is implemented by the Java method: com.metasolv.cartridge.oss.eric_auc_r12_0.prov.AUCProvisioningSub.modifySubscribe rRb Table 19: A_ERIC-AUC_R12-0_MODIFY_SUBSCRIBER-RB Parameter Name
Description
Range
Default Value
Type
Class
MCLI
Remote network element name
S
R
OLD_IMSIS
IMSI digit string 1- 15 digits.
S
O
OLD_AMF
Authentication Management Field.
S
O
OLD_FSETIND
Function set indicator, value 0 - 15.
S
O
OLD_IMSI
IMSI digit string 1- 15 digits.
S
O
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
29
Chapter 3: Atomic Service Description Layer (ASDL) Commands
MML commands This method implements Rollback service for Modify AUC subscriber data MML command. AGSUC:IMSIS=%OLD_IMSIS,AMF=%OLD_AMF,FSETIND=%OLD_FSETIND; Where: %OLD_IMSIS is IMSI %OLD_AMF is old AMF %OLD_FSETIND is old Function set indicator, Application System dependent parameter, used for WCDMA
Output parameters Return as CSDL parameter: A_ERIC-AUC_R12-0_MODIFY_SUBSCRIBER-RB_UDET=<user defined exit type> Return as Info parameter: A_ERIC-AUC_R12-0_MODIFY_SUBSCRIBER_RETURN-RB_INFO="Success" or <error_code>:<error_description>
User exit types User exit types allow cartridge developers and systems administrators to map ASDL exit codes to one of the predefined base exit types. Base exit types determine the product behavior. Cartridges map return codes and status values from a network element to a user defined exit type. Regular expressions (regex) are used to perform pattern searches on responses from network elements. The pattern is stored in "tbl_user_err" in the SARM database. The user exit type contains a regex pattern that is applied at runtime. Regular expressions enable users to associate a series of responses to a specific base type. For example, a regular expression "6" can identify a pattern where any response with the character "6" followed by any number of characters will translate to base type of FAIL. Regular expressions can also allow very specific searches within a response from a network element. Regular expressions are typically compiled before being executed. Compilation produces a binary version of the expression and ensures that the syntax of the regular expression is correct. This compilation occurs using SACT\SADT when user exit types are deployed into ASAP. If the syntax is deemed to be incorrect during compilation, SADT displays an error message and the deployment of the user exit type will fail. For more information on pattern matching, refer to the ASAP Developer Reference and the ASAP Administration Guide.
30
Oracle Corporation
User exit types
Understanding user exit type XML files … <userDefinedExitType> <softwareLoad>DYNAMIC_SL DYNAMIC_VENDOR-DYNAMIC_TECH <searchPattern>SUCCESS.1 <userType>U_SUCCEED2 SUCCEED3 <description>The ASDL provisioning was successful <userDefinedExitType> <searchPattern>90. <userType>U_FAIL FAIL <description>The ASDL failed - fail the current order and stop processing. <userDefinedExitType> <searchPattern>101-110[201-215]4 <userType>U_SOFT_FAIL SOFT_FAIL <description>The ASDL has encountered a soft failure. Processing will continue. <userDefinedExitType> <searchPattern>801-8505 <userType>U_MINOR_ERROR SOFT_FAIL <description>The ASDL has encountered a soft failure. Processing will continue. <userDefinedExitType> <searchPattern>251-275&&[^261-265]6
1.
2. 3. 4. 5.
Pattern searches accommodate situations in which responses from the device contain small variants that represent the same meaning. The user type contains an associated search pattern that is applied at runtime. Using regular expressions, you can default a series of responses. For example a regular expression "90." can specify a pattern where any response with the character "90" followed by any character will translate to base type of FAIL. If the regular expression is defined as "90*", then any response with the character "90" followed by any number of characters will translate to base type of FAIL The user type that the search pattern maps to. The base type that maps to the user type. 101 to 110 and 201 to 215 will translate to a base type of SOFT_FAIL 801-850 will translate to a base type of SOFT_FAIL. Note that the user type differs from the previous range.
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
31
Chapter 3: Atomic Service Description Layer (ASDL) Commands
<userType>U_DELAYED_FAIL DELAYED_FAIL <description>The ASDL has failed during provisioning. <userDefinedExitType> <softwareLoad>BCS36 NORTEL_DMSNortel <searchPattern>*. <userType>U_MAINTAIN MAINTENANCE <description>The ASDL will Wait until the NE comes out of Maintenance Mode
The previous code sample shows some typical search pattern examples. Some additional examples follow:
^.*\b(one|two|three)\b.*$ = matches a complete line of text that contains any of the words "one", "two" or "three" ^(?=.*?\bone\b)(?=.*?\btwo\b)(?=.*?\bthree\b).*$ matches a complete line of text that contains all of the words "one", "two" and "three" "[^"\r\n]*" matches a single-line string that does not allow the quote character to appear inside the string. \b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b matches any IP address.
For more information on search patterns, refer to http://java.sun.com/j2se/1.4.2/docs/api/java/ util/regex/Pattern.html. For more information on user exit types, refer to chapter 3 of the ASAP Developer Reference.
User defined ASDL exit types The following table lists the user defined ASDL exit types. Table 20: User defined ASDL exit types Search pattern
User_type
Base_type
Description
((?s).)*EXECUTED((?s). ERAUC_EXECUTED )*
SUCCEED
Provisioning command successful
((?s).)*END((?s).)*
SUCCEED
Process end
6.
32
ERAUC_END
251 to 275 but not 261 to 265 will translate to a base type of DELAYED_FAILURE.
Oracle Corporation
User defined ASDL exit types
Table 20: User defined ASDL exit types Search pattern
((?s).)*ProvCartridgeException((?s).)* ude:searchPattern> ERAUC_PROVCARTEXCEPFAILThe NE command was denied due to Provisioning cartridge Exception.ERICAUCR12-0((?s).)*IOException((?s).)*ERAUC_IOEXCEPTIONRETRY_DISThe NE command was denied due to IO exception. ude:description> ERICAUCR12-0((?s).)*TelnetException((?s).)*ERAUC_TELNETEXCEPRETRY_DISThe NE command was denied due to telnet exception. ude:description> ERICAUCR12-0((?s).)*Generic Exception((?s).)*ERAUC_GENERICEXCEPFAILThe NE command was denied due to generic exception. ude:description> ERICAUCR12-0<ERAUC_LOOPBACK_OKSUCCEEDLoopback succeed prompt.
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
37
Chapter 3: Atomic Service Description Layer (ASDL) Commands
FAILAUC Fault Code 2, The A4 key indicator is not defined. ude:description> ERICAUCR12-0((?s).)*FAULT CODE 3((?s).)*ERAUC_FCODE_3FAILAUC Fault Code 3, the A4 Key indicator is in use by at least one mobile subscriber.ERICAUCR12-0((?s).)*FAULT CODE 4((?s).)*ERAUC_FCODE_4FAILAUC Fault Code 4, the A3/A8 algorithm indicator is not supported.ERICAUCR12-0((?s).)*FAULT CODE 5((?s).)*ERAUC_FCODE_5FAILAUC Fault Code 5, Storage shortage in the IMSI analysis file.ERICAUCR12-0((?s).)*FAULT CODE 6((?s).)*ERAUC_FCODE_6FAILAUC Fault Code 6, storage shortage in the subscription data file.
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
39
Chapter 3: Atomic Service Description Layer (ASDL) Commands
ERICAUCR12-0((?s).)*FAULT CODE 7((?s).)*ERAUC_FCODE_7FAILAUC Fault Code 7, the IMSI is already subscribed. ude:description> ERICAUCR12-0((?s).)*FAULT CODE 8((?s).)*ERAUC_FCODE_8FAILAUC Fault Code 8, the IMSI given is a prefix of another IMSI already subscribed.ERICAUCR12-0((?s).)*FAULT CODE 9((?s).)*ERAUC_FCODE_9FAILAUC Fault Code 9, there is an IMSI prefix of the IMSI given.ERICAUCR12-0((?s).)*FAULT CODE 10((?s).)*ERAUC_FCODE_10FAILAUC Fault Code 10, a Key data operation is in progress. ude:description> ERICAUCR12-0
40
Oracle Corporation
UserExitType.xml
((?s).)*FAULT CODE 11((?s).)*ERAUC_FCODE_11FAILAUC Fault Code 11, the IMSI has not been subscribed. ude:description> ERICAUCR12-0((?s).)*FAULT CODE 12((?s).)*ERAUC_FCODE_12FAILAUC Fault Code 12, a time out has ocurred during A4KEY encryption. ERICAUCR12-0((?s).)*FAULT CODE 13((?s).)*ERAUC_FCODE_13FAILAUC Fault Code 13, a subscription operation is in progress.ERICAUCR12-0((?s).)*FAULT CODE 14((?s).)*ERAUC_FCODE_14FAILAUC Fault Code 14, the maximum number of subscriptions allowed has been exceeded.ERICAUCR12-0((?s).)*FAULT CODE 19((?s).)*ERAUC_FCODE_19FAILAUC Fault Code 19, no Key data change is in progress. ude:description>
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
41
Chapter 3: Atomic Service Description Layer (ASDL) Commands
ERICAUCR12-0((?s).)*FAULT CODE 29((?s).)*ERAUC_FCODE_29FAILAUC Fault Code 29, the FSET does not support OP. ude:description> ERICAUCR12-0((?s).)*FAULT CODE 30((?s).)*ERAUC_FCODE_30FAILAUC Fault Code 30, an OP change is in progress. ude:description> ERICAUCR12-0((?s).)*FAULT CODE 43((?s).)*ERAUC_FCODE_43FAILAUC Fault Code 43, the A3A8 does not support OP. ude:description> ERICAUCR12-0((?s).)*FAULT CODE 50((?s).)*ERAUC_FCODE_50FAILAUC Fault Code 50, the area has not been initiated for the specific roaming area.ERICAUC
42
Oracle Corporation
UserExitType.xml
R12-0((?s).)*FAULT CODE 51((?s).)*ERAUC_FCODE_51FAILAUC Fault Code 51, Storage shortage in the data file. ude:description> ERICAUCR12-0((?s).)*FAULT CODE 52((?s).)*ERAUC_FCODE_52FAILAUC Fault Code 52, IMSI type stored does not match with the command parameter.ERICAUCR12-0((?s).)*FAULT CODE 53((?s).)*ERAUC_FCODE_53FAILAUC Fault Code 53, MSISDN type stored does not match with the command parameter.ERICAUCR12-0((?s).)*FAULT CODE 54((?s).)*ERAUC_FCODE_54FAILAUC Fault Code 54, Storage congestion in file for storage of characterized areas.ERICAUCR12-0((?s).)*FAULT CODE 55((?s).)*ERAUC_FCODE_55FAIL
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
43
Chapter 3: Atomic Service Description Layer (ASDL) Commands
ERICAUCR12-0((?s).)*FUNCTION BUSY((?s).)*ERAUC_FUNCTION_BUSYRETRY_DISAUC Function Busy.ERICAUCR12-0((?s).)*UNREASONABLE VALUE((?s).)*ERAUC_UNREASON_VALUEFAILAUC parameter was specified with an unreasonable value.ERICAUCR12-0((?s).)*FAULT CODE 1((?s).)*ERAUC_FCODE_1 FAILAUC Fault Code 1, The A4 key indicator is already defined.ERICAUCR12-0((?s).)*FAULT CODE 15((?s).)*ERAUC_FCODE_15FAILAUC Fault Code 15, the A4 algorithm indicator is not supported.ERICAUCR12-0((?s).)*FAULT CODE 16((?s).)*
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
47
Chapter 3: Atomic Service Description Layer (ASDL) Commands
ERAUC_FCODE_16FAILAUC Fault Code 16, a Key data change is in progress. ude:description> ERICAUCR12-0((?s).)*FAULT CODE 17((?s).)*ERAUC_FCODE_17FAILAUC Fault Code 17, a Key data change is pending. ude:description> ERICAUCR12-0((?s).)*FAULT CODE 20((?s).)*ERAUC_FCODE_20FAILAUC Fault Code 20, a customer Key operation is in progress.ERICAUCR12-0((?s).)*FAULT CODE 25((?s).)*ERAUC_FCODE_25FAILAUC Fault Code 25, the parameter is not supported by this exchange.ERICAUCR12-0((?s).)*FAULT CODE 27((?s).)*ERAUC_FCODE_27FAILAUC Fault Code 27, the function set indicator is not supported.
48
Oracle Corporation
UserExitType.xml
ERICAUCR12-0((?s).)*FAULT CODE 32((?s).)*ERAUC_FCODE_32FAILAUC Fault Code 32, an AKA algorithm change is in progress.ERICAUCR12-0((?s).)*FAULT CODE 33((?s).)*ERAUC_FCODE_33FAILAUC Fault Code 33, an AKA algorithm change is pending. ude:description> ERICAUCR12-0((?s).)*FAULT CODE 40((?s).)*ERAUC_FCODE_40FAILAUC Fault Code 40, a subscription data change is pending.ERICAUCR12-0((?s).)*FAULT CODE 45((?s).)*ERAUC_FCODE_45FAILAUC Fault Code 45, a BOP change is in progress. ude:description> ERICAUCR12-0
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
49
Chapter 3: Atomic Service Description Layer (ASDL) Commands
((?s).)*FAULT CODE 26((?s).)*ERAUC_FCODE_26FAILAUC Fault Code 26, the parameter value is not supported by this exchange.ERICAUCR12-0((?s).)*FAULT CODE 24((?s).)*ERAUC_FCODE_24FAILAUC Fault Code 24, functionality connected to the command is not supported by the exchange.ERICAUCR12-0((?s).)*FAULT CODE 34((?s).)*ERAUC_FCODE_34FAILAUC Fault Code 34, the WCDMA IMSI series is not defined.ERICAUCR12-0((?s).)*FAULT CODE 36((?s).)*ERAUC_FCODE_36FAILAUC Fault Code 36, there are no WCDMA subscribers defined in the AUC.ERICAUCR12-0((?s).)*FAULT CODE 37((?s).)*ERAUC_FCODE_37FAIL
50
Oracle Corporation
UserExitType.xml
AUC Fault Code 37, there are no WCDMA subscribers associated to the specified FSET.ERICAUCR12-0((?s).)*FAULT CODE 41((?s).)*ERAUC_FCODE_41FAILAUC Fault Code 41, no subscription data change is pending.ERICAUCR12-0((?s).)*FAULT CODE 39((?s).)*ERAUC_FCODE_39FAILAUC Fault Code 39, a subscription data change is in progress.ERICAUCR12-0((?s).)*FAULT CODE 18((?s).)*ERAUC_FCODE_18FAILAUC Fault Code 18, no Key data change is pending. ude:description> ERICAUCR12-0((?s).)*COMMAND RESTRICTED((?s).)*ERAUC_CMD_RESTRICTEDFAILAUC not accepted, command restricted.
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
51
Chapter 3: Atomic Service Description Layer (ASDL) Commands
52
Oracle Corporation
4
Service Definition The Ericsson AUC 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 21: 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.
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
53
Chapter 4: Service Definition
Table 21: ASDL parameter information Item Type
Description 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 Reference. Class
Indicates one of the following parameter classifications:
C_ERIC-AUC_R12-0_CREATE_KEY-DATA This service creates the key data in AUC. Table 22: C_ERIC-AUC_R12-0_CREATE_KEY-DATA Parameter Name
Description
Range
Default Value
Type
Class
A4IND
A4 algorithm indicator
S
O
A4KEY
A4 key
S
R
AKATYPE
Authentication and Key Agreement (AKA) type.
S
O
KIND
A4 key indicator.
S
R
NE_ID_ERIC-AUC
Remote network element name
S
R
Mapping to ASDLs The following table illustrates the CSDL to ASDL mapping for this service. Table 23: CSDL to ASDL Mapping CSDL
ASDL
C_ERIC-AUC_R12-0_CREATE_KEY-DATA
A_ERIC-AUC_R12-0_CREATE_KEY-DATA
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
55
Chapter 4: Service Definition
C_ERIC-AUC_R12-0_CREATE_SUBSCRIBER This service creates a subscriber in Authentication Center (AUC). The subscriber must be created on the AUC before the subscription is added in AUC. Table 24: C_ERIC-AUC_R12-0_CREATE_SUBSCRIBER Parameter Name
Description
Range
Default Value
Type
Class
A3A8IND
A3 A8 algorithm indicator.
S
O
A4IND
A4 algorithm indicator.
S
O
EKI
Encrypted subscriber authentication key (Ki).
S
R
FSETIND
Function set indicator.
S
O
IMSI
International Mobile Subscriber Identity (IMSI).
S
R
KIND
A4 key indicator.
S
R
NE_ID_ERIC-AUC
Remote network element name
S
R
Mapping to ASDLs The following table illustrates the CSDL to ASDL mapping for this service. Table 25: CSDL to ASDL Mapping CSDL C_ERIC-AUC_R12-0_CREATE_SUBSCRIBER
56
Oracle Corporation
ASDL A_ERIC-AUC_R12-0_CREATE_SUBSCRIBER
CSDL commands
C_ERIC-AUC_R12-0_DELETE_KEY-DATA This service deletes the key data in AUC. Table 26: C_ERIC-AUC_R12-0_DELETE_KEY-DATA Parameter Name
Description
Range
Default Value
Type
Class
A4IND
A4 algorithm indicator
S
O
AKATYPE
Authentication and Key Agreement (AKA) type.
S
O
KIND
A4 key indicator.
S
R
NE_ID_ERIC-AUC
Remote network element name
S
R
SUBSCH
To display number of subscribers whose encrypted subscriber authentication key (Ki) has been changed.
S
O
Mapping to ASDLs The following table illustrates the CSDL to ASDL mapping for this service. Table 27: CSDL to ASDL Mapping CSDL
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
57
Chapter 4: Service Definition
C_ERIC-AUC_R12-0_DELETE_SUBSCRIBER This service deletes a subscriber in Authentication Center (AUC). Table 28: C_ERIC-AUC_R12-0_DELETE_SUBSCRIBER Parameter Name
Description
Range
Default Value
Type
Class
AKATYPE
Authentication and Key Agreement (AKA) type
S
O
IMSI
International Mobile Subscriber Identity (IMSI) series.
S
R
IMSIS
International Mobile Subscriber Identity (IMSI) series.
S
O
NE_ID_ERIC-AUC
Remote network element name
S
R
Mapping to ASDLs The following table illustrates the CSDL to ASDL mapping for this service. Table 29: CSDL to ASDL Mapping CSDL C_ERIC-AUC_R12-0_DELETE_SUBSCRIBER
C_ERIC-AUC_R12-0_GET_KEY-DATA This service gets the key data in AUC. Table 30: C_ERIC-AUC_R12-0_GET_KEY-DATA Parameter Name A4IND
58
Oracle Corporation
Description A4 algorithm indicator.
Range
Default Value
Type S
Class O
CSDL commands
Table 30: C_ERIC-AUC_R12-0_GET_KEY-DATA Parameter Name
Description
Range
Default Value
Type
Class
AKATYPE
Authentication and Key Agreement (AKA) type.
S
O
KIND
A4 key indicator.
S
R
NE_ID_ERIC-AUC
Remote network element name
S
R
SUBSCH
To display number of subscribers whose Encrypted subscriber authentication key (Ki) has been changed.
S
O
Mapping to ASDLs The following table illustrates the CSDL to ASDL mapping for this service. Table 31: CSDL to ASDL Mapping CSDL
ASDL
C_ERIC-AUC_R12-0_GET_KEY-DATA
A_ERIC-AUC_R12-0_GET_KEY-DATA
C_ERIC-AUC_R12-0_GET_SUBSCRIBER This service queries for the subscriber in Authentication Center (AUC). Table 32: C_ERIC-AUC_R12-0_GET_SUBSCRIBER Parameter Name
Description
Range
Default Value
Type
Class
AKATYPE
Authentication and Key Agreement (AKA) type
S
O
IMSIS
International Mobile Subscriber Identity (IMSI) series.
S
R
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
59
Chapter 4: Service Definition
Table 32: C_ERIC-AUC_R12-0_GET_SUBSCRIBER Parameter Name NE_ID_ERIC-AUC
Description
Range
Default Value
Remote network element name
Type S
Class R
Mapping to ASDLs The following table illustrates the CSDL to ASDL mapping for this service. Table 33: CSDL to ASDL Mapping CSDL C_ERIC-AUC_R12-0_GET_SUBSCRIBER
ASDL A_ERIC-AUC_R12-0_GET_SUBSCRIBER
C_ERIC-AUC_R12-0_MODIFY_KEY-DATA This service modifies the key data in AUC. Table 34: C_ERIC-AUC_R12-0_MODIFY_KEY-DATA Parameter Name
Description
Range
Default Value
Type
Class
A4IND
A4 algorithm indicator
S
O
A4KEY
A4 key
S
O
AKATYPE
Authentication and Key Agreement (AKA) type.
S
O
KIND
A4 key indicator.
S
R
NE_ID_ERIC-AUC
Remote network element name
S
R
SUBSCH
To display number of subscribers whose encrypted subscriber authentication key (Ki) has been changed.
S
O
60
Oracle Corporation
CSDL commands
Mapping to ASDLs The following table illustrates the CSDL to ASDL mapping for this service. Table 35: CSDL to ASDL Mapping CSDL
C_ERIC-AUC_R12-0_MODIFY_SUBSCRIBER This service modifies the subscriber in AUC. Table 36: C_ERIC-AUC_R12-0_MODIFY_SUBSCRIBER Parameter Name
Description
Range
Default Value
Type
Class
AKATYPE
Authentication and Key Agreement (AKA) type
S
O
AMF
Authentication management field
S
O
FSETIND
Function set indicator
S
O
IMSI
International Mobile Subscriber Identity (IMSI) series.
S
O
IMSIS
International Mobile Subscriber Identity (IMSI) series.
S
O
NE_ID_ERIC-AUC
Remote network element name
S
R
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
61
Chapter 4: Service Definition
Mapping to ASDLs The following table illustrates the CSDL to ASDL mapping for this service. Table 37: CSDL to ASDL Mapping CSDL C_ERIC-AUC_R12-0_MODIFY_SUBSCRIBER
Configuring ASAP to Support Additional NE Instances You can configure ASAP to support the NE_ERIC-AUC_R12-0-HOST - NEP configuration using the Service Activation Configuration Tool (SACT). Refer to the ASAP Administration Guide for more information. Below is an example of the Activation.Configuration.XML file for the Ericsson AUC cartridge. <device name="T_ERIC-AUC_R12-0_HOST_conn_1"> <environment>DEVELOPMENT TELNET_CONNECTION <device name="T_ERIC-AUC_R12-0_HOST_conn_2"> <environment>DEVELOPMENT TELNET_CONNECTION <device name="T_ERIC-AUC_R12-0_HOST_conn_3"> <environment>DEVELOPMENT TELNET_CONNECTION <device name="T_ERIC-AUC_R12-0_HOST_conn_4"> <environment>DEVELOPMENT TELNET_CONNECTION <device name="T_ERIC-AUC_R12-0_HOST_conn_5"> <environment>DEVELOPMENT TELNET_CONNECTION <device name="T_ERIC-AUC_R12-0_HOST_conn_6"> <environment>DEVELOPMENT TELNET_CONNECTION <device name="T_ERIC-AUC_R12-0_HOST_conn_7"> <environment>DEVELOPMENT TELNET_CONNECTION
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
63
Chapter 5: Configuring ASAP to Support Additional NE Instances
<device name="T_ERIC-AUC_R12-0_HOST_conn_8"> <environment>DEVELOPMENT TELNET_CONNECTION <device name="T_ERIC-AUC_R12-0_HOST_conn_9"> <environment>DEVELOPMENT TELNET_CONNECTION <device name="T_ERIC-AUC_R12-0_HOST_conn_10"> <environment>DEVELOPMENT TELNET_CONNECTION <device name="T_ERIC-AUC_R12-0_HOST_conn_11"> <environment>DEVELOPMENT TELNET_CONNECTION <device name="T_ERIC-AUC_R12-0_HOST_conn_12"> <environment>DEVELOPMENT TELNET_CONNECTION <device name="T_ERIC-AUC_R12-0_HOST_conn_13"> <environment>DEVELOPMENT TELNET_CONNECTION <device name="T_ERIC-AUC_R12-0_HOST_conn_14"> <environment>DEVELOPMENT TELNET_CONNECTION <device name="T_ERIC-AUC_R12-0_HOST_conn_15"> <environment>DEVELOPMENT TELNET_CONNECTION <device name="T_ERIC-AUC_R12-0_HOST_conn_16"> <environment>DEVELOPMENT TELNET_CONNECTION <element name="T_ERIC-AUC_R12-0_HOST"> ERICAUC <softwareLoad>R12-0 $NEP <primaryPool>ERAUCPOL <maximumConnections>16 2 <spawnThreshold>10 8127.0.0.1 <description>The host name or IP Address of the remote NE. TELNET_CONNECTION
64
Oracle Corporation
5000 <description>Port number to connect on remote NE host. description> TELNET_CONNECTION20 <description>Connection timeout in seconds. TELNET_CONNECTION30 <description>Read timeout in seconds. TELNET_CONNECTIONuser <description>Login User Name. TELNET_CONNECTIONpassword <description>Password for the User. TELNET_CONNECTION< <description>Provisioning prompt. TELNET_CONNECTIONUSERCODE: <description>Login prompt from the NE TELNET_CONNECTION
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
65
Chapter 5: Configuring ASAP to Support Additional NE Instances
PASSWORD: <description>Password prompt from the NE TELNET_CONNECTIONDOMAIN: <description>Domain prompt from the NE TELNET_CONNECTIONpthlr1d <description>Domain password for the NE TELNET_CONNECTIONTRUE <description>Flag to turn off or on Response log. description> TELNET_CONNECTIONFALSE <description>Flag to turn off or on reply in ASCII format. TELNET_CONNECTION
Extracting source files Before 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. Create a repository directory. Copy the .sar file to the new directory and un-jar the sar file. 2. After you un-jar the sar file, you can access the XML files.
66
Oracle Corporation
Extracting source files
Loading a new XML file When you finish modifying an XML file, you must create a new sar file, then restart the cartridge using the new file. Follow the instructions in “Testing the cartridge installation” on page 8, for directions on how to load a new XML file.
Ericsson AUC (Authentication Center) R12.0 Cartridge Guide
67
Chapter 5: Configuring ASAP to Support Additional NE Instances