Integration

Guide NX SOAP API Guide

NX SOAP API Guide

Important Notice
Allot Communications Ltd. ("Allot") is not a party to the purchase agreement under which NetEnforcer was purchased,
and will not be liable for any damages of any kind whatsoever caused to the end users using this manual, regardless of
the form of action, whether in contract, tort (including negligence), strict liability or otherwise.
SPECIFICATIONS AND INFORMATION CONTAINED IN THIS MANUAL ARE FURNISHED FOR
INFORMATIONAL USE ONLY, AND ARE SUBJECT TO CHANGE AT ANY TIME WITHOUT NOTICE, AND
SHOULD NOT BE CONSTRUED AS A COMMITMENT BY ALLOT OR ANY OF ITS SUBSIDIARIES. ALLOT
ASSUMES NO RESPONSIBILITY OR LIABILITY FOR ANY ERRORS OR INACCURACIES THAT MAY
APPEAR IN THIS MANUAL, INCLUDING THE PRODUCTS AND SOFTWARE DESCRIBED IN IT.
Please read the End User License Agreement and Warranty Certificate provided with this product before using the
product. Please note that using the products indicates that you accept the terms of the End User License Agreement and
Warranty Certificate.
WITHOUT DEROGATING IN ANY WAY FROM THE AFORESAID, ALLOT WILL NOT BE LIABLE FOR ANY
SPECIAL, EXEMPLARY, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES OF ANY KIND,
REGARDLESS OF THE FORM OF ACTION WHETHER IN CONTRACT, TORT (INCLUDING NEGLIGENCE),
STRICT LIABILITY OR OTHERWISE, INCLUDING, BUT NOT LIMITED TO, LOSS OF REVENUE OR
ANTICIPATED PROFITS, OR LOST BUSINESS, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.

Copyright
Copyright © 1997-2010 Allot Communications. All rights reserved. No part of this document may be reproduced,
photocopied, stored on a retrieval system, transmitted, or translated into any other language without a written permission
and specific authorization from Allot Communications Ltd.

Trademarks
Products and corporate names appearing in this manual may or may not be registered trademarks or copyrights of their
respective companies, and are used only for identification or explanation and to the owners' benefit, without intent to
infringe.
Allot and the Allot Communications logo are registered trademarks of Allot Communications Ltd.
NOTE: This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to Part
15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference when the
equipment is operated in a commercial environment. This equipment generates, uses, and can radiate radio frequency
energy and, if not installed and used in accordance with the instruction manual, may cause harmful interference to radio
communications. Operation of this equipment in a residential area is likely to cause harmful interference in which case
the user will be required to correct the interference at his own expense.
Changes or modifications not expressly approved by Allot Communication Ltd. could void the user's authority to operate
the equipment.

© 2010 Allot Communications. All rights reserved. 2

NX SOAP API Guide

Version History

Document Version Date NX Version

v1b1 4.11.09 NX10.1.1

v2b1 15.4.10 NX10.2.1

© 2010 Allot Communications. All rights reserved. 3

NX SOAP API Guide

Table of Contents
1. Introduction ............................................................................................................ 6
1.1. Allot’s NetXplorer System .............................................................................. 6
1.2. Terms and Concepts ........................................................................................ 6
1.2.1 Catalog ..................................................................................................... 6
1.2.2 Line .......................................................................................................... 6
1.2.3 Pipe .......................................................................................................... 6
1.2.4 Virtual Channel ........................................................................................ 7
1.2.5 Tube ......................................................................................................... 7
1.2.6 NetEnforcer .............................................................................................. 7
1.2.7 Service Gateway ...................................................................................... 7
1.3. Acronyms ........................................................................................................ 8
1.4. Web Services ................................................................................................... 8
2. Typical NX Data Flow ........................................................................................... 9
3. NX WSDL Overview ........................................................................................... 10
3.1. WSDL Files ................................................................................................... 10
3.2. Operations ..................................................................................................... 10
3.3.1 Policy Operations ................................................................................... 10
3.3.2 Catalog Operations................................................................................. 10
3.3.3 Topology Operations ............................................................................. 10
3.3.4 Web Update Operations ......................................................................... 10
3.3. Typical Work-Flow ....................................................................................... 11
4. WSDL Methods ................................................................................................... 11
4.1. Policy Methods .............................................................................................. 11
4.1.1 Policy ..................................................................................................... 11
4.1.2 TCAs ...................................................................................................... 12
4.1.3 TubeGroups............................................................................................ 12
4.1.4 Pipe ........................................................................................................ 13
4.1.5 VC .......................................................................................................... 13
4.2. Catalog Methods ........................................................................................... 14

© 2010 Allot Communications. All rights reserved. 4

NX SOAP API Guide

4.2.1. Resolving Catalog Names ...................................................................... 14

4.2.2. TOS Catalogs ......................................................................................... 14
4.2.3. QOS Catalogs......................................................................................... 14
4.2.4. DOS Catalogs......................................................................................... 15
4.2.5. VLAN Catalogs ..................................................................................... 15
4.2.6. Alert Catalogs ........................................................................................ 16
4.2.7. Application Catalogs .............................................................................. 17
4.2.8. Integrated Service Catalogs (Previously known as CoC Catalogs) ....... 17
4.2.9. Service Chains (Also known as CoCGroup) ......................................... 18
4.2.10. Host .................................................................................................... 18
4.2.11. Host Group ......................................................................................... 19
4.2.12. Service ................................................................................................ 19
4.2.13. Service Groups ................................................................................... 20
4.2.14. Time ................................................................................................... 20
4.2.15. Service Plan ........................................................................................ 21
4.3. Topology Methods ........................................................................................ 21
4.3.1. Devices ................................................................................................... 21
4.4. WebUpdates Methods ................................................................................... 22
4.4.1. Device .................................................................................................... 22
4.4.2. Server ..................................................................................................... 22

© 2010 Allot Communications. All rights reserved. 5

NX SOAP API Guide

1. Introduction
1.1. Allot’s NetXplorer System
Allot’s NetXplorer system provides essential functions to manage IP/broadband
services efficiently and profitably. NetXplorer is a highly scalable centralized
management platform providing a single access point for Allot NetEnforcer® or
Service Gateway deployments of any size, delivering unsurpassed network visibility.
Managers can monitor, provision and consolidate information simultaneously across
multiple Allot Network elements.

1.2. Terms and Concepts

This section introduces some of the basic terms and concepts used in the Allot’s
NetXplorer management system.

1.2.1 Catalog
Catalog entries, which are defined in the catalog editor, serve as conditions or actions
in the rules which make up a policy. In this way, they can be seen as the building
blocks of your policy. Once a catalog has been defined in the catalog editor, it can be
reused in different rules.

1.2.2 Line
A line is a logical entity within a policy and represents the highest level of hierarchy.
The total bandwidth running through the NetEnforcer or Service Gateway can be
divided into lines and each line can then be managed as if it were an independent link.
A line consists of a rule based on one or more sets of conditions and a set of actions
that apply when all of the conditions are met. The default fallback line exists in every
policy. Additional lines can then be added above the fallback line in the policy table.
The fallback line consists of a filter which cannot be modified or deleted. Traffic
which is not classified in any of the lines above it in the hierarchy, will be classified in
the fallback line. Every line, including the fallback line, contains one or more pipes.

1.2.3 Pipe
A pipe is a logical entity within a policy. The total bandwidth running through each
line can be divided into pipes, and each pipe can then be managed independently.
Each pipe consists of a rule based on one or more sets of conditions and a set of
actions that apply when all of the conditions are met. By default, every line contains
at least one pipe – the fallback pipe. Additional pipes can then be added above the
fallback pipe in the policy table. The filter of the fallback pipe cannot be modified or
deleted, and traffic that is not classified into any other pipes within a given line will
be classified in the fallback pipe. Every pipe, including the fallback pipe, contains one
or more virtual channels.

© 2010 Allot Communications. All rights reserved. 6

NX SOAP API Guide

1.2.4 Virtual Channel

A Virtual Channel (VC) is a logical entity within a policy and represents the most
granular level of policy hierarchy. The total bandwidth running through each pipe can
be divided into VCs, and each VC can then be managed independently. Each VC
consists of a rule based on one or more sets of conditions and a set of actions that
apply when all of the conditions are met. By default, every pipe contains at least one
VC – the fallback VC. Additional VCs can then be added above the fallback VC in
the policy table. The filter of the fallback VC cannot be modified or deleted, and
traffic that is not classified into any other VCs within a given pipe will be classified in
the fallback VC.

1.2.5 Tube
A generic term, used to designate a line, pipe or VC

1.2.6 NetEnforcer
The NetEnforcer is a broadband optimization device which collects traffic statistics
from the network and can implement quality of service per application and per
subscriber. Traffic statistics are collected in order to provide both real-time and long-
term data about the network. As well as collecting detailed information about the
traffic passing through, it, the NetEnforcer can also shape that traffic, applying quality
of service parameters which have been pre-defined by the user.

1.2.7 Service Gateway

The Service Gateway is a platform for enhancing service optimization and service
deployment. The Service Gateway provides an open, carrier-grade solution for
broadband service providers to manage multiple 10 or 1 Gigabit lines and deploy
value added services in one integrated platform. Application and subscriber
information within the Service gateway is identified for each traffic flow and
subsequently the flow is dispatched to an array of additional services and actions
using a single DPI process.

© 2010 Allot Communications. All rights reserved. 7

NX SOAP API Guide

1.3. Acronyms

DPI Deep Packet Inspection

NX NetXplorer
NE NetEnforcer
VC Virtual Channels
P2P Peer to Peer
SG Service Gateway
SMP Subscriber Management Platform.
ToS Type of Service
QoS Quality of Service
SOAP Simple Object Access Protocol
WSDL Web Services Data Language

1.4. Web Services

Allot has opened the NetXplorer server application to enable access by external
programs and system components. This enables other components to communicate
with the NX server via WSDL (web services data language). The common language
for doing this is SOAP. Third party applications can therefore be written in any
language that enables that application to view and update the XML files used in the
NetXplorer application server.
To activate the WS interface a WSDL file must be used to generate a code artifact.
This artifact may then be used to establish interaction with the NX Server via the WS
interface. The full WSDL file can be accessed from the NX Server as shown in
section ‎3.1 below.

© 2010 Allot Communications. All rights reserved. 8

NX SOAP API Guide

2. Typical NX Data Flow

The diagram below illustrates the typical management data flow through the Allot
solution

The NetXplorer architecture consists of three layers:

The DPI & QoS layer. This layer can include several NetEnforcer or Service
Gateway devices that implement the network management policies and collect
network usage data.
The NetXplorer Server Layer. This incorporates the actual NetXplorer application,
including the databases. Managing and communicating with the different clients that
access the system, it facilitates NetEnforcer or Service Gateway configuration, policy
provisioning, alarms, monitoring and reporting. The NetXplorer also includes an
integrated data collector, that streamlines the required collection of data from the
managed NetEnforcer or SG devices. In larger NetEnforcer deployments, and
deployments involving Service Gateways an external data collector is deployed
User Interface Layer. The user interface client can be installed on any computer on
the network that can connect to the NetXplorer server. It gives the operator access to a
graphic user interface to manage the solution. Alternatively, the NetXplorer server
can be accessed directly through an open SOAP interface which is described in this
document.

© 2010 Allot Communications. All rights reserved. 9

NX SOAP API Guide

3. NX WSDL Overview

3.1. WSDL Files

Each NetXplorer server includes a webservices interface. The WSDL file can be
accessed from the link below, with the IP address of the relevant NX server inserted
accordingly.
http://<NX-SERVER-IP>/nx/services/WsNxServices?wsdl

3.2. Operations
There are 4 different NX Web Service operations:

3.3.1 Policy Operations

Policy operations relate to the rules which make up the policy. The policy rules fit
into a 3-level hierarchy which consists of lines, pipes and virtual channels. Policy
operations are required to add, modify or delete lines, pipes and virtual channels.

3.3.2 Catalog Operations

Catalog operations relate to the building blocks of the rules – the condition and action
catalog entries. Once defined, these catalog entries are used to make up line, pipe or
VC rules. Catalog operations are required to add, get, delete or update catalogs

3.3.3 Topology Operations

Topology operations relate to the devices (Allot Service Gateways and NetEnforcers)
that make up the Allot system topology. Topology operations are used to add, get,
import or delete devices to be managed by the NetXplorer Server.

3.3.4 Web Update Operations

Web update operations refer to Allot’s Protocol update mechanism (APU), which
enables the administrator to regularly update the Service Catalog with signatures for
the latest applications and protocols, without any system downtime. Web Update
Operations enable the operator to update an NX server or a device (NetEnforcer or
Service Gateway) with the latest protocol pack, or alternatively to roll back to the
previous protocol pack.

© 2010 Allot Communications. All rights reserved. 10

NX SOAP API Guide

3.3. Typical Work-Flow

A typical work flow is represented in the table below. In this example the administrator wishes
to add a NetEnforcer to the network and create a pipe on the NetEnforcer to apply QoS for
traffic generated by a specified user at a specified time of day:
Stage Task Operation Method
1 Add a NetEnforcer device to Topology Operation addDevice
the network tree
2 Create the condition and Catalog Operation addHostCatalogEntries
action catalogs required
addTimeCatalogEntries
addQosCatalogEntries
3 Create a new pipe with the Policy Operation updatePolicy
catalogs defined

4. WSDL Methods
4.1. Policy Methods

4.1.1 Policy
Method Description Parameters Return Value
getPolicy Used to view the current Integer – deviceID Array (TubeDTO)
policy on a given NE or
Integer – PolicyID
SG
Boolean – skeleton
(alerts)
updatePolicy Used to update your Integer – deviceID void
policy (e.g: to add, update
Integer – PolicyID
or delete lines, pipes and
VCs in a policy) Array (TubeDTO)
Boolean - local
Boolean –
isEventSource
exportPolicy Used to export the policy Integer - deviceId Void
of one device to another
exportDefaultPolicy Used to roll a device’s DeviceTopology Void
policy back to the default DTO
policy

© 2010 Allot Communications. All rights reserved. 11

NX SOAP API Guide

4.1.2 TCAs
Method Description Parameters Return Value
getTubeTCAs Used to view the threshold Integer - tubeId Array -
crossing alarms currently (Tube2Alert2Actio
nDTO)
assigned to a line, pipe or
VC
updateTubeTCA Used to change the Tube2Alert2A Void
assignment of threshold ctionDTO
crossing alarms to a line,
pipe or VC
getDeviceTCAs Used to view the threshold Integer - Array -
crossing alarms currently deviceId (Device2Alert2
assigned to a NE or SG ActionDTO)
updateDeviceTCAs Used to change the Device2Alert2 Void
assignment of threshold ActionDTO
crossing alarms to a NE or
SG

4.1.3 TubeGroups

Method Description Parameters Return Value

getTubeGroups Used to view the groups Void Array
of lines, pipes or VCs (TubeGroupDTO)
that have been defined
getTubeGroupsByUser Used to view the groups Integer Array
of lines, pipes or VCs (TubeGroupDTO)
per specified user
getTubeGroupsByIds Used to view the groups Array (Integer) Array
of lines, pipes or VCs (TubeGroupDTO)
specified by ID
deleteTubeGroups Used to delete specified Array (Integer) Void
Line, pipe or VC groups
addTubeGroups Used to add specified Array Array
Line, pipe or VC groups (TubeGroupDTO) (TubeGroupDTO)
updateTubeGrops Used to update specified Array Void
Line, pipe or VC groups (TubeGroupDTO)

© 2010 Allot Communications. All rights reserved. 12

NX SOAP API Guide

4.1.4 Pipe

Method Description Parameters Return Value

getPipes Integer – deviceID Array (TubeDTO)
Integer – PolicyID
Integer - lineId
Boolean – skeleton
(alerts)

4.1.5 VC

Method Description Parameters Return Value

getVcs Integer – deviceID Array (TubeDTO)
Integer – PolicyID
Integer – lineId
Integer - pipeId
Boolean –
skeleton (alerts)

© 2010 Allot Communications. All rights reserved. 13

NX SOAP API Guide

4.2. Catalog Methods

4.2.1. Resolving Catalog Names

Method Description Parameters Return Value

resolveCatalogNames Used to resolve the Array Array

names of specified (CatalogIdentifier) (CatalogIdentifier)
catalogs

4.2.2. TOS Catalogs

Method Description Parameters Return Value

getTosCatalogEntries Used to get a list of void Array(TosDTO)

currently defined
ToS catalog entries
deleteTosCatalogEntries Used to delete an Array(TosDTO) void
array of ToS
catalog entries
addTosCatalogEntries Used to define new Array(TosDTO) void
ToS catalog entries
updateTosCatalogEntries Used to update Array(TosDTO) void
existing ToS
catalog entries
getTosEntriesByIds Used to retrieve a Array(Integer) Array(TosDTO)
list of ToS catalog
entries by ID

4.2.3. QOS Catalogs

Method Description Parameters Return Value

getQoSCatalogEntries Used to get a list of void Array(QosDTO)

currently defined
QoS catalog entries
deleteQoSCatalogEntries Used to delete an Array(QoSDTO) void
array of QoS
catalog entries
addQoSCatalogEntries Used to define new Array(QoSDTO) void
QoS catalog entries
updateQoSCatalogEntries Used to update Array(QoSDTO) void
© 2010 Allot Communications. All rights reserved. 14
NX SOAP API Guide

existing QoS
catalog entries
getQoSEntriesByIds Used to retrieve a Array(Integer) Array(QosDTO)
list of QoS catalog
entries by ID

4.2.4. DOS Catalogs

Method Description Parameters Return Value
getDoSCatalogEntries Used to get a list of void Array(DosDTO)
currently defined
DoS catalog entries
deleteDoSCatalogEntries Used to delete an Array(DoSDTO) Void
array of DoS
catalog entries
addDoSCatalogEntries Used to define new Array(DoSDTO) Void
DoS catalog entries
updateDoSCatalogEntries Used to update Array(DoSDTO) Void
existing DoS
catalog entries
getDoSEntriesByIds Used to retrieve a Array(Integer) Array(DosDTO)
list of DoS catalog
entries by ID

4.2.5. VLAN Catalogs

Method Description Parameters Return Value

getVlanCatalogEntries Used to get a list of void Array(VlanDTO)
currently defined
VLAN catalog
entries
deleteVlanCatalogEntries Used to delete an Array(VlanDTO) void
array of VLAN
catalog entries
addVlanCatalogEntries Used to define new Array(VlanDTO) void
VLAN catalog
© 2010 Allot Communications. All rights reserved. 15
NX SOAP API Guide

entries
updateVlanCatalogEntries Used to update Array(VlanDTO) void
existing VLAN
catalog entries
getVlanEntriesByIds Used to retrieve a Array(Integer) Array(VlanDTO)
list of VLAN
catalog entries by
ID

4.2.6. Alert Catalogs

Method Description Parameters Return Value

getAlertCatalogEntries Used to get a list of void Array(AlertDTO)
currently defined
Alert catalog
entries
deleteAlertCatalogEntries Used to delete an Array(AlertDTO) void
array of Alert
catalog entries
addAlertCatalogEntries Used to define new Array(AlertDTO) void
Alert catalog
entries
updateAlertCatalogEntries Used to update Array(AlertDTO) void
existing Alert
catalog entries
getAlertEntriesByIds Used to retrieve a Array(Integer) Array(AlertDTO)
list of Alert catalog
entries by ID
getAlertCounterEntriesBy Used to get a list of (Array(String) Array(AlertCounter
OIds currently defined DTO)
Alert catalog
entries

© 2010 Allot Communications. All rights reserved. 16

NX SOAP API Guide

4.2.7. Application Catalogs

Method Description Parameters Return Value

getApplicationCatalogEntries Used to get a list of void Array(Application

currently defined DTO)
Application catalog
entries
deleteApplicationCatalogEntries Used to delete an Array(Appli void
array of Application cationDTO)
catalog entries
addApplicationCatalogEntries Used to define new Array(Appli void
Application catalog cationDTO)
entries
updateApplicationCatalogEntries Used to update Array(Appli void
existing Application cationDTO)
catalog entries
getApplicationEntriesByIds Used to retrieve a list Array(Intege Array(Application
of Application r) DTO)
catalog entries by ID

4.2.8. Integrated Service Catalogs (Previously known as CoC Catalogs)

Method Description Parameters Return Value

getCocCatalogEntries Used to get a list of void Array(CocDTO)

currently defined
Integrated Service catalog
entries
deleteCocCatalogEntries Used to delete an array of Array(CocDTO) void
Integrated Service catalog
entries
addCocCatalogEntries Used to define new Array(CocDTO) void
Integrated Service catalog
entries
updateCocCatalogEntries Used to update existing Array(CocDTO) void
Integrated Service catalog
entries

© 2010 Allot Communications. All rights reserved. 17

NX SOAP API Guide

getCocEntriesByIds Used to retrieve a list of Array(Integer) Array(CocDTO)

Integrated Service catalog
entries by ID

4.2.9. Service Chains (Also known as CoCGroup)

Method Description Parameters Return Value

getCocGroupCatalogEntries Used to get a list of void Array(CocGroup

currently defined Service DTO)
Chain catalog entries
deleteCocGroupCatalogEntries Used to delete an array of Array(CocGrou void
Service Chain catalog pDTO)
entries
addCocGroupCatalogEntries Used to define new Service Array(CocGrou void
Chain catalog entries pDTO)
updateCocGroupCatalogEntries Used to update existing Array(CocGrou void
Service Chain catalog pDTO)
entries
getCocGroupEntriesByIds Used to retrieve a list of Array(Integer) Array(CocGroup
Service Chain catalog DTO)
entries by ID

4.2.10. Host

Method Description Parameters Return Value

getHostCatalogEntries Used to get a list of void Array(HostDTO)

currently defined Host
catalog entries
deleteHostCatalogEntries Used to delete an array of Array(HostDT void
Host catalog entries O)
addHostCatalogEntries Used to define new Host Array(HostDT void
catalog entries O)
updateHostCatalogEntries Used to update existing Array(HostDT void
Host catalog entries O)

© 2010 Allot Communications. All rights reserved. 18

NX SOAP API Guide

getHostEntriesByIds Used to retrieve a list of Array(Integer) Array(HostDTO)

Host catalog entries by ID

4.2.11. Host Group

Method Description Parameters Return Value

getHostGroups Used to get a list of void Array(HostGrou
currently defined Host pDTO)
Group catalog entries
deleteHostGroups Used to delete an array of Array(HostGro void
Host Group catalog entries upDTO)
addHostGroups Used to define new Host Array(HostGro void
Group catalog entries upDTO)
updateHostGroups Used to update existing Array(HostGro void
Host Group catalog entries upDTO)
getHostGroupByIds Used to retrieve a list of Array(Integer) Array(HostGrou
Host Group catalog entries pDTO)
by ID

4.2.12. Service

Method Description Parameters Return Value

getServiceCatalogEntries Used to get a list of void Array(ServiceDT
currently defined Service O)
catalog entries
deleteServiceCatalogEntries Used to delete an array of Array(ServiceD void
Service catalog entries TO)
addServiceCatalogEntries Used to define new Service Array(ServiceD void
catalog entries TO)
updateServiceCatalogEntries Used to update existing Array(ServiceD void
Service catalog entries TO)
getServiceEntriesByIds Used to retrieve a list of Array(Integer) Array(ServiceDT
Service catalog entries by O)
ID

© 2010 Allot Communications. All rights reserved. 19

NX SOAP API Guide

4.2.13. Service Groups

Method Description Parameters Return Value

getServiceGroups Used to get a list of void Array(ServiceGr

currently defined Service oupDTO)
Group catalog entries
deleteServiceGroups Used to delete an array of Array(ServiceG void
Service Group catalog roupDTO)
entries
addServiceGroups Used to define new Service Array(ServiceG void
Group catalog entries roupDTO)
updateServiceGroups Used to update existing Array(ServiceG void
Service Group catalog roupDTO)
entries
getServiceGroupByIds Used to retrieve a list of Array(Integer) Array(ServiceGr
Service Group catalog oupDTO)
entries by ID

4.2.14. Time

Method Description Parameters Return Value

getTimeCatalogEntries Used to get a list of void Array(TimeDTO

currently defined Time )
catalog entries
deleteTimeCatalogEntries Used to delete an array of Array(TimeDT void
Time catalog entries O)
addTimeCatalogEntries Used to define new Time Array(TimeDT void
catalog entries O)
updateTimeCatalogEntries Used to update existing Array(TimeDT void
Time catalog entries O)
getTimeEntriesByIds Used to retrieve a list of Array(Integer) Array(TimeDTO
Time catalog entries by ID )

© 2010 Allot Communications. All rights reserved. 20

NX SOAP API Guide

4.2.15. Service Plan

Method Description Parameters Return Value

getServicePlans() Used to get a list of void Array(ServicePla

currently defined Service nDTO[])
Plan catalog entries
getServicePlansByIds() Used to delete an array of Array(Integer[] void
Service Plan catalog entries ids)
addServicePlans() Used to define new Service Array(ServicePl void
Plan catalog entries anDTO[])
updateServicePlans() Used to update existing Array(ServicePl void
Service Plan catalog entries anDTO[])
getServicePlanIdByName() Used to retrieve a list of String name Integer
Service Plan catalog entries
by ID

4.3. Topology Methods

4.3.1. Devices
Method Description Parameters Return Value
getDeviceById Used to view the NEs or Integer - DeviceTopology
SGs currently in the deviceId DTO
network by ID
getDeviceByName Used to view the NEs or String- uiName DeviceTopology
SGs currently in the DTO
network by name
addDevice Used to add an NE or SG DeviceTopolog DeviceTopology
to the network yDTO DTO
ImportDevice Used to import an NE or DeviceTopolog void
SG into the network yDTO
deleteDevice Used to delete an NE or DeviceTopolog void
SG from the network yDTO

© 2010 Allot Communications. All rights reserved. 21

NX SOAP API Guide

4.4. WebUpdates Methods

4.4.1. Device

Method Description Parameters Return Value

updateWuDevice Used to update the NE or Integer deviceId Void

SG to the latest protocol Integer updateNumber
pack
rollbackWuDevice Used to roll back the NE or Integer deviceId Void
SG to the last protocol
pack

4.4.2. Server

Method Description Parameters Return Value

updateWuServer Used to update the NX Void Void
server to the latest protocol
pack
rollbackWuServer Used to roll back the NX void void
server to the last protocol
pack

© 2010 Allot Communications. All rights reserved. 22