alvaristar v4.0 service activation nbi 090427

8/11/2019 AlvariSTAR v4.0 Service Activation NBI 090427

1/46

User GuideSoftware Version: 4.0March 2009P/N 215278

AlvariSTAR Service ActivationNorthbound Interface


2/46

AlvariSTAR Service Activation Northbound Interface

Service Activation NBI User Manual xxvi User Guide

Document History

Topic Description Date Issued

This is the manuals first publication. February 2007

cpeDetailsbyName Added command SW Ver. 3.2, June 2007

cpeDetailsbyMac Added command SW Ver. 3.2, June 2007

serviceListbyCPEName Added command SW Ver. 3.2, June 2007

serviceListbyCPEMac Added command SW Ver. 3.2, June 2007

resetCPEbyMac Added command SW Ver. 3.2, June 2007

radioLinkStatusByCPEName Added command SW Ver. 3.2, June 2007

makeCPETemporarybyName Added command SW Ver. 3.2.0.43,

February 2008

makeCPETemporarybyMAC Added command SW Ver. 3.2.0.43,

February 2008

deleteCPEbyName Added command SW Ver. 3.2.0.43,

February 2008

deleteCPEbyMAC Added command SW Ver. 3.2.0.43,

February 2008

suModify Added command SW Ver. 4.0, March

2009

suListByBST Added command SW Ver. 4.0, March

2009

serviceListByCPEMAConMultipleBST Added command SW Ver. 4.0, March

2009


3/46


Service Activation NBI User Manual xxvii User Guide

Legal Rights

Copyright 4/27/09 Alvarion Ltd. All rights reserved.

The material contained herein is proprietary, privileged, and confidential and

owned by Alvarion or its third party licensors. No disclosure thereof shall be made

to third parties without the express written permission of Alvarion Ltd.

Alvarion Ltd. reserves the right to alter the equipment specifications and

descriptions in this publication without prior notice. No part of this publication

shall be deemed to be part of any contract or warranty unless specifically

incorporated by reference into such contract or warranty.

Trade Names

Alvarion

, BreezeCOM

, WALKair

, WALKnet

, BreezeNET

, BreezeACCESS

,BreezeLINK, BreezeMAX, BreezeLITE, BreezePHONE, 4MOTION,

BreezeCONFIG, AlvariSTAR, AlvariCRAFT, MGW, eMGWand/or other

products and/or services referenced here in are either registered trademarks,

trademarks or service marks of Alvarion Ltd.

All other names are or may be the trademarks of their respective owners.

WiMAX Forum is a registered trademark of the WiMAX Forum. WiMAX, the

WiMAX Forum logo, WiMAX Forum Certified,andtheWiMAX Forum Certified logo

are trademarks of the WiMAX Forum.

Statement of Conditions

The information contained in this manual is subject to change without notice.

Alvarion Ltd. shall not be liable for errors contained herein or for incidental or

consequential damages in connection with the furnishing, performance, or use of

this manual or equipment supplied with it.

Warranties and Disclaimers

All Alvarion Ltd. ("Alvarion") products purchased from Alvarion or through any of

Alvarion's authorized resellers are subject to the following warranty and product

liability terms and conditions.

Exclusive Warranty

(a) Alvarion warrants that the Product hardware it supplies and the tangible

media on which any software is installed, under normal use and conditions, will

be free from significant defects in materials and workmanship for a period of

fourteen (14) months from the date of shipment of a given Product to Purchaser

(the "Warranty Period"). Alvarion will, at its sole option and as Purchaser's sole


4/46


5/46


Service Activation NBI User Manual xxix User Guide

(b) PURCHASER'S SOLE REMEDY FOR BREACH OF THE EXPRESS

WARRANTIES ABOVE SHALL BE REPLACEMENT OR REFUND OF THE

PURCHASE PRICE AS SPECIFIED ABOVE, AT ALVARION'S OPTION. TO THE

FULLEST EXTENT ALLOWED BY LAW, THE WARRANTIES AND REMEDIES SETFORTH IN THIS AGREEMENT ARE EXCLUSIVE AND IN LIEU OF ALL OTHER

WARRANTIES OR CONDITIONS, EXPRESS OR IMPLIED, EITHER IN FACT OR BY

OPERATION OF LAW, STATUTORY OR OTHERWISE, INCLUDING BUT NOT

LIMITED TO WARRANTIES, TERMS OR CONDITIONS OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE, SATISFACTORY QUALITY,

CORRESPONDENCE WITH DESCRIPTION, NON-INFRINGEMENT, AND

ACCURACY OF INFORMATION GENERATED. ALL OF WHICH ARE EXPRESSLY

DISCLAIMED. ALVARION' WARRANTIES HEREIN RUN ONLY TO PURCHASER,

AND ARE NOT EXTENDED TO ANY THIRD PARTIES. ALVARION NEITHER

ASSUMES NOR AUTHORIZES ANY OTHER PERSON TO ASSUME FOR IT ANY

OTHER LIABILITY IN CONNECTION WITH THE SALE, INSTALLATION,

MAINTENANCE OR USE OF ITS PRODUCTS.

Limitation of Liability

(a) ALVARION SHALL NOT BE LIABLE TO THE PURCHASER OR TO ANY THIRD

PARTY, FOR ANY LOSS OF PROFITS, LOSS OF USE, INTERRUPTION OF

BUSINESS OR FOR ANY INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE OR

CONSEQUENTIAL DAMAGES OF ANY KIND, WHETHER ARISING UNDER

BREACH OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY

OR OTHERWISE AND WHETHER BASED ON THIS AGREEMENT OR

OTHERWISE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

(b) TO THE EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT SHALL

THE LIABILITY FOR DAMAGES HEREUNDER OF ALVARION OR ITS EMPLOYEES

OR AGENTS EXCEED THE PURCHASE PRICE PAID FOR THE PRODUCT BY

PURCHASER, NOR SHALL THE AGGREGATE LIABILITY FOR DAMAGES TO ALL

PARTIES REGARDING ANY PRODUCT EXCEED THE PURCHASE PRICE PAID

FOR THAT PRODUCT BY THAT PARTY (EXCEPT IN THE CASE OF A BREACH OF

A PARTY'S CONFIDENTIALITY OBLIGATIONS).

Disposal of Electronic and Electrical Waste

Disposal of Electronic and Electrical Waste

Pursuant to the WEEE EU Directive electronic and electrical waste must not be disposed of with

unsorted waste. Please contact your local recycling authority for disposal of this product.


6/46


Service Activation NBI User Manual xxx User Guide

Important Notice

This user manual is delivered subject to the following conditions and restrictions:

This manual contains proprietary information belonging to Alvarion Ltd. Such

information is supplied solely for the purpose of assisting properly authorized

users of the respective Alvarion products.

No part of its contents may be used for any other purpose, disclosed to any

person or firm or reproduced by any means, electronic and mechanical,

without the express prior written permission of Alvarion Ltd.

The text and graphics are for the purpose of illustration and reference only.

The specifications on which they are based are subject to change withoutnotice.

The software described in this document is furnished under a license. The

software may be used or copied only in accordance with the terms of that

license.

Information in this document is subject to change without notice. Corporate

and individual names and data used in examples herein are fictitious unless

otherwise noted.

Alvarion Ltd. reserves the right to alter the equipment specifications and

descriptions in this publication without prior notice. No part of this

publication shall be deemed to be part of any contract or warranty unless

specifically incorporated by reference into such contract or warranty.

The information contained herein is merely descriptive in nature, and does not

constitute an offer for the sale of the product described herein.

Any changes or modifications of equipment, including opening of the

equipment not expressly approved by Alvarion Ltd. will void equipmentwarranty and any repair thereafter shall be charged for. It could also void the

user's authority to operate the equipment.


7/46


8/46

Contents

Service Activation NBI User Manual 1 User Guide

Contents

1. Introduction ....................................................................................... 25

1.1 WSDL File....................................................................................................................25

1.2 Abbreviations .............................................................................................................26

2. API Northbound Interface .................................................................26

2.1 Radio Link Commands ..............................................................................................26

2.1.1 Radio Link Status..............................................................................................26

2.1.2 Radio Link Status by CPE Name ......................................................................27

2.2 Service Commands....................................................................................................29

2.2.1 Create Service ..................................................................................................29

2.2.2 Modify Service...................................................................................................31

2.2.3 Delete Service...................................................................................................33

2.2.4 Service Status ...................................................................................................34

2.2.5 Service List Request By CPE Name.................................................................35

2.2.6 Service List Request By CPE MAC...................................................................36

2.2.7 Service List by CPE MAC on a Multiple BST....................................................37

2.2.8 Service Profile List ............................................................................................39

2.2.9 Query Service MAC ..........................................................................................39

2.3 Base Station Commands...........................................................................................40

2.3.1 Base Station List ...............................................................................................40

2.4 Subscriber Commands..............................................................................................41

2.4.1 Create Subscriber .............................................................................................41

2.4.2 Modify Subscriber .............................................................................................42


9/46

Contents


2.4.3 Delete Subscriber..............................................................................................43

2.5 SU Related Commands..............................................................................................44

2.5.1 Modify SU..........................................................................................................44

2.5.2 SU List by BST..................................................................................................45

2.6 CPE Commands .........................................................................................................46

2.6.1 Create CPE.......................................................................................................46

2.6.2 Reset CPE by CPE Name.................................................................................47

2.6.3 Reset CPE by MAC Address ............................................................................48

2.6.4 CPE Details Request By CPE Name ................................................................49

2.6.5 CPE Details Request By MAC Address ............................................................50

2.6.6 Make CPE Temporary by Name .......................................................................51

2.6.7 Make CPE Temporary by MAC.........................................................................52

2.6.8 Delete CPE by Name ........................................................................................53

2.6.9 Delete CPE by MAC..........................................................................................54

3. API Error Codes .................................................................................55

3.1 General Error Codes ..................................................................................................55

3.2 Detailed Error Codes..................................................................................................56

Appendix A - NBI Implementation Example .........................................59


10/46

Introduction WSDL File


1. Introduction

The Service Activation Northbound Interface (NBI) provides the means of

integration between the BreezeMAX network elements (Base Stations and CPEs)and an upper level management system (OSS). The upper level management

system issues requests to AlvariSTAR via the NBI, and AlvariSTAR processes

these requests and communicates the results.

The NBI is based on Web Services with XML/SOAP, supporting multiple (up to 25)

simultaneous users. AlvariSTAR manages a queue of the requests to the devices.

1.1 WSDL File

The Web Services Description Language (WSDL) file is included in the AlvariSTAR

installation CD, located in the "mib and wsdl" folder.

The NBI WSDL includes a service element that defines the ports supported by the

Web service. Web service clients can learn from the service element where to

access the service and through which port to access the Web service. In order to

fit the WSDL to your specific environment, the following WSDL element must be

modified.

Open the NBI WSDL file using a text editor and replace the string AlvariSTAR_IP

with the IP address of your AlvariSTAR server machine.

Soap bindings for the WSDL documents defined in this specification MUST use

"document" for the style attribute.

NOTE

The AlvariSTAR NBI server uses by default the 8080 port. If you choose to change the default port

make sure you make the corresponding change to the WSDL file


11/46

API Northbound Interface Abbreviations


1.2 Abbreviations

2. API Northbound Interface

This section defines the commands that are available in AlvariSTAR. These

commands are initiated by the OSS and AlvariSTAR responds with the relevantinformation.

2.1 Radio Link Commands

2.1.1 Radio Link Status

This command is a request to view the radio link status of a specific CPE.

2.1.1.1 Command

RadioLinkStatus

2.1.1.2 Response

RadioLinkStatusResponse

BST Base Station

CPE Customer Premises Equipment

IP Internet Protocol

MAC Media Access Control

NBI Northbound Interface

NMS Network Management System

OSS Operations Support System

RSSI Received Signal Strength Indication

SNR Signal to Noise Ratio

SOAP Simple Object Access Protocol

SU Subscriber Unit

WSDL Web Services Description Language

XSD XML Schema Definition

Parameter Description Remark

CPE_MAC The MAC address of the CPE. Mandatory


12/46

API Northbound Interface Radio Link Commands


This is AlvariSTARs response to the RadioLinkRequest command. If the status is

OK, the following list of parameters is returned. Otherwise, an error code is

returned.

2.1.2 Radio Link Status by CPE Name

This command is a request to view the radio link status of a specific CPE by CPE

name.

2.1.2.1 Command

RadioLinkStatusByCPEName

Parameter Description

ResultCode 0 - Success

10 - error: general

11 - error: feature Web Services not licensed

108 - error: bad cpeMac

201 - error: base station not found

202 - error: su not found

203 - error: radio link parameters not found

402 - error: su not licensed

Result Description

BST_IP The identifier (IP address) of the Base Station to which the CPE can

connect.

SNR_UL The SNR of the uplink signal.

SNR_DL The SNR of the downlink signal.

RSSI_UL The RSSI of the uplink signal.

RSSI_DL The RSSI of the downlink signal.

Rate_UL The rate of the uplink signal.

Rate_DL The rate of the downlink signal.

SlotID The Slot ID of the AU to which the CPE is connected.

CPE_Software_Version The software version of the CPE.

berTest When this functionality is activated, this will display the BER of the uplink

in percentage value.


13/46

API Northbound Interface Radio Link Commands


2.1.2.2 Response

RadioLinkStatusByCPENameResponse

This is AlvariSTARs response to the RadioLinkStatusByCPEName command. If

the status is OK, the following list of parameters is returned. Otherwise, an error

code is returned.


CPE_NAME The identifier (IP address) of the

Base Station from which the list of

service profile names is to be

retrieved.

Mandatory



10 - error: general


115 - error: must input cpe name



203 - error: radio link parameters not found


404 - error: more than one su with the same name

Result Description

BST_IP The identifier (IP address) of the Base Station to which the CPE can

connect.

SNR_UL The SNR of the uplink signal.

SNR_DL The SNR of the downlink signal.

RSSI_UL The RSSI of the uplink signal.

RSSI_DL The RSSI of the downlink signal.

Rate_UL The rate of the uplink signal.

Rate_DL The rate of the downlink signal.

SlotID The Slot ID of the AU to which the CPE is connected.

CPE_Software_Version The software version of the CPE.


14/46

API Northbound Interface Service Commands


2.2 Service Commands

2.2.1 Create Service

This command is a request to create a new service.

2.2.1.1 Command

ServiceCreate

berTest When this functionality is activated, this will display the BER of the uplink

in percentage value.


BST_IP The identifier (IP address) of the

Base Station to which the CPE can

connect.

Mandatory

Service_name The name of the service to be

created.

Mandatory

Subscriber_ID A unique identifier defined by the

customer representative when

configuring a subscriber.

AlvariSTAR uses this parameter to

configure the CPEs subscriber

name.

The Subscriber ID must exist in the

NMS prior to initiating the service

creation.

Mandatory


Service_Profile_Name The name of the service profile as

defined in AlvariSTAR.

Mandatory

VLAN List A list of VLAN IDs behind the CPEassociated with the applicable

subscriber. The list includes VLAN

IDs, each in the range of 0-4094,

separated by commas.

An empty string denotes No VLAN.

Mandatory



15/46


16/46



2.2.2 Modify Service

This command is a request to modify an existing service.

2.2.2.1 Command

ServiceModify



10 - error: general


106 - error: wrong vlan access

107 - error: bad service profile


109 - error: bad subscriber id

110 - error: bad service name

111 - error: bad bs ip

112 - error: bad admin status

113 - error: bad hybrid vlan

114 - error: bad vlan classification mode


206 - error: base station is not licensed

204 - error: base station unreachable

205 - error: base station agent

301 - error: subscriber does not exist

+ ALL service (500) error codes

ResultDescription

NOTE

Changing the CPE MAC address is allowed only for FDD systems where the admin status is

Disabled. For TDD systems, or when the admin status is Enabled, error 513

ERROR_SERVICE_CPEMAC_MISMATCH will be returned.


17/46






connect.

Mandatory


created.

Mandatory






name.

The Subscriber ID must exist in the

NMS prior to initiating the service

creation.

Mandatory


Service_Profile_Name The name of the service profile as

defined in AlvariSTAR.

Mandatory

VLAN List A list of VLAN IDs behind the CPE

associated with the applicable

subscriber. The list includes VLAN

IDs, each in the range of 0-4094,

separated by commas.

An empty string denotes No VLAN.

Mandatory

Hybrid_VLAN_mode Defines the Hybrid VLAN mode

(on/off).

If this parameter is omitted, the

default value (On) is used.

Mandatory

VLAN_Classification_Mode Defines the VLAN classification

mode (on/off).


default value (Off) is used.

Mandatory

Access_VLAN Defines the Access VLAN to be

used (1-4094 or Null for no Access

VLAN).


default value (None) is used.

Mandatory

Admin_Status The administrative status of the

service (Enabled/Disabled).

Mandatory


18/46



2.2.2.2 Response

ServiceModifyResponse

This is AlvariSTARs response to the ServiceModify command.

2.2.3 Delete Service

This command is a request to delete an existing service.

2.2.3.1 Command

ServiceDelete

NOTE

When modifying a service, all of the parameters must be specified in the request, even those that

are not changed.



10 - error: general


106 - error: wrong vlan access

107 - error: bad service profile





112 - error: bad admin status

113 - error: bad hybrid vlan

114 - error: bad vlan classification mode






+ ALL service (500) error codes

ResultDescription


19/46



2.2.3.2 Response

ServiceDeleteResponse

This is AlvariSTARs response to the ServiceDelete command.

2.2.4 Service Status

This command is a request to view the status of an existing service.

2.2.4.1 Command

ServiceStatus




connect.

Mandatory


created.

Mandatory


ResultCode 0 - successful operation

10 - error: general






503 - error: service name does not exist

ResultDescription




connect.

Mandatory


created.

Mandatory


20/46


21/46



2.2.6 Service List Request By CPE MAC

This command is a request to retrieve the list of service(s) by querying by CPE

MAC address) without knowing the serving Base Station.

2.2.6.1 Command

ServiceListByCPEMAC



10 - error: general








BST_IP Identifier of the Base Station to which the CPE can connect.

Service_name Name of the service to be created.

Subscriber_ID Unique identifier defined by the customer representative when configuring

a subscriber.

Service_Profile_Name The Service Profile name as defined in AlvariSTAR.

VLAN List A list of VLAN IDs that are associated with the applicable Subscriber. Each

VLAN IDs is within the range of 0 to 4094, separated by commas. An

empty string refers to No VLAN.

Hybrid_VLAN_mode Defines if the Hybrid VLAN mode is active or not (on/off).

VLAN_Clasification_Mode Defines if the VLAN Classification mode is active or not (on/off). If this

parameter is omitted, then the default value will be used.

Access_VLAN Defines the Access VLAN to be used (1-4094 or Null for no Access

VLAN). If this parameter is omitted, then the default value will be used.

Admin_Status Admin status of the service. (Enabled/Disabled)

Operational_Status Active / Inactive


CPE_MAC The CPEs MAC address. Mandatory


22/46



2.2.6.2 Response

ServiceListByCPEMACResponse

This is AlvariSTARs response to the ServiceListByCPEMAC command. It includesa list of all the all services defined for this CPE. The following information is

specified for each service.

2.2.7 Service List by CPE MAC on a Multiple BST

This command is a request to retrieve the list of services for a specific CPE. All

services from all BSTs are retrieved for the specific MAC.



10 - error: general


108 - error: bad cpe mac






BST_IP Identifier of the Base Station to which the CPE can connect.

Service_name Name of the service to be created.

Subscriber_ID Unique identifier defined by the customer representative when configuring

a subscriber.

Service_Profile_Name The Service Profile name as defined in AlvariSTAR.

VLAN List A list of VLAN IDs that are associated with the applicable Subscriber. Each

VLAN IDs is within the range of 0 to 4094, separated by commas. An

empty string refers to No VLAN.

Hybrid_VLAN_mode Defines if the Hybrid VLAN mode is active or not (on/off).

VLAN_Clasification_Mode Defines if the VLAN Classification mode is active or not (on/off). If this

parameter is omitted, then the default value will be used.

Access_VLAN Defines the Access VLAN to be used (1-4094 or Null for no Access

VLAN). If this parameter is omitted, then the default value will be used.

Admin_Status Admin status of the service. (Enabled/Disabled)

Operational_Status Active / Inactive


23/46



2.2.7.1 Command

serviceListByCPEMAConMultipleBSTRequest

All parameters are mandatory.

2.2.7.2 Response

serviceListByCPEMAConMultipleBSTResponse

This is AlvariSTARs response to the serviceListByCPEMAConMultipleBST

command.

2.2.7.3 Service_Info


cpeMac MAC Address of the CPE


ResultCode 0 successful operation

10 error: general

202 error: su not found

Result Description

Service List List of Service_Info (see Section 2.2.7.3)


bsIp IP of the BS where it is defined

serviceName Name of the service

subscriberId Name/Id of the Subscriber

serviceProfileName Service Profile

vlanList VLAN list

hybridVlanMode Hybrid VLAN mode

vlanClassificationMode Classification mode

accessVlan Access VLAN

adminStatus Administrative status

OperationalStatus Operation Status


24/46



2.2.8 Service Profile List

This command is a request to retrieve the list of service profile names from the

NMS.

2.2.8.1 Command

ServiceProfileList

2.2.8.2 Response

ServiceProfileListResponse

This is AlvariSTARs response to the ServiceProfileList command. It includes a list

of all the Service Profiles that exist in the specified Base Station. The following

information is specified for each Service Profile.

2.2.9 Query Service MAC

Get the BS IP and the MAC address for each BS that has the service registered.



Base Station from which the list of

service profile names is to be

retrieved.

Mandatory



10 - error: general


111- error: bad bs ip





ServiceProfileName The list of service profile names defined in AlvariSTAR.

ServiceProfileID The unique profile ID provided by AlvariSTAR.

BST_IP The list of Base Station IP addresses corresponding to this service profile.

BST_NAME The list of Base Station names corresponding to this service profile.


25/46

API Northbound Interface Base Station Commands


2.2.9.1 Command

queryServiceMAC

2.2.9.2 Response

2.3 Base Station Commands

2.3.1 Base Station List

This command is a request to retrieve the list of Base Stations from the NMS.

2.3.1.1 Command

BaseStationList

2.3.1.2 Response

BaseStationListResponse

This is AlvariSTARs response to the BaseStationList command. If the request is

empty, the response will contain a list of all the Base Stations. If the request


Service_name Service name Mandatory



10 - general error

11 - feature Web Services not licensed


503 - service name does not exist

ResultDescription According to the code

serviceMACList List of elements [bsIP, serviceMAC]



Base Station to be retrieved.

If left empty, all Base Stations will

be retrieved.

Optional


26/46

API Northbound Interface Subscriber Commands


includes a BST_IP, only the relevant parameters for this Base Station will be

retrieved.

2.4 Subscriber Commands

2.4.1 Create Subscriber

This command is a request to create a new subscriber.

2.4.1.1 Command

SubscriberCreate

2.4.1.2 Response

SubscriberCreateResponse



10 - error: general



BST_name The name of the Base Station as defined in AlvariSTAR.

BST_IP The identifier (IP address) of the Base Station

BST_ID The Base Station ID. Always null (this field will be implemented in futurereleases).




connect.

Mandatory






name.

Mandatory

FirstName The subscribers first name. Optional

LastName The subscribers last name. Optional

Description A description of the subscriber. Optional


27/46


28/46


29/46

API Northbound Interface SU Related Commands


2.5 SU Related Commands

2.5.1 Modify SU

This command is a request to change the name of a specific SU identified by MACand the BS IP where it is present.

2.5.1.1 Command

suModifyRequest

All Parameters are mandatory.

2.5.1.2 Response

suModifyResponse

This is AlvariSTARs response to the suModify command.



10 - error: general








304 - error: subscriber is used by at least 1 service


ResultDescription


cpeMac MAC Address of the CPE

cpeName New name of the CPE

bsIp IP of the BS where it is connected


30/46

API Northbound Interface SU Related Commands


2.5.2 SU List by BST

This command is a request to retrieve the list of SUs present on a specific BST.

2.5.2.1 Command

suListByBSTRequest

All parameters are mandatory.

2.5.2.2 Response

suListByBSTResponse

This is AlvariSTARs response to the suListByBST command.


Result Code 0 successful operation

10 error: general

201 error: base station not found

202 error: su not found

204 error: base station unreachable

205 error: base station agent

Result Description


bsIp IP of the BST to query


Result Code 0 successful operation

10 error: general

201 error: base station not found

204 error: base station unreachable

205 error: base station agent

Result Description

SU List List of SU_Info (see Section 2.5.2.3)


31/46


32/46

API Northbound Interface CPE Commands


2.6.1.2 Response

SUResponse

This is AlvariSTARs response to the SuCreate command.

2.6.2 Reset CPE by CPE Name

This command is a request to reset the CPE by CPE name.

2.6.2.1 Command

ResetCPEByName

2.6.2.2 ResponseResetCPEByNameResponse

This is AlvariSTARs response to the ResetCPEByName command.



10 - error: general






405 - error: su could not be created because BS switching mode is IP CS

406 - error: su already exists

ResultDescription Up

Down


CPE_Name The name of the CPE Mandatory


33/46



2.6.3 Reset CPE by MAC Address

This command is a request to reset the CPE by MAC address.

2.6.3.1 Command

ResetCPEByMAC

2.6.3.2 Response

ResetCPEByMACResponse

This is AlvariSTARs response to the ResetCPEByMAC command.



10 - error: general





207 - error: su unreachable


402 - error: su could not reset

ResultDescription


CPE_MAC_Address The CPEs MAC address Mandatory


34/46



2.6.4 CPE Details Request By CPE Name

This command is a request to query a CPE by user name (CPE name).

2.6.4.1 Command

GetCpeDetailsByName

2.6.4.2 Response

GetCpeDetailsByNameResponse

This is AlvariSTARs response to the GetCpeDetailsByName command.



10 - error: general






402 - error: su could not reset

ResultDescription




BST_IP The identifier (IP address) of the Base Station in which the CPE is

created.

CPE_MAC_Address The CPEs MAC address

CPE_Name The name of the CPE

CPE_Serial_number The CPEs serial number

CPE_SW_Ver The CPEs software version


35/46



2.6.5 CPE Details Request By MAC Address

This command is a request to query a CPE by MAC address.

2.6.5.1 Command

GetCpeDetailsByMAC

2.6.5.2 Response

GetCpeDetailsByMACResponse

This is AlvariSTARs response to the GetCpeDetailsByMAC command.


10 - error: general







ResultDescription


CPE_MAC_Address The CPEs MAC address Mandatory


BST_IP The identifier (IP address) of the Base Station in which the CPE is

created.

CPE_MAC_Address The CPEs MAC address

CPE_Name The name of the CPE

CPE_Serial_number The CPEs serial number

CPE_SW_Ver The CPEs software version



36/46



2.6.6 Make CPE Temporary by Name

This command changes the SU permanence status from permanent to temporary

for a specific CPE name. Permanence status can be changed only when the SU

does not have any associated services.

This method assumes that SU names are unique in the Operators network. If

more than one SU exists with the specified name, an error will be returned.

2.6.6.1 Command

makeCPETemporarybyName

2.6.6.2 Response

makeCPETemporarybyNameResponse

This is AlvariSTARs response to the makeCPETemporarybyName command.


10 - error: general







ResultDescription





37/46



2.6.7 Make CPE Temporary by MAC

This command changes the SU permanence status from permanent to temporary

for a specific CPE MAC ID. Permanence status can be changed only when the SU

does not have any associated services.

2.6.7.1 Command

makeCPETemporarybyMAC

2.6.7.2 Response

makeCPETemporarybyMACResponse

This is AlvariSTARs response to the makeCPETemporarybyMAC command.



10 - error: general









514 - error: su has services defined

ResultDescription


CPE_MAC The MAC ID of the CPE Mandatory


38/46



2.6.8 Delete CPE by Name

This command deletes an SU form the Base Station (by CPE name). An SU can be

deleted only when it is not registered or when it has no associated services.

This method assumes that SU names are unique in the Operators network. If

more than one SU exists with the specified name, an error will be returned.

2.6.8.1 Command

deleteCPEbyName

2.6.8.2 Response

deleteCPEbyNameResponse

This is AlvariSTARs response to the deleteCPEbyName command.



10 - error: general









ResultDescription




39/46



2.6.9 Delete CPE by MAC

This command deletes an SU form the Base Station (by CPE MAC ID). An SU can

be deleted only when it is not registered or when it has no associated services.

This method assumes that SU names are unique in the Operators network. Ifmore than one SU exists with the specified name, an error will be returned.

2.6.9.1 Command

deleteCPEbyMAC

2.6.9.2 ResponsedeleteCPEbyMACResponse

This is AlvariSTARs response to the deleteCPEbyMAC command.



10 - error: general










ResultDescription


CPE_MAC The MAC ID of the CPE Mandatory


40/46


41/46

API Error Codes Detailed Error Codes


3.2 Detailed Error Codes

Result

Code

Result Code Constant Result Description

Success

0 SUCCESS Successful operation

Failures

10 ERROR error: general

100 ERROR_INPUT error: input parameters

101 ERROR_INPUT_VLAN error: input parameters VLAN list

102 ERROR_INPUT_VLAN_MUST_DEFINE error: must define VLAN list

103 ERROR_INPUT_VLAN_MUST_BE_EMPTY error: VLAN list must be empty

104 ERROR_INPUT_VLAN_ONLY_ONE error: VLAN list must have only one element

105 ERROR_INPUT_VLAN_ACCESS_LIST_MISMATCH error: VLAN access list mismatch

106 ERROR_INPUT_VLAN_ACCESS error: wrong VLAN access

107 ERROR_INPUT_SERVICE_PROFILE_NAME error: bad service profile

108 ERROR_INPUT_CPEMAC error: bad cpeMac

109 RROR_INPUT_SUBSCRIBER_ID error: bad subscriber id

110 ERROR_INPUT_SERVICE_NAME error: bad service name

111 ERROR_INPUT_BSIP error: bad bs ip

112 ERROR_INPUT_ADMIN_STATUS error: Bad Admin status value

113 ERROR_INPUT_HYBRID_VLAN error: Bad Hybrid VLAN value

114 ERROR_INPUT_VLAN_CLASSIFICATION_MODE error: Bad classification mode value

115 error: must input cpe name

200 ERROR_BS error: device

201 ERROR_BS_NOT_FOUND error: base station not found

202 ERROR_BS_SU_NOT_FOUND error: su not found

203 ERROR_BS_RADIO_LINK_PARAMETERS_NOT_F

OUND

error: radio link parameters not found

204 ERROR_BS_UNREACHABLE error: base station unreachable

205 ERROR_BS_AGENT error: base station agent

207 error: su unreachable

300 ERROR_SUBSCRIBER error: create subscriber


42/46


43/46



513 ERROR_SERVICE_CPEMAC_MISMATCH erro r: service cpeMac mismatch

514 SU_SERVICE_EXISTS error: An associated service exists

Result

Code

Result Code Constant Result Description


44/46



Appendix A NBI Implementation

Example

The following diagram describes an optional scenario for using the NBI web

services when provisioning BreezeMAX services from a autonomous OSS. The NBI

functionality is highlighted in the provisioning flow diagram.


45/46



Figure 1: Optional Provisioning Flow Diagram

Service Profile creation and

distribution to BST

through AlvariSTAR (including

default service profiles)

AlvariSTAR Customer Service

Representative

Installer at customer

premises

Set unique SubscriberIDInstall CPE

Defines admin information

for user

Connect to Operators Web site

(using default service profile)

Enter the following:

CPE MAC

Subscriber ID

InstallationParameters()

Verify Connection is OK RadioLinkStatus()

Reply withRadioLinkStatus

parameters

RadioLinkStatusResponse()

Verify against thresholds

for installation qualification

CPE is

qualified?

Request A* creation of

new service

Yes

ServiceCreate()

Verify Service

can be created

Yes

No

CPE not qualified

No

Return Fail to install CPE

ServiceCreateResponse(Fail)

InstallationParametersResponse(Failure)

Service Faild to

CreateCreate Service at BST

with all service

parameters, including

creation of permanent SU

Return Success InstallationParametersResponse(Success)

Service Created

ServiceCreateResponse(Success)

Request A* creation of

new subscriber SubscriberCreate()

Subscriber successfully

created or already exists

Yes

No

SubscriberCreateResponse(Fail)

SubscriberCreateResponse(Success)


Service Failed to

create


Upper Layer

Management System


46/46

alvaristar v4.0 service activation nbi 090427

Documents