netspan northbound if user guide sr6
TRANSCRIPT
Northbound Interface User Guide
Software Release 6.5 UGD-D00022
Northbound Interface User Guide – SR 6.5
Page 2 Commercial in Confidence UGD-D00022 Rev A
© Copyright by Airspan Networks Inc., 2008. All rights reserved worldwide.
The information contained within this document is proprietary and is subject to all relevant copyright, patent and other laws protecting intellectual property, as well as any specific agreements protecting Airspan Networks Inc. rights in the aforesaid information. Neither this document nor the information contained herein may be published, reproduced or disclosed to third parties, in whole or in part, without the express, prior, written permission of Airspan Networks Inc. In addition, any use of this document or the information contained herein for the purposes other than those for which it is disclosed is strictly forbidden.
Airspan Networks Inc. reserves the right, without prior notice or liability, to make changes in equipment design or specifications.
Information supplied by Airspan Networks Inc. is believed to be accurate and reliable. However, no responsibility is assumed by Airspan Networks Inc. for the use thereof nor for the rights of third parties which may be effected in any way by the use of thereof.
Any representation(s) in this document concerning performance of Airspan Networks Inc. product(s) are for informational purposes only and are not warranties of future performance, either expressed or implied. Airspan Networks Inc. standard limited warranty, stated in its sales contract or order confirmation form, is the only warranty offered by Airspan Networks Inc. in relation thereto.
This document may contain flaws, omissions or typesetting errors; no warranty is granted nor liability assumed in relation thereto unless specifically undertaken in Airspan Networks Inc. sales contract or order confirmation. Information contained herein is periodically updated and changes will be incorporated into subsequent editions. If you have encountered an error, please notify Airspan Networks Inc. All specifications are subject to change without prior notice.
Product performance figures quoted within this document are indicative and for information purposes only.
Northbound Interface User Guide – SR 6.5
Page 3 Commercial in Confidence UGD-D00022 Rev A
Revision History
Revision Originator Date Description
Draft 1.0 David Cann 31/01/2008 Updated with comments from K. Dudzinski
Draft 2.0 David Cann 04/02/2008 Updated with comments from K. Dudzinski and D. Thiru
Revision A David Cann 05/02/2008
Northbound Interface User Guide – SR 6.5
Page 4 Commercial in Confidence UGD-D00022 Rev A
Worldwide Headquarters: Airspan Networks Inc. 777, Yamato Road, Suite 105, Boca Raton, FL 3341-4408, USA Tel: +1 561 893 8670 www.airspan.com
Main Operations: Airspan Communications Ltd Cambridge House, Oxford Road, Uxbridge, Middlesex, UB8 1UN, UK Tel: +44 (0)1895 467100
UK WEE Registration number: WEE/AB0207WZ
Airspan Networks Inc acknowledges the following trademarks used within this document:
Internet Information Services (IIS)
© Microsoft Corporation http://www.microsoft.com
Northbound Interface User Guide – SR 6.5
Page 5 Commercial in Confidence UGD-D00022 Rev A
Table of Contents
Table of Contents .................................................................................................................. 5
Glossary of Terms ............................................................................................................... 10
Summary of Figures and Tables ......................................................................................... 12
1 Introduction .................................................................................................................. 14
1.1 General Overview ................................................................................................. 14
1.1.1 Northbound Interface ..................................................................................... 14
1.2 Where Northbound Interface fits into the Netspan Architecture ............................. 15
1.3 Consuming Web Services ..................................................................................... 15
1.4 Using Asynchronous Clients ................................................................................. 16
2 Get Started with the Northbound Interface ................................................................... 17
2.1 Workflow of the Northbound Interface ................................................................... 17
2.2 Navigating the Northbound Interface ..................................................................... 18
3 Enable or Disable Northbound Interface ...................................................................... 21
3.1 Disabling the Northbound Interface ....................................................................... 21
3.2 Enabling the Northbound Interface ........................................................................ 21
4 Enable or Disable Authentication and Authorisation ..................................................... 22
4.1 Disabling Authentication ....................................................................................... 23
4.2 Enabling Authentication ........................................................................................ 23
5 Provision Service and Define Service Profiles .............................................................. 24
5.1 SS Provisioning .................................................................................................... 24
5.1.1 Provisioning SS [ProvisionSS] ....................................................................... 25
5.1.2 Provisioning Fixed SS [ProvisionFixedSS] ..................................................... 26
5.1.3 Provisioning a Custom SS [ProvisionCustomSS] ........................................... 26
5.1.4 Re-provisioning the SS [Reprovision] ............................................................. 26
5.1.5 De-provisioning the SS [Deprovision] ............................................................. 26
Northbound Interface User Guide – SR 6.5
Page 6 Commercial in Confidence UGD-D00022 Rev A
5.1.6 Disabling Service on the SS [DisableService] ................................................ 26
5.1.7 Enabling Service on the SS [EnableService] .................................................. 26
5.1.8 Getting the SS Provisioning Configuration [GetSSProvisioningConfig] .......... 26
5.1.9 Getting the SS Custom Provisioning Configuration [GetSSCustomProvisioningConfig]............................................................................... 26
5.1.10 Getting the SS Provisioning Status [GetProvisioningStatus] .......................... 26
5.1.11 Provisioning a Custom SS within the NMS [ProvisionCustomSSV2] .............. 27
5.1.12 Getting the Custom SS Provisioning Configuration [GetSSCustomProvisioningConfigV2] .......................................................................... 27
5.2 Service Profiles ..................................................................................................... 27
5.2.1 Producing the Service Profiles List [GetServiceProductList] ........................... 27
5.2.2 Retrieving the Custom Configuration List [GetSSCustomConfigList] .............. 28
5.2.3 Producing the VLAN List [GetVlanList] ........................................................... 28
5.2.4 Retrieving Global Configuration Profiles [GetGlobalConfig]............................ 28
5.2.5 Producing the SS VLAN Port Profiles List [GetSSVlanPortProfileList] ............ 28
5.2.6 Retrieving the Global SSV2 Configuration [GetGlobalConfigV2] .................... 28
5.3 View Inventory ...................................................................................................... 28
5.3.1 Producing the BS Sector List [BSSectorList] .................................................. 28
5.4 Service Product .................................................................................................... 28
5.4.1 Producing the Service Product List [ServiceProductList] ................................ 28
5.4.2 Creating the Service Product Name [ServiceProductCreate] ......................... 29
5.4.3 Deleting the Service Product Name [ServiceProductDelete] .......................... 29
5.4.4 Producing the Service Flow Template List [ServiceFlowTemplateList] ........... 29
5.4.5 Getting the Service Flow Template Configuration [ServiceFlowTemplateGet] 29
5.4.6 Creating the Service Flow Template [ServiceFlowTemplateCreate] ............... 29
5.4.7 Deleting the Service Flow Template [ServiceFlowTemplateDelete] ................ 29
5.4.8 Updating the Service Flow Template [ServiceFlowTemplateUpdate] ............. 29
Northbound Interface User Guide – SR 6.5
Page 7 Commercial in Confidence UGD-D00022 Rev A
5.4.9 Producing the Service Flow Template Classifiers List [ServiceFlowTemplateClassifiersList] ........................................................................... 29
5.4.10 Clearing the Service Flow Template Classifiers List [ServiceFlowTemplateClassifiersClear] ........................................................................ 29
5.4.11 Adding the Service Flow Template Classifiers List [ServiceFlowTemplateClassifiersAdd] .......................................................................... 29
5.4.12 Removing Service Flow Template Classifiers List [ServiceFlowTemplateClassifiersRemove] ................................................................... 29
5.5 Service Class ........................................................................................................ 30
5.5.1 Producing the Service Class List [ServiceClassList]....................................... 30
5.5.2 Getting Service Class [ServiceClassGet] ....................................................... 30
5.5.3 Creating Service Class [ServiceClassCreate] ................................................ 30
5.5.4 Deleting Service Class [ServiceClassDelete] ................................................. 30
5.5.5 Updating Service Class [ServiceClassUpdate] ............................................... 30
5.6 Packet Classifier ................................................................................................... 30
5.6.1 Producing the Packet Classifier List [PacketClassifierList] ............................. 30
5.6.2 Getting the Packet Classifier [PacketClassifierGet] ........................................ 30
5.6.3 Creating the Packet Classifier [PacketClassifierCreate] ................................. 30
5.6.4 Deleting the Packet Classifier [PacketClassifierDelete] .................................. 30
5.6.5 Updating the Packet Classifier [PacketClassifierUpdate] ............................... 31
5.7 Virtual LAN ........................................................................................................... 31
5.7.1 Producing VLAN List [VlanList] ...................................................................... 31
5.7.2 Getting the VLAN Name [VlanGet] ................................................................. 31
5.7.3 Creating the VLAN [VlanCreate] .................................................................... 31
5.7.4 Deleting the VLAN [VLANDelete] ................................................................... 31
5.7.5 Updating the VLAN [VlanUpdate] ................................................................... 31
5.8 Provision the SS VLAN Port Profile ....................................................................... 31
5.8.1 Producing the SS VLAN Port Profile List [SSVlanPortProfileList] ................... 31
Northbound Interface User Guide – SR 6.5
Page 8 Commercial in Confidence UGD-D00022 Rev A
5.8.2 Getting the SS VLAN Port Profile [SSVlanPortProfileGet] .............................. 31
5.8.3 Creating the SS VLAN Port Profile [SSVlanPortProfileCreate] ....................... 31
5.8.4 Deleting the SS VLAN Port Profile VLANS [SSVlanPortProfileDelete] ........... 32
5.8.5 Updating the SS VLAN Port Profile VLANS [SSVlanPortProfileUpdate] ......... 32
5.8.6 Getting the SS VLAN Port Profile VLANS [SSVlanPortProfileVlansList] ......... 32
5.8.7 Clearing SS VLAN Port Profile VLANS [SSVLANPortProfileVLANsClear] ...... 32
5.8.8 Adding SS VLAN Port Profile VLANS [SSVlanPortProfileVlansAdd] .............. 32
5.8.9 Removing SS VLAN Port Profile VLANS [SSVlanPortProfileVlansRemove] .. 32
6 Manage Faults ............................................................................................................. 33
6.1 Listing Active Alarms – Read Only ........................................................................ 33
6.1.1 AlarmList ........................................................................................................ 33
6.1.2 AlarmListChanged ......................................................................................... 33
6.1.3 AlarmListForBSDU......................................................................................... 33
6.1.4 AlarmListForBSTRx ....................................................................................... 34
6.1.5 AlarmListForSS .............................................................................................. 34
6.1.6 AlarmListForSector ........................................................................................ 34
6.1.7 AlarmListForShelf .......................................................................................... 34
6.1.8 AlarmDetailsGet ............................................................................................. 34
6.2 – Editing and Deleting Active Alarms ................................................................... 34
6.2.1 AlarmAcknowledge ........................................................................................ 34
6.2.2 AlarmRelease ................................................................................................ 34
6.2.3 AlarmDelete ................................................................................................... 35
6.2.4 AlarmDetailsCommentSet .............................................................................. 35
6.2.5 AlarmDetailsCommentAppend ....................................................................... 35
7 Appendix ...................................................................................................................... 36
7.1 Parameters and Return Values for Northbound Interface Methods ....................... 36
Northbound Interface User Guide – SR 6.5
Page 9 Commercial in Confidence UGD-D00022 Rev A
7.1.1 SS Provisioning ............................................................................................. 36
7.1.2 ServiceProfiles ............................................................................................... 45
7.1.3 Inventory ........................................................................................................ 48
7.1.4 ServiceProduct .............................................................................................. 48
7.1.5 ServiceClass .................................................................................................. 57
7.1.6 Packet Classifier ............................................................................................ 62
7.1.7 VirtualLan ...................................................................................................... 68
7.1.8 SSVlanPortProfile .......................................................................................... 71
7.1.9 Fault Management ......................................................................................... 78
Northbound Interface User Guide – SR 6.5
Page 10 Commercial in Confidence UGD-D00022 Rev A
Glossary of Terms
AAA Authentication, Authorization and Accounting
AAS Advanced Antenna System
AF Application Function
ARQ Automatic Repeat reQuest
ASN Access Service Network
ASN GW ASN Gateway
ATCA Advanced Telecommunications Computing Architecture
BS Base Station
BWA Broadband Wireless Access
CHAP Challenge Handshake Authentication Protocol
CPE Customer Premises Equipment
CQI Channel Quality Indicator
CSN Connectivity Service Network
DSM Digital Surface Model
DTM Digital Terrain Model
EAP Extensible Authentication Protocol
FA Foreign Agent
FBSS Fast Base Station Switching
FDD Frequency Division Duplex
GUI Graphical User Interface
HA Home Agent
H-ARQ Hybrid Automatic Repeat reQuest
HO Handover/Handoff
IIS Internet Information Services © Microsoft Corporation
IMS IP Multimedia Subsystem
IP Internet Protocol
IPsec IP security
LR Location Register
MAC Media Access Control
MDH Macro Diversity Handover
MIMO Multiple Input Multiple Output
MIP Mobile IP
Northbound Interface User Guide – SR 6.5
Page 11 Commercial in Confidence UGD-D00022 Rev A
MRC Maximal Ratio Combining
MS Mobile Station
NAP Network Access Provider
NAS Network Access Server
NLOS Non Line of Sight
NSP Network Service Provider
NWG Network Working Group
OBSAI Open Base Station Standard Initiative
OFDMA Orthogonal Frequency Division Multiplexing (Multiple Access)
PA Paging Agent
PAAA Proxy AAA
PC Paging Controller
PF Policy Function
PHY PHYsical Layer
PMIP Proxy MIP
PPP Point-to-Point Protocol
RADIUS Remote Authentication Dial In User Service
RRA Radio Resource Agent
RRC Radio Resource Controller
RRM Radio Resource Management
SAS Smart Antenna System
SDR Software Defined Radio
SFA Service Flow Authorization
SFM Service Flow Management
SIM Subscriber Identity Module
SIP Session Initiation Protocol
SOFDMA Scalable Orthogonal Frequency Division Multiplexing (Multiple Access)
STC Space Time Coding
TDD Time Division Duplex
VoIP Voice over IP
X.509 ITU-T standard for PKI digital certificates
Northbound Interface User Guide – SR 6.5
Page 12 Commercial in Confidence UGD-D00022 Rev A
Summary of Figures and Tables
Figure 1 – Northbound Interface Architecture Model ........................................................... 14
Figure 2 – Workflow of Northbound Interface ...................................................................... 17
Figure 3 – Web browser showing Web Services Index ........................................................ 18
Figure 4 – Web browser showing SSProvisioning web service methods ............................. 19
Figure 5 – Web browser showing SSProvisioning WSDL .................................................... 19
Figure 6 – Web browser showing SSProvisioning GetSSProvisioningConfig method details ........................................................................................................................................... 20
Figure 7 – Netspan Web Services Users Administration ..................................................... 22
Northbound Interface User Guide – SR 6.5
Page 13 Commercial in Confidence UGD-D00022 Rev A
About this Guide
This section discusses the purpose, intended audience, references and organisation for this guide.
Purpose
This guide provides the workflows and step-by-step procedures for operating the Northbound Interface feature of the Netspan element manager (EM) for the WiMAX System current release. These procedures include:
Enabling or Disabling the Northbound Interface Authenticating and Authorising access to the Northbound Interface Provisioning network elements and services Managing Faults – listing, editing and deleting
Intended Audience
This guide is intended for persons who are responsible for commissioning the product. These persons should have a working knowledge of both the WiMAX system and the Netspan EM.
Referenced Documentation
Netspan Northbound Interface Reference Manual Rev E. December 2007
Netspan Content Specification – Release 6.5 Rev E. December 2007
Organisation of this Guide
This guide is organised into the following Sections:
Introduction Get Started with Northbound Interface Enable or Disable Northbound Interface Enable or Disable Authentication and Authorisation Provision Service and Define Service Profiles Manage Faults Appendix
Northbound Interface User Guide – SR 6.5
Page 14 Commercial in Confidence UGD-D00022 Rev A
1 Introduction
This section (Section 1) provides a descriptive overview of the feature and its place in the product suite.
1.1 General Overview
1.1.1 Northbound Interface
The Netspan Northbound Interface uses industry-standard Web Services technology. The communication between the Web Service client or consumer and Web Service server or Provider (hosted by Netspan), is achieved via the exchange of SOAP messages over HTTP. The services exposed by the Web Service are defined using WSDL (Web Service Description Language) files, which specify the contract between the client and server. There are a number of software toolkits to automatically generate the Web service client code from WSDL files, thereby facilitating the easy development of Web service clients using most major programming languages / operating systems.
Figure 1 – Northbound Interface Architecture Model
Northbound Interface User Guide – SR 6.5
Page 15 Commercial in Confidence UGD-D00022 Rev A
1.2 Where Northbound Interface fits into the Netspan Architecture
The Netspan Northbound Interface is used typically when operators wish to provision SS in Netspan using their existing, higher level management system. For example, consider that a customer service agent receives a call directly from a customer requesting a new service or a change to an existing service package. The agent could make the requested changes to the customer management system, where the relevant command then would filter down remotely by way of any high-level OSS and be passed seamlessly to Netspan. Alternatively, the command would be passed as part of an automated self-provisioning system, in which case, after purchasing an SS, a customer would enter their credentials into an authenticating front-end server to obtain service.
Note: Netspan does not provide an ‘out of the box’ application / GUI for using and viewing data across the Northbound Interface.
1.3 Consuming Web Services
Northbound interface Web services can be consumed by any client that is capable of making a request over HTTP and parsing out the returned XML.
As standard practice, the role of a type library is taken by the WSDL description of a Web Service.
Get the WSDL description dynamically by calling the Web Service URL appended by the WSDL parameter; in this case, simply
http://<ServerName>/wimaxws1/SSProvisioning.asmx?WSDL
where <ServerName> is the name of the server running Netspan. This is the preferred method, because it always gives an up-to-date description of the service.
There are a number of software toolkits to automatically generate the Web service client code from WSDL files, thereby facilitating the easy development of Web service clients using most major programming languages / operating systems.
The Microsoft .NET framework has a tool for creating something called a Web service proxy that greatly simplifies access to a Web service. Web service proxy can be created in two ways. Using Visual Studio .NET, add what is called a Web Reference by pointing Visual Studio .NET to the URL of the Web service. If not using Visual Studio .NET, use a tool called Web Service Description Language Tool (wsdl.exe) to create the Web service proxy. wsdl.exe utility requires a path to a Web service or to the WSDL that describes the Web service. Given this, it will generate the proxy class. This class has the same method signatures as the Web service and hides the implementation details so that calling the Web service is transparent. That is: Running wsdl.exe against the SSProvisioning in a command line as shown below:
Wsdl http://<ServerName>/WiMaxWS1/SSProvisioning.asmx /language:cs
gets back a new file named after the class contained within the SSProvisioning.asmx file, SSProvisioning.cs.
Northbound Interface User Guide – SR 6.5
Page 16 Commercial in Confidence UGD-D00022 Rev A
Note: The instructions above refer to the .NET development environment. The developer of the WS client should refer to the documentation of their development system and the language libraries for help on how to do the similar tasks in the environment of their choice.
1.4 Using Asynchronous Clients
XML Web services are a convenient way to access services of Northbound Interface over HTTP. This can introduce some uncertainties in calling methods of the Web services, due to the latencies involved in transiting data from client to server or server to client over the Internet and during method execution (depending on the server and the method called) over peak times. This can cause the application to behave as if blocked or appear to be sluggish while retrieving information from a web service. The solution is to call the Web service in an asynchronous fashion. This enables the application to send the request to a Web service and then continue doing other work. When the Web service response returns, the application retrieves the data and displays it to the user.
Asynchronous access is more useful in a windows-form type of application, where one can go ahead and make the form available to the user immediately. When the data becomes available, just update it in the form already displayed.
Northbound Interface User Guide – SR 6.5
Page 17 Commercial in Confidence UGD-D00022 Rev A
2 Get Started with the Northbound Interface
2.1 Workflow of the Northbound Interface
The Workflow required to start and operate the Northbound Interface is shown in the following diagram:
Figure 2 – Workflow of Northbound Interface
Northbound Interface User Guide – SR 6.5
Page 18 Commercial in Confidence UGD-D00022 Rev A
2.2 Navigating the Northbound Interface
Navigate the Northbound Interface by entering the URL of the web service in the address bar of a web browser as shown in the following screen images. The Index page provides links to specific web services.
Figure 3 – Web browser showing Web Services Index
View the particular web service by clicking on its link in the list.
Northbound Interface User Guide – SR 6.5
Page 19 Commercial in Confidence UGD-D00022 Rev A
Figure 4 – Web browser showing SSProvisioning web service methods
View the underlying WSDL by clicking on “Service Description”.
Figure 5 – Web browser showing SSProvisioning WSDL
Northbound Interface User Guide – SR 6.5
Page 20 Commercial in Confidence UGD-D00022 Rev A
View information regarding an individual web service method by returning to the SSProvisioning methods screen then clicking on the name of the method.
Figure 6 – Web browser showing SSProvisioning GetSSProvisioningConfig method details
Northbound Interface User Guide – SR 6.5
Page 21 Commercial in Confidence UGD-D00022 Rev A
3 Enable or Disable Northbound Interface
By default, the Northbound Interface is enabled.
3.1 Disabling the Northbound Interface
The step-by-step procedure to disable the interface is as follows:
1. Locate the WebServices subdirectory of the Netspan Installation (typically C:\Program Files\Airspan Networks Inc\AS8200 Netspan V8\WebServices).
2. Edit the Web.Config file in this directory using any standard text editor. 3. Locate the line in subsection <WiMaxWS1.WS>
<add key="WebServiceEnabled" value="true" />
and change the value=”true” to value = “false”.
4. Locate the WebUI.Netspan subdirectory of the Netspan Installation (typically C:\Program Files\Airspan Networks Inc\AS8200 Netspan V8\WebUI.Netspan).
5. Edit the Web.Config file in this directory using any standard text editor. 6. Locate the line in subsection <WiMaxWS1.WS>
<add key="WebServiceEnabled" value="true" />
and change the value=”true” to value = “false”.
7. Restart IIS so that the changes to the Web.Config files take effect.
3.2 Enabling the Northbound Interface
The step-by-step procedure to enable the interface is as follows:
1. Locate the WebServices subdirectory of the Netspan Installation (typically C:\Program Files\Airspan Networks Inc\AS8200 Netspan V8\WebServices).
2. Edit the Web.Config file in this directory using any standard text editor. 3. Locate the line in subsection <WiMaxWS1.WS>
<add key="WebServiceEnabled" value="false" />
and change the value=”false” to value = “true”.
4. Locate the WebUI.Netspan subdirectory of the Netspan Installation (typically C:\Program Files\Airspan Networks Inc\AS8200 Netspan V8\WebUI.Netspan).
5. Edit the Web.Config file in this directory using any standard text editor. 6. Locate the line in subsection <WiMaxWS1.WS>
<add key="WebServiceEnabled" value="false" />
and change the value=”false” to value = “true”.
7. Restart IIS so that the changes to the Web.Config files take effect.
Northbound Interface User Guide – SR 6.5
Page 22 Commercial in Confidence UGD-D00022 Rev A
4 Enable or Disable Authentication and Authorisation
By default, authentication is enabled. In this mode, the user name and password of a user entitled to access the Netspan Web services must be provided in the SOAP Header of every Web Service method request.
Netspan is pre-configured with an administrative user for web services, called “wsadmin”, which has the “WS Administrators” role. This role automatically has rights to all Netspan web services. An additional role, “WS Service Provisioners”, whose access is restricted to purely the SS Provisioning procedures in the web service interface, is also supplied. Provided the web service interface is enabled, the “wsadmin” user is visible from the “Users” page in Netspan, and it is possible to create new users having either the “WS Administrators” or “WS Service Provisioners” role. Any user having the “WS Administrators” or “WS Service Provisioners” role should be authorised to access any of the procedures described in this document.
Since authentication is enabled by default, in order to use the Internet Explorer test page with Netspan Web services then it is necessary to disable authentication. In this mode, no credentials need to be supplied to access any of the Web Service procedures.
Note: The IE test page can only be used as a way of testing a local Web Service; testing of a remote Web Service is not supported.
Figure 7 – Netspan Web Services Users Administration
Northbound Interface User Guide – SR 6.5
Page 23 Commercial in Confidence UGD-D00022 Rev A
4.1 Disabling Authentication
The step-by-step procedure to disable authentication is as follows:
1. Locate the WebServices subdirectory of the Netspan Installation (typically C:\Program Files\Airspan Networks Inc\AS8200 Netspan V8\WebServices).
2. Edit the Web.Config file in this directory using any standard text editor. 3. Locate the line in subsection <Sys.Common.Security>
<add key="authenticationenabled" value="true" /> and change the value=”true” to value=”false”.
4. Restart IIS so that the changes to the Web.Config files take effect.
4.2 Enabling Authentication
The step-by-step procedure to disable authentication is as follows:
1. Locate the WebServices subdirectory of the Netspan Installation (typically C:\Program Files\Airspan Networks Inc\AS8200 Netspan V8\WebServices).
2. Edit the Web.Config file in this directory using any standard text editor. 3. Locate the line in subsection <Sys.Common.Security>
<add key="authenticationenabled" value="false" /> and change the value=”false” to value=”true”.
4. Restart IIS so that the changes to the Web.Config files take effect.
Northbound Interface User Guide – SR 6.5
Page 24 Commercial in Confidence UGD-D00022 Rev A
5 Provision Service and Define Service Profiles
Configuration Management –Provisioning Service of Subscriber Stations
The following three Web Services that do not require a licence are provided for Provisioning SS:
SSProvisioning - allows management of Subscriber Provisioning, such as Provision, De-provision, Re-Provision, Enable and Disable Services on SS.
ServiceProfiles - allows retrieving Services and Profiles available on the NMS. This data is used by the SS Provisioning web service above to provision SS.
Inventory - allows retrieving BS TRx Channels configured in the NMS. This data is used by the SS Provisioning web service above to provision SS.
Configuration Management – Defining Service Profiles
The following five web services are provided for the management of services and profiles on the NMS and require a special licence key to use:
Service Product - provides facilities to view, create and delete operations of Service Product and Service Flow Templates in NMS.
Service Class - assists with view, update, create and delete operations of Service Classes in NMS.
Packet Classifier - provides operations to retrieve, create, modify and delete Packet Classifiers in NMS.
SSVlan Port Profile - provides operations to retrieve, create, modify and delete SS Vlan Port Profile in NMS.
Virtual LAN - Web Service has been provided to assist with view, update, create and delete operations of Virtual LAN in NMS.
5.1 SS Provisioning
The Netspan Northbound interface concentrates on SS Provisioning. This service allows the provisioning of SSs and also the execution of a number of other standard operations related to SS Provisioning, e.g. Enabling or Disabling service on an SS.
The interface can be viewed by browsing to http://<webserver>/WiMaxWS1/SSProvisioning.asmx.
SSProvisioning methods can be grouped as Obsolete methods, Deprecated methods, Status methods and Action methods.
Obsolete methods that are no longer supported include the following:
• ProvisionCustomSS
ProvisionCustomSS is replaced by ProvisionCustomSSV2
Northbound Interface User Guide – SR 6.5
Page 25 Commercial in Confidence UGD-D00022 Rev A
Deprecated methods are retained for compatibility with existing web service clients, and these methods include the following:
• GetSSCustomProvisioningConfig
GetSSCustomProvisioningConfig is replaced by GetSSCustomProvisioningConfigV2.
Status methods return status information for a particular SS, and these methods include the following:
• GetProvisioningStatus • GetSSCustomProvisioningConfigV2 • GetSSProvisioningConfig
Action methods perform an action for a particular SS and have further categories as given in the following:
Provision an SS
• ProvisionCustomSSV2 • ProvisionFixedSS • ProvisionSS
Deprovision an SS
• Deprovision
Disable / Enable service on an SS
• DisableService • EnableService
Resend existing provisioned configuration to the BSs
• Reprovision
The following SSProvisioning methods are supported:
5.1.1 Provisioning SS [ProvisionSS]
Provision an SS within the NMS with the specified Service Product. The Service Product must already exist within the NMS. If the SS does not already exist in the NMS it is created, otherwise the existing SS is updated.
Northbound Interface User Guide – SR 6.5
Page 26 Commercial in Confidence UGD-D00022 Rev A
5.1.2 Provisioning Fixed SS [ProvisionFixedSS]
Provision an SS within the NMS with the specified Service Product on the specified sector only. The Service Product and sector must already exist within the NMS. If the SS does not already exist in the NMS it is created, otherwise the existing SS is updated.
5.1.3 Provisioning a Custom SS [ProvisionCustomSS]
This action is no longer supported in SR6.1. It returns error E02015, message “This method is no longer supported.”
5.1.4 Re-provisioning the SS [Reprovision]
Resend the configuration information related to Provisioning for this SS to every Sector it has recently registered on. Users can track the progress of this re-provisioning by calling GetProvisioningStatus() on this SS. Returns an error if the SS does not already exist.
5.1.5 De-provisioning the SS [Deprovision]
Remove any provisioning configuration that has been assigned to this SS in the NMS. As a result of this change, the system will asynchronously remove the configuration information related to provisioning for this SS from every Sector it has recently registered on. Users can track the progress of this de-provisioning by calling GetProvisioningStatus() on this SS. Returns an error if the SS does not already exist.
5.1.6 Disabling Service on the SS [DisableService]
Disable service on the specified SS. As a result of this change, the system will asynchronously remove the configuration information related to provisioning for this SS from every Sector it has recently registered on. Returns an error if the SS does not already exist.
5.1.7 Enabling Service on the SS [EnableService]
Enable service on the specified SS. As a result of this change, the system will asynchronously configure the information related to provisioning for this SS on every Sector it has recently registered on. Returns an error if the SS does not already exist.
5.1.8 Getting the SS Provisioning Configuration [GetSSProvisioningConfig]
Get the standard Provisioning parameters, (as defined in 802.16f), that are configured for the specified SS.
5.1.9 Getting the SS Custom Provisioning Configuration [GetSSCustomProvisioningConfig]
Get the Provisioning parameters, (those defined in 802.16f and proprietary custom extensions), that are configured for the specified SS.
5.1.10 Getting the SS Provisioning Status [GetProvisioningStatus]
Gets the status of the provisioning for this SS on every Sector it has recently registered on. If the SS has not recently registered on any Sector, returns an empty array.
Northbound Interface User Guide – SR 6.5
Page 27 Commercial in Confidence UGD-D00022 Rev A
5.1.11 Provisioning a Custom SS within the NMS [ProvisionCustomSSV2]
Method version 2 was first introduced in SR5.0. Provision an SS within the NMS with the specified provisioning properties. The Provisioning parameters include those permitted in 802.16f and additional proprietary custom quantities. If the SS does not already exist in the NMS, it is created, otherwise the existing SS is updated.
5.1.12 Getting the Custom SS Provisioning Configuration [GetSSCustomProvisioningConfigV2]
Method version 2 was first introduced in SR5.0. Get the Provisioning parameters, (those defined in 802.16f and proprietary custom extensions), that are configured for the specified SS.
5.2 Service Profiles
To assist SS Provisioning, an additional Web Service has been provided to permit enumeration of those templates/ profiles used in SSProvisioning.
Note: This interface is read-only, i.e. templates can be neither created, modified nor deleted over the Web Services interface.
The interface can be viewed by browsing to http://<webserver>/WiMaxWS1/ServiceProfile.asmx.
ServiceProfiles methods can be grouped as Deprecated methods and Current methods.
Deprecated methods are retained for compatibility with existing web service clients, and these methods include the following:
• GetGlobalConfig
GetGlobalConfig is replaced by GetGlobalConfigV2.
Current methods return data that is useful for the SSProvisioning web service, and these methods include the following:
• GetGlobalConfigV2 • GetSSCustomConfigList • GetVlanList • GetSSVlanPortProfileList • GetServiceProductList
The following ServiceProfiles procedures are supported:
5.2.1 Producing the Service Profiles List [GetServiceProductList]
Produces a list of the names of the Service Products configured in the NMS.
Northbound Interface User Guide – SR 6.5
Page 28 Commercial in Confidence UGD-D00022 Rev A
5.2.2 Retrieving the Custom Configuration List [GetSSCustomConfigList]
Produces a list of the names of the SS Custom configurations configured in the NMS.
5.2.3 Producing the VLAN List [GetVlanList]
Produces a list of the Vlans configured in the NMS.
5.2.4 Retrieving Global Configuration Profiles [GetGlobalConfig]
Retrieves the default global profiles configured in the NMS for the SSs.
5.2.5 Producing the SS VLAN Port Profiles List [GetSSVlanPortProfileList]
Produces a list of the SS Vlan Port Profiles configured in the NMS.
5.2.6 Retrieving the Global SSV2 Configuration [GetGlobalConfigV2]
Retrieves the extended set of default global profiles configured in the NMS for the SSs.
5.3 View Inventory
Inventory Web Service has been provided to assist with view operations of Inventories in NMS. These are new actions in SR6.0.
The interface can be viewed by browsing to http://<webserver>/wimaxws1/Inventory.asmx.
Inventory currently has only one method as follows:
• BSSectorList - Produces a list of names of BS TRx Channels configured in the NMS. Returns a null if no BS TRx Channels are found.
The following Inventory procedures are supported:
5.3.1 Producing the BS Sector List [BSSectorList]
Produces a list of existing Base Station TRx Channel list names from NMS.
5.4 Service Product
ServiceProduct Web Service has been provided to assist with view, create and delete operations of Service Product and Service Flow Templates in NMS. These are new procedures in SR6.0.
Note: Access to these actions is allowed based on an appropriate electronic license key.
The interface can be viewed by browsing to http://<webserver>/wimaxws1/ServiceProduct.asmx. The following actions are supported:
5.4.1 Producing the Service Product List [ServiceProductList]
Produces a list of the names of Service Products configured in NMS.
Northbound Interface User Guide – SR 6.5
Page 29 Commercial in Confidence UGD-D00022 Rev A
5.4.2 Creating the Service Product Name [ServiceProductCreate]
Creates a Service Product with no service flows.
5.4.3 Deleting the Service Product Name [ServiceProductDelete]
Deletes an existing Service Product.
5.4.4 Producing the Service Flow Template List [ServiceFlowTemplateList]
Produces a list of Service Flow Template names for the specified Service product name in NMS.
5.4.5 Getting the Service Flow Template Configuration [ServiceFlowTemplateGet]
Gets a Service Flow Template configuration from the NMS for the specified Service Product and Service Flow Template.
5.4.6 Creating the Service Flow Template [ServiceFlowTemplateCreate]
Creates a Service Flow Template in a Service Product with the specified parameters.
5.4.7 Deleting the Service Flow Template [ServiceFlowTemplateDelete]
Deletes an existing Service Flow Template from the specified Service Product.
5.4.8 Updating the Service Flow Template [ServiceFlowTemplateUpdate]
Updates an existing Service Flow Template in the specified Service Product with the specified parameters.
5.4.9 Producing the Service Flow Template Classifiers List [ServiceFlowTemplateClassifiersList]
Produces a list of Classifier names for an existing Service Flow Template in the specified Service Product.
5.4.10 Clearing the Service Flow Template Classifiers List [ServiceFlowTemplateClassifiersClear]
Clears all the PacketClassifier from an existing Service Flow Template in the specified Service Product.
5.4.11 Adding the Service Flow Template Classifiers List [ServiceFlowTemplateClassifiersAdd]
Adds an existing Packet Classifier to and existing Service Flow Template in the specified Service Product.
5.4.12 Removing Service Flow Template Classifiers List [ServiceFlowTemplateClassifiersRemove]
Removes existing Packet Classifier from a Service Flow Template in the specified Service Product.
Northbound Interface User Guide – SR 6.5
Page 30 Commercial in Confidence UGD-D00022 Rev A
5.5 Service Class
ServiceClass Web Service has been provided to assist with view, update, create and delete operations of Service Classes in NMS.
Note: Access to these actions is allowed based on an appropriate electronic license key.
The interface can be viewed by browsing to http://<webserver>/wimaxws1/ServiceClass.asmx. The following actions are supported:
5.5.1 Producing the Service Class List [ServiceClassList]
Produces a list of Service Class names configured in NMS.
5.5.2 Getting Service Class [ServiceClassGet]
Gets the configuration of the specified Service Class.
5.5.3 Creating Service Class [ServiceClassCreate]
Creates a new Service Class with the specified parameters passed.
5.5.4 Deleting Service Class [ServiceClassDelete]
Removes existing Service Class in NMS.
5.5.5 Updating Service Class [ServiceClassUpdate]
Updates an existing Service Class in NMS with the parameters passed.
5.6 Packet Classifier
PacketClassifier Web Service has been provided to assist with view, update, create and delete operations of Packet Classifiers in NMS. These are new actions in SR6.0.
Note: Access to these actions is allowed based on an appropriate electronic license key.
The interface can be viewed by browsing to http://<webserver>/wimaxws1/PacketClassifier.asmx. The following actions are supported:
5.6.1 Producing the Packet Classifier List [PacketClassifierList]
Produces the list of existing Packet Classifier names configured in NMS.
5.6.2 Getting the Packet Classifier [PacketClassifierGet]
Get the configuration of the specified Packet Classifier in NMS.
5.6.3 Creating the Packet Classifier [PacketClassifierCreate]
Creates a new Packet Classifier in the NMS.
5.6.4 Deleting the Packet Classifier [PacketClassifierDelete]
Removes an existing Packet Classifier in NMS.
Northbound Interface User Guide – SR 6.5
Page 31 Commercial in Confidence UGD-D00022 Rev A
5.6.5 Updating the Packet Classifier [PacketClassifierUpdate]
Updates an existing Packet Classifier in the NMS with the parameters passed.
5.7 Virtual LAN
VirtualLan Web Service has been provided to assist with view, update, create and delete operations of Virtual LAN in NMS.
Note: Access to these actions is allowed based on an appropriate electronic license key.
The interface can be viewed by browsing to http://<webserver>/wimaxws1/VirtualLan.asmx. The following actions are supported.
5.7.1 Producing VLAN List [VlanList]
Produces a list of VLANs configured in NMS.
5.7.2 Getting the VLAN Name [VlanGet]
Gets VLAN configuration of the specified VLAN Name in NMS.
5.7.3 Creating the VLAN [VlanCreate]
Creates a new VLAN in the NMS.
5.7.4 Deleting the VLAN [VLANDelete]
Deletes an existing VLAN in NMS.
5.7.5 Updating the VLAN [VlanUpdate]
Updates an existing VLAN with new parameters specified.
5.8 Provision the SS VLAN Port Profile
SSVlanPortProfile Web Service has been provided to assist with view, update, create and delete operations of SS Virtual LAN Port Profiles in NMS. These are new actions in SR6.0.
Note: Access to these actions is allowed based on an appropriate electronic license key.
The interface can be viewed by browsing to http://<webserver>/wimaxws1/SSVlanPortProfile.asmx. The following actions are supported:
5.8.1 Producing the SS VLAN Port Profile List [SSVlanPortProfileList]
Produces a list of the SS VLAN Port Profiles configured in the NMS.
5.8.2 Getting the SS VLAN Port Profile [SSVlanPortProfileGet]
Gets the configuration of an existing SS VLAN Port Profile in NMS.
5.8.3 Creating the SS VLAN Port Profile [SSVlanPortProfileCreate]
Creates a new SS VLAN Port Profile in NMS with the specified parameters.
Northbound Interface User Guide – SR 6.5
Page 32 Commercial in Confidence UGD-D00022 Rev A
5.8.4 Deleting the SS VLAN Port Profile VLANS [SSVlanPortProfileDelete]
Deletes all VLANs from and existing SS VLAN Port Profile in the NMS.
5.8.5 Updating the SS VLAN Port Profile VLANS [SSVlanPortProfileUpdate]
Updates an existing VLAN to an existing SS VLAN PORT Profile in the NMS.
5.8.6 Getting the SS VLAN Port Profile VLANS [SSVlanPortProfileVlansList]
Gets an existing VLAN from and existing SS VLAN Port Profile in NMS.
5.8.7 Clearing SS VLAN Port Profile VLANS [SSVLANPortProfileVLANsClear]
Clears all VLANs from and existing SS VLAN Port Profile in the NMS.
5.8.8 Adding SS VLAN Port Profile VLANS [SSVlanPortProfileVlansAdd]
Adds an existing VLAN to an existing SS VLAN PORT Profile in the NMS.
5.8.9 Removing SS VLAN Port Profile VLANS [SSVlanPortProfileVlansRemove]
Removes an existing VLAN from and existing SS VLAN Port Profile in NMS.
Northbound Interface User Guide – SR 6.5
Page 33 Commercial in Confidence UGD-D00022 Rev A
6 Manage Faults
Faults Management
The following Fault Management web service does not require a special licence key to use:
Fault Management - Provided to assist with the operations of Fault Management of NMS, such as retrieving, releasing, acknowledging and commenting Alarms.
Note: To view Parameters and Return Values for all the methods listed in this section, please turn in this document to the Appendix.
6.1 Listing Active Alarms – Read Only
The Fault Management Web Service has been provided to assist with the operations of Fault Management of NMS. These are new methods in SR6.5.
The Fault Management interface can be viewed by browsing to http://<webserver>/wimaxws1/FaultManagement.asmx.
The interface can be classified as follows:
Active Alarms – Read Only
APIs to retrieve active alarms from NMS
• AlarmList • AlarmListChanged • AlarmListForBSDU • AlarmListForBSTRx • AlarmListForSS • AlarmListForSector • AlarmListForShelf • AlarmDetailsGet
The following read only methods are supported:
6.1.1 AlarmList
Produces a list of active alarms in the NMS. Returns a null if no Alarms are found.
6.1.2 AlarmListChanged
Produces a list of active alarms changed since lastChangedTime in the NMS. Returns a null if no Alarms are found.
6.1.3 AlarmListForBSDU
Produces a list of active alarms for the specified BSDU macAddress in the NMS. Returns a null if no Alarms are found.
Northbound Interface User Guide – SR 6.5
Page 34 Commercial in Confidence UGD-D00022 Rev A
6.1.4 AlarmListForBSTRx
Produces a list of active alarms for the specified BSID in the NMS. Returns a null if no Alarms are found.
6.1.5 AlarmListForSS
Produces a list of active alarms for the specified SS macAddress in the NMS. Returns a null if no Alarms are found.
6.1.6 AlarmListForSector
Produces a list of active alarms for the specified Sector BSID in the NMS. Returns a null if no Alarms are found.
6.1.7 AlarmListForShelf
Produces a list of active alarms for the specified shelfId in the NMS. Returns a null if no Alarms are found.
6.1.8 AlarmDetailsGet
Gets detailed information on an active Alarm with AlarmID that exists in the NMS. Returns an error if the AlarmID does not already exist.
6.2 – Editing and Deleting Active Alarms
Active Alarms – Edit and Delete
The Fault Management interface can be viewed by browsing to http://<webserver>/wimaxws1/FaultManagement.asmx.
APIs to modify and delete an active alarm in the NMS
• AlarmAcknowledge • AlarmDelete • AlarmDetailsCommentAppend • AlarmDetailsCommentSet • AlarmRelease
The following edit and delete methods are supported:
6.2.1 AlarmAcknowledge
Acknowledges (sets „acknowledged‟ flag of) an existing active Alarm with AlarmID that exists in the NMS. Returns an error if the AlarmID does not already exist.
6.2.2 AlarmRelease
Releases (clears „acknowledged‟ flag of) an existing active Alarm with AlarmID that exists in the NMS. Returns an error if the AlarmID does not already exist.
Northbound Interface User Guide – SR 6.5
Page 35 Commercial in Confidence UGD-D00022 Rev A
6.2.3 AlarmDelete
Deletes an existing active Alarm with AlarmID that exists in the NMS. Returns an error if the AlarmID does not already exist.
6.2.4 AlarmDetailsCommentSet
Sets comment on an existing active Alarm with AlarmID that exists in the NMS. Returns an error if the AlarmID does not already exist.
6.2.5 AlarmDetailsCommentAppend
Appends a comment on an existing active Alarm with AlarmID that exists in the NMS. Returns an error if the AlarmID does not already exist.
Northbound Interface User Guide – SR 6.5
Page 36 Commercial in Confidence UGD-D00022 Rev A
7 Appendix
7.1 Parameters and Return Values for Northbound Interface Methods
7.1.1 SS Provisioning
7.1.1.1 ProvisionSS
Method ProvisionSS( string macAddress, string serviceProductName)
Description Provision an SS within the NMS with the specified Service Product. The Service Product must already exist within the NMS. If the SS does not already exist in the NMS it is created, otherwise the existing SS is updated.
Parameters
macAddress
serviceProductName
Mandatory parameter. Mac Address is specified using format xx:xx:xx:xx:xx:xx where xx is a hex digit.
Mandatory parameter. The name of an existing Service product within the NMS
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E01018: Invalid Mac Address
E02004: A Service Product name must be supplied for this service
E02005: No Service Product exists with the supplied name
E02012: For this method to be supported, a default SS Custom Configuration must be specified in the NMS
E02013: For this method to be supported, a default SS VLAN Port Profile must be specified in the NMS.
7.1.1.2 ProvisionFixedSS
Northbound Interface User Guide – SR 6.5
Page 37 Commercial in Confidence UGD-D00022 Rev A
Method ProvisionFixedSS( string macAddress, string serviceProductName, string homeSectorBSID)
Description Provision an SS within the NMS with the specified Service Product on the specified sector only. The Service Product and sector must already exist within the NMS. If the SS does not already exist in the NMS it is created, otherwise the existing SS is updated.
Parameters
macAddress
serviceProductName
homeSectorBSID
Mandatory parameter. Mac Address is specified using format xx:xx:xx:xx:xx:xx where x is a hex digit.
Mandatory parameter. The name of an existing Service product within the NMS
Optional parameter. BSID is of the format xxxxxx:xxxxxx where x is a hex digit. Must identify an existing Sector in the NMS.
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E01018: Invalid Mac Address
E02002: Invalid BS Id. Please supply a string of format xxxxxx:xxxxxx where x is a hex digit.
E02003: No Sector exists with the supplied BS Id
E02004: A Service Product name must be supplied for this service
E02005: No Service Product exists with the supplied name
E02012: For this method to be supported, a default SS Custom Configuration must be specified in the NMS
E02013: For this method to be supported, a default SS VLAN Port Profile must be specified in the NMS.
7.1.1.3 ProvisionCustomSS
Northbound Interface User Guide – SR 6.5
Page 38 Commercial in Confidence UGD-D00022 Rev A
This method is no longer supported in SR5.0. It returns error E02015, message “This method is no longer supported.”
7.1.1.4 Reprovision
Method Reprovision ( string macAddress)
Description Resend the configuration information related to Provisioning for this SS to every Sector it has recently registered on. Users can track the progress of this reprovisioning by calling GetProvisioningStatus() on this SS. Returns an error if the SS does not already exist.
Parameters
macAddress
Mandatory parameter. Mac Address is specified using format xx:xx:xx:xx:xx:xx where xx is a hex digit.
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02001: No SS with this Mac Address exists
E01036: Reprovisioning this SS has no effect as the SS has Service Disabled
7.1.1.5 Deprovision
Method Deprovision ( string macAddress)
Description Remove any provisioning configuration that has been assigned to this SS in the NMS. As a result of this change, the system will asynchronously remove the configuration information related to provisioning for this SS from every Sector it has recently registered on. Users can track the progress of this de-provisioning by calling GetProvisioningStatus() on this SS. Returns an error if the SS does not already exist.
Parameters
macAddress
Mandatory parameter. Mac Address is specified using format
Northbound Interface User Guide – SR 6.5
Page 39 Commercial in Confidence UGD-D00022 Rev A
xx:xx:xx:xx:xx:xx where xx is a hex digit.
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E01018: Invalid Mac Address
E02001: No SS with this Mac Address exists.
7.1.1.6 DisableService
Method DisableService( string macAddress)
Description Disable service on the specified SS. As a result of this change, the system will asynchronously remove the configuration information related to provisioning for this SS from every Sector it has recently registered on. Returns an error if the SS does not already exist.
Parameters
macAddress
Mandatory parameter. Mac Address is specified using format xx:xx:xx:xx:xx:xx where xx is a hex digit.
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E01018: Invalid Mac Address
E02001: No SS with this Mac Address exists.
7.1.1.7 EnableService
Method EnableService( string macAddress)
Description Enable service on the specified SS. As a result of this change, the system will asynchronously configure the information related to provisioning for this SS on every Sector it has recently registered on. Returns an error if the SS does not already exist.
Northbound Interface User Guide – SR 6.5
Page 40 Commercial in Confidence UGD-D00022 Rev A
Parameters
macAddress
Mandatory parameter. Mac Address is specified using format xx:xx:xx:xx:xx:xx where xx is a hex digit.
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E01018: Invalid Mac Address
E02001: No SS with this Mac Address exists.
7.1.1.8 GetSSProvisioningConfig
Method GetSSProvisioningConfig( string macAddress)
Description Get the standard Provisioning parameters, (as defined in 802.16f), that are configured for the specified SS.
Parameters
macAddress
Mandatory parameter. Mac Address is specified using format xx:xx:xx:xx:xx:xx where xx is a hex digit.
Returns
SSProvisioningConfig
Properties:
MacAddress
Service Product Name
Home Sector BSID
SS Description1
SS Description2
SS Description3
SS Description4
SS Description5
7.1.1.9 GetSSCustomProvisioningConfig
Method GetSSCustomProvisioningConfig( string macAddress)
Description Get the Provisioning parameters, (those defined in 802.16f and proprietary custom extensions), that are configured for the specified SS.
Northbound Interface User Guide – SR 6.5
Page 41 Commercial in Confidence UGD-D00022 Rev A
Parameters
macAddress
Mandatory parameter. Mac Address is specified using format xx:xx:xx:xx:xx:xx where xx is a hex digit.
Return
SSCustomProvisioningConfig
Properties:
MacAddress
Service Product Name
Home Sector BSID
VlanList (integer array of Vlan IDs of Vlans the SS is a member of)
CustomConfigName
SS Description1
SS Description2
SS Description3
SS Description4
SS Description5
7.1.1.10 GetProvisioningStatus
Method GetProvisioningStatus( string macAddress)
Description Gets the status of the provisioning for this SS on every Sector it has recently registered on. If the SS has not recently registered on any Sector, returns an empty array.
Parameters
macAddress
Mandatory parameter. Mac Address is specified using format xx:xx:xx:xx:xx:xx where xx is a hex digit.
Returns Array of
SSProvisioningStatus
(1 per Sector recently registered with).
Properties:
BS Name
BS IP Address
BS Id of Sector
NMS-BS ConnectionState
ProvisioningState
RegistrationState
Time first detected on this Sector
Time last detected on this Sector
Stats on pending configuration changes for this SS on the given sector. Stats are:
Total changes
New (unprocessed) changes
In Progress changes (SNM P changes being built
Northbound Interface User Guide – SR 6.5
Page 42 Commercial in Confidence UGD-D00022 Rev A
by Provisioning Service.
AwaitingResponse changes (SNMP changes sent to Job Service for transmission but no response received at Provisioning Service).
Queued (stored in Provisioning Service for dispatch to the Job Service).
Failed Changes which have received a NACK from the BS.
7.1.1.11 ProvisionCustomSSV2
This is a new method in SR5.0.
Method ProvisionCustomSSV2(string macAddress, string serviceProductName, string homeSectorBSID, string customConfigName, string vlanPortProfileName)
Description Provision an SS within the NMS with the specified provisioning properties. The Provisioning parameters include those permitted in 802.16f and additional proprietary custom quantities. If the SS does not already exist in the NMS, it is created, otherwise the existing SS is updated.
Northbound Interface User Guide – SR 6.5
Page 43 Commercial in Confidence UGD-D00022 Rev A
Parameters
string macAddress
string serviceProductName
string homeSectorBSID
string customConfigName
string vlanPortProfileName
Mandatory parameter. Mac Address is specified using format xx:xx:xx:xx:xx:xx where x is a hex digit.
Mandatory parameter. The name of an existing Service product within the NMS
Optional parameter. BSID is of the format xxxxxx:xxxxxx where x is a hex digit. Must identify an existing Sector in the NMS.
Optional parameter. The name of an existing SS Custom Configuration within the NMS. If no name is specified then the NMS must have a default SS Custom Configuration configured.
Optional parameter. The name of an existing SS Vlan Port Profile within the NMS. If no name is specified then the NMS must have a default SS Vlan Port Profile configured.
Northbound Interface User Guide – SR 6.5
Page 44 Commercial in Confidence UGD-D00022 Rev A
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E01018: Invalid Mac Address
E02002: Invalid BS Id. Please supply a string of format xxxxxx:xxxxxx where x is a hex digit.
E02003: No Sector exists with the supplied BS Id
E02004: A Service Product name must be supplied for this service
E02005: No Service Product exists with the supplied name
E02006: No SS Custom Config exists with the supplied name.
E02010: If no SS Custom Configuration is supplied, then a default SS Custom Configuration must be configured in the NMS.
E02017: If no SS Vlan Port Profile is supplied, then a default SS Vlan Port Profile must be configured in the NMS.
E02016: No SS Vlan Port Profile exists with this name..
7.1.1.12 GetSSCustomProvisioningConfigV2
This is a new method in SR5.0.
Method GetSSCustomProvisioningConfigV2( string macAddress)
Description Get the Provisioning parameters, (those defined in 802.16f and proprietary custom extensions), that are configured for the specified SS.
Parameters
Mandatory parameter. Mac Address is specified
Northbound Interface User Guide – SR 6.5
Page 45 Commercial in Confidence UGD-D00022 Rev A
macAddress using format xx:xx:xx:xx:xx:xx where xx is a hex digit.
Return
SSCustomProvisioningConfig
Properties:
MacAddress
Service Product Name
Home Sector BSID
CustomConfigName
VlanPortProfileName
Description1
Description2
Description3
Description4
Description5
7.1.2 ServiceProfiles
7.1.2.1 GetServiceProductList
Method GetServiceProductList()
Description Produces a list of the names of the Service Products configured in the NMS
Parameters
None
Returns
Array of ServiceProductDetails
Properties:
Name
Description
7.1.2.2 GetSSCustomConfigList
Method GetSSCustomConfigList()
Description Produces a list of the names of the SS Custom configurations configured in the NMS
Northbound Interface User Guide – SR 6.5
Page 46 Commercial in Confidence UGD-D00022 Rev A
Parameters
None
Returns
Array of CustomConfigDetails
Properties:
Name
Description
7.1.2.3 GetVlanList
Method GetVlanList()
Description Produces a list of the Vlans configured in the NMS
Parameters
None
Returns
Array of VlanDetails
Properties:
Name
Vlan ID
7.1.2.4 GetGlobalConfig
Method GetGlobalConfig()
Description Retrieves the default global profiles configured in the NMS for the SSs..
Parameters
None
Returns Properties:
Northbound Interface User Guide – SR 6.5
Page 47 Commercial in Confidence UGD-D00022 Rev A
GlobalConfigDetails
ServiceProductName
CustomConfigName
Vlan ID
7.1.2.5 GetSSVlanPortProfileList
This is a new method in SR5.0.
Method GetSSVlanPortProfileList()
Description Produces a list of the SS Vlan Port Profiles configured in the NMS.
Parameters
None
Returns
Array of VlanPortProfileDetails
Properties:
Name
Description
7.1.2.6 GetGlobalConfigV2
This is a new method in SR5.0.
Method GetGlobalConfigV2()
Description Retrieves the extended set of default global profiles configured in the NMS for the SSs..
Parameters
None
Returns Properties:
Northbound Interface User Guide – SR 6.5
Page 48 Commercial in Confidence UGD-D00022 Rev A
GlobalConfigDetails
ServiceProductName
CustomConfigName
VlanPortProfileName
7.1.3 Inventory
7.1.3.1 BSSectorList
Method BSSectorList
Description Produces a list of existing Base Station TRx Channel list names from NMS
Parameters
None
Returns
Array of BSSectorDetails
Properties:
Channel Name
Channel BSID
7.1.4 ServiceProduct
7.1.4.1 Service Product List
Method ServiceProductList()
Description Produces a list of the names of Service Products configured in NMS
Parameters
None
Returns
Array of
Properties:
Name
Description
Northbound Interface User Guide – SR 6.5
Page 49 Commercial in Confidence UGD-D00022 Rev A
ServiceProductDetails
7.1.4.2 Service Product Create
Method ServiceProductCreate(string serviceProductName)
Description Creates a Service Product with no service flows
Parameters
serviceProductName
Mandatory parameter. The name of the new Service Product to create
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02037: WSServiceProductNameEmpty
E02019:WSServiceProductAlreadyExists
7.1.4.3 Service Product Delete
Method ServiceProductDelete(string serviceProductName)
Description Deletes an existing Service Product
Parameters
serviceProductName
Mandatory parameter. The name of the new Service Product to create
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
Northbound Interface User Guide – SR 6.5
Page 50 Commercial in Confidence UGD-D00022 Rev A
E02014: WSWebServiceDisabled
E02037: WSServiceProductNameEmpty
E02018: WSServiceProductDoesNotExist
E02020: WSCannotDeleteServiceProductInUse
7.1.4.4 Service Flow Template List
Method ServiceFlowTemplateList(string serviceProductName)
Description Produces a list of Service Flow Template names for the specified Service product name in NMS
Parameters
serviceProductName
Mandatory parameter. The name of the new Service Product
Returns
Array of ServiceFlowTemplateDetails
Properties:
Name
Description
7.1.4.5 Service Flow Template Get
Method ServiceFlowTemplateGet(string serviceProductName, string serviceFlowTemplateDescription)
Description Gets a Service Flow Template configuration from the NMS for the specified Service Product and Service Flow Template
Parameters
serviceProductName
Mandatory parameter. The name of the Service product
Mandatory parameter. The name of the Service Flow
Northbound Interface User Guide – SR 6.5
Page 51 Commercial in Confidence UGD-D00022 Rev A
serviceFlowTemplateDescription Template description
Return
ServiceFlowTemplateConfig
Properties:
ServiceProductName
ServiceFlowTemplateDescription
Direction
ServiceClassName
InitialState
ConvergenceSublayerType
(to get Service Flow Template Classifier List use ServiceFlowTemplateClassifiersList)
7.1.4.6 Service Flow Template Create
Method ServiceFlowTemplateCreate(ServiceFlowTemplateConfig serviceFlowTemplateConfig)
Description Creates a Service Flow Template in a Service Product with the specified parameters.
Parameters
ServiceFlowTemplateConfig
Mandatory parameter. ServiceProductName
Mandatory parameter. ServiceFlowTemplateDescription
Mandatory parameter. Direction
Mandatory parameter. ServiceClassName
Mandatory parameter. InitialState
Mandatory parameter. ConvergenceSublayerType
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02039: WSServiceClassNameEmpty
E02038: WSServiceFlowTemplateDescriptionEmpty
Northbound Interface User Guide – SR 6.5
Page 52 Commercial in Confidence UGD-D00022 Rev A
E02037: WSServiceProductNameEmpty
E02025: WSServiceClassDoesNotExist
E02023: WSServiceFlowTemplateAlreadyExists
E02021: WSServiceProductInUse
E02018: WSServiceProductDoesNotExist
7.1.4.7 Service Flow Template Delete
Method ServiceFlowTemplateDelete(string serviceProductName, string serviceFlowTemplateDescription)
Description Deletes an existing Service Flow Template from the specified Service Product
Parameters
serviceProductName
serviceFlowTemplateDescription
Mandatory parameter. The name of the Service Product
Mandatory parameter. The name of the Service Flow Template description
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02022: WSServiceFlowTemplateDoesNotExist
E02021: WSServiceProductInUse
E02018: WSServiceProductDoesNotExist
E02038: WSServiceFlowTemplateDescriptionEmpty
E02037: WSServiceProductNameEmpty
Northbound Interface User Guide – SR 6.5
Page 53 Commercial in Confidence UGD-D00022 Rev A
7.1.4.8 Service Flow Template Update
Method ServiceFlowTemplateUpdate(ServiceFlowTemplateConfig serviceFlowTemplateConfig)
Description Updates an existing Service Flow Template in the specified Service Product with the specified parameters
Parameters
ServiceFlowTemplateConfig
Mandatory parameter. ServiceProductName
Mandatory parameter. ServiceFlowTemplateDescription
Mandatory parameter. Direction
Mandatory parameter. ServiceClassName
Mandatory parameter. InitialState
Mandatory parameter. ConvergenceSublayerType
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02039: WSServiceClassNameEmpty
E02038: WSServiceFlowTemplateDescriptionEmpty
E02037: WSServiceProductNameEmpty
E02018: WSServiceProductDoesNotExist
E02021: WSServiceProductInUse
E02022: WSServiceFlowTemplateDoesNotExist
E02025: WSServiceClassDoesNotExist
7.1.4.9 Service Flow Template Classifiers List
Method ServiceFlowTemplateClassifiersList(string serviceProductName, string
Northbound Interface User Guide – SR 6.5
Page 54 Commercial in Confidence UGD-D00022 Rev A
serviceFlowTemplateDescription)
Description Produces a list of Classifier names for an existing Service Flow Template in the specified Service Product.
Parameters
serviceProductName
serviceFlowTemplateDescription
Mandatory parameter. The name of the Service Product
Mandatory parameter. The name of the Service Flow Template description
Returns
Array of ServiceFlowTemplateClassifierDetails
Properties:
Name
7.1.4.10 Service Flow Template Classifiers Clear
Method ServiceFlowTemplateClassifiersClear(string serviceProductName, string serviceFlowTemplateDescription)
Description Clears all the PacketClassifier from an existing Service Flow Template in the specified Service Product.
Parameters
serviceProductName
serviceFlowTemplateDescription
Mandatory parameter. The name of the Service Product
Mandatory parameter. The name of the Service Flow Template description
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02021: WSServiceProductInUse
E02038: WSServiceFlowTemplateDescriptionEmpty
Northbound Interface User Guide – SR 6.5
Page 55 Commercial in Confidence UGD-D00022 Rev A
E02037: WSServiceProductNameEmpty
E02018: WSServiceProductDoesNotExist
E02022: WSServiceFlowTemplateDoesNotExist
E02028: WSPacketClassifierDoesNotExist
7.1.4.11 Service Flow Template Classifiers Add
Method ServiceFlowTemplateClassifiersAdd(string serviceProductName, string serviceFlowTemplateDescription, string packetClassifierName)
Description Adds an existing Packet Classifier to and existing Service Flow Template in the specified Service Product
Parameters
serviceProductName
serviceFlowTemplateDescription
packetClassifierName
Mandatory parameter. The name of the Service Product
Mandatory parameter. The name of the Service Flow Template description
Mandatory parameter. The name of the Packet Classifier
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02038: WSServiceFlowTemplateDescriptionEmpty
E02037: WSServiceProductNameEmpty
E02040: WSPacketClassifierNameEmpty
E02021: WSServiceProductInUse
E02018: WSServiceProductDoesNotExist
E02022: WSServiceFlowTemplateDoesNotExist
Northbound Interface User Guide – SR 6.5
Page 56 Commercial in Confidence UGD-D00022 Rev A
E02028: WSPacketClassifierDoesNotExist
E02029: WSPacketClassifierAlreadyExists
7.1.4.12 Service Flow Template Classifiers Remove
Method ServiceFlowTemplateClassifiersRemove(string serviceProductName, string serviceFlowTemplateDescription, string packetClassifierName)
Description Removes existing Packet Classifier from a Service Flow Template in the specified Service Product.
Parameters
serviceProductName
serviceFlowTemplateDescription
packetClassifierName
Mandatory parameter. The name of the Service product
Mandatory parameter. The name of the Service Flow Template description
Mandatory parameter. The name of the Packet Classifier
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02038: WSServiceFlowTemplateDescriptionEmpty
E02037: WSServiceProductNameEmpty
E02040: WSPacketClassifierNameEmpty
E02021: WSServiceProductInUse
E02018: WSServiceProductDoesNotExist
E02022: WSServiceFlowTemplateDoesNotExist
Northbound Interface User Guide – SR 6.5
Page 57 Commercial in Confidence UGD-D00022 Rev A
E02028: WSPacketClassifierDoesNotExist
7.1.5 ServiceClass
7.1.5.1 Service Class List
Method ServiceClassList ()
Description Produces a list of Service Class names configured in NMS
Parameters None
Returns
Array of ServiceClassDetails
Properties:
Name
7.1.5.2 Get Service Class
Method ServiceClassGet(string serviceClassName)
Description Gets the configuration of the specified Service Class
Parameters
serviceClassName
Mandatory parameter. The name of the Service Class
Return
ServiceClassConfig
Properties:
Name
SchedulingType
TrafficPriority
ReqTxPolicyBroadcastBWReqOn
ReqTxPolicyPiggybackReqOn
ReqTxPolicyFragmentationOn
ReqTxPolicyPHSOn
Northbound Interface User Guide – SR 6.5
Page 58 Commercial in Confidence UGD-D00022 Rev A
ReqTxPolicySDUPackingOn
ReqTxPolicyCRCOn
MaxSustainedRate
MaxTrafficBurst
MinReservedRate
MinRsvdTolerableRate
ToleratedJitter
MaxLatency
FixedVsVariableSduInd
SduSize
ExtPollPeriod
ARQ (s not supported by hardware category: MicroMAX. The configuration system will not set ARQ objects on targets of this type.)
ArqEnable
ArqWindowSize
ArqFragmentLifetime
ArqSyncLossTimeout
ArqDeliverInOrder
ArqRxPurgeTimeout
ArqBlockSize
7.1.5.3 Create Service Class
Method ServiceClassCreate(ServiceClassConfig)
Description Creates a new Service Class with the specified parameters passed.
Parameters
ServiceClassConfig
Mandatory parameter. Name
Mandatory parameter. SchedulingType
Mandatory parameter. TrafficPriority
Mandatory parameter. ReqTxPolicyBroadcastBWReqOn
Mandatory parameter. ReqTxPolicyPiggybackReqOn
Northbound Interface User Guide – SR 6.5
Page 59 Commercial in Confidence UGD-D00022 Rev A
Mandatory parameter. ReqTxPolicyFragmentationOn
Mandatory parameter. ReqTxPolicyPHSOn
Mandatory parameter. ReqTxPolicySDUPackingOn
Mandatory parameter. ReqTxPolicyCRCOn
Mandatory parameter. MaxSustainedRate
Mandatory parameter. MaxTrafficBurst
Mandatory parameter. MinReservedRate
Mandatory parameter. MinRsvdTolerableRate
Mandatory parameter. ToleratedJitter
Mandatory parameter. MaxLatency
Mandatory parameter. FixedVsVariableSduInd
Mandatory parameter. SduSize
Mandatory parameter. ExtPollPeriod
ARQ (s not supported by hardware category: MicroMAX. The configuration system will not set ARQ objects on targets of this type.)
Mandatory parameter. ArqEnable
Mandatory parameter. ArqWindowSize
Mandatory parameter. ArqFragmentLifetime
Mandatory parameter. ArqSyncLossTimeout
Mandatory parameter. ArqDeliverInOrder
Mandatory parameter. ArqRxPurgeTimeout
Mandatory parameter. ArqBlockSize
Return Values E00000: No Error
Northbound Interface User Guide – SR 6.5
Page 60 Commercial in Confidence UGD-D00022 Rev A
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02039: WSServiceClassNameEmpty
E02026: WSServiceClassAlreadyExists
7.1.5.4 Delete Service Class
Method ServiceClassDelete(string serviceClassName)
Description Removes existing Service Class in NMS
Parameters
serviceClassName
Mandatory parameter. The name of the Service Class
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02039: WSServiceClassNameEmpty
E02025: WSServiceClassDoesNotExist
7.1.5.5 Update Service Class
Method ServiceClassUpdate(ServiceClassConfig)
Description Updates an existing Service Class in NMS with the parameters passed
Parameters
ServiceClassConfig
Mandatory parameter. Name
Northbound Interface User Guide – SR 6.5
Page 61 Commercial in Confidence UGD-D00022 Rev A
Mandatory parameter. SchedulingType
Mandatory parameter. TrafficPriority
Mandatory parameter. ReqTxPolicyBroadcastBWReqOn
Mandatory parameter. ReqTxPolicyPiggybackReqOn
Mandatory parameter. ReqTxPolicyFragmentationOn
Mandatory parameter. ReqTxPolicyPHSOn
Mandatory parameter. ReqTxPolicySDUPackingOn
Mandatory parameter. ReqTxPolicyCRCOn
Mandatory parameter. MaxSustainedRate
Mandatory parameter. MaxTrafficBurst
Mandatory parameter. MinReservedRate
Mandatory parameter. MinRsvdTolerableRate
Mandatory parameter. ToleratedJitter
Mandatory parameter. MaxLatency
Mandatory parameter. FixedVsVariableSduInd
Mandatory parameter. SduSize
Mandatory parameter. ExtPollPeriod
ARQ (s not supported by hardware category: MicroMAX. The configuration system will not set ARQ objects on targets of this type.)
Mandatory parameter. ArqEnable
Mandatory parameter. ArqWindowSize
Mandatory parameter. ArqFragmentLifetime
Mandatory parameter. ArqSyncLossTimeout
Northbound Interface User Guide – SR 6.5
Page 62 Commercial in Confidence UGD-D00022 Rev A
Mandatory parameter. ArqDeliverInOrder
Mandatory parameter. ArqRxPurgeTimeout
Mandatory parameter. ArqBlockSize
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02039: WSServiceClassNameEmpty
E02025: WSServiceClassDoesNotExist
7.1.6 Packet Classifier
7.1.6.1 Packet Classifier List
Method PacketClassifierList()
Description Produces the list of existing Packet Classifier names configured in NMS
Parameters None
Returns
Array of PacketClassifierDetails
Properties:
Name
7.1.6.2 Get Packet Classifier
Method PacketClassifierGet(string packetClassifierName)
Description Get the configuration of the specified Packet Classifier in NMS
Northbound Interface User Guide – SR 6.5
Page 63 Commercial in Confidence UGD-D00022 Rev A
Parameters
packetClassifierName
Mandatory parameter. The name of the Packet Classifier
Return
PacketClassifierConfig
Properties:
Name
Priority
Action L3 Rules
IpTosLow
IpTosHigh
IpTosMask
IpProtocol
IpAddressType
IpSourceAddress
IpSourceMask
IpDestAddress
IpDestMask
SourcePortStart
SourcePortEnd
DestPortStart
DestPortEnd L2 Rules
SourceMacAddress
SourceMacMask
DestMacAddress
DestMacMask
EnetProtocolIDType
EnetProtocolID
VlanId
UserPriLow
UserPriHigh Payload header Suppression
PhsSize
PhsMask
PhsVerify VLAN Tagging
Dot1QtagEnabled
Dot1QtagVlanId
Dot1QTagPriority
Northbound Interface User Guide – SR 6.5
Page 64 Commercial in Confidence UGD-D00022 Rev A
7.1.6.3 Create Packet Classifier
Method PacketClassifierCreate(PacketClassifierConfig packetClassifierConfig)
Description Creates a new Packet Classifier in the NMS
Parameters
PacketClassifierConfig
Mandatory parameter. Name
Mandatory parameter. NPriority
Mandatory parameter. NAction
L3 Rules
Mandatory parameter. NIpTosLow
Mandatory parameter. NIpTosHigh
Mandatory parameter. NIpTosMask
Mandatory parameter. NIpProtocol
Mandatory parameter. NIpAddressType
Mandatory parameter. NIpSourceAddress
Mandatory parameter. NIpSourceMask
Mandatory parameter. NIpDestAddress
Mandatory parameter. NIpDestMask
Mandatory parameter. NSourcePortStart
Mandatory parameter. NSourcePortEnd
Mandatory parameter. NDestPortStart
Mandatory parameter. NDestPortEnd
L2 Rules
Mandatory parameter. NSourceMacAddress
Northbound Interface User Guide – SR 6.5
Page 65 Commercial in Confidence UGD-D00022 Rev A
Mandatory parameter. NSourceMacMask
Mandatory parameter. NDestMacAddress
Mandatory parameter. NDestMacMask
Mandatory parameter. NEnetProtocolIDType
Mandatory parameter. NEnetProtocolID
Mandatory parameter. NVlanId
Mandatory parameter. NUserPriLow
Mandatory parameter. NUserPriHigh
Payload header Suppression
Mandatory parameter. NPhsSize
Mandatory parameter. NPhsMask
Mandatory parameter. NPhsVerify
VLAN Tagging
Mandatory parameter. NDot1QtagEnabled
Mandatory parameter. NDot1QtagVlanId
Mandatory parameter. NDot1QTagPriority
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02040: WSPacketClassifierNameEmpty
E02029: WSPacketClassifierAlreadyExists
7.1.6.4 Delete Packet Classifier
Method PacketClassifierDelete(string packetClassifierName)
Northbound Interface User Guide – SR 6.5
Page 66 Commercial in Confidence UGD-D00022 Rev A
Description Removes an existing Packet Classifier in NMS
Parameters
packetClassifierName
Mandatory parameter. The name of the Packet Classifier
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02040: WSPacketClassifierNameEmpty
E02028: WSPacketClassifierDoesNotExist
7.1.6.5 Update Packet Classifier
Method PacketClassifierUpdate(PacketClassifierConfig packetClassifierConfig)
Description Updates an existing Packet Classifier in the NMS with the parameters passed
Parameters
PacketClassifierConfig
Mandatory parameter. Name
Mandatory parameter. NPriority
Mandatory parameter. NAction
L3 Rules
Mandatory parameter. NIpTosLow
Mandatory parameter. NIpTosHigh
Mandatory parameter. NIpTosMask
Northbound Interface User Guide – SR 6.5
Page 67 Commercial in Confidence UGD-D00022 Rev A
Mandatory parameter. NIpProtocol
Mandatory parameter. NIpAddressType
Mandatory parameter. NIpSourceAddress
Mandatory parameter. NIpSourceMask
Mandatory parameter. NIpDestAddress
Mandatory parameter. NIpDestMask
Mandatory parameter. NSourcePortStart
Mandatory parameter. NSourcePortEnd
Mandatory parameter. NDestPortStart
Mandatory parameter. NDestPortEnd
L2 Rules
Mandatory parameter. NSourceMacAddress
Mandatory parameter. NSourceMacMask
Mandatory parameter. NDestMacAddress
Mandatory parameter. NDestMacMask
Mandatory parameter. NEnetProtocolIDType
Mandatory parameter. NEnetProtocolID
Mandatory parameter. NVlanId
Mandatory parameter. NUserPriLow
Mandatory parameter. NUserPriHigh
Payload header Suppression
Mandatory parameter. NPhsSize
Mandatory parameter. NPhsMask
Mandatory parameter. NPhsVerify
VLAN Tagging
Northbound Interface User Guide – SR 6.5
Page 68 Commercial in Confidence UGD-D00022 Rev A
Mandatory parameter. NDot1QtagEnabled
Mandatory parameter. NDot1QtagVlanId
Mandatory parameter. NDot1QTagPriority
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02040: WSPacketClassifierNameEmpty
E02028: WSPacketClassifierDoesNotExist
7.1.7 VirtualLan
7.1.7.1 VlanList
Method VlanList ()
Description Produces a list of VLANs configured in NMS
Parameters
None
Returns
Array of VlanDetails
Properties:
Name
Vlan ID
7.1.7.2 Get Vlan
Method VlanGet(string vlanName)
Description Gets VLAN configuration of the specified VLAN Name in NMS
Parameters
Northbound Interface User Guide – SR 6.5
Page 69 Commercial in Confidence UGD-D00022 Rev A
vLANName Mandatory parameter. The name of the VLAN to get
Returns
VlanConfig
Properties:
Name
VlanID
Description
DHCPRelayAgentActive
SingleUser
MACForcedForwarding
MACForceForwardIPAddress
BroadcastServiceClassName
AddToEveryBsPortListOnCreate
7.1.7.3 Create Vlan
Method VlanCreate(VlanConfig vlanConfig)
Description Creates a new VLAN in the NMS
Parameters
VlanConfig
Mandatory parameter. Name
Mandatory parameter. VlanID
Mandatory parameter. Description
Mandatory parameter. DHCPRelayAgentActive
Mandatory parameter. SingleUser
Mandatory parameter. MACForcedForwarding
Mandatory parameter. MACForcForwardIPAddress
Mandatory parameter. BroadcastServiceClassName
Mandatory parameter. AddToEveryBsPortListOnCreate
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
Northbound Interface User Guide – SR 6.5
Page 70 Commercial in Confidence UGD-D00022 Rev A
E02014: WSWebServiceDisabled
E02040: WSVlanNameEmpty
E02043: WSParameterEmpty
E02032: WSVlanAlreadyExists
E02025: WSServiceClassDoesNotExist
7.1.7.4 Delete Vlan
Method VLANDelete(string vLANName)
Description Deletes an existing VLAN in NMS
Parameters
vlanName
Name of VLAN to delete
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02040: WSVlanNameEmpty
E02031: WSVlanDoesNotExist
7.1.7.5 Update Vlan
Method VlanUpdate(VlanConfig vlanConfig)
Description Updates an existing VLAN with new parameters specified
Parameters
VlanConfig
Mandatory parameter. Name
Northbound Interface User Guide – SR 6.5
Page 71 Commercial in Confidence UGD-D00022 Rev A
Mandatory parameter. VlanID
Mandatory parameter. Description
Mandatory parameter. DHCPRelayAgentActive
Mandatory parameter. SingleUser
Mandatory parameter. MACForcedForwarding
Mandatory parameter. MACForcForwardIPAddress
Mandatory parameter. BroadcastServiceClassName
Mandatory parameter. AddToEveryBsPortListOnCreate
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02040: WSVlanNameEmpty
E02043: WSParameterEmpty
E02031: WSVlanDoesNotExist
E02025: WSServiceClassDoesNotExist
7.1.8 SSVlanPortProfile
7.1.8.1 SS Vlan Port Profile List
Method SSVlanPortProfileList()
Description Produces a list of the SS VLAN Port Profiles configured in the NMS.
Parameters
None
Northbound Interface User Guide – SR 6.5
Page 72 Commercial in Confidence UGD-D00022 Rev A
Returns
Array of VlanPortProfileDetails
Properties:
Name
Description
7.1.8.2 Get SS Vlan Port Profile
Method SSVlanPortProfileGet(string ssVlanPortProfileName)
Description Gets the configuration of an existing SS VLAN Port Profile in NMS
Parameters
ssVLANPortProfileName
Mandatory parameter. The name of the SS VLAN Port Profile to get
Returns
VlanPortProfileConfig
Properties:
Name
Description
PortMode
AllowedFrameType
PortVlanIDName
IngressFilterEnabled
DeafultPriority
To get the Port VLAN list in SS VLAN Port Profiles use SSVlanPortProfileVLANsList()
7.1.8.3 Create SS Vlan Port Profile
Method SSVlanPortProfileCreate(VlanPortProfileConfig vlanPortProfileConfig )
Northbound Interface User Guide – SR 6.5
Page 73 Commercial in Confidence UGD-D00022 Rev A
Description Creates a new SS VLAN Port Profile in NMS with the specified parameters
Parameters
VlanPortProfileConfig
Properties:
Mandatory parameter. Name
Mandatory parameter. Description
Mandatory parameter. PortMode
Mandatory parameter. AllowedFrameType
Mandatory parameter. PortVlanIDName
Mandatory parameter. IngressFilterEnabled
Mandatory parameter. DeafultPriority
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02043: WSParameterEmpty
E02042: WSSSVLANPortProfileNameEmpty
E02035: WSSSVlanPortProfileAlreadyExists
E02041: WSVlanNameEmpty
E02031: WSVlanDoesNotExist
7.1.8.4 Delete SS Vlan Port Profile
Method SSVlanPortProfileDelete(string ssVlanPortProfileName)
Description Deletes an existing SS VLAN Port Profile in NMS
Parameters
Northbound Interface User Guide – SR 6.5
Page 74 Commercial in Confidence UGD-D00022 Rev A
ssVlanPortProfileName Name of SS VLAN Port Profile to delete
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02042: WSSSVLANPortProfileNameEmpty
E02034: WSSSVlanPortProfileDoesNotExist
7.1.8.5 Update SS Vlan Port Profile
Method SSVlanPortProfileUpdate(VlanPortProfileConfig vlanPortProfileConfig)
Description Update an existing SS VLAN Port Profile in the NMS
Parameters
VlanPortProfileConfig
Properties:
Mandatory parameter. Name
Mandatory parameter. Description
Mandatory parameter. PortMode
Mandatory parameter. AllowedFrameType
Mandatory parameter. PortVlanIDName
Mandatory parameter. IngressFilterEnabled
Mandatory parameter. DeafultPriority
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02043: WSParameterEmpty
Northbound Interface User Guide – SR 6.5
Page 75 Commercial in Confidence UGD-D00022 Rev A
E02042: WSSSVLANPortProfileNameEmpty
E02034: WSSSVlanPortProfileDoesNotExist
E02041: WSVlanNameEmpty
E02031: WSVlanDoesNotExist
7.1.8.6 SS Vlan Port Profile Vlans List
Method SSVlanPortProfileVlansList(string ssVlanPortProfileName)
Description Gets a list of VLANs in an existing SS VLAN Port Profile in the NMS
Parameters
ssVlanPortProfileName
Name of SS VLAN Port Profile
Returns
Array of VlanDetails
Properties:
Name
VlanID
7.1.8.7 Clear SS Vlan Port Profile Vlans
Method SSVLANPortProfileVLANsClear(string ssVLANPortProfileName)
Description Clears all VLANs from and existing SS VLAN Port Profile in the NMS
Parameters
ssVlanPortProfileName
Name of SS VLAN Port Profile
Return Values E00000: No Error
Northbound Interface User Guide – SR 6.5
Page 76 Commercial in Confidence UGD-D00022 Rev A
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02042: WSSSVLANPortProfileNameEmpty
E02034: WSSSVlanPortProfileDoesNotExist
7.1.8.8 Add SS Vlan Port Profile Vlans
Method SSVlanPortProfileVlansAdd(string ssVlanPortProfileName, string vlanName)
Description Adds an existing VLAN to an existing SS VLAN PORT Profile in the NMS
Parameters
ssVlanPortProfileName
vlanName
Name of SS VLAN Port Profile
Name of VLAN
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02042: WSSSVLANPortProfileNameEmpty
E02034: WSSSVlanPortProfileDoesNotExist
E02041: WSVlanNameEmpty
E02031: WSVlanDoesNotExist
Northbound Interface User Guide – SR 6.5
Page 77 Commercial in Confidence UGD-D00022 Rev A
7.1.8.9 Remove SS Vlan Port Profile Vlans
Method SSVlanPortProfileVlansRemove(string ssVlanPortProfileName, string vlanName)
Description Removes an existing VLAN from and existing SS VLAN Port Profile in NMS
Parameters
ssVlanPortProfileName
vlanName
Name of SS VLAN Port Profile
Name of VLAN to remove
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02042: WSSSVLANPortProfileNameEmpty
E02034: WSSSVlanPortProfileDoesNotExist
E02041: WSVlanNameEmpty
E02031: WSVlanDoesNotExist
Northbound Interface User Guide – SR 6.5
Page 78 Commercial in Confidence UGD-D00022 Rev A
7.1.9 Fault Management
7.1.9.1 AlarmList
Method AlarmList
Description Produces a list of active alarms in the NMS. Returns a null if no Alarm is found.
Parameters None
Returns
Array of Alarm
Properties:
AlarmID
AlarmType
AlarmSource
AlarmInfo
Severity
LastReceived
AlarmCount
Acknowledged
LastAcknowledged
UserName
7.1.9.2 AlarmDetailsGet
Method AlarmDetailsGet(decimal alarmID)
Description Gets detail information on an active Alarm with alarmID that exist in the NMS. Returns an error if the alarmID does not already exist.
Parameters
alarmID
Mandatory parameter. The alarmID
Northbound Interface User Guide – SR 6.5
Page 79 Commercial in Confidence UGD-D00022 Rev A
Method AlarmDetailsGet(decimal alarmID)
Returns
AlarmDetails
Properties:
AlarmID
AlarmType
AlarmSource
AlarmInfo
Comment
Severity
FirstReceived
LastReceived
AlarmCount
RaiseCount
Acknowledged
UserName
ITUEventType
ProbableCause
Description
UserDescription
7.1.9.3 AlarmAcknowledge
Method AlarmAcknowledge(decimal alarmID)
Description Acknowledges an existing active Alarm with alarmID that exist in the NMS. Returns an error if the alarmID does not already exist.
Parameters
alarmID
Mandatory parameter. The alarmID
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02044: WSInvalidAlarmID
E02035: WSUnknownAlarmID
Northbound Interface User Guide – SR 6.5
Page 80 Commercial in Confidence UGD-D00022 Rev A
7.1.9.4 AlarmRelease
Method AlarmRelease(decimal alarmID)
Description Releases an existing active Alarm with alarmID that exist in the NMS. Returns an error if the alarmID does not already exist.
Parameters
alarmID
Mandatory parameter. The alarmID
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02044: WSInvalidAlarmID
E02035: WSUnknownAlarmID
7.1.9.5 AlarmDelete
Method AlarmDelete(decimal alarmID)
Description Deletes an existing active Alarm with alarmID that exist in the NMS. Returns an error if the alarmID does not already exist.
Parameters
alarmID
Mandatory parameter. The alarmID
Northbound Interface User Guide – SR 6.5
Page 81 Commercial in Confidence UGD-D00022 Rev A
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02044: WSInvalidAlarmID
E02035: WSUnknownAlarmID
7.1.9.6 AlarmDetailsCommentAppend
Method AlarmDetailsCommentAppend(decimal alarmID, string comment)
Description Appends a comment on an existing active Alarm with alarmID that exist in the NMS. Returns an error if the alarmID does not already exist.
Parameters
alarmID
comment
Mandatory parameter. The alarmID
Mandatory parameter. The comment
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02044: WSInvalidAlarmID
E02035: WSUnknownAlarmID
7.1.9.7 AlarmDetailsCommentSet
Method AlarmDetailsCommentSet(decimal alarmID, string comment)
Northbound Interface User Guide – SR 6.5
Page 82 Commercial in Confidence UGD-D00022 Rev A
Method AlarmDetailsCommentSet(decimal alarmID, string comment)
Description Sets comment on an existing active Alarm with alarmID that exist in the NMS. Returns an error if the alarmID does not already exist.
Parameters
alarmID
comment
Mandatory parameter. The alarmID
Mandatory parameter. The comment
Return Values
E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02044: WSInvalidAlarmID
E02035: WSUnknownAlarmID
7.1.9.8 AlarmListChanged
Method AlarmListChanged(string lastChangedTime)
Description Produces a list of active alarms changed since lastChangedTime in the NMS. Returns null if no Alarm is found.
Parameters
lastChangedTime
Mandatory parameter. The lastChangedTime
Returns
Array of Alarm
Properties:
AlarmID
AlarmType
AlarmSource
AlarmInfo
Severity
LastReceived
AlarmCount
Acknowledged
LastAcknowledged
UserName
Northbound Interface User Guide – SR 6.5
Page 83 Commercial in Confidence UGD-D00022 Rev A
7.1.9.9 AlarmListForBSDU
Method AlarmListForBSDU(string macAddress)
Description Produces a list of active alarms for the specified BSDU macAddress in the NMS. Returns null if no Alarm is found.
Parameters
macAddress
Mandatory parameter. The macAddress
Returns
Array of Alarm
Properties:
AlarmID
AlarmType
AlarmSource
AlarmInfo
Severity
LastReceived
AlarmCount
Acknowledged
LastAcknowledged
UserName
7.1.9.10 AlarmListForBSTRx
Method AlarmListForBSTRx(string BSID)
Description Produces a list of active alarms for the specified BSID in the NMS. Returns null if no Alarm is found.
Parameters
BSID
Mandatory parameter. The BSID
Northbound Interface User Guide – SR 6.5
Page 84 Commercial in Confidence UGD-D00022 Rev A
Method AlarmListForBSTRx(string BSID)
Returns
Array of Alarm
Properties:
AlarmID
AlarmType
AlarmSource
AlarmInfo
Severity
LastReceived
AlarmCount
Acknowledged
LastAcknowledged
UserName
7.1.9.11 AlarmListForSS
Method AlarmListForSS(string macAddress)
Description Produces a list of active alarms for the specified SS macAddress in the NMS. Returns null if no Alarm is found.
Parameters
macAddress
Mandatory parameter. The macAddress
Returns
Array of Alarm
Properties:
AlarmID
AlarmType
AlarmSource
AlarmInfo
Severity
LastReceived
AlarmCount
Acknowledged
LastAcknowledged
UserName
7.1.9.12 AlarmListForSector
Northbound Interface User Guide – SR 6.5
Page 85 Commercial in Confidence UGD-D00022 Rev A
Method AlarmListForSector(string BSID)
Description Produces a list of active alarms for the specified sector BSID in the NMS. Returns null if no Alarm is found.
Parameters
BSID
Mandatory parameter. The BSID
Returns
Array of Alarm
Properties:
AlarmID
AlarmType
AlarmSource
AlarmInfo
Severity
LastReceived
AlarmCount
Acknowledged
LastAcknowledged
UserName
7.1.9.13 AlarmListForShelf
Method AlarmListForShelf(string shelfID)
Description Produces a list of active alarms for the specified shelfID in the NMS. Returns null if no Alarm is found.
Parameters
shelfID
Mandatory parameter. The shelfID
Returns
Array of Alarm
Properties:
AlarmID
AlarmType
AlarmSource
AlarmInfo
Severity
LastReceived
AlarmCount
Acknowledged
LastAcknowledged
UserName
Northbound Interface User Guide – SR 6.5
Page 86 Commercial in Confidence UGD-D00022 Rev A