Programmer's Guide (Supporting ADX v03.1.00) Manual

46 Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01
Methods
3
Return values
Table 101 contains the return values of the method.
Error messages
List of Error Messages
getAllTelnetClients
Description
This method retrieves all the configured Telnet clients information.
Parameters
Table 102 contains the parameters required for the method.
Return values
Table 103 contains the return values of the method.
Error messages
List of Error Messages
TABLE 101 Return values
Name Type Description
genericInfo ResponseInformation Generic information. This provides the information - total entries
available and the time at which the values are retrieved.
connectionList SshServerConnection[ ] Retrieves all the established SSH connections information.
TABLE 102 Parameters
Name Type Presence Rules Description
startIndex unsignedInt Optional Sets the start
index for retrieving
the configured
Telnet clients.
When both startIndex and numRetrieved
parameters are not present, then all the
possible configured Telnet clients will be
returned.
numRetrieved unsignedInt Optional Specifies the number of configured Telnet
clients to be retrieved. The maximum
value allowed is 64. When both startIndex
and numRetrieved parameters are not
present, then all possible configured
Telnet clients will be returned.
Filter TelnetClientFilter Optional Filter criteria.
TABLE 103 Return values
Name Type Description
genericInfo ResponseInformation Generic information. This provides the information - total entries available
and the time at which the values are retrieved.
clientList TelnetClient[ ] Retrieves all the configured Telnet clients information.