Instruction manual

Appendix B: NetScaler API Reference
NetScaler 9000 Series Installation and Configuration Guide - Volume 1 B-5
NSICG60_JAN05
Note: The exact syntax of the API call will depend on the language being
used to write the client program. The above
ns__addlbvserver
function prototype is similar to the one that would be generated by the
gSOAP package at
http://www.cs.fsu.edu/~engelen/
soap.html.
The result that is returned for all
NSConfig requests consists of:
z rc: An integer return code. The value is zero if the request succeeded; a
non-zero value is returned if the request failed.
z message: A string message. This contains meaningful information only if
the request fails (rc is non-zero). For example, “Required argument
missing”.
z List: A type-specific list of result entities. This element is present only for
requests that retrieve information from the NetScaler 9000 system. For
example, the API method names starting with “
get”, which corresponds
to the CLI show commands.
B.7 Example: Setting the NetScaler Configuration
This example shows a NetScaler CLI command, the corresponding API
method, the resulting XML request, and the XML response that will be sent
back to the client.
Note: The actual API method and the XML SOAP message contents may
differ from the example shown below. The XML shown will be
encased in a SOAP envelope, which will in turn be carried in an
int ns__addlbvserver(void *handle,
string vServerName,
string serviceType,
string IPAddress,
unsignedShort port,
ns__addlbvserverResponse *out);