Cartridge Guide Release 1 - Oracle · 1 Overview 1-11Overview This guide provides a detailed...

[1] Oracle® Communications ASAP Cartridge for Oracle Communications Application Orchestrator 1.0Cartridge Guide

Release 1.0

First Edition

January 2015

Oracle Communications ASAP Cartridge for Oracle Communications Application Orchestrator 1.0 Cartridge Guide, Release 1.0

First Edition

Copyright © 2015, Oracle and/or its affiliates. All rights reserved.

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 is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware 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 that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about 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 unless otherwise set forth in an applicable agreement between you and Oracle. 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, except as set forth in an applicable agreement between you and Oracle.

iii

Contents

1 Overview

Supported Services .................................................................................................................................. 1-1Hardware and Software Requirements................................................................................................ 1-1

NE Interface ........................................................................................................................................ 1-2ASAP Version ..................................................................................................................................... 1-2Jersey 2.9 Libraries ............................................................................................................................. 1-2

Connecting to the OCAO NE ................................................................................................................. 1-3Communication Parameters ................................................................................................................... 1-3

2 Atomic Service Description Layer Commands

ASDL Commands..................................................................................................................................... 2-2A_ORACLE-AO_1.0_ADD_THRESHOLD .................................................................................... 2-2A_ORACLE-AO_1.0_ADD_VIM ..................................................................................................... 2-3A_ORACLE-AO_1.0_CONFIGURE_VDU ..................................................................................... 2-4A_ORACLE-AO_1.0_DELETE_NFGROUP ................................................................................... 2-4A_ORACLE-AO_1.0_DELETE_THRESHOLD.............................................................................. 2-5A_ORACLE-AO_1.0_DELETE_VIM............................................................................................... 2-5A_ORACLE-AO_1.0_DEPLOY_VDU ............................................................................................. 2-6A_ORACLE-AO_1.0_UNDEPLOY_VDU....................................................................................... 2-6A_ORACLE-AO_1.0_UPDATE_THRESHOLD............................................................................. 2-7

About User Exit Types............................................................................................................................. 2-7Understanding User Exit Type XML Files ..................................................................................... 2-8

User Defined ASDL Exit Types............................................................................................................. 2-9UserExitType.xml ................................................................................................................................. 2-10

3 Common Service Description Layer Commands

CSDL Commands ..................................................................................................................................... 3-2ADD_THRESHOLD .......................................................................................................................... 3-3ADD_VIM ........................................................................................................................................... 3-3CONFIGURE_VDU ........................................................................................................................... 3-4DELETE_NFGROUP ......................................................................................................................... 3-4DELETE_THRESHOLD .................................................................................................................... 3-5DELETE_VIM ..................................................................................................................................... 3-5DEPLOY_VDU ................................................................................................................................... 3-5UNDEPLOY_VDU............................................................................................................................. 3-6

iv

UPDATE_THRESHOLD ................................................................................................................... 3-6

4 Configuring ASAP to Support Additional NE Instances

Configuration XML File .......................................................................................................................... 4-1Extracting Source Files ............................................................................................................................ 4-3

Loading a New XML File .................................................................................................................. 4-3

1

Overview 1-1

1Overview

This guide provides a detailed description of the Oracle Communications ASAP Cartridge for Oracle Communications Application Orchestrator 1.0. It contains an overview and technical information for extending and integrating the cartridge into a customer environment.

This guide includes information on Oracle Communications ASAP (ASAP) related to the use of this cartridge. For additional information on using ASAP, refer to the ASAP documentation.

The ASAP cartridge for Application Orchestrator provides the ASAP service configuration and network element (NE) interface to activate subscriber services on the Oracle Communications Application Orchestrator (OCAO) network elements.

Supported ServicesTable 1–1 describes the services that the ASAP cartridge for Application Orchestrator supports.

Table 1–1 Supported Services

Service Description

DELETE_NFGROUP Deletes an NF group

ADD_THRESHOLD Adds a threshold

DELETE_THRESHOLD Deletes a threshold

UPDATE_THRESHOLD Updates an existing threshold

CONFIGURE_VDU Configures a VDU

DEPLOY_VDU Deploys a VDU

UNDEPLOY_VDU Undeploys a VDU

ADD_VIM Adds a VIM

DELETE_VIM Deletes a VIM

Hardware and Software RequirementsThe following sections describe the high-level software and hardware requirements for provisioning subscriber services on authentication center:

■ NE Interface

■ ASAP Version

Hardware and Software Requirements

1-2 ASAP Cartridge for Application Orchestrator Cartridge Guide

■ Jersey 2.9 Libraries

NE InterfaceThe following database tables in Service Activation Request Manager (SARM) are configured to support the NE configuration:

■ tbl_host_clli

■ tbl_clli_route

■ tbl_comm_param

■ tbl_resource_pool

■ tbl_ne_config

ASAP VersionThis cartridge was developed and tested using ASAP version 7.2.0.3

For more information on the operating environment of this ASAP version, refer the ASAP version 7.2.0.3 readme.

Jersey 2.9 LibrariesCopy the following Jersey 2.9 libraries to $ASAP_BASE/lib/OracleComms_ASAP_OCAO. Go to the Jersey Web site at: https://jersey.java.net/download.html

■ javax.ws.rs.jar

■ javax.ws.rs-api-2.0.jar

■ jersey-client.jar

■ jersey-common.jar

■ jersey-container-servlet.jar

■ jersey-container-servlet-core.jar

■ jersey-server.jar

■ aopalliance-repackaged-2.3.0.jar

■ asm-debug-all-5.0.2.jar

■ hk2-api-2.3.0.jar

■ hk2-locator-2.3.0.jar

■ hk2-utils-2.3.0.jar

■ javassist-3.18.1-GA.jar

■ javax.annotation-api-1.2.jar

■ javax.inject-2.3.0.jar

■ javax.servlet-api-3.0.1.jar

■ jaxb-api-2.2.7.jar

■ jersey-guava-2.9.jar

■ jersey-entity-filtering-2.9.jar

■ jersey-media-moxy-2.9.jar

Communication Parameters

Overview 1-3

■ org.osgi.core-4.2.0.jar

■ osgi-resource-locator-1.0.1.jar

■ persistence-api-1.0.jar

■ validation-api-1.1.0.Final.jar

■ jersey-media-multipart-2.9.1.jar

■ jersey-media-sse-2.9.1.jar

Connecting to the OCAO NEThe cartridge uses RESTful API calls over the standard HTTP protocol to communicate with the Application Orchestrator RESTful API.

Communication ParametersTable 1–2 describes the parameters for the sample NE configuration XML used by Service Activation Configuration Tool (SACT).

Table 1–2 Communication Parameters and their Default Values

Parameter Label Parameter Value Description

HOST_IPADDR 10.10.10.1 IP address

PORT 8443 Port

USER_NAME admin user name

PASSWORD admin port

TRUST_STORE_FILE /export/home/ASAP/config/nncentral.truststore

Trust store file with location

TRUST_STORE_PWD nsodev Trust store password

USE_HTTPS YES Use HTTPS - YES or NO.

The default is YES.

MAX_POLL_TIME 240 Maximum poll time in seconds

POLL_INTERVAL 30 Polling frequency in seconds

Communication Parameters


2

Atomic Service Description Layer Commands 2-1

2Atomic Service Description Layer Commands

This chapter describes the Atomic Service Description Layer (ASDL) commands that are provided with this cartridge.

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

Table 2–1 describes the ASDL parameters.

Table 2–1 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.

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 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 about parameter types, see ASAP Developer’s Guide.

ASDL Commands


For a detailed description of the Required and Optional parameter classifications, see ASAP System Administrator’s Guide.

ASDL CommandsThis cartridge provides the following ASDL commands:

■ A_ORACLE-AO_1.0_ADD_THRESHOLD

■ A_ORACLE-AO_1.0_ADD_VIM

■ A_ORACLE-AO_1.0_CONFIGURE_VDU

■ A_ORACLE-AO_1.0_DELETE_NFGROUP

■ A_ORACLE-AO_1.0_DELETE_THRESHOLD

■ A_ORACLE-AO_1.0_DELETE_VIM

■ A_ORACLE-AO_1.0_DEPLOY_VDU

■ A_ORACLE-AO_1.0_UNDEPLOY_VDU

■ A_ORACLE-AO_1.0_UPDATE_THRESHOLD

A_ORACLE-AO_1.0_ADD_THRESHOLDAdds a threshold.

This command is implemented by the following Java method: com.mslv.activation.cartridge.oracle.ao.x1_0.threshold.add.generated.AddThresholdProxy.execute

Table 2–2 describes the parameters for this command.

Class Indicates one of the following parameter classifications:

■ R - Required scalar parameter

■ O - Optional scalar parameter

■ C - Required compound parameter

■ N - Optional compound parameter

■ M - Mandatory indexed parameter

■ I - Optional indexed parameter

■ S - Parameter count

Table 2–2 A_ORACLE-AO_1.0_ADD_THRESHOLD Parameters

Parameter Name Description Type Class

THRESHOLD_CRITICAL Threshold for critical level S R

THRESHOLD_DECLINE_DURATION Duration for the declining direction S R

THRESHOLD_MAJOR Threshold for major level S R

THRESHOLD_MAX Maximum number of calls or sessions depending on the metric name

S R

Table 2–1 (Cont.) ASDL Parameter Information

Item Description

ASDL Commands


HTTP/JSON MessageSyntax

URI - http://OCAO_ipaddress:port/rest/v0.0/ocao/nfGroups/nfGroupId/thresholds

HTTP method - POST

Request body (Sample JSON message):{ "name":"CPUUtilization" "criticalThreshold":"90", "declineDuration":"1", "growthDuration":"2", "majorThreshold":"40", "maxNumber":"200", }

A_ORACLE-AO_1.0_ADD_VIMCreates a new VIM.

This command is implemented by the following Java method: com.mslv.activation.cartridge.oracle.ao.x1_0.vim.add.generated.AddVimProxy.execute


Table 2–3 A_ORACLE-AO_1.0_ADD_VIM Parameters


DATACENTER_NAME The data center name S R

ORGANIZATION Organization name for the data center S R

VCLOUD_IPADDRESS The vCloud IP address S R

VCLOUD_PASSWORD Password to log into the cloud S R

VCLOUD_PORT vCloud director TCP/IP port S R

VCLOUD_USERNAME User name to log into the cloud S R

VIM_NAME Unique name of the VM engine resource S R

VIM_TYPE Vcloud_5_1, vcloud_5_5, or Oracle Enterprise Manager S R

MCLI The identifier of the OCAO NE S R

THRESHOLD_NAME This is the predefined threshold metric name.

Valid values are:

■ CallsPerSecond

■ ActiveSessions

■ ActiveLocalContacts

■ CPUUtilization

■ MemoryUtilization

S R


THRESHOLD_GROWTH_DURATION Duration for the growing direction S R

NFGROUP_NAME NF group name S R

Table 2–2 (Cont.) A_ORACLE-AO_1.0_ADD_THRESHOLD Parameters


ASDL Commands



URI - http://OCAO_ipaddress:port/rest/v0.0/ocao/vims

HTTP method - POST

Request body (Sample JSON message):

{ "type":"VCLOUD_5_5", "name":"tgeVmEngine-10", "userName":"nnc", "password":"abc123", "organization":"Oracle", "ip":"10.10.10.1", "port":"4400", "vdc":"MainVDC" }

A_ORACLE-AO_1.0_CONFIGURE_VDUConfigures a VDU.

This command is implemented by the following Java method: com.mslv.activation.cartridge.oracle.ao.x1_0.vdu.configure.generated.ConfigureVduProxy.execute


Table 2–4 A_ORACLE-AO_1.0_CONFIGURE_VDU Parameters


VDU_IPADDRESS VDU IP address S R

VDU_NAME VDU name S R



URI - http://OCAO_ipaddress:port/rest/v0.0/ocao/vdus/vduId

HTTP method - PUT

Request body (Sample JSON message):{ "nfVm": { "ip":"172.30.81.167", "name": "vm-tge-167" } }

A_ORACLE-AO_1.0_DELETE_NFGROUPDeletes an NF group.

This command is implemented by the following Java method: com.mslv.activation.cartridge.oracle.ao.x1_0.nfgroup.delete.generated.DeleteNfgroupProxy.execute


Table 2–5 A_ORACLE-AO_1.0_DELETE_NFGROUP Parameters




ASDL Commands



URI - http://OCAO_ipaddress:port/rest/v0.0/ocao/vims/vimId

HTTP method - POST

Request body (JSON message):<Not applicable>

A_ORACLE-AO_1.0_DELETE_THRESHOLDDeletes a threshold.

This command is implemented by the following Java method: com.mslv.activation.cartridge.oracle.ao.x1_0.threshold.delete.generated.DeleteThresholdProxy.execute


Table 2–6 A_ORACLE-AO_1.0_DELETE_THRESHOLD




THRESHOLD_NAME This is the name of the predefined threshold metric S R


URI - http://OCAO_ipaddress:port/rest/v0.0/ocao/nfGroups/nfGroupId/thresholds/thresholdId

HTTP method - DELETE

Request body ( JSON message):<Not applicable>

A_ORACLE-AO_1.0_DELETE_VIMDeletes a VIM.

This command is implemented by the following Java method:

com.mslv.activation.cartridge.oracle.ao.x1_0.vim.delete.generated.DeleteVimProxy.execute


Table 2–7 A_ORACLE-AO_1.0_DELETE_VIM Parameters



VIM_ID VIM resource identifier S R


ASDL Commands


URI - http://OCAO_ipaddress:port/rest/v0.0/ocao/vims/vimId

HTTP method - POST

Request body (JSON message):<Not applicable>

A_ORACLE-AO_1.0_DEPLOY_VDUDeploys a VDU.


com.mslv.activation.cartridge.oracle.ao.x1_0.scale_up.add.generated.AddScale_upProxy.execute


Table 2–8 A_ORACLE-AO_1.0_DEPLOY_VDU




NFGROUP_ID NF group identifier S O


URI - http://OCAO_ipaddress:port/rest/v0.0/ocao/vdus/vdu_ID/action

HTTP method - POST

Request body:

{ "type": "undeploy" }

A_ORACLE-AO_1.0_UNDEPLOY_VDUUndeploys a VDU.


com.mslv.activation.cartridge.oracle.ao.x1_0.spin_down.add.generated.AddSpin_downProxy.execute


Table 2–9 A_ORACLE-AO_1.0_UNDEPLOY_VDU Parameters






URI - http://OCAO_ipaddress:port/rest/v0.0/ocao/vdus/vdu_ID/action

About User Exit Types


HTTP method - POST

Request body:

{ "type": "undeploy" }

A_ORACLE-AO_1.0_UPDATE_THRESHOLDUpdates a threshold.


com.mslv.activation.cartridge.oracle.ao.x1_0.threshold.update.generated.UpdateThresholdProxy.execute


Table 2–10 A_ORACLE-AO_1.0_UPDATE_THRESHOLD Parameters







S R



THRESHOLD_NAME This is the predefined threshold metric name S R


URI - http://OCAO_ipaddress:port/rest/v0.0/ocao/nfGroups/nfGroupId/thresholds/thresholdId

HTTP method - PUT

Request body (Sample JSON message):{ "criticalThreshold":"90", "declineDuration":"1", "growthDuration":"2", "majorThreshold":"40", "maxNumber":"200"}

About User Exit TypesUser exit types allow cartridge developers and system administrators to map ASDL exit codes to 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 in which any response

About User Exit Types


with the character 6 followed by any number of characters translates to base type of FAIL.

Regular expressions 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 or 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 fails.

For more information about pattern matching, see ASAP Developer’s Guide and ASAP System Administrator’s Guide.

Understanding User Exit Type XML Files…<userDefinedExitType><neDescriptor><softwareLoad>DYNAMIC_SL</softwareLoad><technology>DYNAMIC_VENDOR-DYNAMIC_TECH</technology></neDescriptor><searchPattern>SUCCESS.</searchPattern>...1<userType>U_SUCCEED</userType>...2<baseType>SUCCEED<</baseType>...3<description>The ASDL provisioning was successful</description></userDefinedExitType><userDefinedExitType><searchPattern>90.</searchPattern><userType>U_FAIL</userType><baseType>FAIL</baseType><description>The ASDL failed - fail the current order and stop processing.</description></userDefinedExitType><userDefinedExitType><searchPattern>101-110[201-215]</searchPattern>...4<userType>U_SOFT_FAIL</userType><baseType>SOFT_FAIL</baseType><description>The ASDL has encountered a soft failure. Processing will continue.</description></userDefinedExitType><userDefinedExitType><searchPattern>801-850</searchPattern>...5<userType>U_MINOR_ERROR</userType><baseType>SOFT_FAIL</baseType><description>The ASDL has encountered a soft failure. Processing will continue.</description></userDefinedExitType><userDefinedExitType><searchPattern>251-275&&[^261-265]</searchPattern>...6<userType>U_DELAYED_FAIL</userType><baseType>DELAYED_FAIL</baseType><description>The ASDL has failed during provisioning.</description></userDefinedExitType><userDefinedExitType><neDescriptor><softwareLoad>BCS36</softwareLoad><technology>NORTEL_DMS</technology><neVendor>Nortel</neVendor></neDescriptor>

User Defined ASDL Exit Types


<searchPattern>*.</searchPattern><userType>U_MAINTAIN</userType><baseType>MAINTENANCE</baseType><description>The ASDL will Wait until the NE comes out of Maintenance Mode</description></userDefinedExitType>

The following descriptions correspond to the numbered elements highlighted in bold in the code sample:

1. 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 in which any response with the character "90" followed by any character translates to the FAIL base type. If the regular expression is defined as "90*", any response with the character "90" followed by any number of characters translates to the FAIL base type.

2. The user type that the search pattern maps to.

3. The base type that maps to the user type.

4. 101 to 110 and 201 to 215 translate to a base type of SOFT_FAIL

5. 801-850 translate to the SOFT_FAIL base type. Note that the user type differs from the previous range.

6. 251 to 275, but not 261 to 265 translate to the DELAYED_FAILURE base type.

The code sample shows some typical search pattern examples. Some additional examples are:

■ ^.*\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 with any IP address

For more information about search patterns, go to:

https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html

For more information about user exit types, see ASAP Developer’s Guide.

User Defined ASDL Exit TypesTable 2–11 lists the user defined ASDL exit types.

Table 2–11 User Defined ASDL Exit Types

Search Pattern User Type Base Type Description

Success AO_1-0_PROV_SUCCESS SUCCEED Command Provisioned successfully

Failure AO_1-0_PROV_FAILURE FAIL Command Provisioning failed

((?s).)*GENERIC_EXCEPTION:((?s).)*

AO_1-0_GEN_EXCEPTION FAIL Generic Exception

UserExitType.xml


UserExitType.xml <?xml version="1.0" encoding="UTF-8"?><serviceModel xmlns="http://www.metasolv.com/ServiceActivation/2003/ServiceModel"> <userDefinedExitType> <neDescriptor> <softwareLoad>1.0<//softwareLoad> <technology>AO<//technology> <neVendor>ORACLE<//neVendor> <//neDescriptor> <searchPattern>Success<//searchPattern> <userType>AO_1-0_PROV_SUCCESS<//userType> <baseType>SUCCEED<//baseType> <description>Command Provisioned successfully.<//description> <//userDefinedExitType> ..................... <//serviceModel >

((?s).)*PROV_CARTRIDGE_EXCEPTION:((?s).)*

AO_1-0_PRV_CART_EXCP FAIL Provisioning Cartridge Exception

200 AO_1-0_CMD_OKAY SUCCEED Provisioned Command okay

202 AO_1-0_CMD_ACCEPTED SUCCEED Provisioned command accepted

204 AO_1-0_CMD_NOCONTENT SUCCEED No Content retrieved from NE

400 AO_1-0_BAD_REQUEST FAIL Bad request to NE

401 AO_1-0_CMD_UNAUTHRZD FAIL Command not authorized to NE

403 AO_1-0_CMD_FORBIDDEN FAIL Command forbidden by NE

404 AO_1-0_CMD_NOT_FOUND FAIL Command not found in the NE

500 AO_1-0_INTRN_SRV_ERR FAIL Internal NE Server error

Timeout TIMEOUT FAIL Operation timed-out

NFGROUPNOTFOUND NFG_RECORD_NOT_FOUND

SUCCEED NF group does not exist or already deleted

Unknown UNKWN_DEPLOY_STATUS FAIL Unknown deployment status

NOVDUELIGIBLE NO_VDU_ELIGIBLE SUCCEED No VDU is eligible to deploy or un-deploy

THRESHOLDNOTFOUND THRESHOLD_NOT_FOUND SUCCEED Threshold does not exist or already deleted

NOTFOUND RECORD_NOT_FOUND FAIL Record not found

Table 2–11 (Cont.) User Defined ASDL Exit Types

Search Pattern User Type Base Type Description

3

Common Service Description Layer Commands 3-1

3Common Service Description Layer Commands

This chapter describes the Common Service Description Layer (CSDL) commands that are included in the Oracle Communications ASAP cartridge for Application Orchestrator 1.0.

The 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.

Table 3–1 describes the type of parameter information that is included in the cartridge.

Table 3–1 CSDL 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

CSDL Commands


For a detailed description of the Required and Optional parameter classifications, see ASAP System Administrator’s Guide.

CSDL CommandsThis cartridge provides the following CSDL commands:

■ ADD_THRESHOLD

■ ADD_VIM

■ CONFIGURE_VDU

■ DELETE_NFGROUP

■ DELETE_THRESHOLD

■ DELETE_VIM

■ DEPLOY_VDU

■ UNDEPLOY_VDU

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 about parameter types, see ASAP Developer’s Guide.

Class Indicates one of the following parameter classifications:

■ R - Required scalar parameter

■ O - Optional scalar parameter

■ C - Required compound parameter

■ N - Optional compound parameter

■ M - Mandatory indexed parameter

■ I - Optional indexed parameter

■ S - Parameter count

Table 3–1 (Cont.) CSDL Parameter Information

Item Description

CSDL Commands


■ UPDATE_THRESHOLD

ADD_THRESHOLDAdds a threshold.

Table 3–2 describes the ADD_THRESHOLD parameters.

Table 3–2 ADD_THRESHOLD Parameters









S R

THRESHOLD_NAME This is the predefined threshold metric name.

Valid values are:

■ CallsPerSecond

■ ActiveSessions

■ ActiveLocalContacts

■ CPUUtilization

■ MemoryUtilization

S R

Mapping to ASDLsTable 3–3 illustrates the CSDL to ASDL mapping for this service.

Table 3–3 CSDL to ASDL Mapping

CSDL ASDL

ADD_THRESHOLD A_ORACLE-AO_1.0_ADD_THRESHOLD

ADD_VIMAdds a VIM.

Table 3–4 describes the ADD_VIM parameters.

Table 3–4 ADD_VIM


DATACENTER_NAME The data center name S R


ORGANIZATION Organization name for the data center S R

VCLOUD_IPADDRESS The vCloud IP address S R

VCLOUD_PASSWORD Password to log into the cloud S R

VCLOUD_PORT vCloud director TCP/IP port S R

CSDL Commands




CSDL ASDL

ADD_VIM A_ORACLE-AO_1.0_ADD_VIM

CONFIGURE_VDUConfigures a VDU.

Table 3–6 describes the CONFIGURE_VDU parameters.

Table 3–6 CONFIGURE_VDU Parameters




VDU_NAME VDU name S R



CSDL ASDL

CONFIGURE_VDU A_ORACLE-AO_1.0_CONFIGURE_VDU

DELETE_NFGROUPDeletes an NF group.

Table 3–8 describes the DELETE_NFGROUP parameters.

Table 3–8 DELETE_NFGROUP Parameters





VCLOUD_USERNAME User name to log into the cloud S R

VIM_NAME Unique name of the VM engine resource S R

VIM_TYPE Vcloud_5_1, vcloud_5_5, or Oracle Enterprise Manager

S R

Table 3–4 (Cont.) ADD_VIM



CSDL ASDL

DELETE_NFGROUP A_ORACLE-AO_1.0_DELETE_NFGROUP

CSDL Commands


DELETE_THRESHOLDDeletes a threshold.

Table 3–10 describes the DELETE_THRESHOLD parameters.

Table 3–10 DELETE_THRESHOLD Parameters







CSDL ASDL

DELETE_THRESHOLD A_ORACLE-AO_1.0_DELETE_THRESHOLD

DELETE_VIMDeletes a VIM.

Table 3–12 describes the DELETE_VM parameters.

Table 3–12 DELETE_VIM Parameters



VIM_ID VIM resource ID S R



CSDL ASDL

DELETE_VIM A_ORACLE-AO_1.0_DELETE_VIM

DEPLOY_VDUDeploys a VDU.

Table 3–14 describes the DEPLOY_VDU parameters.

Table 3–14 DEPLOY_VDU Parameters





CSDL Commands




CSDL ASDL

DEPLOY_VDU A_ORACLE-AO_1.0_DEPLOY_VDU

UNDEPLOY_VDUUndeploys a VDU.

Table 3–16 describes the UNDEPLOY_VDU parameters.

Table 3–16 UNDEPLOY_VDU Parameters







CSDL ASDL

UNDEPLOY_VDU A_ORACLE-AO_1.0_UNDEPLOY_VDU

UPDATE_THRESHOLDUpdates a threshold.

Table 3–18 describes the UPDATE_THRESHOLD parameters.

Table 3–18 UPDATE_THRESHOLD Parameters







CSDL Commands




CSDL ASDL

UPDATE_THRESHOLD A_ORACLE-AO_1.0_UPDATE_THRESHOLD



S R


Table 3–18 (Cont.) UPDATE_THRESHOLD Parameters


CSDL Commands


4

Configuring ASAP to Support Additional NE Instances 4-1

4Configuring ASAP to Support Additional NE Instances

You can configure Oracle Communications ASAP (ASAP) to support the T_ORACLE-AO_1.0_HOST - NEP configuration using Service Activation Configuration Tool (SACT). For more information, see ASAP System Administrator’s Guide.

Configuration XML FileThe following example shows the Activation.Configuration.XML file of the cartridge:

<?xml version="1.0" encoding="UTF-8"?><activationConfig xmlns="http://www.metasolv.com/ServiceActivation/2003/ActivationConfig"> <connectionPool name="OCAOCONN"> <device name="Connection1"> <environment/> <lineType>GENERIC_MESSAGE_BASED_CONNECTION</lineType> </device> </connectionPool> <element name="T_ORACLE-AO_1.0_HOST"> <vendor>ORACLE</vendor> <technology>AO</technology> <softwareLoad>1.0</softwareLoad> <nepServerName>$NEP</nepServerName> <primaryPool>OCAOCONN</primaryPool> <maximumConnections>5</maximumConnections> <dropTimeout>1</dropTimeout> <spawnThreshold>5</spawnThreshold> <killThreshold>3</killThreshold> <routingElement name="T_ORACLE-AO_1.0_HOST"/> <communicationParameter> <label>HOST_IPADDR</label> <value> <value>10.10.10.1</value> </value> <description>IP address</description> <deviceName>COMMON_DEVICE_CFG</deviceName> <lineType>GENERIC_MESSAGE_BASED_CONNECTION</lineType> </communicationParameter> <communicationParameter> <label>PORT</label> <value> <value>8443</value> </value> <description>Port</description> <deviceName>COMMON_DEVICE_CFG</deviceName>

Configuration XML File


<lineType>GENERIC_MESSAGE_BASED_CONNECTION</lineType> </communicationParameter> <communicationParameter> <label>USER_NAME</label> <value> <value>admin</value> </value> <description>user name</description> <deviceName>COMMON_DEVICE_CFG</deviceName> <lineType>GENERIC_MESSAGE_BASED_CONNECTION</lineType> </communicationParameter> <communicationParameter> <label>PASSWORD</label> <value> <value>admin</value> </value> <description>port</description> <deviceName>COMMON_DEVICE_CFG</deviceName> <lineType>GENERIC_MESSAGE_BASED_CONNECTION</lineType> </communicationParameter> <communicationParameter> <label>TRUST_STORE_FILE</label> <value> <value>/export/home/iravicha/724P3ASAP/ASAP/config/nncentral.truststore</value> </value> <description>Trust store file with location</description> <deviceName>COMMON_DEVICE_CFG</deviceName> <lineType>GENERIC_MESSAGE_BASED_CONNECTION</lineType> </communicationParameter> <communicationParameter> <label>TRUST_STORE_PWD</label> <value> <value>nsodev</value> </value> <description>Trust store password</description> <deviceName>COMMON_DEVICE_CFG</deviceName> <lineType>GENERIC_MESSAGE_BASED_CONNECTION</lineType> </communicationParameter> <communicationParameter> <label>USE_HTTPS</label> <value> <value>YES</value> </value> <description>Use HTTPS - YES or NO, default value: YES</description> <deviceName>COMMON_DEVICE_CFG</deviceName> <lineType>GENERIC_MESSAGE_BASED_CONNECTION</lineType> </communicationParameter> <communicationParameter> <label>MAX_POLL_TIME</label> <value> <value>240</value> </value> <description>Maximum poll time in seconds</description> <deviceName>COMMON_DEVICE_CFG</deviceName> <lineType>GENERIC_MESSAGE_BASED_CONNECTION</lineType> </communicationParameter> <communicationParameter> <label>POLL_INTERVAL</label> <value> <value>30</value>

Extracting Source Files

Configuring ASAP to Support Additional NE Instances 4-3

</value> <description>Polling freqency in seconds</description> <deviceName>COMMON_DEVICE_CFG</deviceName> <lineType>GENERIC_MESSAGE_BASED_CONNECTION</lineType> </communicationParameter> <description>OCAO Host name configured in ASAP</description> </element></activationConfig>

Extracting Source FilesBefore you can access an XML file to modify it, you must extract it from the .sar file.

To extract source files from the .sar file:

1. Create a repository directory.

2. Copy the .sar file to the new directory.

3. Un-jar the .sar file.

After you un-jar the .sar file, you can access the XML files and modify them.

Loading a New XML FileAfter you modify an XML file, you must create a new SAR file and then redeploy the cartridge using the new file.

Extracting Source Files


Date post:	22-Sep-2020
Category:	Documents
Upload:	others
View:	0 times
Download:	0 times

Cartridge Guide Release 1 - Oracle · 1 Overview 1-11Overview This guide provides a detailed...

Documents