group list

Generates a list of all groups, by group names, whose names match the specified pattern.

Requires authentication (administrator ID and password) to use this command.

Syntax

group list pattern max_return

group list-dn pattern max_return

Options

list pattern max_return
Specifies the pattern for the group name for which to be searched. The pattern can include a mixture of wildcard and string constants, and is not case-sensitive (for example, *austin*).

The max_return option specifies the limit of how many entries must be returned for a single request; for example, 2. The number that is returned is also governed by the server configuration. The configuration specifies the maximum number of results that can be returned as part of a search operation. The actual maximum returned entries is the minimum of max_return and the configured value on the server.

list-dn pattern max_return
Lists user registry identifiers whose user registry common name attribute matches the pattern specified. The returned list contains groups, which are defined in the user registry. The groups might not necessarily be Security Access Manager groups. You can import groups that are not Security Access Manager groups into Security Access Manager by using the group import command.

Return codes

0
The command completed successfully.
1
The command failed. When a command fails, the pdadmin command provides a description of the error and an error status code in hexadecimal format (for example, 0x14c012f2). See "Error messages" in the IBM Knowledge Center. This reference provides a list of the Security Access Manager error messages by decimal or hexadecimal codes.

Examples

  • The following example lists 3 groups that match the specified pattern of a group name that contains the letter a:
    pdadmin sec_master> group list *a* 3
    The output is like:
    Sales
    Marketing
    Alex
  • The following example lists 2 groups that match the specified pattern of a distinguished name that contains the letter t:
    pdadmin sec_master> group list-dn *t* 2
    The output is like:
    cn=credit,ou=Austin,o=Tivoli,c=US Sales
    cn=marketing,ou=Boston,o=Austin Sale,c=US Marketing

See also

group show