Professional Documents
Culture Documents
Northbound Interface
Netspan
Guide
Software Release 9.0
Northbound Interface Netspan Guide
Acknowledgements
Airspan Networks Inc acknowledges the following trademarks used within this document:
© Intel Corporation http://www.intel.com/
Copyright
© Copyright by Airspan Networks Inc., 2010. 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.
UK WEE Registration number: WEE/AB0207WZ
Table of Contents
Acknowledgements ................................................................................................................................. 2
Copyright ................................................................................................................................................. 2
Table of Contents .................................................................................................................................... 3
Summary of Figures ................................................................................................................................ 4
Summary of Tables ................................................................................................................................. 4
1 About this Guide .............................................................................................................................. 6
1.1 Purpose ................................................................................................................................... 6
1.2 Intended Audience .................................................................................................................. 6
1.3 Conventions ............................................................................................................................ 6
1.4 Referenced Documentation .................................................................................................... 7
1.5 Organisation of this Guide ....................................................................................................... 7
2 Introduction...................................................................................................................................... 8
2.1 General Overview ................................................................................................................... 8
2.1.1 Northbound Interface ...................................................................................................... 8
2.2 Where Northbound Interface fits into the Netspan Architecture ............................................. 8
2.3 Consuming Web Services ....................................................................................................... 8
2.4 Using Asynchronous Clients ................................................................................................... 9
3 Get Started .................................................................................................................................... 10
3.1 Workflow of the Northbound Interface .................................................................................. 10
3.2 Navigating the Northbound Interface .................................................................................... 11
4 Set-up Northbound Interface ......................................................................................................... 13
4.1 Disabling the Northbound Interface ...................................................................................... 13
4.2 Enabling the Northbound Interface ....................................................................................... 13
5 Set-up Authentication and Authorisation ....................................................................................... 14
5.1 Disabling Authentication ........................................................................................................ 14
5.2 Enabling Authentication ........................................................................................................ 14
6 Provision Service and Define Service Profiles .............................................................................. 16
6.1 SS Provisioning ..................................................................................................................... 16
6.2 Service Profiles ..................................................................................................................... 18
6.3 Inventory................................................................................................................................ 19
6.4 Service Product ..................................................................................................................... 19
6.5 Service Class ........................................................................................................................ 20
6.6 Packet Classifier ................................................................................................................... 21
6.7 Virtual LAN ............................................................................................................................ 21
6.8 Provision the SS VLAN Port Profile ...................................................................................... 22
6.9 Manage Faults....................................................................................................................... 22
6.9.1 Listing Active Alarms – Read Only ................................................................................ 22
Summary of Figures
Figure 1 – Northbound Interface Architecture Model .............................................................................. 8
Figure 2 – Workflow of Northbound Interface ....................................................................................... 10
Figure 3 – Web browser showing Web Service Index .......................................................................... 11
Figure 4 – Web browser showing SSProvisioning web service methods ............................................. 11
Figure 5 – Web browser showing SSProvisioning WSDL .................................................................... 12
Figure 6 – Web browser showing SSProvisioning GetSSProvisioningConfig method details ............. 12
Figure 7 – Netspan Web Services Users Administration ...................................................................... 14
Summary of Tables
Table 1 - Services ................................................................................................................................. 16
Table 2 - SSProvisioning.asmx methods .............................................................................................. 18
Table 3 - Service Profiles.asmx methods ............................................................................................. 19
Table 4 - Inventory.asmx method ......................................................................................................... 19
Table 5 - ServiceProduct.asmx methods .............................................................................................. 20
Table 6 - ServiceClass.asmx methods ................................................................................................. 21
Table 7 - PacketClassifier.asmx methods ............................................................................................. 21
Table 8 - VirtualLan.asmx methods ...................................................................................................... 22
Table 9 - SSVlanPortProfile.asmx methods .......................................................................................... 22
Table 10 - FaultManagement.asmx methods – Active Alarms ............................................................. 23
Table 11 - FaultManagement.asmx methods - Edit and Delete Active Alarms .................................... 24
1.1 Purpose
This guide provides the workflow 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:
Enable or Disable the Northbound Interface
Enable or Disable Authentication and Authorisation
Provision network elements and services
Manage Faults
1.3 Conventions
This document uses the following informational conventions.
Icon Description
Checkpoint: Marks a point in the workflow where there may be an exit or branch
to some other procedure. At each Checkpoint the reason for an exit or branch is
given along with specific directions to locate the entry point in the other
procedure.
Caution: Describes a possible risk and how to lessen or avoid the risk.
2 Introduction
This section provides a descriptive overview of the feature and its place in the product suite.
Get the WSDL description dynamically by calling the Web Service URL appended by the WSDL
parameter; see the following example:
http://<ServerName>/ WiMaxWS1/<WebService.asmx>?WSDL
where <ServerName> is the name of the server running Netspan and <WebService.asmx> is the
desired web service method. 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.
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.
3 Get Started
3.1 Workflow of the Northbound Interface
The workflow required to start and operate the Northbound Interface is shown in the following
diagram:
View Information regarding an individual web service method by returning to the web service methods
screen then clicking on the name of the method.
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.
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.
Table 1 - Services
1
These Web Services are license controlled. A valid license key is necessary to use this feature.
2
In SR9.0 Netspan offer MIB based provisioning of SS/MS service (test mode of provisioning).This is
matched by relevant NBIF methods defined in SS Provisioning Web Service.
6.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 . The following table provides a summary of
methods and associated descriptions:
Method Status Applicability Description
GetProvisioningStatus Active 16d & 16e 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.
GetSSCustomProvisioningConfig Deprecated 16d Get the Provisioning parameters,
(those defined in 802.16f and
proprietary custom extensions), that
are configured for the specified SS.
GetSSCustomProvisioningConfigV2 Active 16d & 16e Get the Provisioning parameters,
(those defined in 802.16f and
proprietary custom extensions), that
are configured for the specified SS.
GetSSProvisioningConfig Active 16d & 16e Get the Provisioning parameters,
(those defined in 802.16f), that are
configured for the specified SS.
6.3 Inventory
Inventory Web Service has been provided to assist with view operations of Inventories in NMS. The
interface can be viewed by browsing to http://<webserver>/wimaxws1/Inventory.asmx .
Method Status Applicability Description
BSSectorList Active 16d & 16e Produces a list of existing Base Station TRx
Channel list names from NMS.
VlanList Active 16d & 16e Produces a list of VLANs configured in NMS.
VlanGet Active 16d & 16e Gets VLAN configuration of the specified VLAN
Name in NMS.
VlanCreate Active 16d & 16e Creates a new VLAN in the NMS.
VLANDelete Active 16d & 16e Deletes an existing VLAN in NMS.
VlanUpdate Active 16d & 16e Updates an existing VLAN with new parameters
specified.
7 Appendix A
7.1 Parameters and Return Values for Northbound Interface Methods
7.1.1 SS Provisioning
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 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
serviceProductName
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.1 MS Provisioning
ProvisionMS (string macAddress, string serviceProductName)
Description Provision an MS within the NMS with the specified Service Product.
The Service Product must already exist within the NMS. If the MS
does not already exist in the NMS it is created, otherwise the
existing MS is updated.
Parameters
7.1.1.2 ProvisionFixedSS
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 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
serviceProductName
within the NMS
Optional parameter. BSID is of the format xxxxxx:xxxxxx where x is
homeSectorBSID 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 ProvisionFixedMS
Method ProvisionFixedMS (string macAddress, string
serviceProductName, string homeSectorBSID)
Description Provision an MS within the NMS with the specified provisioning
properties on the specified sector only. The Provisioning parameters
are restricted to those permitted in 802.16i. If the SS does not
already exist in the NMS it is created, otherwise the existing SS is
updated.
Parameters
7.1.1.4 ProvisionCustomSS
This method is no longer supported as of SR5.0. It returns error E02015 message „This method is no
longer supported.‟
7.1.1.5 ProvisionCustomSSV2
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.
Parameters
string macAddress 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
string serviceProductName
product within the NMS
Optional parameter. BSID is of the format xxxxxx:xxxxxx
string homeSectorBSID 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
string customConfigName the NMS must have a default SS Custom Configuration
configured.
7.1.1.6 ProvisionCustomMS
Method ProvisionCustomMS (string macAddress, string
serviceProductName, string homeSectorBSID, string
customConfigName, string vlanPortProfileName)
Description Provision an MS within the NMS with the specified provisioning
properties. The Provisioning parameters include those permitted in
802.16i and additional proprietary custom quantities. If the MS does
not already exist in the NMS, it is created, otherwise the existing MS
is updated.
Parameters
7.1.1.7 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.8 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
7.1.1.9 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.10 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.
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.11 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 Properties:
SSProvisioningConfig MacAddress
Service Product Name
Home Sector BSID
SS Description1
SS Description2
SS Description3
SS Description4
SS Description5
7.1.1.12 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.
Parameters
macAddress Mandatory parameter. Mac Address is specified using
format xx:xx:xx:xx:xx:xx where xx is a hex digit.
Return Properties:
SSCustomProvisioningConfig 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.13 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 Properties:
SSProvisioningStatus BS Name
(1 per Sector recently BS IP Address
registered with). 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
7.1.1.14 GetSSCustomProvisioningConfigV2
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
macAddress Mandatory parameter. Mac Address is specified using
format xx:xx:xx:xx:xx:xx where xx is a hex digit.
Return Properties:
SSCustomProvisioningConfig 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 Properties:
Array of Name
ServiceProductDetails Description
7.1.2.2 GetSSCustomConfigList
Method GetSSCustomConfigList()
Description Produces a list of the names of the SS Custom configurations
configured in the NMS
Parameters None
Returns Properties:
Array of Name
CustomConfigDetails Description
7.1.2.3 GetMSCustomConfigList
Method GetMSCustomConfigList()
Description Produces a list of the MS Custom Config profiles configured in
the NMS.
Parameters None
Returns Properties:
• Name
Array of
MSCustomConfigDetails
7.1.2.4 GetVlanList
Method GetVlanList()
Description Produces a list of the Vlans configured in the NMS
Parameters None
Returns Properties:
Array of Name
VlanDetails Vlan ID
7.1.2.5 GetGlobalConfig
Method GetGlobalConfig()
Description Retrieves the default global profiles configured in the NMS for the
SSs.
Parameters None
Returns Properties:
GlobalConfigDetails ServiceProductName
CustomConfigName
Vlan ID
7.1.2.6 GetGlobalConfigV2
Method GetGlobalConfigV2()
Description Retrieves the extended set of default global profiles configured in the
NMS for the SSs.
Parameters None
Returns Properties:
GlobalConfigDetails ServiceProductName
CustomConfigName
VlanPortProfileName
7.1.2.7 GetGlobalConfigMS
Method GetGlobalConfigMS()
7.1.2.8 GetSSVlanPortProfileList
Method GetSSVlanPortProfileList()
Description Produces a list of the SS Vlan Port Profiles configured in the NMS.
Parameters None
Returns Properties:
Array of Name
VlanPortProfileDetails Description
7.1.2.9 GetMSVlanPortProfileList
Method GetMSVlanPortProfileList()
Description Produces a list of the SS Vlan Port Profiles configured in the NMS
that are compatible with MSs.
Parameters None
Returns Properties:
• Name
Array of
VlanPortProfileDetails • Description
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 Properties:
Array of Channel Name
BSSectorDetails Channel BSID
7.1.4 ServiceProduct
7.1.4.1 ServiceProductList
Method ServiceProductList()
Description Produces a list of the names of Service Products configured in NMS
Parameters None
Returns Properties:
Array of Name
ServiceProductDetails Description
7.1.4.2 ServiceProductCreate
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 ServiceProductDelete
Method ServiceProductDelete(string serviceProductName)
Description Deletes an existing Service Product
Parameters
serviceProductName Mandatory parameter. The name of the new Service Product to create
7.1.4.4 ServiceFlowTemplateList
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 Properties:
Array of Name
ServiceFlowTemplateDetails Description
7.1.4.5 ServiceFlowTemplateGet
Method ServiceFlowTemplateGet(string serviceProductName, string
serviceFlowTemplateDescription)
Description Gets a Service Flow Template configuration from the NMS for the
7.1.4.6 ServiceFlowTemplateCreate
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
E02037: WSServiceProductNameEmpty
E02025: WSServiceClassDoesNotExist
E02023: WSServiceFlowTemplateAlreadyExists
E02021: WSServiceProductInUse
E02018: WSServiceProductDoesNotExist
7.1.4.7 ServiceFlowTemplateDelete
Method ServiceFlowTemplateDelete(string serviceProductName,
string serviceFlowTemplateDescription)
7.1.4.8 ServiceFlowTemplateUpdate
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 ServiceFlowTemplateClassifiersList
Method ServiceFlowTemplateClassifiersList(string
serviceProductName, string
serviceFlowTemplateDescription)
Description Produces a list of Classifier names for an existing Service
Flow Template in the specified Service Product.
Parameters
serviceProductName Mandatory parameter. The name of the Service Product
serviceFlowTemplateDescription Mandatory parameter. The name of the Service Flow
Template description
Returns Properties:
Array of Name
ServiceFlowTemplateClassifierDetails
7.1.4.10 ServiceFlowTemplateClassifiersClear
Method ServiceFlowTemplateClassifiersClear(string
serviceProductName, string
serviceFlowTemplateDescription)
Description Clears all the PacketClassifier from an existing Service Flow
Template in the specified Service Product.
Parameters
serviceProductName Mandatory parameter. The name of the Service Product
serviceFlowTemplateDescription 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
E02037: WSServiceProductNameEmpty
E02018: WSServiceProductDoesNotExist
E02022: WSServiceFlowTemplateDoesNotExist
E02028: WSPacketClassifierDoesNotExist
7.1.4.11 ServiceFlowTemplateClassifiersAdd
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 Mandatory parameter. The name of the Service Product
serviceFlowTemplateDescription Mandatory parameter. The name of the Service Flow Template
description
packetClassifierName
Mandatory parameter. The name of the Packet Classifier
7.1.4.12 ServiceFlowTemplateClassifiersRemove
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 Mandatory parameter. The name of the Service product
serviceFlowTemplateDescription Mandatory parameter. The name of the Service Flow Template
description
packetClassifierName
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
E02028: WSPacketClassifierDoesNotExist
7.1.5 ServiceClass
7.1.5.1 ServiceClassList
Method ServiceClassList ()
Description Produces a list of Service Class names configured in NMS
Parameters None
Returns Properties:
Array of Name
ServiceClassDetails
7.1.5.2 GetServiceClass
Method ServiceClassGet(string serviceClassName)
Description Gets the configuration of the specified Service Class
Parameters
serviceClassName Mandatory parameter. The name of the Service Class
Return Properties:
ServiceClassConfig Name
SchedulingType
TrafficPriority
ReqTxPolicyBroadcastBWReqOn
ReqTxPolicyPiggybackReqOn
ReqTxPolicyFragmentationOn
ReqTxPolicyPHSOn
ReqTxPolicySDUPackingOn
ReqTxPolicyCRCOn
MaxSustainedRate
MaxTrafficBurst
MinReservedRate
MinRsvdTolerableRate
ToleratedJitter
MaxLatency
FixedVsVariableSduInd
SduSize
ExtPollPeriod
7.1.5.3 CreateServiceClass
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
7.1.5.4 DeleteServiceClass
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 UpdateServiceClass
Method ServiceClassUpdate(ServiceClassConfig)
Description Updates an existing Service Class in NMS with the parameters passed
Parameters
ServiceClassConfig Mandatory parameter. Name
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
E02025: WSServiceClassDoesNotExist
7.1.6.2 GetPacketClassifier
Method PacketClassifierGet(string packetClassifierName)
Description Get the configuration of the specified Packet Classifier in NMS
Parameters
packetClassifierName Mandatory parameter. The name of the Packet Classifier
Return Properties:
PacketClassifierConfig 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
7.1.6.3 CreatePacketClassifier
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
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
7.1.6.4 DeletePacketClassifier
Method PacketClassifierDelete(string packetClassifierName)
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 UpdatePacketClassifier
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
Mandatory parameter. NIpProtocol
7.1.7 VirtualLan
7.1.7.1 VlanList
Method VlanList ()
Description Produces a list of VLANs configured in NMS
Parameters None
Returns Properties:
Array of VlanDetails Name
Vlan ID
7.1.7.2 VlanGet
Method VlanGet(string vlanName)
Description Gets VLAN configuration of the specified VLAN Name in NMS
Parameters
vLANName Mandatory parameter. The name of the VLAN to get
Returns Properties:
VlanConfig Name
VlanID
Description
DHCPRelayAgentActive
SingleUser
MACForcedForwarding
MACForceForwardIPAddress
BroadcastServiceClassName
AddToEveryBsPortListOnCreate
7.1.7.3 VlanCreate
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
E02014: WSWebServiceDisabled
E02040: WSVlanNameEmpty
E02043: WSParameterEmpty
E02032: WSVlanAlreadyExists
E02025: WSServiceClassDoesNotExist
7.1.7.4 VlanDelete
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 VlanUpdate
Method VlanUpdate(VlanConfig vlanConfig)
Description Updates an existing VLAN with new parameters specified
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
E02014: WSWebServiceDisabled
E02040: WSVlanNameEmpty
E02043: WSParameterEmpty
E02031: WSVlanDoesNotExist
E02025: WSServiceClassDoesNotExist
7.1.8 SSVlanPortProfile
7.1.8.1 SSVlanPortProfileList
Method SSVlanPortProfileList()
Description Produces a list of the SS VLAN Port Profiles configured in the NMS.
Parameters None
Returns Properties:
Array of Name
VlanPortProfileDetails Description
7.1.8.2 SSVlanPortProfileGet
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 Properties:
VlanPortProfileConfig Name
Description
PortMode
AllowedFrameType
PortVlanIDName
IngressFilterEnabled
DeafultPriority
7.1.8.3 SSVlanPortProfileCreate
Method SSVlanPortProfileCreate(VlanPortProfileConfig
vlanPortProfileConfig )
Description Creates a new SS VLAN Port Profile in NMS with the specified
parameters
Parameters Properties:
VlanPortProfileConfig 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 SSVlanPortProfileDelete
Method SSVlanPortProfileDelete(string ssVlanPortProfileName)
Description Deletes an existing SS VLAN Port Profile in NMS
Parameters
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 SVlanPortProfileUpdate
Method SSVlanPortProfileUpdate(VlanPortProfileConfig
vlanPortProfileConfig)
Description Update an existing SS VLAN Port Profile in the NMS
Parameters Properties:
VlanPortProfileConfig 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
E02034: WSSSVlanPortProfileDoesNotExist
E02041: WSVlanNameEmpty
E02031: WSVlanDoesNotExist
7.1.8.6 SSVlanPortProfileVlansList
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 Properties:
Array of VlanDetails Name
VlanID
7.1.8.7 SSVLANPortProfileVLANsClear
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
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02042: WSSSVLANPortProfileNameEmpty
E02034: WSSSVlanPortProfileDoesNotExist
7.1.8.8 SSVlanPortProfileVlansAdd
Method SSVlanPortProfileVlansAdd(string ssVlanPortProfileName, string
vlanName)
Description Adds an existing VLAN to an existing SS VLAN PORT Profile in the
NMS
Parameters
ssVlanPortProfileName Name of SS VLAN Port Profile
vlanName Name of VLAN
Return Values E00000: No Error
E02009: Web Service Authorisation Failure
E02014: WSWebServiceDisabled
E02042: WSSSVLANPortProfileNameEmpty
E02034: WSSSVlanPortProfileDoesNotExist
E02041: WSVlanNameEmpty
E02031: WSVlanDoesNotExist
7.1.8.9 SSVlanPortProfileVlansRemove
Method SSVlanPortProfileVlansRemove(string ssVlanPortProfileName,
string vlanName)
Description Removes an existing VLAN from and existing SS VLAN Port Profile in
NMS
Parameters
ssVlanPortProfileName Name of SS VLAN Port Profile
vlanName 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
Description Produces a list of active alarms in the NMS. Returns a null if no Alarm is
found.
Parameters None
Returns Properties:
Array of Alarm 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
Returns Properties:
AlarmDetails 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
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
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 Mandatory parameter. The alarmID
comment 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)
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 Mandatory parameter. The alarmID
comment 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 Properties:
Array of Alarm AlarmID
AlarmType
AlarmSource
AlarmInfo
Severity
LastReceived
AlarmCount
Acknowledged
LastAcknowledged
UserName
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 Properties:
Array of Alarm 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
Returns Properties:
Array of Alarm 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 Properties:
Array of Alarm AlarmID
AlarmType
AlarmSource
AlarmInfo
Severity
LastReceived
AlarmCount
Acknowledged
LastAcknowledged
UserName
7.1.9.12 AlarmListForSector
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 Properties:
Array of Alarm 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 Properties:
Array of Alarm AlarmID
AlarmType
AlarmSource
AlarmInfo
Severity
LastReceived
AlarmCount
Acknowledged
LastAcknowledged
UserName
8 Appendix C – Checklist
The Checklist below gives the high-level steps in the Workflow for this procedure. Detach or print this
page to use as a job-aid for completing the actions this procedure requires.
Procedure Actions Outcome
Revision History
Revision Originator(s) Date Description
st
Draft 1.0 David Cann 28/08/2008 1 Draft
Draft 2.0 David Cann 23/09/2008 Updated Section 6 with
mobile details.
Draft 3.0 M Falik 04/11/2009 Updates & formatting
Rev A M Falik 16/12/2009 Revisions & publish
Rev B M Falik 27/05/2010 Updates
Rev C M Falik 22/06/2010 Revisions & publish
Contact Information
Customer Service Help-Desk for customer service emergency
Airspan Networks have introduced the Airspan Tracker application to enable prompt and efficient
Customer Support services.
If you do not have an Airspan Tracker account, please obtain login credentials by filling-in the form in
the main page www.airspan.com/Support Register New Account.
Worldwide Headquarters:
Airspan Networks Inc.
777, Yamato Road, Suite 310,
Boca Raton, FL 33431, USA
Tel: +1 561 893 8670
www.airspan.com
Feedback:
To provide feedback on this document, please send comments to the following email address:
documentfeedback@airspan.com