VBrick 7000 Series, Руководство по началу работы

Страница: 65 / 78

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