Sie sind auf Seite 1von 90

E-OPS Web Services Northbound Interface Specification

Version 5.6

432006-2443-2S3-A00

E-OPS Web Services NorthBound Interface Specification Version 5.6 Catalog No. Y44803 June 2011

Copyright by ECI Telecom, 2011. All rights reserved worldwide. This is a legal agreement between you, the end user, and ECI Telecom Ltd. (ECI Telecom). BY OPENING THE DOCUMENTATION AND/OR DISK PACKAGE, YOU ARE AGREEING TO BE BOUND BY THE TERMS OF THIS AGREEMENT. IF YOU DO NOT AGREE TO THE TERMS OF THIS AGREEMENT, PROMPTLY RETURN THE UNOPENED DOCUMENTATION AND/OR DISK PACKAGE AND THE ACCOMPANYING ITEMS (INCLUDING WRITTEN MATERIALS AND BINDERS OR OTHER CONTAINERS), TO THE PLACE FROM WHICH YOU OBTAINED THEM. The information contained in the documentation and/or disk is proprietary and is subject to all relevant copyright, patent, and other laws protecting intellectual property, as well as any specific agreement protecting ECI Telecom's rights in the aforesaid information. Neither this document nor the information contained in the documentation and/or disk may be published, reproduced, or disclosed to third parties, in whole or in part, without the express prior written permission of ECI Telecom. In addition, any use of this document, the documentation and/or the disk, or the information contained therein for any purposes other than those for which it was disclosed, is strictly forbidden. ECI Telecom reserves the right, without prior notice or liability, to make changes in equipment design or specifications. Information supplied by ECI Telecom is believed to be accurate and reliable. However, no responsibility whatsoever is assumed by ECI Telecom for the use thereof, nor for the rights of third parties, which may be affected in any way by the use and/or dissemination thereof. Any representation(s) in the documentation and/or disk concerning performance of ECI Telecom product(s) are for informational purposes only and are not warranties of product performance or otherwise, either express or implied. ECI Telecom's standard limited warranty, stated in its sales contract or order confirmation form, is the only warranty offered by ECI Telecom. The documentation and/or disk is provided AS IS and may contain flaws, omissions, or typesetting errors. No warranty is granted nor liability assumed in relation thereto, unless specifically undertaken in ECI Telecom's sales contract or order confirmation. Information contained in the documentation and in the disk is periodically updated, and changes will be incorporated in subsequent editions. If you have encountered an error, please notify ECI Telecom. All specifications are subject to change without prior notice. The documentation and/or disk and all information contained therein is owned by ECI Telecom and is protected by all relevant copyright, patent, and other applicable laws and international treaty provisions. Therefore, you must treat the information contained in the documentation and disk as any other copyrighted material (for example, a book or musical recording). Other Restrictions. You may not rent, lease, sell, or otherwise dispose of the documentation and disk, as applicable. YOU MAY NOT USE, COPY, MODIFY, OR TRANSFER THE DOCUMENTATION AND/OR DISK OR ANY COPY IN WHOLE OR PART, EXCEPT AS EXPRESSLY PROVIDED IN THIS LICENSE. ALL RIGHTS NOT EXPRESSLY GRANTED ARE RESERVED BY ECI TELECOM. All trademarks mentioned herein are the property of their respective holders. ECI Telecom shall not be liable to you or to any other party for any loss or damage whatsoever or howsoever caused, arising directly or indirectly in connection with this documentation and/or disk, the information contained therein, its use, or otherwise. Notwithstanding the generality of the aforementioned, you expressly waive any claim and/or demand regarding liability for indirect, special, incidental, or consequential loss or damage which may arise in respect of the documentation and/or disk and/or the information contained therein, howsoever caused, even if advised of the possibility of such damages. The end user hereby undertakes and acknowledges that they read the "Before You Start/Safety Guidelines" instructions and that such instructions were understood by them. It is hereby clarified that ECI Telecom shall not be liable to you or to any other party for any loss or damage whatsoever or howsoever caused, arising directly or indirectly in connection with you fulfilling and/or failed to fulfill in whole or in part the "Before You Start/Safety Guidelines" instructions.

Contents
Overview ................................................................................. 1-1 Set DSL Profile ....................................................................... 2-1
Set DSL Profile Request ................................................................................. 2-1 Set DSL Profile Response .............................................................................. 2-4 Set DSL Profile Fault Response ..................................................................... 2-6

Add TP Label .......................................................................... 3-1


Add TP Label Response ................................................................................. 3-4

Modify TP Label ...................................................................... 4-1


Modify TP Label Request ............................................................................... 4-1 Modify TP Label Response ............................................................................. 4-4

Remove TP Label ................................................................... 5-1


Remove TP Label Request ............................................................................. 5-1 Remove TP Label Response .......................................................................... 5-3

Set Template ........................................................................... 6-1


Set Template Request .................................................................................... 6-1 Set Template Response ................................................................................. 6-4

Set DSL Template ................................................................... 7-1


Set DSL Template Request ............................................................................ 7-1 Set DSL Template Response ......................................................................... 7-5

Set ONT Template .................................................................. 8-1


Set ONT Template Request............................................................................ 8-1 Set ONT Template Response ....................................................................... 8-12

Set Ethernet UNI Template .................................................... 9-1


Set Ethernet UNI Template Request............................................................... 9-1 Set Ethernet UNI Template Response ............................................................ 9-8

Set Pots UNI Template ......................................................... 10-1


Set Pots UNI Template Request ................................................................... 10-1 Set Pots UNI Template Response ................................................................ 10-4

432006-2443-2S3-A00

ECI Telecom Ltd. Proprietary

Contents

E-OPS Web Services NorthBound Interface Specification

Invoke Async Action ............................................................ 10-1


Invoke Async Action Request ....................................................................... 11-1 Invoke Async Action Response .................................................................... 11-4 Invoke Async Action Fault Response............................................................ 11-5

Get Async Action Status...................................................... 11-1


Get Async Action Status Request ................................................................. 12-1 Get Async Action Status Response .............................................................. 12-2

Appendix .................................................................................A-1
NBI Log File .................................................................................................... A-1 Services List ................................................................................................... A-1

ii

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

1
Overview
The E-OPS Web Services NorthBound Interface (NBI) enables performance of operations on the E-OPS system. This document describes these operations and the SOAP messages used for calling their corresponding web services. The NBI was defined and implemented according to the Multi-Technology Operations System Interface (MTOSI), which is a de-facto standard for implementing interfaces between OSSs. MTOSI was defined by the Telemanagement Forum (TM Forum). For further information, please refer to http://www.tmforum.org/browse.aspx?catid=2319. NOTE: The NBI implements a subset of MTOSI definitions.
This document describes the relevant elements in each SOAP message. Using optional elements that are not described in this document might cause unexpected results.

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

1-1

Overview

E-OPS Web Services NorthBound Interface Specification

1-2

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

2
Set DSL Profile
The Set DSL Profile Operation is descibed by the MTOSI 2.0 TerminationPointControl Service. It allows an OS to modify the profile of a DSL port (Physical Termination Point - PTP) controlled by the E-OPS system.

Set DSL Profile Request


The setTerminationPointData operation is described by MTOSI 2.0.

Header
The following elements are required:

activityName setTerminationPointData msgName setTerminationPointData msgType REQUEST senderURI the URI of the request sender destinationURI http://www.ecitele.com communicationPattern SimpleResponse communicationStyle RPC vendorExtensions

ECIVersion 5.6 opType SET_DSL_PROFILE

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

2-1

Set DSL Profile

E-OPS Web Services NorthBound Interface Specification

Body
The following elements are required:

tpInfo.tpRef.rdn[] rdn (Relative Distinguish Name). This type/value element identifies the port or GPON ONT to be modified:

NE

type ME value either the name or the IP address of a particular network element.

Choice: Port

type PTP value an identifier of a particular port on the NE in the form: /shelf=x/slot=y/port=z

tpInfo.transmissionParametersList.transmissionParameter .vendorExtension a list of vendor specific additional elements.

Profile Type name profileType //optional

value one of the following: NgxdslMasterProfile VopTemplateName UsDataRateProfile DsDataRateProfile LineSpectrumProfile UpboProfile DpboProfile RfiBandsProfile XdslSnrMarginProfile InpDelayProfile VirtualNoiseProfile HfSpecificProfile HfOptionalSpecificProf If theres no profileType, The profile Type will be downloaded according to NE version: NgxdslMasterProfile for 4.2 and lower and VopTemplateName for 4.2 and above.

2-2

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Set DSL Profile

DSL profile name xdslProfile

value one of the following: a VOP template name for NEs of v4.2 or newer a global profile name for NEs of v4.1 or older.

reset modem flag (optional, by default: yes)


name resetModem value yes or no

Set DSL Profile Request Example


The following are XML examples of setTerminationPointData request message:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <wsse:Security soapenv:mustUnderstand="1" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsu="http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext-1.0.xsd"> <wsse:UsernameToken wsu:Id="UsernameToken-9670462"> <wsse:Username>webServicesUser</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis200401-wss-username-token-profile1.0#PasswordText">webServicesUserPassword</wsse:Password> </wsse:UsernameToken> </wsse:Security> <tns:header xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:s0="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"> <tns:activityName>setTerminationPointData</tns:activityName> <tns:msgName>setTerminationPointData</tns:msgName> <tns:msgType>REQUEST</tns:msgType> <tns:senderURI>http://www.oss1.com</tns:senderURI> <tns:destinationURI>http://www.ecitele.com</tns:destinationURI> <tns:communicationPattern>SimpleResponse</tns:communicationPattern> <tns:communicationStyle>RPC</tns:communicationStyle> <tns:vendorExtensions> <ECIVersion>5.6</ECIVersion> <opType>SET_DSL_PROFILE_TO_PORT</opType> </tns:vendorExtensions> </tns:header> </soapenv:Header> <soapenv:Body>

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

2-3

Set DSL Profile

E-OPS Web Services NorthBound Interface Specification

<tns:setTerminationPointDataRequest xmlns:s0="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1" xmlns:s3="http://www.tmforum.org/mtop/nrb/xsd/lp/v1" xmlns:s1="http://www.tmforum.org/mtop/fmw/xsd/nam/v1" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://www.tmforum.org/mtop/rp/xsd/tpc/v1" xmlns:s2="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"> <tns:tpInfo> <s0:tpRef> <s1:rdn> <s1:type>ME</s1:type> <s1:value>172.21.105.53</s1:value> </s1:rdn> <s1:rdn> <s1:type>PTP</s1:type> <s1:value>/shelf=0/slot=2/port=3</s1:value> </s1:rdn> </s0:tpRef> <s3:transmissionParametersList> <s3:transmissionParameters> <s3:vendorExtensions> <profileType>NgxdslMasterProfile</profileType> <xdslProfile>DEFVAL_17A_ISDN</xdslProfile> <resetModem>NO</resetModem> </s3:vendorExtensions> </s3:transmissionParameters> </s3:transmissionParametersList> </tns:tpInfo> </tns:setTerminationPointDataRequest> </soapenv:Body> </soapenv:Envelope>

Set DSL Profile Response


The following parameters are returned in the response message:

modifiedTp.ptp.name.rdn[] rdn (Relative Distinguish Name). These type/value elements identify the port that was modified by the operation. This element is identical to the rdn element sent in the request message. modifiedTp.ptp.transmissionParametersList.transmissionParameter.vendor Extension indicates the elements that were used for modifying the port. This element is identical to the corresponding element sent in the request.

2-4

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Set DSL Profile

Set DSL Profile Response Example


The following is an XML example of setTerminationPointData Response message:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <ns2:header xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <ns2:activityName>setTerminationPointData</ns2:activityName> <ns2:msgName>setTerminationPointDataResponse</ns2:msgName> <ns2:msgType>RESPONSE</ns2:msgType> <ns2:senderURI>http://www.ecitele.com</ns2:senderURI> <ns2:destinationURI>/MTOSI/SoapScope</ns2:destinationURI> <ns2:activityStatus xsi:type="ns2:ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">SUCCESS</ns2:activityStatus> <ns2:communicationPattern>SimpleResponse</ns2:communicationPattern> <ns2:communicationStyle>RPC</ns2:communicationStyle> <ns2:timestamp>2008-07-28T14:27:54.835Z</ns2:timestamp> </ns2:header> </soapenv:Header> <soapenv:Body> <ns21:setTerminationPointDataResponse xmlns:ns21="http://www.tmforum.org/mtop/rp/xsd/tpc/v1"> <ns21:modifiedTp> <ptp xsi:type="PhysicalTerminationPointType" xmlns="http://www.tmforum.org/mtop/nrf/xsd/ptp/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <name xmlns="http://www.tmforum.org/mtop/fmw/xsd/coi/v1"> <rdn xmlns="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <type>MD</type> <value>/A416206/Site</value> </rdn> <rdn xmlns="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <type>ME</type> <value>105 - 7</value> </rdn> <rdn xmlns="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <type>PTP</type> <value>/shelf=0/slot=1/port=1</value> </rdn> </name> <transmissionParametersList xmlns="http://www.tmforum.org/mtop/nrb/xsd/lp/v1"> <transmissionParameters> <vendorExtensions> <profileType>NgxdslMasterProfile</profileType> <xdslProfile>DEFVAL_17A_ISDN</xdslProfile> <resetModem>NO</resetModem> </vendorExtensions> </transmissionParameters> </transmissionParametersList> </ptp> </ns21:modifiedTp> </ns21:setTerminationPointDataResponse> </soapenv:Body> </soapenv:Envelope>

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

2-5

Set DSL Profile

E-OPS Web Services NorthBound Interface Specification

Set DSL Profile Fault Response


In case an error occurs during the setTerminationPointData operation, a fault message with the error details is returned. The following is a list of elements returned in the fault message:

faultString error message detail.anyType. setTerminationPointDataException

an element of one of the following: invalidInput entityNotFound notInValidState commFailure internalError

reason error message (identical to faultString)

Set DSL Profile Fault Response Example


The following is an XML example of the setTerminationPointData Fault Response message:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Fault> <faultcode>soapenv:Server</faultcode> <faultstring>Modify managed entity failed. Failed to download NGxDSL Line profile aaa to NE. The setup of LimitMask does not enable a limit PSD mask that is relevant for the Vdsl2ClassMask and Vdsl2EnaImplementProfile values..</faultstring> <detail> <ns123:setTerminationPointDataException xmlns:ns123="http://www.tmforum.org/mtop/rp/xsd/tpc/v1"> <internalError xmlns="http://www.tmforum.org/mtop/fmw/xsd/msg/v1"> <header xmlns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <activityName>setTerminationPointData</activityName> <msgName>SetTerminationPointDataException</msgName> <msgType>ERROR</msgType> <senderURI /> <destinationURI /> <activityStatus xsi:type="ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">FAILURE</activityStatus>

2-6

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Set DSL Profile

<communicationPattern>SimpleResponse</communicationPattern> <communicationStyle>RPC</communicationStyle> <timestamp>2011-0227T12:16:25.931+02:00</timestamp> </header> <reason>Modify managed entity failed. Failed to download NGxDSL Line profile aaa to NE. The setup of LimitMask does not enable a limit PSD mask that is relevant for the Vdsl2ClassMask and Vdsl2EnaImplementProfile values..</reason> </internalError> </ns123:setTerminationPointDataException> </detail> </soapenv:Fault> </soapenv:Body> </soapenv:Envelope>

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

2-7

Set DSL Profile

E-OPS Web Services NorthBound Interface Specification

2-8

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

3
Add TP Label
The Add TP Label operation, implemented with the setTerminationPointData operation, as described by MTOSI 2.0.

Header
The following elements are required: activityName setTerminationPointData msgName setTerminationPointData msgType REQUEST senderURI the URI of the request sender destinationURI http://www.ecitele.com communicationPattern SimpleResponse communicationStyle RPC vendorExtensions

ECIVersion 5.6 opType ADD_TP_LABEL / addTPLabels

Body

NE

type ME value either the name or the IP of a particular network element.

For DSL PTP


type PTP value /shelf=x/slot=y/port=z

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

3-1

Add TP Label

E-OPS Web Services NorthBound Interface Specification


For ONT: FTP


type FTP value /shelf=x/slot=y/port=z/ont=t

setTerminationPointDataRequest.transmissionParametersList. transmissionParameters[0]

layer value : VENDOR_EXT vendorExtensions[] The following vendorExtention attributes are optional: name uniNumber value= // this attribute is optional and is used only when the labels are for ONT POTS or Eth UNI name =TPLabels value=

Label1 <free string, 0-32 characters> - this one is mandatory Label2 - <free string, 0-32 characters> - optional Label3 - <free string, 0-32 characters> - optional Label4 - <free string, 0-32 characters> - optional Label5 - <free string, 0-32 characters> - optional

Add TP Label Request Example


The following is an XML example of setTerminationPointData request message for the ADD_TP_LABEL request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <tns:header xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:s0="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"> <tns:activityName>setTerminationPointData</tns:activityName> <tns:msgName>setTerminationPointData</tns:msgName> <tns:msgType>REQUEST</tns:msgType> <tns:senderURI>http://www.oss1.com</tns:senderURI> <tns:destinationURI>http://www.ecitele.com</tns:destinationURI> <tns:communicationPattern>SimpleResponse</tns:communicationPattern> <tns:communicationStyle>RPC</tns:communicationStyle> <tns:vendorExtensions>
3-2 ECI Telecom Ltd. Proprietary 458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Add TP Label

<ECIVersion>5.6</ECIVersion> <opType>addTPLabels</opType> </tns:vendorExtensions> </tns:header> </soapenv:Header> <soapenv:Body> <tns:setTerminationPointDataRequest xmlns:s0="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1" xmlns:s3="http://www.tmforum.org/mtop/nrb/xsd/lp/v1" xmlns:s1="http://www.tmforum.org/mtop/fmw/xsd/nam/v1" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://www.tmforum.org/mtop/rp/xsd/tpc/v1" xmlns:s2="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"> <tns:tpInfo> <s0:tpRef> <s1:rdn> <s1:type>ME</s1:type> <s1:value>172.21.105.48</s1:value> </s1:rdn> <s1:rdn> <s1:type>PTP</s1:type> <s1:value>/shelf=0/slot=7/port=6</s1:value> </s1:rdn> </s0:tpRef> <s3:transmissionParametersList> <s3:transmissionParameters> <s3:vendorExtensions>
<TPLabel1>L1</TPLabel1>

</s3:vendorExtensions> </s3:transmissionParameters> </s3:transmissionParametersList> </tns:tpInfo> </tns:setTerminationPointDataRequest> </soapenv:Body> </soapenv:Envelope>

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

3-3

Add TP Label

E-OPS Web Services NorthBound Interface Specification

Add TP Label Response


Add TP Label Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <ns2:header xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <ns2:activityName>setTerminationPointData</ns2:activityName> <ns2:msgName>setTerminationPointDataResponse</ns2:msgName> <ns2:msgType>RESPONSE</ns2:msgType> <ns2:senderURI>http://www.ecitele.com</ns2:senderURI> <ns2:destinationURI>http://www.oss1.com</ns2:destinationURI> <ns2:activityStatus xsi:type="ns2:ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">SUCCESS</ns2:activityStatus> <ns2:communicationPattern>SimpleResponse</ns2:communicationPattern> <ns2:communicationStyle>RPC</ns2:communicationStyle> <ns2:timestamp>2011-0406T08:59:11.744+03:00</ns2:timestamp> </ns2:header> </soapenv:Header> <soapenv:Body> <ns123:setTerminationPointDataResponse xmlns:ns123="http://www.tmforum.org/mtop/rp/xsd/tpc/v1"> <ns123:modifiedTp> <ptp xsi:type="PhysicalTerminationPointType" xmlns="http://www.tmforum.org/mtop/nrf/xsd/ptp/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <name xmlns="http://www.tmforum.org/mtop/fmw/xsd/coi/v1"> <rdn xmlns="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <type>ME</type> <value>172.21.105.48</value> </rdn> <rdn xmlns="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <type>PTP</type> <value>/shelf=0/slot=7/port=6</value> </rdn> </name> <transmissionParametersList xmlns="http://www.tmforum.org/mtop/nrb/xsd/lp/v1"> <transmissionParameters> <vendorExtensions>

3-4

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Add TP Label

<TPLabel1 xmlns="">L1</TPLabel1> </vendorExtensions> </transmissionParameters> </transmissionParametersList> </ptp> </ns123:modifiedTp> </ns123:setTerminationPointDataResponse> </soapenv:Body> </soapenv:Envelope>

Add TP Label Fault Response Example


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Fault> <faultcode>soapenv:Server</faultcode> <faultstring>create TP label failed Title 3 is not defined. .</faultstring> <detail> <ns123:setTerminationPointDataException xmlns:ns123="http://www.tmforum.org/mtop/rp/xsd/tpc/v1"> <internalError xmlns="http://www.tmforum.org/mtop/fmw/xsd/msg/v1"> <header xmlns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <activityName>setTerminationPointData</activityName> <msgName>SetTerminationPointDataException</msgName> <msgType>ERROR</msgType> <senderURI /> <destinationURI /> <activityStatus xsi:type="ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">FAILURE</activityStatus> <communicationPattern>SimpleResponse</communicationPattern> <communicationStyle>RPC</communicationStyle> <timestamp>2011-0406T09:09:32.996+03:00</timestamp> </header> <reason>create TP label failed Title 3 is not defined. .</reason> </internalError> </ns123:setTerminationPointDataException> </detail> </soapenv:Fault> </soapenv:Body> </soapenv:Envelope>

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

3-5

Add TP Label

E-OPS Web Services NorthBound Interface Specification

3-6

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

4
Modify TP Label
Modify TP Label Request
The Modify TP Label operation, implemented with the setTerminationPointData operation, as described by MTOSI 2.0.

Header
The following elements are required: activityName setTerminationPointData msgName setTerminationPointData msgType REQUEST senderURI the URI of the request sender destinationURI http://www.ecitele.com communicationPattern SimpleResponse communicationStyle RPC vendorExtensions

ECIVersion 5.6 opType MODIFY_TP_LABEL / modifyTPLabels

Body

NE

type ME value either the name or the IP of a particular network element.

For DSL

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

4-1

Modify TP Label

E-OPS Web Services NorthBound Interface Specification

PTP

type PTP value /shelf=x/slot=y/port=z

For ONT: FTP


type FTP value /shelf=x/slot=y/port=z/ont=t

setTerminationPointDataRequest.transmissionParametersList. transmissionParameters[0]

layer value : VENDOR_EXT vendorExtensions[] The following vendorExtention attributes are optional: name uniNumber value= // this attribute is optional and is used only when the labels are for ONT POTS or Eth UNI name =TPLabels value=

Label1 <free string, 0-32 characters> - this one is mandatory Label2 - <free string, 0-32 characters> - optional Label3 - <free string, 0-32 characters> - optional Label4 - <free string, 0-32 characters> - optional Label5 - <free string, 0-32 characters> - optional

Modify TP Label Request Example


The following is an XML example of setTerminationPointData request message for the ADD_TP_LABEL request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <tns:header xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:s0="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"> <tns:activityName>setTerminationPointData</tns:activityName> <tns:msgName>setTerminationPointData</tns:msgName> <tns:msgType>REQUEST</tns:msgType> <tns:senderURI>http://www.oss1.com</tns:senderURI>

4-2

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Modify TP Label

<tns:destinationURI>http://www.ecitele.com</tns:destinationURI> <tns:communicationPattern>SimpleResponse</tns:communicationPattern> <tns:communicationStyle>RPC</tns:communicationStyle> <tns:vendorExtensions> <ECIVersion>5.6</ECIVersion> <opType>modifyTPLabels</opType> </tns:vendorExtensions> </tns:header> </soapenv:Header> <soapenv:Body> <tns:setTerminationPointDataRequest xmlns:s0="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1" xmlns:s3="http://www.tmforum.org/mtop/nrb/xsd/lp/v1" xmlns:s1="http://www.tmforum.org/mtop/fmw/xsd/nam/v1" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://www.tmforum.org/mtop/rp/xsd/tpc/v1" xmlns:s2="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"> <tns:tpInfo> <s0:tpRef> <s1:rdn> <s1:type>ME</s1:type> <s1:value>105-48</s1:value> </s1:rdn> <s1:rdn> <s1:type>PTP</s1:type> <s1:value>/shelf=0/slot=7/port=6</s1:value> </s1:rdn> </s0:tpRef> <s3:transmissionParametersList> <s3:transmissionParameters> <s3:vendorExtensions>
<TPLabel1>L1</TPLabel1> <TPLabel2>pp</TPLabel2>

</s3:vendorExtensions> </s3:transmissionParameters> </s3:transmissionParametersList> </tns:tpInfo>


</tns:setTerminationPointDataRequest>

</soapenv:Body> </soapenv:Envelope>

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

4-3

Modify TP Label

E-OPS Web Services NorthBound Interface Specification

Modify TP Label Response


Modify TP Label Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <ns2:header xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <ns2:activityName>setTerminationPointData</ns2:activityName> <ns2:msgName>setTerminationPointDataResponse</ns2:msgName> <ns2:msgType>RESPONSE</ns2:msgType> <ns2:senderURI>http://www.ecitele.com</ns2:senderURI> <ns2:destinationURI>http://www.oss1.com</ns2:destinationURI> <ns2:activityStatus xsi:type="ns2:ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">SUCCESS</ns2:activityStatus> <ns2:communicationPattern>SimpleResponse</ns2:communicationPattern> <ns2:communicationStyle>RPC</ns2:communicationStyle> <ns2:timestamp>2011-0406T09:17:31.244+03:00</ns2:timestamp> </ns2:header> </soapenv:Header> <soapenv:Body> <ns123:setTerminationPointDataResponse xmlns:ns123="http://www.tmforum.org/mtop/rp/xsd/tpc/v1"> <ns123:modifiedTp> <ptp xsi:type="PhysicalTerminationPointType" xmlns="http://www.tmforum.org/mtop/nrf/xsd/ptp/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <name xmlns="http://www.tmforum.org/mtop/fmw/xsd/coi/v1"> <rdn xmlns="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <type>ME</type> <value>105-48</value> </rdn> <rdn xmlns="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <type>PTP</type> <value>/shelf=0/slot=7/port=6</value> </rdn> </name> <transmissionParametersList xmlns="http://www.tmforum.org/mtop/nrb/xsd/lp/v1"> <transmissionParameters> <vendorExtensions>
<TPLabel1 xmlns="">L1</TPLabel1>
4-4 ECI Telecom Ltd. Proprietary 458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Modify TP Label

<TPLabel2 xmlns="">pp</TPLabel2>

</vendorExtensions> </transmissionParameters> </transmissionParametersList> </ptp> </ns123:modifiedTp> </ns123:setTerminationPointDataResponse> </soapenv:Body> </soapenv:Envelope>

Modify TP Label Fault Response Example


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Fault> <faultcode>soapenv:Server</faultcode> <faultstring>modify TP label failed Title 3 is not defined. .</faultstring> <detail> <ns123:setTerminationPointDataException xmlns:ns123="http://www.tmforum.org/mtop/rp/xsd/tpc/v1"> <internalError xmlns="http://www.tmforum.org/mtop/fmw/xsd/msg/v1"> <header xmlns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <activityName>setTerminationPointData</activityName> <msgName>SetTerminationPointDataException</msgName> <msgType>ERROR</msgType> <senderURI /> <destinationURI /> <activityStatus xsi:type="ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">FAILURE</activityStatus> <communicationPattern>SimpleResponse</communicationPattern> <communicationStyle>RPC</communicationStyle> <timestamp>2011-0406T09:25:28.447+03:00</timestamp> </header> <reason>modify TP label failed Title 3 is not defined. .</reason> </internalError> </ns123:setTerminationPointDataException> </detail> </soapenv:Fault> </soapenv:Body> </soapenv:Envelope>

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

4-5

Modify TP Label

E-OPS Web Services NorthBound Interface Specification

4-6

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

5
Remove TP Label
Remove TP Label Request
The Remove TP Label operation, implemented with the setTerminationPointData operation, as described by MTOSI 2.0.

Header
The following elements are required: activityName setTerminationPointData msgName setTerminationPointData msgType REQUEST senderURI the URI of the request sender destinationURI http://www.ecitele.com communicationPattern SimpleResponse communicationStyle RPC vendorExtensions

ECIVersion 5.6 opType REMOVE_TP_LABEL / removeTPLabels

Body

NE

type ME value either the name or the IP of a particular network element.

For DSL

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

5-1

Remove TP Label

E-OPS Web Services NorthBound Interface Specification

PTP

type PTP value /shelf=x/slot=y/port=z

For ONT: FTP


type FTP value /shelf=x/slot=y/port=z/ont=t

setTerminationPointDataRequest.transmissionParametersList. transmissionParameters[0]

layer value : VENDOR_EXT vendorExtensions[] The following vendorExtention attributes are optional: name uniNumber value= // this attribute is optional and is used only when the labels are for ONT POTS or Eth UNI

Remove TP Label Request Example


The following is an XML example of setTerminationPointData request message for the ADD_TP_LABEL request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <tns:header xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:s0="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"> <tns:activityName>setTerminationPointData</tns:activityName> <tns:msgName>setTerminationPointData</tns:msgName> <tns:msgType>REQUEST</tns:msgType> <tns:senderURI>http://www.oss1.com</tns:senderURI> <tns:destinationURI>http://www.ecitele.com</tns:destinationURI> <tns:communicationPattern>SimpleResponse</tns:communicationPattern> <tns:communicationStyle>RPC</tns:communicationStyle> <tns:vendorExtensions> <ECIVersion>5.6</ECIVersion> <opType>removeTPLabels</opType> </tns:vendorExtensions> </tns:header> </soapenv:Header> <soapenv:Body>
5-2 ECI Telecom Ltd. Proprietary 458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Remove TP Label

<tns:setTerminationPointDataRequest xmlns:s0="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1" xmlns:s1="http://www.tmforum.org/mtop/fmw/xsd/nam/v1" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://www.tmforum.org/mtop/rp/xsd/tpc/v1" xmlns:s2="http://www.tmforum.org/mtop/fmw/xsd/gen/v1" xmlns:s3="http://www.tmforum.org/mtop/nrb/xsd/lp/v1"> <tns:tpInfo> <s0:tpRef> <s1:rdn> <s1:type>ME</s1:type> <s1:value>172.21.105.48</s1:value> </s1:rdn> <s1:rdn> <s1:type>PTP</s1:type> <s1:value>/shelf=0/slot=7/port=6</s1:value> </s1:rdn> </s0:tpRef> </tns:tpInfo> </tns:setTerminationPointDataRequest> </soapenv:Body> </soapenv:Envelope>

Remove TP Label Response


Remove TP Label Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <ns2:header xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <ns2:activityName>setTerminationPointData</ns2:activityName> <ns2:msgName>setTerminationPointDataResponse</ns2:msgName> <ns2:msgType>RESPONSE</ns2:msgType> <ns2:senderURI>http://www.ecitele.com</ns2:senderURI> <ns2:destinationURI>http://www.oss1.com</ns2:destinationURI> <ns2:activityStatus xsi:type="ns2:ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">SUCCESS</ns2:activityStatus> <ns2:communicationPattern>SimpleResponse</ns2:communicationPattern> <ns2:communicationStyle>RPC</ns2:communicationStyle> <ns2:timestamp>2011-0406T09:41:09.135+03:00</ns2:timestamp> </ns2:header> </soapenv:Header>
458006-2705-013-A00 ECI Telecom Ltd. Proprietary 5-3

Remove TP Label

E-OPS Web Services NorthBound Interface Specification

<soapenv:Body> <ns123:setTerminationPointDataResponse xmlns:ns123="http://www.tmforum.org/mtop/rp/xsd/tpc/v1"> <ns123:modifiedTp> <ptp xsi:type="PhysicalTerminationPointType" xmlns="http://www.tmforum.org/mtop/nrf/xsd/ptp/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <name xmlns="http://www.tmforum.org/mtop/fmw/xsd/coi/v1"> <rdn xmlns="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <type>ME</type> <value>172.21.105.48</value> </rdn> <rdn xmlns="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <type>PTP</type> <value>/shelf=0/slot=7/port=6</value> </rdn> </name> </ptp> </ns123:modifiedTp> </ns123:setTerminationPointDataResponse> </soapenv:Body> </soapenv:Envelope>

5-4

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

6
Set Template
Set Template Request
The use of setTemplate as described below is limited to Hi-FOCuS version of up to 2.5.

Header
The following elements are required: activityName setTerminationPointData msgName setTerminationPointData msgType REQUEST senderURI the URI of the request sender destinationURI http://www.ecitele.com communicationPattern SimpleResponse communicationStyle RPC vendorExtensions

ECIVersion 5.6 opType SET_TEMPLATE

Body

NE

type ME value either the name or the IP of a particular network element.

PTP type PTP

value /shelf=x/slot=y/port=z
ECI Telecom Ltd. Proprietary 6-1

458006-2705-013-A00

Set Template

E-OPS Web Services NorthBound Interface Specification

setTerminationPointDataRequest.transmissionParametersList. transmissionParameters[0]

layer value : VENDOR_EXT vendorExtensions[] The following vendorExtention attributes are optional: basedOnTemplate mteAdministrativeState UP, DOWN resetModem TRUE, FALSE remoteID the ports remote id (value can be empty to set the remoteId to null) tpRef.rdn (CTP)- one of the following: /vp=x/vc=y (for ATM) , or /ethernet=x for ell remoteID circuited pvid portDefaultUserPriority flowPackageProfile

flowProfile flowProfileLocal

flowPackageLocal Note: All the vendor extension parameters are optional except basedOnTemplate which is mandatory (as indicated above).

Set Template Request Example


The following is an XML example of setTerminationPointData request message for the SET_TEMPLATE request:
soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <tns:header xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:s0="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"> <tns:activityName>setTerminationPointData</tns:activityName> <tns:msgName>setTerminationPointData</tns:msgName> <tns:msgType>REQUEST</tns:msgType> <tns:senderURI>http://www.oss1.com</tns:senderURI>

6-2

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Set Template

<tns:destinationURI>http://www.ecitele.com</tns:destinationURI> <tns:communicationPattern>SimpleResponse</tns:communicationPattern> <tns:communicationStyle>RPC</tns:communicationStyle> <tns:vendorExtensions> <ECIVersion>5.6</ECIVersion> <opType>setTemplate</opType> </tns:vendorExtensions> </tns:header> </soapenv:Header> <soapenv:Body> <tns:setTerminationPointDataRequest xmlns:s0="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1" xmlns:s3="http://www.tmforum.org/mtop/nrb/xsd/lp/v1" xmlns:s1="http://www.tmforum.org/mtop/fmw/xsd/nam/v1" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://www.tmforum.org/mtop/rp/xsd/tpc/v1" xmlns:s2="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"> <tns:tpInfo> <s0:tpRef> <s1:rdn> <s1:type>ME</s1:type> <s1:value>172.20.0.246</s1:value> </s1:rdn> <s1:rdn> <s1:type>PTP</s1:type> <s1:value>/shelf=0/slot=7/port=1</s1:value> </s1:rdn> </s0:tpRef> <s3:transmissionParametersList> <s3:transmissionParameters> <s3:vendorExtensions> <basedOnTemplate>ptp1</basedOnTemplate> <mteAdministrativeState>UP</mteAdministrativeState> <remoteId>rid</remoteId> <resetLineFlag>TRUE</resetLineFlag> <tns:tpInfo> <s0:tpRef> <s1:rdn> <s1:type>CTP</s1:type> <s1:value>/ethernet=1</s1:value> </s1:rdn> </s0:tpRef> <remoteId>rid1</remoteId> <circuitId>cid1</circuitId> <pvid>101</pvid> <portDefaultUserPriority>1</portDefaultUserPriority> <flowPackageLocal>101</flowPackageLocal> </tns:tpInfo>
458006-2705-013-A00 ECI Telecom Ltd. Proprietary 6-3

Set Template

E-OPS Web Services NorthBound Interface Specification

</s3:vendorExtensions> </s3:transmissionParameters> </s3:transmissionParametersList> </tns:tpInfo> </tns:setTerminationPointDataRequest> </soapenv:Body> </soapenv:Envelope>

Set Template Response


Set Template Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <ns2:header xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <ns2:activityName>setTerminationPointData</ns2:activityName> <ns2:msgName>setTerminationPointDataResponse</ns2:msgName> <ns2:msgType>RESPONSE</ns2:msgType> <ns2:senderURI>http://www.ecitele.com</ns2:senderURI> <ns2:destinationURI>http://www.oss1.com</ns2:destinationURI> <ns2:activityStatus xsi:type="ns2:ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">SUCCESS</ns2:activityStatus> <ns2:communicationPattern>SimpleResponse</ns2:communicationPattern> <ns2:communicationStyle>RPC</ns2:communicationStyle> <ns2:timestamp>2011-0615T08:29:20.313+03:00</ns2:timestamp> </ns2:header> </soapenv:Header> <soapenv:Body> <ns123:setTerminationPointDataResponse xmlns:ns123="http://www.tmforum.org/mtop/rp/xsd/tpc/v1"> <ns123:modifiedTp> <ptp xsi:type="PhysicalTerminationPointType" xmlns="http://www.tmforum.org/mtop/nrf/xsd/ptp/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <name xmlns="http://www.tmforum.org/mtop/fmw/xsd/coi/v1"> <rdn xmlns="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <type>ME</type> <value>172.21.219.2</value> </rdn> <rdn xmlns="http://www.tmforum.org/mtop/fmw/xsd/nam/v1">
6-4 ECI Telecom Ltd. Proprietary 458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Set Template

<type>PTP</type> <value>/shelf=0/slot=3/port=3</value> </rdn> </name> <transmissionParametersList xmlns="http://www.tmforum.org/mtop/nrb/xsd/lp/v1"> <transmissionParameters> <vendorExtensions> <basedOnTemplate xmlns="">252Temp1</basedOnTemplate> <mteAdministrativeState xmlns="">UP</mteAdministrativeState> <remoteId xmlns="">rid</remoteId> <tns:tpInfo xmlns:tns="http://www.tmforum.org/mtop/rp/xsd/tpc/v1"> <s0:tpRef xmlns:s0="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1"> <s1:rdn xmlns:s1="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <s1:type>CTP</s1:type> <s1:value>/ethernet=1</s1:value> </s1:rdn> </s0:tpRef> <remoteId xmlns="" /> <pvid xmlns="">101</pvid> <portDefaultUserPriority xmlns="">1</portDefaultUserPriority> <flowProfile xmlns="">test</flowProfile> </tns:tpInfo> </vendorExtensions> </transmissionParameters> </transmissionParametersList> </ptp> </ns123:modifiedTp> </ns123:setTerminationPointDataResponse> </soapenv:Body> </soapenv:Envelope>

Set Template Fault Response Example


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Fault> <faultcode>soapenv:Server</faultcode> <faultstring>Modifying entity by template failed. entityKey=ResourcePort [PhysicalPortKey: PortOnCard #4 VDSL2 Card #3 UnknownShelf #0 Ni number #1 Device Name: 219-2 ip: 172.21.219.2 id: 8a8591a0302bdbc201303a24cc6c0003] templateName=atm1 type=NGXDSL_PORT_TEMPLATE. Illegal additional parameters. .</faultstring> <detail>

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

6-5

Set Template

E-OPS Web Services NorthBound Interface Specification

<ns123:setTerminationPointDataException xmlns:ns123="http://www.tmforum.org/mtop/rp/xsd/tpc/v1"> <invalidInput xmlns="http://www.tmforum.org/mtop/fmw/xsd/msg/v1"> <header xmlns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <activityName>setTerminationPointData</activityName> <msgName>SetTerminationPointDataException</msgName> <msgType>ERROR</msgType> <senderURI /> <destinationURI /> <activityStatus xsi:type="ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">FAILURE</activityStatus> <communicationPattern>SimpleResponse</communicationPattern> <communicationStyle>RPC</communicationStyle> <timestamp>2011-0601T08:04:02.218+03:00</timestamp> </header> <reason>Modifying entity by template failed. entityKey=ResourcePort [PhysicalPortKey: PortOnCard #4 VDSL2 Card #3 UnknownShelf #0 Ni number #1 Device Name: 219-2 ip: 172.21.219.2 id: 8a8591a0302bdbc201303a24cc6c0003] templateName=atm1 type=NGXDSL_PORT_TEMPLATE. Illegal additional parameters. .</reason> </invalidInput> </ns123:setTerminationPointDataException> </detail> </soapenv:Fault> </soapenv:Body> </soapenv:Envelope>

6-6

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

7
Set DSL Template
Set DSL Template Request
1. The use of SET_DSL_TEMPLATE is for Hi-FOCUS version of R4.x and up. It should not work on NEs of R4.x and up 2. All attributes under vendorExtention, except basedOnTemplate are optional. Optional means that the attribute may be required based on the template structure (if appears as complete on assignment) 3. The PTP object referred to the port can include the path (shelf=0/slot ) or the first label in the CIT. in case of more than one ports/ONTs assigned to this label it will refer arbitrarrily to the first one 4. If bridge port does not exist on network side of a servicethe operation is failed. This API do not create a default bridge prot in such case

Header
The following elements are required: activityName setTerminationPointData msgName setTerminationPointData msgType REQUEST senderURI the URI of the request sender destinationURI http://www.ecitele.com communicationPattern SimpleResponse communicationStyle RPC vendorExtensions

ECIVersion 5.6 opType SET_DSL_TEMPLATE

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

7-1

Set DSL Template

E-OPS Web Services NorthBound Interface Specification

Body

NE

type ME value either the name or the IP of a particular network element.

PTP type PTP

value /shelf=x/slot=y/port=z

setTerminationPointDataRequest.transmissionParametersList. transmissionParameters[0]

layer value : VENDOR_EXT vendorExtensions[] The following vendorExtention attributes are optional: basedOnTemplate mteAdministrativeState UP, DOWN resetModem TRUE, FALSE remoteID the ports remote id (value can be empty to set the remoteId to null) tpRef.rdn (CTP)- one of the following: /vp=x/vc=y (for ATM) , or /ethernet=x for ell remoteID circuited pvid portDefaultUserPriority services o serviceId=<sequential number of service in the services table> localEndpoint //this attribute stands for the local user port where this template is applied to. This is relevant for N:1 and 1:1 services vsiProfileName = <profile name> egressSVlan= <VLAN ID> egressCVlan= <VLAN ID> ingressSVlan= <VLAN ID> igressCVlan= <VLAN ID> egressSVlanPriority= <Priority, 07>
458006-2705-013-A00

7-2

ECI Telecom Ltd. Proprietary

E-OPS Web Services NorthBound Interface Specification

Set DSL Template

egressCVlanPriority= <Priority, 07> ingressSVlanPriority= <Priority, 07> remoteId= ingressTDProfile =<profile name>

remoteEndpoint //this attribute stands for the remote port (e.g. IPNI, TENI-N) and is relevant only for 1:1 services PTP or FTP =/shelf=0/slot=1/port=1 or /shelf=0/lagId=1 vsiProfileName = <profile name> egressSVlan= <VLAN ID> egressCVlan= <VLAN ID> ingressSVlan= <VLAN ID> igressCVlan= <VLAN ID> egressSVlanPriority= <Priority, 07> egressCVlanPriority= <Priority, 07> ingressSVlanPriority= <Priority, 07> ingressTDProfile =<profile name>

Set DSL Template Request Example


The following is an XML example of setTerminationPointData request message for the SET_DSL_TEMPLATE request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wsswssecurity-secext-1.0.xsd"> <wsse:UsernameToken wsu:Id="UsernameToken-4825196" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wsswssecurity-utility-1.0.xsd"> <wsse:Username>admin</wsse:Username> <wsse:Password Type="http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-username-token-profile1.0#PasswordText">aaaaaa</wsse:Password> </wsse:UsernameToken>

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

7-3

Set DSL Template

E-OPS Web Services NorthBound Interface Specification

</wsse:Security> <tns:header xmlns:tns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:s0="http://www.tmforum.org/mtop/fmw/xsd/gen/v1" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <tns:activityName>setTerminationPointData</tns:activityName> <tns:msgName>setTerminationPointData</tns:msgName> <tns:msgType>REQUEST</tns:msgType> <tns:senderURI>http://www.bt.com/v21</tns:senderURI> <tns:destinationURI>http://www.ecitele.com</tns:destinationURI> <tns:communicationPattern>SimpleResponse</tns:communicationPattern> <tns:communicationStyle>RPC</tns:communicationStyle> <tns:vendorExtensions> <ECIVersion>5.6</ECIVersion> <opType>SET_DSL_TEMPLATE</opType> </tns:vendorExtensions> </tns:header> </soapenv:Header> <soapenv:Body> <tns:setTerminationPointDataRequest xmlns:tns="http://www.tmforum.org/mtop/rp/xsd/tpc/v1" xmlns:s0="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1" xmlns:s1="http://www.tmforum.org/mtop/fmw/xsd/nam/v1" xmlns:s2="http://www.tmforum.org/mtop/nrb/xsd/lay/v1" xmlns:s3="http://www.tmforum.org/mtop/nrb/xsd/lp/v1" xmlns:s4="http://www.tmforum.org/mtop/fmw/xsd/gen/v1" xmlns:s5="http://www.tmforum.org/mtop/nrf/xsd/com/v1" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <tns:tpInfo> <s0:tpRef> <s1:rdn> <s1:type>ME</s1:type> <s1:value>209-56</s1:value> </s1:rdn> <s1:rdn> <s1:type>PTP</s1:type> <s1:value>/shelf=0/slot=2/port=5</s1:value> </s1:rdn> </s0:tpRef> <s3:transmissionParametersList> <s3:transmissionParameters> <s3:layer>LR_DSL</s3:layer> <s3:vendorExtensions> <basedOnTemplate>dsl_test </basedOnTemplate>

7-4

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Set DSL Template

<mteAdministrativeState>up</mteAdministrativeState> <resetLineFlag>true</resetLineFlag> <remoteId>remoteId@123</remoteId> <tns:tpInfo> <s0:tpRef> <s1:rdn> <s1:type>CTP</s1:type> <s1:value>/ethernet=1</s1:value> </s1:rdn> </s0:tpRef> <pvid>100</pvid> <portDefaultUserPriority>7</portDefaultUserPriority> <remoteID>538834</remoteID> <services> <serviceId id="1"> <localEndpoint> <ingressSVlanPriority>7</ingressSVlanPriority> </localEndpoint> </serviceId> </services> </tns:tpInfo> </s3:vendorExtensions> </s3:transmissionParameters> </s3:transmissionParametersList> </tns:tpInfo> </tns:setTerminationPointDataRequest> </soapenv:Body> </soapenv:Envelope>

Set DSL Template Response


Set DSL Template Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <ns2:header xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <ns2:activityName>setTerminationPointData</ns2:activityName> <ns2:msgName>setTerminationPointDataResponse</ns2:msgName> <ns2:msgType>RESPONSE</ns2:msgType> <ns2:senderURI>http://www.ecitele.com</ns2:senderURI> <ns2:destinationURI>http://www.oss1.com</ns2:destinationURI> <ns2:activityStatus xsi:type="ns2:ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">SUCCESS</ns2:activityStatus>
458006-2705-013-A00 ECI Telecom Ltd. Proprietary 7-5

Set DSL Template

E-OPS Web Services NorthBound Interface Specification

<ns2:communicationPattern>SimpleResponse</ns2:communicationPattern> <ns2:communicationStyle>RPC</ns2:communicationStyle> <ns2:timestamp>2011-0307T09:08:28.172+02:00</ns2:timestamp> </ns2:header> </soapenv:Header> <soapenv:Body> <ns123:setTerminationPointDataResponse xmlns:ns123="http://www.tmforum.org/mtop/rp/xsd/tpc/v1"> <ns123:modifiedTp> <ptp xsi:type="PhysicalTerminationPointType" xmlns="http://www.tmforum.org/mtop/nrf/xsd/ptp/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <name xmlns="http://www.tmforum.org/mtop/fmw/xsd/coi/v1"> <rdn xmlns="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <type>ME</type> <value>172.21.105.48</value> </rdn> <rdn xmlns="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <type>PTP</type> <value>/shelf=0/slot=7/port=9</value> </rdn> </name> <transmissionParametersList xmlns="http://www.tmforum.org/mtop/nrb/xsd/lp/v1"> <transmissionParameters> <vendorExtensions> <basedOnTemplate xmlns="">test121</basedOnTemplate> <mteAdministrativeState xmlns="">UP</mteAdministrativeState> <remoteId xmlns="">rid</remoteId> <resetLineFlag xmlns="">TRUE</resetLineFlag> <tns:tpInfo xmlns:tns="http://www.tmforum.org/mtop/rp/xsd/tpc/v1"> <s0:tpRef xmlns:s0="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1"> <s1:rdn xmlns:s1="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <s1:type>CTP</s1:type> <s1:value>/ethernet=1</s1:value> </s1:rdn> </s0:tpRef> <remoteID xmlns="">rid3</remoteID> <pvid xmlns="">101</pvid> <portDefaultUserPriority xmlns="">1</portDefaultUserPriority> <Services xmlns=""> <ServiceId id="1">
7-6 ECI Telecom Ltd. Proprietary 458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Set DSL Template

<localEndpoint> <ingressSVlan>99</ingressSVlan> </localEndpoint> </ServiceId> </Services> </tns:tpInfo> </vendorExtensions> </transmissionParameters> </transmissionParametersList> </ptp> </ns123:modifiedTp> </ns123:setTerminationPointDataResponse> </soapenv:Body> </soapenv:Envelope>

Set DSL Template Fault Response Example


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Fault> <faultcode>soapenv:Server</faultcode> <faultstring>Modifying entity by template failed. entityKey=ResourcePort [PhysicalPortKey: PortOnCard #4 VDSL2 Card #3 UnknownShelf #0 Ni number #1 Device Name: 219-2 ip: 172.21.219.2 id: 8a8591a0302bdbc201303a24cc6c0003] templateName=atm1 type=NGXDSL_PORT_TEMPLATE. Illegal additional parameters. .</faultstring> <detail> <ns123:setTerminationPointDataException xmlns:ns123="http://www.tmforum.org/mtop/rp/xsd/tpc/v1"> <invalidInput xmlns="http://www.tmforum.org/mtop/fmw/xsd/msg/v1"> <header xmlns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <activityName>setTerminationPointData</activityName> <msgName>SetTerminationPointDataException</msgName> <msgType>ERROR</msgType> <senderURI /> <destinationURI /> <activityStatus xsi:type="ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">FAILURE</activityStatus> <communicationPattern>SimpleResponse</communicationPattern> <communicationStyle>RPC</communicationStyle> <timestamp>2011-0601T08:04:02.218+03:00</timestamp> </header> <reason>Modifying entity by template failed. entityKey=ResourcePort [PhysicalPortKey: PortOnCard #4 VDSL2 Card #3
458006-2705-013-A00 ECI Telecom Ltd. Proprietary 7-7

Set DSL Template

E-OPS Web Services NorthBound Interface Specification

UnknownShelf #0 Ni number #1 Device Name: 219-2 ip: 172.21.219.2 id: 8a8591a0302bdbc201303a24cc6c0003] templateName=atm1 type=NGXDSL_PORT_TEMPLATE. Illegal additional parameters. .</reason> </invalidInput> </ns123:setTerminationPointDataException> </detail> </soapenv:Fault> </soapenv:Body> </soapenv:Envelope>

7-8

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

8
Set ONT Template
Set ONT Template Request
1. The use of SET_ONT_TEMPLATE is for Hi-FOCUS version of R4.x and up. It should not work on NEs of R4.x and up 2. All attributes under vendorExtention, except basedOnTemplate are optional. Optional means that the attribute may be required based on the template structure (if appears as complete on assignment) 3. If the ONT entry in the OLT does not exist the API creates it using the serial number of the password (based on discovery mode) 4. The FTP object referred to the ONT can include the path (shelf=0/slot ) or the first label in the CIT. in case of more than one ports/ONTs assigned to this label it will refer arbitrarrily to the first one 5. If bridge port does not exist on network side of a servicethe operation is failed. This API do not create a default bridge prot in such case

Header
The following elements are required: activityName setTerminationPointData msgName setTerminationPointData msgType REQUEST senderURI the URI of the request sender destinationURI http://www.ecitele.com communicationPattern SimpleResponse communicationStyle RPC vendorExtensions ECIVersion 5.6 opType SET_ONT_TEMPLATE
458006-2705-013-A00 ECI Telecom Ltd. Proprietary 8-1

Set ONT Template

E-OPS Web Services NorthBound Interface Specification

Body

NE

type ME value either the name or the IP of a particular network element.

FTP type FTP

value /shelf=x/slot=y/port=z/ont=w

setTerminationPointDataRequest.transmissionParametersList. transmissionParameters[0]

layer value : VENDOR_EXT vendorExtensions[] The following vendorExtention attributes are optional: basedOnTemplate mteAdministrativeState UP, DOWN OntSerialNumberFormat =//byNumber/byValue. optional attribute, default is byNumber
vendorID=//optional, 4 characters, relevant only when

OntSerialNumberFormat=byVendor
serialNumber//optional, pending on discovery mode. 8 characters

if OntSerialNumberFormat=byVendor. 16 characters if OntSerialNumberFormat=byNumber OntPassword = //optional, pending on discovery mode remoteID the ports remote id (value can be empty to set the remoteId to null) voIP // this block is for voice SIP agent and POTS ports remoteID o o o o o o o ipAddress=// WAN External IP Address Sample Value: 0.0.0.0 ipMask=// Subnet Mask - int [0..2040] Sample Value: 0 ipGateway=// Gateway IP Address primaryDnsServer=// First DNSServer IP Address Sample Value: 0.0.0.0 secondaryDnsServer=// Second DNSServer IP Address Sample Value: 0.0.0.0

8-2

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Set ONT Template

potsUnis // this block is repeated for every POTS port potsUni o o o o o o o o PTP or FTP =/shelf=0/slot=1/port=1 or /shelf=0/lagId=1 portIdentificationUserName portIdentificationPassword portIdentificationDirectoryNumber rxGain txGain dialPlan lineReversalOnAnswer

gemConnections gemConnection o o o connectionType connectionId localGem services serviceId=<sequential number of service in the services table> localEndpoint //this attribute stands for the local user port where this template is applied to. This is relevant for N:1 and 1:1 services o o o o o o o o o vsiProfileName = <profile name> egressSVlan= <VLAN ID> egressCVlan= <VLAN ID> ingressSVlan= <VLAN ID> igressCVlan= <VLAN ID> egressSVlanPriority= <Priority, 0-7> egressCVlanPriority= <Priority, 0-7> ingressSVlanPriority= <Priority, 0-7> remoteID=
8-3

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

Set ONT Template

E-OPS Web Services NorthBound Interface Specification

ingressTDProfile =<profile name>

remoteEndpoint //this attribute stands for the remote port (e.g. IPNI, TENI-N) and is relevant only for 1:1 services o PTP or FTP =/shelf=0/slot=1/port=1 or /shelf=0/lagId=1 vsiProfileName = <profile name> egressSVlan= <VLAN ID> egressCVlan= <VLAN ID> ingressSVlan= <VLAN ID> igressCVlan= <VLAN ID> egressSVlanPriority= <Priority, 0-7> egressCVlanPriority= <Priority, 0-7> ingressSVlanPriority= <Priority, 0-7> ingressTDProfile =<profile name>

o o o o o o o o o o remoteGem services

serviceId=<sequential number of service in the services table> localEndpoint //this attribute stands for the local user port where this template is applied to. This is relevant for N:1 and 1:1 services o o o o vsiProfileName = <profile name> egressSVlan= <VLAN ID> egressCVlan= <VLAN ID> ingressSVlan= <VLAN ID>
458006-2705-013-A00

8-4

ECI Telecom Ltd. Proprietary

E-OPS Web Services NorthBound Interface Specification

Set ONT Template

o o o o o o o ethUni uniConnections

igressCVlan= <VLAN ID> egressSVlanPriority= <Priority, 0-7> egressCVlanPriority= <Priority, 0-7> ingressSVlanPriority= <Priority, 0-7> remoteID= ingressTDProfile =<profile name>

uniConnection o o o o
o

tpRef.rdn (PTP)///shelf=0/slot=1/port=1 connectionType connectionId pvid portDefaultUserPriority the connections default priority services serviceId=<sequen tial number of service in the services table> localEndpoint //this attribute stands for the local user port where this template is applied to. This is relevant for N:1 and 1:1 services vsiProfileName = <profile name> egressSVlan= <VLAN ID> egressCVlan= <VLAN ID>

o o o

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

8-5

Set ONT Template

E-OPS Web Services NorthBound Interface Specification

o o o o o o o

ingressSVlan= <VLAN ID> igressCVlan= <VLAN ID> egressSVlanPriorit y= <Priority, 0-7> egressCVlanPriori ty= <Priority, 0-7> ingressSVlanPriori ty= <Priority, 0-7> remoteID= ingressTDProfile =<profile name>

Set ONT Template Request Example


The following is an XML example of setTerminationPointData request message for the SET_ONT_TEMPLATE request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <tns:header xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:s0="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"> <tns:activityName>setTerminationPointData</tns:activityName> <tns:msgName>setTerminationPointData</tns:msgName> <tns:msgType>REQUEST</tns:msgType> <tns:senderURI>http://www.oss1.com</tns:senderURI> <tns:destinationURI>http://www.ecitele.com</tns:destinationURI> <tns:communicationPattern>SimpleResponse</tns:communicationPattern> <tns:communicationStyle>RPC</tns:communicationStyle> <tns:vendorExtensions> <ECIVersion>5.6</ECIVersion> <opType>SET_ONT_TEMPLATE</opType> </tns:vendorExtensions> </tns:header> </soapenv:Header> <soapenv:Body>

8-6

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Set ONT Template

<tns:setTerminationPointDataRequest xmlns:s0="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1" xmlns:s3="http://www.tmforum.org/mtop/nrb/xsd/lp/v1" xmlns:s1="http://www.tmforum.org/mtop/fmw/xsd/nam/v1" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://www.tmforum.org/mtop/rp/xsd/tpc/v1" xmlns:s2="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"> <tns:tpInfo> <s0:tpRef> <s1:rdn> <s1:type>ME</s1:type> <s1:value>172.21.105.203</s1:value> </s1:rdn> <s1:rdn> <s1:type>FTP</s1:type> <s1:value>/shelf=0/slot=8/port=1/ont=19</s1:value> </s1:rdn> </s0:tpRef> <s3:transmissionParametersList> <s3:transmissionParameters> <s3:vendorExtensions> <basedOnTemplate>ont</basedOnTemplate> <mteAdministrativeState>UP</mteAdministrativeState> <vendorID>eci-</vendorID> <serialNumber>12345678</serialNumber> <voIP> <ipAddress>0.0.0.0</ipAddress> <ipMask>255.255.255.255</ipMask> <ipGateway>0.0.0.0</ipGateway> <primaryDnsServer>0.0.0.0</primaryDnsServer> <secondaryDnsServer>0.0.0.0</secondaryDnsServer> <potsUnis> <potsUni> <s0:tpRef> <s1:rdn> <s1:type>PTP</s1:type> <s1:value>/shelf=0/slot=2/port=1</s1:value> </s1:rdn> </s0:tpRef> <portIdentificationDirectoryNumber>972.0</portIdentificationDirector yNumber> <portIdentificationUserName>aaa</portIdentificationUserName> <portIdentificationPassword>bbbbbb</portIdentificationPassword> <rxGain>40</rxGain> <txGain>60</txGain> <dialPlan>profileName</dialPlan>
458006-2705-013-A00 ECI Telecom Ltd. Proprietary 8-7

Set ONT Template

E-OPS Web Services NorthBound Interface Specification

<lineReversalOnAnswer>true</lineReversalOnAnswer> </potsUni> <potsUni> <s0:tpRef> <s1:rdn> <s1:type>PTP</s1:type> <s1:value>/shelf=0/slot=2/port=2</s1:value> </s1:rdn> </s0:tpRef> <portIdentificationDirectoryNumber>97203.0</portIdentificationDirect oryNumber> <portIdentificationUserName>ccc</portIdentificationUserName> <portIdentificationPassword>dddd</portIdentificationPassword> <rxGain>50</rxGain> <txGain>80</txGain> <dialPlan>None</dialPlan> <lineReversalOnAnswer>false</lineReversalOnAnswer> </potsUni> </potsUnis> </voIP> <gemConnections> <gemConnection> <connectionType>GEM</connectionType> <connectionId>1</connectionId> <localGem> <services> <serviceId id="1"> <localEndpoint> <vsiProfileName>profile name</vsiProfileName> <egressSVlan>11</egressSVlan> <egressCVlan>22</egressCVlan> <ingressSVlan>33</ingressSVlan> <ingressCVlan>44</ingressCVlan> <egressSVlanPriority>2</egressSVlanPriority> <egressCVlanPriority>3</egressCVlanPriority> <ingressSVlanPriority>4</ingressSVlanPriority> <ingressTDProfile>profile name</ingressTDProfile> </localEndpoint> <remoteEndpoint> <s0:tpRef> <s1:rdn> <s1:type>PTP</s1:type> <s1:value>/shelf=0/slot=17/port=2</s1:value> </s1:rdn> </s0:tpRef>
8-8 ECI Telecom Ltd. Proprietary 458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Set ONT Template

<vsiProfileName>profile name</vsiProfileName> <egressSVlan>11</egressSVlan> <egressCVlan>22</egressCVlan> <ingressSVlan>33</ingressSVlan> <ingressCVlan>44</ingressCVlan> <egressSVlanPriority>2</egressSVlanPriority> <egressCVlanPriority>3</egressCVlanPriority> <ingressSVlanPriority>4</ingressSVlanPriority> <ingressTDProfile>profile name</ingressTDProfile> </remoteEndpoint> </serviceId> <serviceId id="2"> <localEndpoint> <vsiProfileName>profile name</vsiProfileName> <egressSVlan>11</egressSVlan> <egressCVlan>22</egressCVlan> <ingressSVlan>33</ingressSVlan> <ingressCVlan>44</ingressCVlan> <egressSVlanPriority>2</egressSVlanPriority> <egressCVlanPriority>3</egressCVlanPriority> <ingressSVlanPriority>4</ingressSVlanPriority> <ingressTDProfile>profile name</ingressTDProfile> </localEndpoint> <remoteEndpoint> <s0:tpRef> <s1:rdn> <s1:type>PTP</s1:type> <s1:value>/shelf=0/slot=17/port=2</s1:value> </s1:rdn> </s0:tpRef> <vsiProfileName>profile name</vsiProfileName> <egressSVlan>11</egressSVlan> <egressCVlan>22</egressCVlan> <ingressSVlan>33</ingressSVlan> <ingressCVlan>44</ingressCVlan>

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

8-9

Set ONT Template

E-OPS Web Services NorthBound Interface Specification

<egressSVlanPriority>2</egressSVlanPriority> <egressCVlanPriority>3</egressCVlanPriority> <ingressSVlanPriority>4</ingressSVlanPriority> <ingressTDProfile>profile name</ingressTDProfile> </remoteEndpoint> </serviceId> </services> </localGem> <remoteGem> <services> <serviceId id="1"> <localEndpoint> <vsiProfileName>profile name</vsiProfileName> <egressSVlan>11</egressSVlan> <egressCVlan>22</egressCVlan> <ingressSVlan>33</ingressSVlan> <ingressCVlan>44</ingressCVlan> <egressSVlanPriority>2</egressSVlanPriority> <egressCVlanPriority>3</egressCVlanPriority> <ingressSVlanPriority>4</ingressSVlanPriority> <ingressTDProfile>profile name</ingressTDProfile> </localEndpoint> </serviceId> <serviceId id="2"> <localEndpoint> <vsiProfileName>profile name</vsiProfileName> <egressSVlan>11</egressSVlan> </localEndpoint> </serviceId> </services> </remoteGem> </gemConnection> <gemConnection> <connectionType>GEM</connectionType> <connectionId>1</connectionId> <localGem> <services> <serviceId id="1"> <localEndpoint> <vsiProfileName>profile name</vsiProfileName> <egressSVlan>11</egressSVlan>
8-10 ECI Telecom Ltd. Proprietary 458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Set ONT Template

<egressCVlan>22</egressCVlan> </localEndpoint> <remoteEndpoint> <s0:tpRef> <s1:rdn> <s1:type>PTP</s1:type> <s1:value>/shelf=0/slot=17/port=2</s1:value> </s1:rdn> </s0:tpRef> <vsiProfileName>profile name</vsiProfileName> <egressSVlan>11</egressSVlan> <egressCVlan>22</egressCVlan> </remoteEndpoint> </serviceId> </services> </localGem> <remoteGem> <services> <serviceId id="1"> <localEndpoint> <vsiProfileName>profile name</vsiProfileName> <egressSVlan>11</egressSVlan> <egressCVlan>22</egressCVlan> </localEndpoint> </serviceId> </services> </remoteGem> </gemConnection> </gemConnections> <ethUni> <uniConnections> <uniConnection> <connectionType>ETHERNET</connectionType> <connectionId>1</connectionId> <pvid>11</pvid> <portDefaultUserPriority>3</portDefaultUserPriority> <services> <serviceId id="1"> <localEndpoint> <vsiProfileName>profile name</vsiProfileName> <egressSVlan>11</egressSVlan> <egressCVlan>22</egressCVlan> </localEndpoint> </serviceId> </services>
458006-2705-013-A00 ECI Telecom Ltd. Proprietary 8-11

Set ONT Template

E-OPS Web Services NorthBound Interface Specification

</uniConnection> </uniConnections> </ethUni> </s3:vendorExtensions> </s3:transmissionParameters> </s3:transmissionParametersList> </tns:tpInfo> </tns:setTerminationPointDataRequest> </soapenv:Body> </soapenv:Envelope>

Set ONT Template Response


Set ONT Template Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <ns2:header xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <ns2:activityName>setTerminationPointData</ns2:activityName> <ns2:msgName>setTerminationPointDataResponse</ns2:msgName> <ns2:msgType>RESPONSE</ns2:msgType> <ns2:senderURI>http://www.ecitele.com</ns2:senderURI> <ns2:destinationURI>http://www.oss1.com</ns2:destinationURI> <ns2:activityStatus xsi:type="ns2:ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">SUCCESS</ns2:activityStatus> <ns2:communicationPattern>SimpleResponse</ns2:communicationPattern> <ns2:communicationStyle>RPC</ns2:communicationStyle> <ns2:timestamp>2011-0511T09:32:44.552+03:00</ns2:timestamp> </ns2:header> </soapenv:Header> <soapenv:Body> <ns123:setTerminationPointDataResponse xmlns:ns123="http://www.tmforum.org/mtop/rp/xsd/tpc/v1"> <ns123:modifiedTp> <ptp xsi:type="PhysicalTerminationPointType" xmlns="http://www.tmforum.org/mtop/nrf/xsd/ptp/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <name xmlns="http://www.tmforum.org/mtop/fmw/xsd/coi/v1"> <rdn xmlns="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <type>ME</type> <value>172.21.208.56</value>
8-12 ECI Telecom Ltd. Proprietary 458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Set ONT Template

</rdn> <rdn xmlns="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <type>FTP</type> <value>/shelf=0/slot=14/port=1/ont=1</value> </rdn> </name> <transmissionParametersList xmlns="http://www.tmforum.org/mtop/nrb/xsd/lp/v1"> <transmissionParameters> <vendorExtensions> <basedOnTemplate xmlns="">ont</basedOnTemplate> <mteAdministrativeState xmlns="">UP</mteAdministrativeState> <voIP xmlns=""> <potsUnis> <potsUni> <s0:tpRef xmlns:s0="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1"> <s1:rdn xmlns:s1="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <s1:type>PTP</s1:type> <s1:value>/shelf=0/slot=2/port=1</s1:value> </s1:rdn> </s0:tpRef> < portIdentificationUserName >aaa</ portIdentificationUserName > </potsUni> <potsUni> <s0:tpRef xmlns:s0="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1"> <s1:rdn xmlns:s1="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <s1:type>PTP</s1:type> <s1:value>/shelf=0/slot=2/port=2</s1:value> </s1:rdn> </s0:tpRef> < portIdentificationUserName >ccc</ portIdentificationUserName >

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

8-13

Set ONT Template

E-OPS Web Services NorthBound Interface Specification

</potsUni> </potsUnis> </voIP> </vendorExtensions> </transmissionParameters> </transmissionParametersList> </ptp> </ns123:modifiedTp> </ns123:setTerminationPointDataResponse> </soapenv:Body> </soapenv:Envelope>

Set ONT Template Fault Response Example


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Fault> <faultcode>soapenv:Server</faultcode> <faultstring>Modifying entity by template failed. entityKey=org.tmf.sid.resource.compound.ResourceCollectionKey@1389b8 4f templateName=ont type=GPON_RESOURCE_TEMPLATE_46 additionalParams={VOICE_UNI_userName={2.1=aaa, 2.2=ccc}, mteAdministrativeState=UP, VOICE_UNI_password={2.1=bbb, 2.2=ddd}}. Failed to Change ONT UNI validity, slot 2 port 2. All UNI entities associated with a given UNI group number should be of the same type. In the specific case of Ethernet UNI, all UNI entities should also have the same setting of FrameTypes object ..</faultstring> <detail> <ns123:setTerminationPointDataException xmlns:ns123="http://www.tmforum.org/mtop/rp/xsd/tpc/v1"> <internalError xmlns="http://www.tmforum.org/mtop/fmw/xsd/msg/v1"> <header xmlns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <activityName>setTerminationPointData</activityName> <msgName>SetTerminationPointDataException</msgName> <msgType>ERROR</msgType> <senderURI /> <destinationURI /> <activityStatus xsi:type="ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">FAILURE</activityStatus> <communicationPattern>SimpleResponse</communicationPattern> <communicationStyle>RPC</communicationStyle> <timestamp>2011-0511T09:31:42.840+03:00</timestamp> </header>

8-14

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Set ONT Template

<reason>Modifying entity by template failed. entityKey=org.tmf.sid.resource.compound.ResourceCollectionKey@1389b8 4f templateName=ont type=GPON_RESOURCE_TEMPLATE_46 additionalParams={VOICE_UNI_userName={2.1=aaa, 2.2=ccc}, mteAdministrativeState=UP, VOICE_UNI_password={2.1=bbb, 2.2=ddd}}. Failed to Change ONT UNI validity, slot 2 port 2. All UNI entities associated with a given UNI group number should be of the same type. In the specific case of Ethernet UNI, all UNI entities should also have the same setting of FrameTypes object ..</reason> </internalError> </ns123:setTerminationPointDataException> </detail> </soapenv:Fault> </soapenv:Body> </soapenv:Envelope>

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

8-15

Set ONT Template

E-OPS Web Services NorthBound Interface Specification

8-16

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

9
Set Ethernet UNI Template
Set Ethernet UNI Template Request
1. GEM connections as appears in the teamplate are created with the group ID of the selected UNI port 2. The FTP object referred to the ONT can include the path (shelf=0/slot ) or the first label in the CIT for the specific UNI port. in case of more than one ports/ONTs assigned to this label it will refer arbitrarrily to the first one. 3. In case the ONT UNI is identified by its label, the uniNumber attribute in the vendorExtention section is ignored 4. If bridge port does not exist on network side of a servicethe operation is failed. This API do not create a default bridge prot in such case

Header
The following elements are required: activityName setTerminationPointData msgName setTerminationPointData msgType REQUEST senderURI the URI of the request sender destinationURI http://www.ecitele.com communicationPattern SimpleResponse communicationStyle RPC vendorExtensions ECIVersion 5.6 opType SET_ETH_UNI_TEMPLATE
458006-2705-013-A00 ECI Telecom Ltd. Proprietary 9-1

Set Ethernet UNI Template

E-OPS Web Services NorthBound Interface Specification

Body

NE

type ME value either the name or the IP of a particular network element.

FTP type FTP

value /shelf=x/slot=y/port=z/ont=w

setTerminationPointDataRequest.transmissionParametersList. transmissionParameters[0]

layer value : VENDOR_EXT vendorExtensions[] The following vendorExtention attributes are optional: PTP =/shelf=0/slot=1/port=1 basedOnTemplate mteAdministrativeState UP, DOWN remoteID the ports remote id (value can be empty to set the remoteId to null) o gemConnections
gemConnection

o o o o

connectionType connectionId

usTcont 1-8 //ID of an existing T-CONT


already localGem

services serviceId=<sequential number of service in the services table> localEndpoint //this attribute stands for the local user port where this template is applied to. This is relevant for N:1 and 1:1 services o o o vsiProfileName = <profile name> egressSVlan= <VLAN ID> egressCVlan= <VLAN ID>

9-2

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Set Ethernet UNI Template

o o o o o o o

ingressSVlan= <VLAN ID> igressCVlan= <VLAN ID> egressSVlanPriority= <Priority, 0-7> egressCVlanPriority= <Priority, 0-7> ingressSVlanPriority= <Priority, 0-7> remoteID= ingressTDProfile =<profile name>

remoteEndpoint //this attribute stands for the remote port (e.g. IPNI, TENI-N) and is relevant only for 1:1 services o PTP or FTP =/shelf=0/slot=1/port=1 or /shelf=0/lagId=1 vsiProfileName = <profile name> egressSVlan= <VLAN ID> egressCVlan= <VLAN ID> ingressSVlan= <VLAN ID> igressCVlan= <VLAN ID> egressSVlanPriority= <Priority, 0-7> egressCVlanPriority= <Priority, 0-7> ingressSVlanPriority= <Priority, 0-7> ingressTDProfile =<profile name>

o o o o o o o o o o
remoteGem

services serviceId=<sequential number of service in the services table>

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

9-3

Set Ethernet UNI Template

E-OPS Web Services NorthBound Interface Specification

localEndpoint //this attribute stands for the local user port where this template is applied to. This is relevant for N:1 and 1:1 services o o o o o o o o o o vsiProfileName = <profile name> egressSVlan= <VLAN ID> egressCVlan= <VLAN ID> ingressSVlan= <VLAN ID> igressCVlan= <VLAN ID> egressSVlanPriority= <Priority, 0-7> egressCVlanPriority= <Priority, 0-7> ingressSVlanPriority= <Priority, 0-7> remoteID= ingressTDProfile =<profile name>

ethUni

uniConnections

uniConnection

o o o o
o

tpRef.rdn (PTP)///shelf=0/slot=1/port=1
connectionType connectionId

pvid portDefaultUserPriority the connections default priority services serviceId=<sequen tial number of service in the services table>

9-4

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Set Ethernet UNI Template

localEndpoint //this attribute stands for the local user port where this template is applied to. This is relevant for N:1 and 1:1 services vsiProfileName = <profile name> egressSVlan= <VLAN ID> egressCVlan= <VLAN ID> ingressSVlan= <VLAN ID> igressCVlan= <VLAN ID> egressSVlanPriorit y= <Priority, 0-7> egressCVlanPriori ty= <Priority, 0-7> ingressSVlanPriori ty= <Priority, 0-7> remoteID= ingressTDProfile =<profile name>

o o o o o o o o o o

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

9-5

Set Ethernet UNI Template

E-OPS Web Services NorthBound Interface Specification

Set Ethernet UNI Template Request Example


The following is an XML example of setTerminationPointData request message for the SET_ETH_UNI_TEMPLATE request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <tns:header xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:s0="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"> <tns:activityName>setTerminationPointData</tns:activityName> <tns:msgName>setTerminationPointData</tns:msgName> <tns:msgType>REQUEST</tns:msgType> <tns:senderURI>http://www.oss1.com</tns:senderURI> <tns:destinationURI>http://www.ecitele.com</tns:destinationURI> <tns:communicationPattern>SimpleResponse</tns:communicationPattern> <tns:communicationStyle>RPC</tns:communicationStyle> <tns:vendorExtensions> <ECIVersion>5.6</ECIVersion> <opType>SET_ETH_UNI_TEMPLATE</opType> </tns:vendorExtensions> </tns:header> </soapenv:Header> <soapenv:Body> <tns:setTerminationPointDataRequest xmlns:s0="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1" xmlns:s3="http://www.tmforum.org/mtop/nrb/xsd/lp/v1" xmlns:s1="http://www.tmforum.org/mtop/fmw/xsd/nam/v1" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://www.tmforum.org/mtop/rp/xsd/tpc/v1" xmlns:s2="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"> <tns:tpInfo> <s0:tpRef> <s1:rdn> <s1:type>ME</s1:type> <s1:value>172.21.105.203</s1:value> </s1:rdn> <s1:rdn> <s1:type>FTP</s1:type> <s1:value>/shelf=0/slot=8/port=1/ont=10</s1:value> </s1:rdn> </s0:tpRef> <s3:transmissionParametersList> <s3:transmissionParameters> <s3:vendorExtensions>
9-6 ECI Telecom Ltd. Proprietary 458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Set Ethernet UNI Template

<s0:tpRef> <s1:rdn> <s1:type>PTP</s1:type> <s1:value>/shelf=0/slot=1/port=2</s1:value> </s1:rdn> </s0:tpRef> <basedOnTemplate>gem3</basedOnTemplate> <gemConnections> <gemConnection> <connectionType>GEM</connectionType> <connectionId>1</connectionId> <usTcont>3 </usTcont> <localGem> <services> <serviceId id="1"> <localEndpoint> <ingressSVlan>99</ingressSVlan> </localEndpoint> </serviceId> </services> </localGem> </gemConnection> </gemConnections> </s3:vendorExtensions> </s3:transmissionParameters> </s3:transmissionParametersList> </tns:tpInfo> </tns:setTerminationPointDataRequest> </soapenv:Body> </soapenv:Envelope>

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

9-7

Set Ethernet UNI Template

E-OPS Web Services NorthBound Interface Specification

Set Ethernet UNI Template Response


Set Ethernet UNI Template Response Example
<<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <ns2:header xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <ns2:activityName>setTerminationPointData</ns2:activityName> <ns2:msgName>setTerminationPointDataResponse</ns2:msgName> <ns2:msgType>RESPONSE</ns2:msgType> <ns2:senderURI>http://www.ecitele.com</ns2:senderURI> <ns2:destinationURI>http://www.oss1.com</ns2:destinationURI> <ns2:activityStatus xsi:type="ns2:ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">SUCCESS</ns2:activityStatus> <ns2:communicationPattern>SimpleResponse</ns2:communicationPattern> <ns2:communicationStyle>RPC</ns2:communicationStyle> <ns2:timestamp>2011-0512T14:38:05.609+03:00</ns2:timestamp> </ns2:header> </soapenv:Header> <soapenv:Body> <ns123:setTerminationPointDataResponse xmlns:ns123="http://www.tmforum.org/mtop/rp/xsd/tpc/v1"> <ns123:modifiedTp> <ptp xsi:type="PhysicalTerminationPointType" xmlns="http://www.tmforum.org/mtop/nrf/xsd/ptp/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <name xmlns="http://www.tmforum.org/mtop/fmw/xsd/coi/v1"> <rdn xmlns="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <type>ME</type> <value>172.21.105.203</value> </rdn> <rdn xmlns="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <type>FTP</type> <value>/shelf=0/slot=8/port=1/ont=10</value> </rdn> </name>
9-8 ECI Telecom Ltd. Proprietary 458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Set Ethernet UNI Template

<transmissionParametersList xmlns="http://www.tmforum.org/mtop/nrb/xsd/lp/v1"> <transmissionParameters> <vendorExtensions> <s0:tpRef xmlns:s0="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1"> <s1:rdn xmlns:s1="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <s1:type>PTP</s1:type> <s1:value>/shelf=0/slot=1/port=2</s1:value> </s1:rdn> </s0:tpRef> <basedOnTemplate xmlns="">gem3</basedOnTemplate> <gemConnections xmlns=""> <gemConnection> <connectionType>GEM</connectionType> <connectionId>1</connectionId> <usTcont>3</usTcont> <localGem> <services> <serviceId id="1"> <localEndpoint> <ingressSVlan>99</ingressSVlan> </localEndpoint> </serviceId> </services> </localGem> </gemConnection> </gemConnections> </vendorExtensions> </transmissionParameters> </transmissionParametersList> </ptp> </ns123:modifiedTp> </ns123:setTerminationPointDataResponse> </soapenv:Body> </soapenv:Envelope>

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

9-9

Set Ethernet UNI Template

E-OPS Web Services NorthBound Interface Specification

Set Ethernet UNI Template Fault Response Example


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Fault> <faultcode>soapenv:Server</faultcode> <faultstring>Modifying entity by template failed. entityKey=org.tmf.sid.resource.compound.ResourceCollectionKey@a73951 62 templateName=localGem services type=ETHERNET_UNI_COLLECTION_TEMPLATE additionalParams={SERVICE_ingressSVlanId={0.1.LOCAL.1.LOCAL=88, 0.1.LOCAL.1.REMOTE=99}, GEM_tcontId={0.1.REMOTE=3}}. Illegal additional parameters. .</faultstring> <detail> <ns123:setTerminationPointDataException xmlns:ns123="http://www.tmforum.org/mtop/rp/xsd/tpc/v1"> <invalidInput xmlns="http://www.tmforum.org/mtop/fmw/xsd/msg/v1"> <header xmlns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <activityName>setTerminationPointData</activityName> <msgName>SetTerminationPointDataException</msgName> <msgType>ERROR</msgType> <senderURI /> <destinationURI /> <activityStatus xsi:type="ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">FAILURE</activityStatus> <communicationPattern>SimpleResponse</communicationPattern> <communicationStyle>RPC</communicationStyle> <timestamp>2011-0512T14:43:13.453+03:00</timestamp> </header> <reason>Modifying entity by template failed. entityKey=org.tmf.sid.resource.compound.ResourceCollectionKey@a73951 62 templateName=localGem services type=ETHERNET_UNI_COLLECTION_TEMPLATE additionalParams={SERVICE_ingressSVlanId={0.1.LOCAL.1.LOCAL=88, 0.1.LOCAL.1.REMOTE=99}, GEM_tcontId={0.1.REMOTE=3}}. Illegal additional parameters. .</reason> </invalidInput> </ns123:setTerminationPointDataException> </detail> </soapenv:Fault> </soapenv:Body> </soapenv:Envelope>

9-10

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

10
Set Pots UNI Template
Set Pots UNI Template Request
Header
The following elements are required: activityName setTerminationPointData msgName setTerminationPointData msgType REQUEST senderURI the URI of the request sender destinationURI http://www.ecitele.com communicationPattern SimpleResponse communicationStyle RPC vendorExtensions

ECIVersion 5.6 opType SET_POTS_UNI_TEMPLATE

Body

NE

type ME value either the name or the IP of a particular network element. type FTP value /shelf=x/slot=y/port=z/ont=w

FTP

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

10-1

Set Pots UNI Template

E-OPS Web Services NorthBound Interface Specification

setTerminationPointDataRequest.transmissionParametersList. transmissionParameters[0]

layer value : VENDOR_EXT vendorExtensions[] The following vendorExtention attributes are optional:

PTP =/shelf=0/slot=1/port=1 basedOnTemplate


uniGroupID=n adminState=up/down portIdentificationDirectoryNumber = portIdentificationUserName= portIdentificationPassword = rxGain=//Range [-120..60]- (-12 to 6 db) txGain=//Range [-120..60]- (-12 to 6 db) dialPlan=//profile name lineReversalOnAnswer=true/false

Set Pots UNI Template Request Example


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <tns:header xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:s0="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"> <tns:activityName>setTerminationPointData</tns:activityName> <tns:msgName>setTerminationPointData</tns:msgName> <tns:msgType>REQUEST</tns:msgType> <tns:senderURI>http://www.oss1.com</tns:senderURI> <tns:destinationURI>http://www.ecitele.com</tns:destinationURI> <tns:communicationPattern>SimpleResponse</tns:communicationPattern> <tns:communicationStyle>RPC</tns:communicationStyle> <tns:vendorExtensions> <ECIVersion>5.6</ECIVersion> <opType>SET_POTS_UNI_TEMPLATE</opType> </tns:vendorExtensions> </tns:header> </soapenv:Header> <soapenv:Body> <tns:setTerminationPointDataRequest

10-2

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Set Pots UNI Template

xmlns:s0="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1" xmlns:s3="http://www.tmforum.org/mtop/nrb/xsd/lp/v1" xmlns:s1="http://www.tmforum.org/mtop/fmw/xsd/nam/v1" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://www.tmforum.org/mtop/rp/xsd/tpc/v1" xmlns:s2="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"> <tns:tpInfo> <s0:tpRef> <s1:rdn> <s1:type>ME</s1:type> <s1:value>172.21.105.203</s1:value> </s1:rdn> <s1:rdn> <s1:type>FTP</s1:type> <s1:value>/shelf=0/slot=8/port=1/ont=10</s1:value> </s1:rdn> </s0:tpRef> <s3:transmissionParametersList> <s3:transmissionParameters> <s3:vendorExtensions> <s0:tpRef> <s1:rdn> <s1:type>PTP</s1:type> <s1:value>/shelf=0/slot=2/port=2</s1:value> </s1:rdn> </s0:tpRef> <basedOnTemplate>voice1</basedOnTemplate> <adminState>down</adminState> <portIdentificationDirectoryNumber>asdf</portIdentificationDirectory Number> <portIdentificationUserName>abdc</portIdentificationUserName> <portIdentificationPassword>aaa</portIdentificationPassword> <lineReversalOnAnswer>true</lineReversalOnAnswer> <rxGain>30</rxGain> <txGain>40</txGain> <dialPlan>dial_plan_default</dialPlan> </s3:vendorExtensions> </s3:transmissionParameters> </s3:transmissionParametersList> </tns:tpInfo> </tns:setTerminationPointDataRequest> </soapenv:Body> </soapenv:Envelope>

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

10-3

Set Pots UNI Template

E-OPS Web Services NorthBound Interface Specification

Set Pots UNI Template Response


Set Pots UNI Template Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <ns2:header xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <ns2:activityName>setTerminationPointData</ns2:activityName> <ns2:msgName>setTerminationPointDataResponse</ns2:msgName> <ns2:msgType>RESPONSE</ns2:msgType> <ns2:senderURI>http://www.ecitele.com</ns2:senderURI> <ns2:destinationURI>http://www.oss1.com</ns2:destinationURI> <ns2:activityStatus xsi:type="ns2:ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">SUCCESS</ns2:activityStatus> <ns2:communicationPattern>SimpleResponse</ns2:communicationPattern> <ns2:communicationStyle>RPC</ns2:communicationStyle> <ns2:timestamp>2011-0518T14:36:25.223+03:00</ns2:timestamp> </ns2:header> </soapenv:Header> <soapenv:Body> <ns123:setTerminationPointDataResponse xmlns:ns123="http://www.tmforum.org/mtop/rp/xsd/tpc/v1"> <ns123:modifiedTp> <ptp xsi:type="PhysicalTerminationPointType" xmlns="http://www.tmforum.org/mtop/nrf/xsd/ptp/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <name xmlns="http://www.tmforum.org/mtop/fmw/xsd/coi/v1"> <rdn xmlns="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <type>ME</type> <value>172.21.105.203</value> </rdn> <rdn xmlns="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <type>FTP</type> <value>/shelf=0/slot=8/port=1/ont=10</value> </rdn> </name> <transmissionParametersList xmlns="http://www.tmforum.org/mtop/nrb/xsd/lp/v1"> <transmissionParameters> <vendorExtensions>

10-4

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Set Pots UNI Template

<s0:tpRef xmlns:s0="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1"> <s1:rdn xmlns:s1="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> <s1:type>PTP</s1:type> <s1:value>/shelf=0/slot=2/port=2</s1:value> </s1:rdn> </s0:tpRef> <basedOnTemplate xmlns="">voice1</basedOnTemplate> <adminState xmlns="">down</adminState> <portIdentificationDirectoryNumber xmlns="">asdf</portIdentificationDirectoryNumber> <portIdentificationUserName xmlns="">kjhg</portIdentificationUserName> <portIdentificationPassword xmlns="">aaa</portIdentificationPassword> <lineReversalOnAnswer xmlns="">true</lineReversalOnAnswer> <rxGain xmlns="">30</rxGain> <txGain xmlns="">40</txGain> <dialPlan xmlns="">dial_plan_default</dialPlan> </vendorExtensions> </transmissionParameters> </transmissionParametersList> </ptp> </ns123:modifiedTp> </ns123:setTerminationPointDataResponse> </soapenv:Body> </soapenv:Envelope>

Set Pots UNI Template Fault Response Example


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Fault> <faultcode>soapenv:Server</faultcode> <faultstring>Modifying entity by template failed. entityKey=org.tmf.sid.resource.compound.ResourceCollectionKey@9f994c a0 templateName=voice1 type=VOIP_UNI_COLLECTION_TEMPLATE additionalParams={VOICE_UNI_txGain={2.2=40}, VOICE_UNI_lasEnabled={2.2=false}, VOICE_UNI_userName={2.2=kjhg}, VOICE_UNI_mteAdministrativeState={2.2=down}, VOICE_UNI_rxGain={2.2=30}, VOICE_UNI_dialPlanProfile={2.2=dial_plan_default}, VOICE_UNI_userIdentificationPort={2.2=asdf }, VOICE_UNI_password={2.2=aaa}}. Failed to modify Voice UNI, slot 2 port 2. Either there is no row in the SIP Agent Configuration table
458006-2705-013-A00 ECI Telecom Ltd. Proprietary 10-5

Set Pots UNI Template

E-OPS Web Services NorthBound Interface Specification

with the specified ID or the specified row is invalid..</faultstring> <detail> <ns123:setTerminationPointDataException xmlns:ns123="http://www.tmforum.org/mtop/rp/xsd/tpc/v1"> <internalError xmlns="http://www.tmforum.org/mtop/fmw/xsd/msg/v1"> <header xmlns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <activityName>setTerminationPointData</activityName> <msgName>SetTerminationPointDataException</msgName> <msgType>ERROR</msgType> <senderURI /> <destinationURI /> <activityStatus xsi:type="ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">FAILURE</activityStatus> <communicationPattern>SimpleResponse</communicationPattern> <communicationStyle>RPC</communicationStyle> <timestamp>2011-0518T14:41:21.497+03:00</timestamp> </header> <reason>Modifying entity by template failed. entityKey=org.tmf.sid.resource.compound.ResourceCollectionKey@9f994c a0 templateName=voice1 type=VOIP_UNI_COLLECTION_TEMPLATE additionalParams={VOICE_UNI_txGain={2.2=40}, VOICE_UNI_lasEnabled={2.2=false}, VOICE_UNI_userName={2.2=kjhg}, VOICE_UNI_mteAdministrativeState={2.2=down}, VOICE_UNI_rxGain={2.2=30}, VOICE_UNI_dialPlanProfile={2.2=dial_plan_default}, VOICE_UNI_userIdentificationPort={2.2=asdf }, VOICE_UNI_password={2.2=aaa}}. Failed to modify Voice UNI, slot 2 port 2. Either there is no row in the SIP Agent Configuration table with the specified ID or the specified row is invalid..</reason> </internalError> </ns123:setTerminationPointDataException> </detail> </soapenv:Fault> </soapenv:Body>

10-6

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

11
Invoke Async Action
The invokeAsyncAction operation is descibed by the ECI AsyncActionInterfaceHttp Service. This operation enables asynchronous invocation of NBI operations. The invokeAsyncAction request is an outer message envelope containing the internal xml request operation to be performed asynchronously. As for now, setTemplate operation (which configures the DSL port) is supported. Upon reception of the invokeAsyncAction request, a Request ID will be generated by the E-OPS EMS. The request ID is a unique random character string. An immediate response message (invokeAsyncAction response) shall be sent by the EMS in reply to the invokeAsyncAction request message. The response shall contain the Request ID. This value will be used in getAsyncActionStatus Request to trace the internal request xml state. It will also appear in the NBI Logger screen that includes the details of all NBI asynchronous operations.

Invoke Async Action Request


The invokeAsyncAction operation is described by ECI AsyncActionInterfaceHttp Service.

Header
The following elements are required:

activityName invokeAsyncAction msgName invokeAsyncAction msgType REQUEST senderURI the URI of the request sender

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

11-1

Invoke Async Action

E-OPS Web Services NorthBound Interface Specification

destinationURI http://www.ecitele.com communicationPattern SimpleResponse communicationStyle RPC

Body
The following elements are required:

invokeAsyncActionRequest.asyncActionData serviceEndpoint

type String value The URL to invoke the internal xml, e.g. <protocol>://<Server Name / IP>:<port number><WSDL name and path> For example, the service end point of set Template operation will be:

http[s]://<Server Name>:8080/nbi/services/TerminationPointControlHttp soapAction


type String value the soap action of the operation, i.e. setTerminationPointData type String value the internal xml request to be invoke in asynchronous mode

xmlRequest

Invoke Async Action Request Example


The following are XML example of invokeAsyncAction request message:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <tns:header xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:s0="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"> <tns:activityName>invokeAsyncAction</tns:activityName> <tns:msgName>invokeAsyncAction</tns:msgName> <tns:msgType>REQUEST</tns:msgType> <tns:senderURI>http://www.oss1.com</tns:senderURI> <tns:destinationURI>http://www.ecitele.com</tns:destinationURI> <tns:communicationPattern>SimpleResponse</tns:communicationPattern> <tns:communicationStyle>RPC</tns:communicationStyle>
11-2 ECI Telecom Ltd. Proprietary 458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Invoke Async Action

</tns:header> </soapenv:Header> <soapenv:Body> <aai:invokeAsyncActionRequest xmlns:s1="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1" xmlns:s3="http://www.tmforum.org/mtop/nrb/xsd/lp/v1" xmlns:s2="http://www.tmforum.org/mtop/fmw/xsd/nam/v1" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wsswssecurity-utility-1.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:s0="http://www.tmforum.org/mtop/rp/xsd/tpc/v1" xmlns:aai="http://www.ecitele.com/mtop/aa/xsd/aai/v1-0" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wsswssecurity-secext-1.0.xsd" xmlns:tns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:s4="http://www.tmforum.org/mtop/mri/xsd/rir/v1"> <aai:asyncActionData> <aai:serviceEndpoint>http://A442210:8080/nbi/services/TerminationPointC ontrolHttp</aai:serviceEndpoint> <aai:soapAction>setTerminationPointData</aai:soapAction> <aai:xmlRequest> <soapenv:Envelope> <soapenv:Header> <wsse:Security> <wsse:UsernameToken wsu:Id="UsernameToken-16294124"> <wsse:Username>webServicesUser</wsse:Username> <wsse:Password Type="http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-username-token-profile1.0#PasswordText">webServicesUserPassword</wsse:Password> </wsse:UsernameToken> </wsse:Security> <tns:header xmlns:s5="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"> <tns:activityName>setTerminationPointData</tns:activityName> <tns:msgName>setTerminationPointData</tns:msgName> <tns:msgType>REQUEST</tns:msgType> <tns:senderURI>http://www.oss1.com</tns:senderURI> <tns:destinationURI>http://www.ecitele.com</tns:destinationURI> <tns:communicationPattern>SimpleResponse</tns:communicationPattern> <tns:communicationStyle>RPC</tns:communicationStyle> <tns:vendorExtensions> <ECIVersion>5.6</ECIVersion> <opType>setTemplate</opType> </tns:vendorExtensions> </tns:header> </soapenv:Header> <soapenv:Body> <s0:setTerminationPointDataRequest> <s0:tpInfo> <s1:tpRef> <s2:rdn> <s2:type>ME</s2:type> <s2:value>219-2</s2:value> </s2:rdn> <s2:rdn> <s2:type>PTP</s2:type> <s2:value>/shelf=0/slot=6/port=16</s2:value>
458006-2705-013-A00 ECI Telecom Ltd. Proprietary 11-3

Invoke Async Action

E-OPS Web Services NorthBound Interface Specification

</s2:rdn> </s1:tpRef> <s3:transmissionParametersList> <s3:transmissionParameters> <s3:vendorExtensions> <basedOnTemplate>Atm</basedOnTemplate> <s0:tpInfo> <s1:tpRef> <s2:rdn> <s2:type>CTP</s2:type> <s2:value>/vp=4/vc=44</s2:value> </s2:rdn> </s1:tpRef> <pvid>3</pvid> <portDefaultUserPriority>7</portDefaultUserPriority> <vpi>6</vpi> <vci>66</vci> </s0:tpInfo> </s3:vendorExtensions> </s3:transmissionParameters> </s3:transmissionParametersList> </s0:tpInfo> </s0:setTerminationPointDataRequest> </soapenv:Body> </soapenv:Envelope>

</aai:xmlRequest>
</aai:asyncActionData> </aai:invokeAsyncActionRequest> </soapenv:Body> </soapenv:Envelope>

Invoke Async Action Response


The following element is returned:

requestID a unique random character string To be used for tracing the internal request xml state

11-4

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Invoke Async Action

Invoke Async Action Response Example


The following is an XML example of invokeAsyncAction Response message:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <ns2:header xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <ns2:activityName>invokeAsyncAction</ns2:activityName> <ns2:msgName>invokeAsyncActionResponse</ns2:msgName> <ns2:msgType>RESPONSE</ns2:msgType> <ns2:senderURI>http://www.ecitele.com</ns2:senderURI> <ns2:destinationURI>http://www.oss1.com</ns2:destinationURI> <ns2:activityStatus xsi:type="ns2:ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">SUCCESS</ns2:activityStatus> <ns2:communicationPattern>SimpleResponse</ns2:communicationPattern> <ns2:communicationStyle>RPC</ns2:communicationStyle> <ns2:timestamp>2011-0705T15:06:37.565+03:00</ns2:timestamp> </ns2:header> </soapenv:Header> <soapenv:Body> <ns4:invokeAsyncActionResponse xmlns:ns4="http://www.ecitele.com/mtop/aa/xsd/aai/v1-0"> <ns4:asyncInvocationResult> <ns4:requestID>b8a81d6f-b988-49bd-9e0313e50ba1d9c8</ns4:requestID> </ns4:asyncInvocationResult> </ns4:invokeAsyncActionResponse> </soapenv:Body> </soapenv:Envelope>

Invoke Async Action Fault Response


In case an error occurs during the invokeAsyncAction operation, a fault message with the error details is returned. The following is a list of elements returned in the fault message:

faultString error message detail.invokeAsyncActionException

an element of one of the following: internalError invalidInput

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

11-5

Invoke Async Action

E-OPS Web Services NorthBound Interface Specification

notImplemented objectInUse unableToComply

reason error message (identical to faultString)

Invoke Async Action Fault Response Example


The following is an XML example of the invokeAsyncAction Fault Response message:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Fault> <faultcode>soapenv:Server</faultcode> <faultstring>Error invoking asynchronous action: Failed to send message to queue queue/eci/queue/NBI_REQUESTS.</faultstring> <detail> <ns4:invokeAsyncActionException xmlns:ns4="http://www.ecitele.com/mtop/aa/xsd/aai/v1-0"> <internalError xmlns="http://www.tmforum.org/mtop/fmw/xsd/msg/v1"> <header xmlns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <activityName>invokeAsyncAction</activityName> <msgName>InvokeAsyncActionException</msgName> <msgType>ERROR</msgType> <senderURI /> <destinationURI /> <activityStatus xsi:type="ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">FAILURE</activityStatus> <communicationPattern>SimpleResponse</communicationPattern> <communicationStyle>RPC</communicationStyle> <timestamp>2011-07-05T18:23:58.195+03:00</timestamp> </header> <reason>Error invoking asynchronous action: Failed to send message to queue queue/eci/queue/NBI_REQUESTS.</reason> </internalError> </ns4:invokeAsyncActionException> </detail> </soapenv:Fault> </soapenv:Body> </soapenv:Envelope>

11-6

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

12
Get Async Action Status
The getAsyncActionStatus Operation is descibed by the ECI AsyncActionInterfaceHttp Service. This operation is used by the OSS to poll the result of the Asyncronous Action operation.

Get Async Action Status Request


The getAsyncActionStatus operation is described by ECI according to MTOSI 20 convensions.

Header
The following elements are required: activityName getAsyncActionStatus msgName getAsyncActionStatus msgType REQUEST senderURI the URI of the request sender destinationURI http://www.ecitele.com communicationPattern SimpleResponse communicationStyle RPC

Body

getAsyncActionStatusRequest

requestID the request ID that was returned in invokeAsyncAction Response

Get Async Action Status Request Example


The following is an XML example of getAsyncActionStatus request message:

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

12-1

Get Async Action Status

E-OPS Web Services NorthBound Interface Specification

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <tns:header xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:s0="http://www.tmforum.org/mtop/fmw/xsd/gen/v1"> <tns:activityName>getAsyncActionStatus</tns:activityName> <tns:msgName>getAsyncActionStatus</tns:msgName> <tns:msgType>REQUEST</tns:msgType> <tns:senderURI>http://www.oss1.com</tns:senderURI> <tns:destinationURI>http://www.ecitele.com</tns:destinationURI> <tns:communicationPattern>SimpleResponse</tns:communicationPattern> <tns:communicationStyle>RPC</tns:communicationStyle> </tns:header> </soapenv:Header> <soapenv:Body> <aai:getAsyncActionStatusRequest xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aai="http://www.ecitele.com/mtop/aa/xsd/aai/v1-0"> <aai:requestID>d13aa3e3-c9eb-4f00-a3833615e920f67a</aai:requestID> </aai:getAsyncActionStatusRequest> </soapenv:Body> </soapenv:Envelope>

Get Async Action Status Response

getAsyncActionStatusResponse. asyncActionResult asyncActionStatus can be one of the following: PENDING, IN_PROGRESS, SUCCESS, FAILED, NON_EXISTENT

asyncActionErrorCode - optional, returned in case asyncActionStatus is FAILED. The value can be one of the following: commLoss, entityNotFound, internalError, invalidInput asyncActionErrorDescription - a verbal error description vendorExtensions type asyncActionStatusCode

value a numeriv code. See Status Code column in the table below type asyncActionStatusDescription value a verbal error description. See Status Description column in the table below

12-2

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Get Async Action Status

The following table details the contents of the fields of the getAsyncActionStatus response message, for each of the status conditions: Async Action Status PENDING IN PROGRESS SUCCESS NOTEXIST ENT FAILED Async Action Error Code Will not appear Will not appear Will not appear Will not appear Async Action Error Description Will not appear Will not appear Will not appear Will not appear Status Code 100 200 400 3000 Status Description

commLoss entityNotFound internalError invalidInput

<specific description> <specific description> <specific description> <specific description>

5030 5040 5050 5070

The request is waiting to be processed. The request is currently in progress. The request has been completed successfully. The given Request ID cannot be found in the data base. Communication Loss: <specific description> Entity Not Found: <specific description> Internal Error: <specific description> Invalid Input: <specific description>

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

12-3

Get Async Action Status

E-OPS Web Services NorthBound Interface Specification

Get Async Action Status Response Example


Success example:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <ns2:header xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <ns2:activityName>getAsyncActionStatus</ns2:activityName> <ns2:msgName>getAsyncActionStatusResponse</ns2:msgName> <ns2:msgType>RESPONSE</ns2:msgType> <ns2:senderURI>http://www.ecitele.com</ns2:senderURI> <ns2:destinationURI>http://www.oss1.com</ns2:destinationURI> <ns2:activityStatus xsi:type="ns2:ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">SUCCESS</ns2:activityStatus> <ns2:communicationPattern>SimpleResponse</ns2:communicationPattern> <ns2:communicationStyle>RPC</ns2:communicationStyle> <ns2:timestamp>2011-07-05T19:19:59.580+03:00</ns2:timestamp> </ns2:header> </soapenv:Header> <soapenv:Body> <ns4:getAsyncActionStatusResponse xmlns:ns4="http://www.ecitele.com/mtop/aa/xsd/aai/v1-0"> <ns4:asyncActionResult> <ns4:asyncActionStatus>SUCCESS</ns4:asyncActionStatus> <ns4:vendorExtensions> <asyncActionStatusCode>400</asyncActionStatusCode> <asyncActionStatusDescription>The request has been completed successfully</asyncActionStatusDescription> </ns4:vendorExtensions> </ns4:asyncActionResult> </ns4:getAsyncActionStatusResponse> </soapenv:Body> </soapenv:Envelope>

Pending example:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <ns2:header xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <ns2:activityName>getAsyncActionStatus</ns2:activityName> <ns2:msgName>getAsyncActionStatusResponse</ns2:msgName> <ns2:msgType>RESPONSE</ns2:msgType> <ns2:senderURI>http://www.ecitele.com</ns2:senderURI> <ns2:destinationURI>http://www.oss1.com</ns2:destinationURI> <ns2:activityStatus xsi:type="ns2:ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">SUCCESS</ns2:activityStatus> <ns2:communicationPattern>SimpleResponse</ns2:communicationPattern> <ns2:communicationStyle>RPC</ns2:communicationStyle> <ns2:timestamp>2011-07-05T19:25:42.935+03:00</ns2:timestamp> </ns2:header> </soapenv:Header> <soapenv:Body> <ns4:getAsyncActionStatusResponse xmlns:ns4="http://www.ecitele.com/mtop/aa/xsd/aai/v1-0"> <ns4:asyncActionResult>
12-4 ECI Telecom Ltd. Proprietary 458006-2705-013-A00

E-OPS Web Services NorthBound Interface Specification

Get Async Action Status

<ns4:asyncActionStatus>PENDING</ns4:asyncActionStatus> <ns4:vendorExtensions> <asyncActionStatusCode>100</asyncActionStatusCode> <asyncActionStatusDescription>The request is waiting to be processed</asyncActionStatusDescription> </ns4:vendorExtensions> </ns4:asyncActionResult> </ns4:getAsyncActionStatusResponse> </soapenv:Body> </soapenv:Envelope>

Failed Example:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <ns2:header xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <ns2:activityName>getAsyncActionStatus</ns2:activityName> <ns2:msgName>getAsyncActionStatusResponse</ns2:msgName> <ns2:msgType>RESPONSE</ns2:msgType> <ns2:senderURI>http://www.ecitele.com</ns2:senderURI> <ns2:destinationURI>http://www.oss1.com</ns2:destinationURI> <ns2:activityStatus xsi:type="ns2:ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">SUCCESS</ns2:activityStatus> <ns2:communicationPattern>SimpleResponse</ns2:communicationPattern> <ns2:communicationStyle>RPC</ns2:communicationStyle> <ns2:timestamp>2011-07-05T19:28:37.300+03:00</ns2:timestamp> </ns2:header> </soapenv:Header> <soapenv:Body> <ns4:getAsyncActionStatusResponse xmlns:ns4="http://www.ecitele.com/mtop/aa/xsd/aai/v1-0"> <ns4:asyncActionResult> <ns4:asyncActionStatus>FAILED</ns4:asyncActionStatus> <ns4:asyncActionErrorCode>entityNotFound</ns4:asyncActionErrorCode> <ns4:asyncActionErrorDescription>Entity Not Found: Get card

failed. NE=172.21.176.34 card=8 Unknown. Card not found. .</ns4:asyncActionErrorDescription>


<ns4:vendorExtensions> <asyncActionStatusCode>5030</asyncActionStatusCode> <asyncActionStatusDescription>Entity Not Found: Get card

failed. NE=172.21.176.34 card=8 Unknown. Card not found. .</asyncActionStatusDescription>


</ns4:vendorExtensions> </ns4:asyncActionResult> </ns4:getAsyncActionStatusResponse> </soapenv:Body> </soapenv:Envelope>

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

12-5

Get Async Action Status

E-OPS Web Services NorthBound Interface Specification

Get Async Action Status Fault Response Example


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Fault> <faultcode>soapenv:Server</faultcode> <faultstring>Internal error: SYSTEM ERROR..</faultstring> <detail> <ns4:getAsyncActionStatusException xmlns:ns4="http://www.ecitele.com/mtop/aa/xsd/aai/v1-0"> <internalError xmlns="http://www.tmforum.org/mtop/fmw/xsd/msg/v1"> <header xmlns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <activityName>getAsyncActionStatus</activityName> <msgName>GetAsyncActionStatusException</msgName> <msgType>ERROR</msgType> <senderURI /> <destinationURI /> <activityStatus xsi:type="ActivityStatusType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">FAILURE</activityStatus> <communicationPattern>SimpleResponse</communicationPattern> <communicationStyle>RPC</communicationStyle> <timestamp>2011-07-06T11:27:26.213+03:00</timestamp> </header> <reason>Internal error: SYSTEM ERROR..</reason> </internalError> </ns4:getAsyncActionStatusException> </detail> </soapenv:Fault> </soapenv:Body> </soapenv:Envelope>

12-6

ECI Telecom Ltd. Proprietary

458006-2705-013-A00

A
Appendix
NBI Log File
NBI log file is located by default on Z2 server at: <OPS Installation Dir>/Accelent/Product/Nms_Home/eci-nbi.log See log file for details when the returned activity status is Warning or a fault message is returned.

Services List

TerminationPointControlHttp

Operations: createFloatingTerminationPoint, deleteFloatingTerminationPoint, setTerminationPointData Location in WSDL bundle: WSDL/mtosi20/ResourceProvisioning/IIS/wsdl/TerminationPointContr ol/TerminationPointControlHttp.wsdl The service URL on E-OPS server: http://<E-OPS Z2 Host>:8080/nbi/services/TerminationPointControlHttp Operations: invokeAsyncAction, getAsyncActionStatus Location in WSDL bundle: WSDL/mtosi20/ECIExtensions/AsyncAction/wsdl/AsyncActionInterfa ce/AsyncActionInterfaceHttp.wsdl The service URL on E-OPS server: http://<E-OPS Z2 Host>:8080/nbi/services/AsyncActionInterfaceHttp

AsyncActionInterfaceHttp

458006-2705-013-A00

ECI Telecom Ltd. Proprietary

A-1

Get Async Action Status

E-OPS Web Services NorthBound Interface Specification

A-2

ECI Telecom Ltd. Proprietary

458006-2705-013-A00