Web Services; Web Services Interface - VBrick 9000 Series Getting Started Manual

Web Services

Topics in this chapter

Web Services Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Web Services Interface
VBrick 9000 Series appliances provide a standards-based SOAP architecture to programmatically
interface to the appliance. The Web Service interface allows the user application to
parameters in the appliance. The methods supported by the service are listed below.
Table 22. Web Services Methods
Method
getNewSessionId (device)
test (echoString)
login (sessionId, loginName,
hashedPassword)
beginEdit (sessionId, editName)
endEdit (sessionId)
endOtherEdit (sessionId)
logout (sessionId)
getParameterValue (sessionId,
parnName, parmIndex)
setParameterValue (sessionId,
parmName, parmIndex, parmValue)
setMultipleParameterValue
(sessionId, parmName, parmValue,
count)
H.264 Encoding/Decoding Appliance Getting Started Guide
Description
Used to get a new session id from the appliance. It allows the
web service to maintain session with the appliance.
Used as a test web service method to test if the interface to
the appliance is working. It returns the input string as an
echo.
Used as method to allows the user to login into the box as a
particular user with appropriate privileges. Returns
successful, otherwise.
ERROR
Used as a method to begin the edit session to become editor
of parameters. Returns
editName
otherwise.
Used as a method to end the editor session. Returns
successful, otherwise.
ERROR
Used as a method to forcefully end another editor session.
Returns if successful,
OK
Used to logout of a web session. Returns
otherwise.
ERROR
Used as a parameter to get a parameter value. Returns
parameter value as a string if successful,
Used as a method to set a parameter value. Returns
successful, otherwise.
ERROR
Used as a method to set multiple parameter values, where
is a string array of names,
parmName
of values to the corresponding array of names, and count is
the number of items in the array. Returns
otherwise.
ERROR
Chapter 8
Get/Set
if successful,
ERROR
otherwise.
ERROR
if successful,
OK
otherwise
ERROR
is a string array
parmValue
if successful,
OK
MIB
if
OK
if
OK
if
OK
53