VBrick 7000 Series, Getting Started Manual

Page: 66 / 78

56 © 2009 VBrick Systems, Inc.
The WSDL file for the web service methods can be obtained by calling the following URL
where
<appliance_ip_address>
is the IP address of the appliance or a host name that can be
resolved to an IP by the local DNS server.
http://<appliance_ip_address>/VBrickWebSrvc/VBrickWebSrvc.wsdl
All methods return
ERROR
as the response if the request cannot be fulfilled.
OK
is returned
for methods that complete successfully.
GetNewSessionId
returns a new SessionId if it
succeeds;
test
returns the input string as an echo. In order to set parameters, the user must be
authenticated and must also be an active editor (by calling
beginEdit
). A typical sequence of
calls to the methods is shown below.
T
To Get a parameter value
1. Get a new SessionId by calling
getNewSessionId
.
2. Login into the appliance by calling the
login
method and supplying the login name and
hashed password value. The algorithm to hash the password is provided as "C" code and
also as a VBCrypt package for the Microsoft .NET and C# environments.
3. Get the parameter value by calling the
getParameterValue
method supplying the MIB
name and parameter Index (if any). Note: Some parameters may require the user to be
the active editor. More parameters can be retrieved by calling the method several times.
4. Logout of the session by calling the
logout
method.
T
To Set a parameter value
1. Get a new SessionId by calling
getNewSessionId
.
2. Login into the appliance by calling the
login
method and supplying the login name and
hashed password value. The algorithm to hash the password is provided as "C" code and
also as a VBCrypt package for the Microsoft .NET and C# environments.
3. Call the
beginEdit
method to become the active editor in the box.
4. Set the parameter value by calling the
setParameterValue
method supplying the MIB
name, parameter Index (if any), and parameter value. More parameters can be set by
calling the method several times, or by calling the
setMultipleParameterValue
method.
5. End the edit by calling
endEdit
6. Logout of the session by calling the
logout
method.
Note There are multiple ways to locate and verify VBrick parameters. See Setting VBrick
Parameters on page 50 for more information.
Note If you successfully login to the appliance, you must logout when your session
completes or subsequent users will be unable to access the appliance. You should end
edit and logout if login or begin edit were successful regardless of the success or
failure of your Get or Set call.