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

Brocade Virtual ADX XML API Programmer’s Guide 71
53-1003248-01
Methods
3
getAllRoleTemplates
Description
Retrieves all the role templates configured on the system. Total number of templates filed added as
part of the response header (field “total Entries Available”).
Returns all the role templates
configured on the device, if ‘startIndex’ and ‘numRetrieved’ values are zero.
Parameters
Table 176 contains the parameters required for the method.
Return values
Table 177 contains the return values of the method.
Error messages
List of Error Messages
getAllUsers
Description
Retrieves all the users based on the filter criteria specified. Total number of users added to
response information header (field - totalEntriesAvailable). Returns the total number of users in the
response header, if the numRetrieved and startIndex fields are zero.
Parameters
Table 178 contains the parameters required for the method.
TABLE 176 Parameters
Name Type Presence Rules Description
startIndex unsignedInt Optional Identifies the starting index for retrieving the
contexts information.
numRetrieved unsignedInt Optional Identifies the number of contexts to be retrieved.
Maximum value allowed is 256.
filter RoleTemplateFilter Optional Specifies the filter criteria.
TABLE 177 Return values
Name Type Description
genericInfo ResponseInformation Identifies the generic information about all the role
templates configured on the system.
roleTemplates RoleTemplate [ ] Identifies the role template information retrieved
and the total number of role templates.
TABLE 178 Parameters
Name Type Presence Rules Description
startIndex unsignedInt Optional Any positive integer value
1 through 1024.
Identifies the start index for retrieving the
contexts information.