User guide

Northbound Interface User Interaction
973
AlliedView NMS Administration Guide
12.3.1.2 Review the Associated WSDL and Available Services
Use
http://<nmsserver-IP>:9090/axis/services to see the WSDL and the services available. Note that a relevant file is available
only after activating the web services.
12.3.1.3 Deactivate Web Services (Axis/SOAP)
This operation must be done after the server is started.
1. Change directories to <NMS_HOME>/bin
2. Execute AT_WebService.bat/sh with 'undeploy' parameter
• AT_WebService.bat undeploy (for Windows installations)
• AT_WebService.sh undeploy (for Solaris installations)
12.3.2 User Security
Security will use existing security concepts, which requires a correct user and password and the user must be authorized to
perform the requested operation. Audit trails will be logged only in operations that make modification to NMS or devices
(e.g. setEventTarget and removeEventTarget in this release).
In NMS there are several operations that are not restricted to any user and the default behavior will be used for their
corresponding web service operation. All northbound APIs that have corresponding operations already in NMS will use the
security restrictions for those operations. If the user could not be authenticated (invalid user and/or password) or if not
authorized to perform the requested operation, the operation fails and the client will get an AxisFault exception with the
failure reason.
12.3.3 Operation Threshold Activation
The administrator can set the threshold that allows the specified number of operations to be executed over a specific time
interval. This is intended to reduce the server load from processing excessive number of operations and affecting other
services. This should be done after the administrator and those implementing clients for this interface decide on what
thresholds are acceptable based on the NMS server usage. When thresholds are exceeded the next operations will be
denied and stricter restrictions will be enforced until operation execution rate is reduced to current restriction before
returning to normal execution rate. By default this feature is not activated and all web service operations will be processed
normally.
12.3.3.1 Activate
Create (or edit) a file
NMS_HOME/conf/AT_tmp_conf.properties and specify the properties, then restart the NMS server:
• WS_PROCESS_COUNT=<number> - (for operations count)
• WS_INTERVAL=<number> - (for time interval in seconds)
12.3.3.2 Deactivate
To deactivate, comment out the entries in the file above by using the # character in the beginning of the line (or delete the
file if those are the only two entries), then restart the server
12.3.4 Axis/SOAP Interface Client Development - Examples
Client programs intended for performing operations on NMS using this interface can be implemented in any language that
supports SOAP; however languages that do not support HashMaps will be limited to operations that do not take a HashMap
as a parameter or return it as results. The WSDL file provided contains all operations available and the client program
developer will need to use it to get the correct syntax of operations and details provided here will be useful explaining object
contents.