Brocade Virtual ADX XML API Programmer’s Guide (Supporting ADX v03.1.00) - Manual (Page 80)

70 Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01
Methods
3
Parameters
Table 173 contains the parameters required for the method.
Return values
None.
Error messages
List of Error Messages
getAllContexts
Description
Retrieves all the contexts configured on the system. Total number of contexts added as part of the
response header field "totalEntriesAvailable". Return the total number of contexts configured on
the device if startIndex and numRetrieved values are zero.
Parameters
Table 174 contains the parameters required for the method.
Return values
Table 175 contains the return values of the method.
Error messages
List of Error Messages
TABLE 173 Parameters
Name Type Presence Rules Description
enablePasswordAging boolean Optional Boolean to identify if password aging is required.
TABLE 174 Parameters
Name Type Presence Rules Description
startIndex unsignedInt Optional Any positive integer
value 1 through 256. Identifies the start index for retrieving the
contexts information.
numRetrieved unsignedInt Optional Any positive integer
value 1 through 256. Identifies the number of contexts to be
retrieved. Maximum value allowed is 256.
filter ContextFilter Optional Specifies the filter criteria.
TABLE 175 Return values
Name Type Description
genericInfo ResponseInformation Generic information
contexts ContextSummary [ ] Identifies the context information to be retrieved.