Sie sind auf Seite 1von 59
UGD-D00108 Rev C Northbound Interface Netspan Guide Software Release 9.0

UGD-D00108 Rev C

Northbound Interface Netspan Guide

Software Release 9.0

UGD-D00108 Rev C Northbound Interface Netspan Guide Software Release 9.0
Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

Acknowledgements

Airspan Networks Inc acknowledges the following trademarks used within this document:

the following trademarks used within this document: © Intel Corporation http://www.intel.com/ © Microsoft

© Intel Corporation

this document: © Intel Corporation http://www.intel.com/ © Microsoft Corporation http://www.microsoft.com Copyright

© Microsoft Corporation

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

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

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

Northbound Interface Netspan Guide 6.9.2 Editing and Deleting Active Alarms 23 7 Appendix A 25

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide 6.9.2 Editing and Deleting Active Alarms 23 7 Appendix A 25 7.1

6.9.2

Editing and Deleting Active Alarms

23

7 Appendix A

25

7.1

Parameters and Return Values for Northbound Interface Methods

25

7.1.1 SS Provisioning

25

7.1.2 ServiceProfiles

32

7.1.3 Inventory

34

7.1.4 ServiceProduct

34

7.1.5 ServiceClass

39

7.1.6 Packet Classifier

43

7.1.7 VirtualLan

46

7.1.8 SSVlanPortProfile

48

7.1.9 Fault Management

52

8 Appendix C Checklist

57

Revision History Contact Information

58

59

Summary of Figures

Figure 1 Northbound Interface Architecture Model Figure 2 Workflow of Northbound Interface Figure 3 Web browser showing Web Service Index Figure 4 Web browser showing SSProvisioning web service methods Figure 5 Web browser showing SSProvisioning WSDL

8

10

11

11

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 SSProvisioning.asmx methods Service Profiles.asmx methods

16

Table

2

18

Table

3

19

Table 4 - Inventory.asmx method

19

Table

5

-

-

ServiceProduct.asmx methods ServiceClass.asmx methods

20

Table

6

21

Table 7 - PacketClassifier.asmx methods

21

- Table 9 - SSVlanPortProfile.asmx methods Table 10 - FaultManagement.asmx methods Active Alarms Table 11 - FaultManagement.asmx methods - Edit and Delete Active Alarms

Table

8

VirtualLan.asmx methods

22

22

23

24

Northbound Interface Netspan Guide Table 12 - Checklist for Procedure 57 Page 5 Commercial in

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide Table 12 - Checklist for Procedure 57 Page 5 Commercial in Confidence

Table 12 - Checklist for Procedure

57

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

1 About this Guide

This section discusses the purpose, intended audience, conventions, referenced documentation and organisation for this guide.

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.2 Intended Audience

This guide is intended for persons who are responsible for managing Netspan. These persons should have a working knowledge of the WiMAX system.

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

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.

Reference: Gives a resource in the workflow that may be needed to complete a procedure

Reference: Gives a resource in the workflow that may be needed to complete a procedure along with specific directions to use the resource.

Caution: Describes a possible risk and how to lessen or avoid the risk.

Caution: Describes a possible risk and how to lessen or avoid the risk.

Advice: Provides a recommendation based on best practice.

Advice: Provides a recommendation based on best practice.

Note: Provides useful information.

Note: Provides useful information.

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

1.4 Referenced Documentation

Netspan Northbound Interface Reference Manual

Netspan Content Specification

1.5 Organisation of this Guide

This guide is organised into the following Sections:

About this Guide

Get Started

Set-up Northbound Interface

Set-up Authentication and Authorisation

Provision Service and Define Service Profiles

Manage Faults

Appendix

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

2

Introduction

This section provides a descriptive overview of the feature and its place in the product suite.

2.1 General Overview

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

using most major programming languages / operating systems. Figure 1 – Northbound Interface Architecture Model 2.2

Figure 1 Northbound Interface Architecture Model

2.2 Where Northbound Interface fits into the Netspan Architecture

The Netspan Northbound Interface is used typically when operators wish to provision SSs 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.

into an authenticating front-end server to obtain service. Note: Netspan do not provide an „out of

Note: Netspan do not provide an „out of the box‟ application / GUI for using and viewing data across the Northbound Interface.

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

Northbound Interface Netspan Guide Get the WSDL description dynamically by calling the Web Service URL

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide Get the WSDL description dynamically by calling the Web Service URL appended

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.

within the SSProvisioning.asmx file, SSProvisioning.cs. Note: The instructions above refer to the .NET development

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.

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

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

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:

the Northbound Interface is shown in the following diagram: Figure 2 – Workflow of Northbound Interface

Figure 2 Workflow of Northbound Interface

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

3.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. The url of the web page is:

http://<server>/WiMaxWS1/ where <server> is the name or IP address of the Netspan server.

is the name or IP address of the Netspan server. Figure 3 – Web browser showing

Figure 3 Web browser showing Web Service Index

View the particular web service by clicking on its link in the list.

particular web service by clicking on its link in the list. Figure 4 – Web browser

Figure 4 Web browser showing SSProvisioning web service methods

Northbound Interface Netspan Guide View the underlying WSDL by clicking on „Service Description‟ Figure 5

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide View the underlying WSDL by clicking on „Service Description‟ Figure 5 –

View the underlying WSDL by clicking on „Service Description‟

the underlying WSDL by clicking on „Service Description‟ Figure 5 – Web browser showing SSProvisioning WSDL

Figure 5 Web browser showing SSProvisioning WSDL

View Information regarding an individual web service method by returning to the web service methods screen then clicking on the name of the method.

methods screen then clicking on the name of the method. Figure 6 – Web browser showing

Figure 6 Web browser showing SSProvisioning GetSSProvisioningConfig method details

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

4 Set-up Northbound Interface

By default, the Northbound Interface is enabled.

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

4.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 Netspan Guide

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

5 Set-up 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.

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.

An

be supplied to access any of the Web Service procedures. An Note: The IE test page

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.

Service; testing of a remote Web Service is not supported. Figure 7 – Netspan Web Services

Figure 7 Netspan Web Services Users Administration

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

5.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).

Northbound Interface Netspan Guide 2. Edit the Web.Config file in this directory using any standard

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide 2. Edit the Web.Config file in this directory using any standard text

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 Netspan Guide

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

6 Provision Service and Define Service Profiles

Web services apply to both 802.16e and 802.16d deployments, although not all services are supported for all deployments. The following table provides a summary of services:

Web Service

802.16d

802.16e (with ASNGW)

802.16e (Standalone)

Inventory

Y

Y

Y

Fault Management

Y

Y

Y

SS Provisioning

Y

N

Y

2

Packet Classifier 1

Y

N

Y

2

Service Class 1

Y

N

Y

2

Service Product 1

Y

N

Y

2

SS VLAN Port Profile 1

Y

N

Y

2

VLAN 1

Y

N

Y

2

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.

Northbound Interface Netspan Guide Method Status Applicability Description ProvisionSS Active 16d

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide Method Status Applicability Description ProvisionSS Active 16d

Method

Status

Applicability

Description

ProvisionSS

Active

16d

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.

ProvisionMS

Active

16e

Provision an MS within the NMS with the specified provisioning properties. The Provisioning parameters are restricted to those permitted in 802.16i. If the MS does not already exist in the NMS it is created, otherwise the existing MS is updated.

ProvisionFixedSS

Active

16d

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.

ProvisionFixedMS

Active

16e

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 MS does not already exist in the NMS it is created, otherwise the existing MS is updated.

ProvisionCustomSS

Obsolete

16d

This action is no longer supported as of SR6.1. It returns error E02015, message “This method is no longer supported.”

ProvisionCustomSSV2

Active

16d

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.

ProvisionCustomMS

Active

16e

Provision an MS within the NMS with the specified provisioning properties. The Provisioning parameters include those defined 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.

Northbound Interface Netspan Guide Method Status Applicability Description R eprovision Active 16d

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide Method Status Applicability Description R eprovision Active 16d

Method

Status

Applicability

Description

Reprovision

Active

16d & 16e

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.

Deprovision

Active

16d & 16e

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.

EnableService

Active

16d & 16e

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.

DisableService

Active

16d & 16e

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.

Table 2 - SSProvisioning.asmx methods

6.2 Service Profiles

To assist SS Provisioning, an additional Web Service has been provided to permit enumeration of those templates/ profiles used in SSProvisioning.

of those templates/ profiles used in SSProvisioning. Note: This interface is read-only, i.e. templates can be

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 . The following table provides a summary of methods and associated descriptions:

Method

Status

Applicability

Description

GetGlobalConfig

Depreciated

16d

Retrieves the default global profiles configured in the NMS for the SSs.

Northbound Interface Netspan Guide Method Status Applicability Description GetGlobalConfigV2 Active 16d

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide Method Status Applicability Description GetGlobalConfigV2 Active 16d

Method

Status

Applicability

Description

GetGlobalConfigV2

Active

16d

Retrieves the extended set of default global profiles configured in the NMS for the SSs.

GetGlobalConfigMS

Active

16e

Retrieves the extended set of default global profiles configured in the NMS for MSs.

GetSSCustomConfigList

Active

16d

Produces a list of the names of the SS Custom configurations configured in the NMS.

GetMSCustomConfigList

Active

16e

Produces a list of the MS Custom Config profiles configured in the NMS.

GetSSVlanPortProfileList

Active

16d

Produces a list of the SS VLAN Port Profiles configured in the NMS.

GetMSVlanPortProfileList

Active

16e

Produces a list of the MS VLAN Port Profiles configured in the NMS that are compatible with MSs.

GetServiceProductList

Active

16d & 16e

Produces a list of the names of the Service Products configured in the NMS.

GetVlanList

Active

16d & 16e

Produces a list of the VLANs configured in the NMS.

Table 3 - Service Profiles.asmx methods

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.

Table 4 - Inventory.asmx method

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

of Service Product and Service Flow Templates in NMS. Note: Access to these actions is allowed

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 table provides a summary of methods and associated descriptions:

Method

Status

Applicability

Description

ServiceProductList

Active

16d & 16e

Produces a list of the names of Service Products configured in NMS.

ServiceProductCreate

Active

16d & 16e

Creates a Service Product with no service flows.

ServiceProductDelete

Active

16d & 16e

Deletes an existing Service Product.

Northbound Interface Netspan Guide Method Status Applicability Description ServiceFlowTemplateList Active

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide Method Status Applicability Description ServiceFlowTemplateList Active

Method

Status

Applicability

Description

ServiceFlowTemplateList

Active

16d & 16e

Produces a list of Service Flow Template names for the specified Service product name in NMS.

ServiceFlowTemplateGet

Active

16d & 16e

Gets a Service Flow Template configuration from the NMS for the specified Service Product and Service Flow Template.

ServiceFlowTemplateCreate

Active

16d & 16e

Creates a Service Flow Template in a Service Product with the specified parameters.

ServiceFlowTemplateDelete

Active

16d & 16e

Deletes an existing Service Flow Template from the specified Service Product.

ServiceFlowTemplateUpdate

Active

16d & 16e

Updates an existing Service Flow Template in the specified Service Product with the specified parameters.

ServiceFlowTemplateClassifiersList

Active

16d & 16e

Produces a list of Classifier names for an existing Service Flow Template in the specified Service Product.

ServiceFlowTemplateClassifiersClear

Active

16d & 16e

Clears all the PacketClassifier from an existing Service Flow Template in the specified Service Product.

ServiceFlowTemplateClassifiersAdd

Active

16d & 16e

Adds an existing Packet Classifier to and existing Service Flow Template in the specified Service Product.

ServiceFlowTemplateClassifiersRemove

Active

16d & 16e

Removes existing Packet Classifier from a Service Flow Template in the specified Service Product.

Table 5 - ServiceProduct.asmx methods

6.5 Service Class

ServiceClass Web Service has been provided to assist with view, update, create and delete operations of Service Classes in NMS.

create and delete operations of Service Classes in NMS. Note: Access to these actions is allowed

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 table provides a summary of methods and associated descriptions:

Method

Status

Applicability

Description

ServiceClassList

Active

16d & 16e

Produces a list of Service Class names configured in NMS.

ServiceClassGet

Active

16d & 16e

Gets the configuration of the specified Service Class.

ServiceClassCreate

Active

16d & 16e

Creates a new Service Class with the specified parameters passed.

Northbound Interface Netspan Guide Method Status Applicability Description ServiceClassDelete Active

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide Method Status Applicability Description ServiceClassDelete Active

Method

Status

Applicability

Description

ServiceClassDelete

Active

16d & 16e

Removes existing Service Class in NMS.

ServiceClassUpdate

Active

16d & 16e

Updates an existing Service Class in NMS with the parameters passed.

Table 6 - ServiceClass.asmx methods

6.6 Packet Classifier

PacketClassifier Web Service has been provided to assist with view, update, create and delete operations of Packet Classifiers in NMS.

Note: Access to these actions is allowed based on an appropriate electronic license key. 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 table provides a summary of methods and associated descriptions:

Method

Status

Applicability

Description

PacketClassifierList

Active

16d & 16e

Produces the list of existing Packet Classifier names configured in NMS.

PacketClassifierGet

Active

16d & 16e

Get the configuration of the specified Packet Classifier in NMS.

PacketClassifierCreate

Active

16d & 16e

Creates a new Packet Classifier in the NMS.

PacketClassifierDelete

Active

16d & 16e

Removes an existing Packet Classifier in NMS.

PacketClassifierUpdate

Active

16d & 16e

Updates an existing Packet Classifier in the NMS with the parameters passed.

Table 7 - PacketClassifier.asmx methods

6.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. 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 table provides a summary of methods and associated descriptions:

Method

Status

Applicability

Description

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.

Northbound Interface Netspan Guide Table 8 - VirtualLan.asmx methods 6.8 Provision the SS VLAN Port

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide Table 8 - VirtualLan.asmx methods 6.8 Provision the SS VLAN Port Profile

Table 8 - VirtualLan.asmx methods

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

Note: Access to these actions is allowed based on an appropriate electronic license key. 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 table provides a summary of methods and associated descriptions:

Method

Status

Applicability

Description

SSVlanPortProfileList

Active

16d & 16e

Produces a list of the SS VLAN Port Profiles configured in the NMS.

SSVlanPortProfileGet

Active

16d & 16e

Gets the configuration of an existing SS VLAN Port Profile in NMS.

SSVlanPortProfileCreate

Active

16d & 16e

Creates a new SS VLAN Port Profile in NMS with the specified parameters.

SSVlanPortProfileDelete

Active

16d & 16e

Deletes all VLANs from and existing SS VLAN Port Profile in the NMS.

SSVlanPortProfileUpdate

Active

16d & 16e

Updates an existing VLAN to an existing SS VLAN PORT Profile in the NMS.

SSVlanPortProfileVlansList

Active

16d & 16e

Gets an existing VLAN from and existing SS VLAN Port Profile in NMS.

SSVLANPortProfileVLANsClear

Active

16d & 16e

Clears all VLANs from and existing SS VLAN Port Profile in the NMS.

SSVlanPortProfileVlansAdd

Active

16d & 16e

Adds an existing VLAN to an existing SS VLAN PORT Profile in the NMS.

SSVlanPortProfileVlansRemove

Active

16d & 16e

Removes an existing VLAN from and existing SS VLAN Port Profile in NMS.

Table 9 - SSVlanPortProfile.asmx methods

6.9 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 To view Parameters and Return Values for all the methods listed in this section, please turn in this document to the Appendix.

6.9.1 Listing Active Alarms Read Only

The Fault Management Web Service has been provided to assist with the operations of Fault Management of NMS.

Northbound Interface Netspan Guide The Fault Management interface can be viewed by browsing to

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide The Fault Management interface can be viewed by browsing to

The Fault Management interface can be viewed by browsing to http://<webserver>/wimaxws1/FaultManagement.asmx. The following table provides a summary of methods and associated descriptions:

Method

Status

Applicability

Description

AlarmList

Active

16d & 16e

Produces a list of active alarms in the NMS. Returns a null if no Alarms are found.

AlarmListChanged

Active

16d & 16e

Produces a list of active alarms changed since lastChangedTime in the NMS. Returns a null if no Alarms are found.

AlarmListForBSDU

Active

16d & 16e

Produces a list of active alarms for the specified BSDU macAddress in the NMS. Returns a null if no Alarms are found.

AlarmListForBSTRx

Active

16d & 16e

Produces a list of active alarms for the specified BSID in the NMS. Returns a null if no Alarms are found.

AlarmListForSS

Active

16d & 16e

Produces a list of active alarms for the specified SS macAddress in the NMS. Returns a null if no Alarms are found.

AlarmListForSector

Active

16d & 16e

Produces a list of active alarms for the specified Sector BSID in the NMS. Returns a null if no Alarms are found.

AlarmListForShelf

Active

16d & 16e

Produces a list of active alarms for the specified shelfId in the NMS. Returns a null if no Alarms are found.

AlarmDetailsGet

Active

16d & 16e

Gets detailed information on an active Alarm with AlarmID

that exists in the NMS. does not already exist.

Returns an error if the AlarmID

Table 10 - FaultManagement.asmx methods Active Alarms

6.9.2 Editing and Deleting Active Alarms

Active Alarms Edit and Delete

APIs to modify and delete an active alarm in the NMS.

The Fault Management interface can be viewed by browsing to http://<webserver>/wimaxws1/FaultManagement.asmx. The following table provides a summary of methods and associated descriptions:

Method

Status

Applicability

Description

AlarmAcknowledge

Active

16d & 16e

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.

AlarmRelease

Active

16d & 16e

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.

AlarmDelete

Active

16d & 16e

Deletes an existing active Alarm with AlarmID that exists in the NMS. Returns an error if the AlarmID does not already exist.

Northbound Interface Netspan Guide Method Status Applicability Description AlarmDetailsCommentSet Active

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide Method Status Applicability Description AlarmDetailsCommentSet Active

Method

Status

Applicability

Description

AlarmDetailsCommentSet

Active

16d & 16e

Sets comment on an existing active Alarm with AlarmID that exists in the NMS. Returns an error if the AlarmID does not already exist.

AlarmDetailsCommentAppend

Active

16d & 16e

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.

Table 11 - FaultManagement.asmx methods - Edit and Delete Active Alarms

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide

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.

serviceProductName

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

 

macAddress

Mandatory parameter. Mac Address is specified using format xx:xx:xx:xx:xx:xx where xx is a hex digit.

serviceProductName

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

Northbound Interface Netspan Guide E02005: No Service Product exists with the supplied name E02012: For

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide E02005: No Service Product exists with the supplied name E02012: For this

E02005: No Service Product exists with the supplied name

E02012: For this method to be supported, a default MS Custom Configuration must be specified in the NMS

E02013: For this method to be supported, a default MS VLAN Port Profile must be specified in the NMS.

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.

serviceProductName

Mandatory parameter. The name of an existing Service product within the NMS

homeSectorBSID

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

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

 

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

Northbound Interface Netspan Guide serviceProductName within the NMS Optional parameter. BSID is of the format

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide serviceProductName within the NMS Optional parameter. BSID is of the format

serviceProductName

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.

homeSectorBSID

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 MS Custom Configuration must be specified in the NMS

E02013: For this method to be supported, a default MS VLAN Port Profile must be specified in the NMS.

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.

string serviceProductName

Mandatory parameter. The name of an existing Service product within the NMS

string homeSectorBSID

Optional parameter. BSID is of the format xxxxxx:xxxxxx where x is a hex digit. Must identify an existing Sector in the NMS.

string customConfigName

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.

Northbound Interface Netspan Guide string vlanPortProfileName Optional parameter. The name of an existing SS Vlan

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide string vlanPortProfileName Optional parameter. The name of an existing SS Vlan Port

string vlanPortProfileName

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.

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

 

macAddress

Mandatory parameter. Mac Address is specified using format xx:xx:xx:xx:xx:xx where xx is a hex digit.

serviceProductName

Mandatory parameter. The name of an existing Service product within the NMS

homeSectorBSID

Optional parameter. BSID is of the format xxxxxx:xxxxxx where x is

a

hex digit. Must identify an existing Sector in the NMS.

customConfigName

Optional parameter. The name of an existing MS Custom Configuration within the NMS. If no name is specified then the NMS must have a default MS Custom Configuration configured.

vlanPortProfileName

Optional parameter. The name of an existing MS Vlan Port Profile within the NMS. If no name is specified then the NMS must have a default MS Vlan Port Profile configured.

Northbound Interface Netspan Guide Return Values E00000: No Error E02009: Web Service Authorisation Failure

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide Return Values E00000: No Error E02009: Web Service Authorisation Failure

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 MS Custom Config exists with the supplied name.

E02010: If no MS Custom Configuration is supplied, then a default MS Custom Configuration must be configured in the NMS.

E02017: If no SS Vlan Port Profile is supplied, then a default MS Vlan Port Profile must be configured in the NMS.

E02016: No MS Vlan Port Profile exists with this name.

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

 
Northbound Interface Netspan Guide macAddress Mandatory parameter. Mac Address is specified using format

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide macAddress Mandatory parameter. Mac Address is specified using format

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

Northbound Interface Netspan Guide Returns Properties: SSProvisioningConfig MacAddress Service Product Name Home

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide Returns Properties: SSProvisioningConfig MacAddress Service Product Name Home

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

(1 per Sector recently registered with).

Northbound Interface Netspan Guide given sector. Stats are: Total changes New (unprocessed) changes In Progress

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide given sector. Stats are: Total changes New (unprocessed) changes In Progress

given sector. Stats are:

Total changes New (unprocessed) changes In Progress changes (SNM P changes being built by Provisioning Service. AwaitingResponse changes (SNMP changes sent to Job Service for transmission but no response received at

AwaitingResponse changes (SNMP changes sent to Job Service for transmission but no response received at Provisioning Service). changes (SNM P changes being built by Provisioning Service. Queued (stored in Provisioning Service for dispatch

Queued (stored in Provisioning Service for dispatch to the Job Service).

Failed Changes which have received a NACK from the BS.no response received at Provisioning Service). Queued (stored in Provisioning Service for dispatch to the Job

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 ServiceProductDetails

Array of ServiceProductDetails Name

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 Netspan Guide Parameters None Returns Properties: Array of CustomConfigDetails Name

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide Parameters None Returns Properties: Array of CustomConfigDetails Name

Parameters

None

Returns

Properties:

Array of CustomConfigDetails

Array of CustomConfigDetails Name

Name

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

 
Array of   Name

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

 
GlobalConfigDetails   ServiceProductName CustomConfigName Vlan ID

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

GlobalConfigDetails ServiceProductName

ServiceProductName

CustomConfigName

VlanPortProfileName

7.1.2.7

GetGlobalConfigMS

Method

GetGlobalConfigMS()

Northbound Interface Netspan Guide Description Retrieves the extended set of default global profiles configured in

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide Description Retrieves the extended set of default global profiles configured in the

Description

Retrieves the extended set of default global profiles configured in the NMS for MSs.

Parameters

None

Returns

Properties:

ServiceProductName

CustomConfigName

GetGlobalConfigMSResult

VlanPortProfileName

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 VlanPortProfileDetails

Array of VlanPortProfileDetails Name

Name

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

Array of Channel Name

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

Array of Name

Name

Northbound Interface Netspan Guide ServiceProductDetails Description 7.1.4.2 ServiceProductCreate Method

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide ServiceProductDetails Description 7.1.4.2 ServiceProductCreate Method

ServiceProductDetails

ServiceProductDetails Description

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

Return Values

E00000: No Error

E02009: Web Service Authorisation Failure

E02014: WSWebServiceDisabled

E02037: WSServiceProductNameEmpty

E02018: WSServiceProductDoesNotExist

E02020: WSCannotDeleteServiceProductInUse

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 ServiceFlowTemplateDetails

Array of ServiceFlowTemplateDetails Name

Name

Description

7.1.4.5 ServiceFlowTemplateGet

Method

ServiceFlowTemplateGet(string serviceProductName, string serviceFlowTemplateDescription)

Description

Gets a Service Flow Template configuration from the NMS for the

Northbound Interface Netspan Guide   specified Service Product and Service Flow Template Parameters  

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide   specified Service Product and Service Flow Template Parameters  
 

specified Service Product and Service Flow Template

Parameters

 

serviceProductName

Mandatory parameter. The name of the Service product

serviceFlowTemplateDescription

Mandatory parameter. The name of the Service Flow Template description

Return

Properties:

ServiceFlowTemplateConfig

ServiceProductName

ServiceFlowTemplateDescription

Direction

ServiceClassName

InitialState

ConvergenceSublayerType

(to get Service Flow Template Classifier List use ServiceFlowTemplateClassifiersList)

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)

Northbound Interface Netspan Guide Description Deletes an existing Service Flow Template from the specified Service

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide Description Deletes an existing Service Flow Template from the specified Service

Description

Deletes an existing Service Flow Template from 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

E02022: WSServiceFlowTemplateDoesNotExist

E02021: WSServiceProductInUse

E02018: WSServiceProductDoesNotExist

E02038: WSServiceFlowTemplateDescriptionEmpty

E02037: WSServiceProductNameEmpty

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

Northbound Interface Netspan Guide   serviceFlowTemplateDescription) Description Produces a list of Classifier

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide   serviceFlowTemplateDescription) Description Produces a list of Classifier
 

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 ServiceFlowTemplateClassifierDetails

Array of ServiceFlowTemplateClassifierDetails Name

Name

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

Northbound Interface Netspan Guide Return Values E00000: No Error E02009: Web Service Authorisation Failure

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide Return Values E00000: No Error E02009: Web Service Authorisation Failure

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

E02029: WSPacketClassifierAlreadyExists

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

Northbound Interface Netspan Guide Returns Properties: Array of ServiceClassDetails Name 7.1.5.2 GetServiceClass

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide Returns Properties: Array of ServiceClassDetails Name 7.1.5.2 GetServiceClass

Returns

Properties:

Array of ServiceClassDetails

Array of ServiceClassDetails Name

Name

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

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

Northbound Interface Netspan Guide   Mandatory parameter. ReqTxPolicyBroadcastBWReqOn Mandatory parameter.

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide   Mandatory parameter. ReqTxPolicyBroadcastBWReqOn Mandatory parameter.
 

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

Mandatory parameter. ArqDeliverInOrder

Mandatory parameter. ArqRxPurgeTimeout

Mandatory parameter. ArqBlockSize

Return Values

E00000: No Error

E02009: Web Service Authorisation Failure

E02014: WSWebServiceDisabled

E02039: WSServiceClassNameEmpty

E02026: WSServiceClassAlreadyExists

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

Northbound Interface Netspan Guide E02039: WSServiceClassNameEmpty E02025: WSServiceClassDoesNotExist 7.1.5.5

Northbound Interface Netspan Guide

Northbound Interface Netspan Guide E02039: WSServiceClassNameEmpty E02025: WSServiceClassDoesNotExist 7.1.5.5
E02039: WSServiceClassNameEmpty E02025: WSServiceClassDoesNotExist
E02039: WSServiceClassNameEmpty E02025: WSServiceClassDoesNotExist

E02039: WSServiceClassNameEmpty

E02025: WSServiceClassDoesNotExist

7.1.5.5

UpdateServiceClass