netspan northbound if user guide sr6

Download Netspan Northbound if User Guide SR6

Post on 28-Apr-2015

59 views

Category:

Documents

0 download

Embed Size (px)

TRANSCRIPT

Northbound Interface User GuideSoftware Release 6.5 UGD-D00022

Northbound Interface User Guide SR 6.5

Copyright by Airspan Networks Inc., 2008. All rights reserved worldwide.

The information contained within this document is proprietary and is subject to all relevant copyright, patent and other laws protecting intellectual property, as well as any specific agreements protecting Airspan Networks Inc. rights in the aforesaid information. Neither this document nor the information contained herein may be published, reproduced or disclosed to third parties, in whole or in part, without the express, prior, written permission of Airspan Networks Inc. In addition, any use of this document or the information contained herein for the purposes other than those for which it is disclosed is strictly forbidden. Airspan Networks Inc. reserves the right, without prior notice or liability, to make changes in equipment design or specifications. Information supplied by Airspan Networks Inc. is believed to be accurate and reliable. However, no responsibility is assumed by Airspan Networks Inc. for the use thereof nor for the rights of third parties which may be effected in any way by the use of thereof. Any representation(s) in this document concerning performance of Airspan Networks Inc. product(s) are for informational purposes only and are not warranties of future performance, either expressed or implied. Airspan Networks Inc. standard limited warranty, stated in its sales contract or order confirmation form, is the only warranty offered by Airspan Networks Inc. in relation thereto. This document may contain flaws, omissions or typesetting errors; no warranty is granted nor liability assumed in relation thereto unless specifically undertaken in Airspan Networks Inc. sales contract or order confirmation. Information contained herein is periodically updated and changes will be incorporated into subsequent editions. If you have encountered an error, please notify Airspan Networks Inc. All specifications are subject to change without prior notice. Product performance figures quoted within this document are indicative and for information purposes only.

Page 2

Commercial in Confidence

UGD-D00022 Rev A

Northbound Interface User Guide SR 6.5

Revision HistoryRevision Draft 1.0 Originator David Cann Date 31/01/2008 Description Updated with comments from K. Dudzinski Updated with comments from K. Dudzinski and D. Thiru

Draft 2.0

David Cann

04/02/2008

Revision A

David Cann

05/02/2008

Page 3

Commercial in Confidence

UGD-D00022 Rev A

Northbound Interface User Guide SR 6.5

Worldwide Headquarters: Airspan Networks Inc. 777, Yamato Road, Suite 105, Boca Raton, FL 3341-4408, USA Tel: +1 561 893 8670 www.airspan.com

Main Operations: Airspan Communications Ltd Cambridge House, Oxford Road, Uxbridge, Middlesex, UB8 1UN, UK Tel: +44 (0)1895 467100

UK WEE Registration number: WEE/AB0207WZ Airspan Networks Inc acknowledges the following trademarks used within this document:

Internet Information Services (IIS) Microsoft Corporation http://www.microsoft.com

Page 4

Commercial in Confidence

UGD-D00022 Rev A

Northbound Interface User Guide SR 6.5

Table of ContentsTable of Contents.................................................................................................................. 5 Glossary of Terms............................................................................................................... 10 Summary of Figures and Tables ......................................................................................... 12 1 Introduction .................................................................................................................. 14 1.1 General Overview ................................................................................................. 14 Northbound Interface ..................................................................................... 14

1.1.1 1.2 1.3 1.4 2

Where Northbound Interface fits into the Netspan Architecture ............................. 15 Consuming Web Services ..................................................................................... 15 Using Asynchronous Clients ................................................................................. 16

Get Started with the Northbound Interface ................................................................... 17 2.1 2.2 Workflow of the Northbound Interface ................................................................... 17 Navigating the Northbound Interface..................................................................... 18

3

Enable or Disable Northbound Interface ...................................................................... 21 3.1 3.2 Disabling the Northbound Interface ....................................................................... 21 Enabling the Northbound Interface........................................................................ 21

4

Enable or Disable Authentication and Authorisation ..................................................... 22 4.1 4.2 Disabling Authentication ....................................................................................... 23 Enabling Authentication ........................................................................................ 23

5

Provision Service and Define Service Profiles .............................................................. 24 5.1 SS Provisioning .................................................................................................... 24 Provisioning SS [ProvisionSS] ....................................................................... 25 Provisioning Fixed SS [ProvisionFixedSS] ..................................................... 26 Provisioning a Custom SS [ProvisionCustomSS] ........................................... 26 Re-provisioning the SS [Reprovision] ............................................................. 26 De-provisioning the SS [Deprovision] ............................................................. 26 Commercial in Confidence UGD-D00022 Rev A

5.1.1 5.1.2 5.1.3 5.1.4 5.1.5

Page 5

Northbound Interface User Guide SR 6.5

5.1.6 5.1.7 5.1.8

Disabling Service on the SS [DisableService] ................................................ 26 Enabling Service on the SS [EnableService] .................................................. 26 Getting the SS Provisioning Configuration [GetSSProvisioningConfig] .......... 26

5.1.9 Getting the SS Custom Provisioning Configuration [GetSSCustomProvisioningConfig]............................................................................... 26 5.1.10 5.1.11 Getting the SS Provisioning Status [GetProvisioningStatus] .......................... 26 Provisioning a Custom SS within the NMS [ProvisionCustomSSV2] .............. 27

5.1.12 Getting the Custom SS Provisioning Configuration [GetSSCustomProvisioningConfigV2] .......................................................................... 27 5.2 Service Profiles ..................................................................................................... 27 Producing the Service Profiles List [GetServiceProductList]........................... 27 Retrieving the Custom Configuration List [GetSSCustomConfigList] .............. 28 Producing the VLAN List [GetVlanList] ........................................................... 28 Retrieving Global Configuration Profiles [GetGlobalConfig]............................ 28 Producing the SS VLAN Port Profiles List [GetSSVlanPortProfileList] ............ 28 Retrieving the Global SSV2 Configuration [GetGlobalConfigV2] .................... 28

5.2.1 5.2.2 5.2.3 5.2.4 5.2.5 5.2.6 5.3

View Inventory ...................................................................................................... 28 Producing the BS Sector List [BSSectorList] .................................................. 28

5.3.1 5.4

Service Product .................................................................................................... 28 Producing the Service Product List [ServiceProductList] ................................ 28 Creating the Service Product Name [ServiceProductCreate] ......................... 29 Deleting the Service Product Name [ServiceProductDelete] .......................... 29 Producing the Service Flow Template List [ServiceFlowTemplateList] ........... 29 Getting the Service Flow Template Configuration [ServiceFlowTemplateGet] 29 Creating the Service Flow Template [ServiceFlowTemplateCreate] ............... 29 Deleting the Service Flow Template [ServiceFlowTemplateDelete] ................ 29 Updating the Service Flow Template [ServiceFlowTemplateUpdate] ............. 29 Commercial in Confidence UGD-D00022 Rev A

5.4.1 5.4.2 5.4.3 5.4.4 5.4.5 5.4.6 5.4.7 5.4.8

Page 6

Northbound Interface User Guide SR 6.5

5.4.9 Producing the Service Flow Template Classifiers List [ServiceFlowTemplateClassifiersList] ........................................................................... 29 5.4.10 Clearing the Service Flow Template Classifiers List [ServiceFlowTemplateClassifiersClear] ........................................................................ 29 5.4.11 Adding the Service Flow Template Classifiers List [ServiceFlowTemplateClassifiersAdd] .......................................................................... 29 5.4.12 Removing Service Flow Template Classifiers List [ServiceFlowTemplateClassifiersRemove] ................................................................... 29 5.5 Service Class ............................................................

Recommended

View more >