getMembersOfGroup command

Use this command to view a list of the members of a group.

Purpose

Use the getMembersOfGroup command to view a list of the members of a group.
If successful, the getMembersOfGroup command returns the type of each member and the associated uniqueNames of each of the member. For example:
  • PersonAccount, uid=dmeyer,cn=users,dc=yourco,dc=com
  • Group, cn=groupA,cn=groups,dc=yourco,dc=com
Note: If the Use global security settings option is selected for the user realm or the Global federated repositories option is selected as the realm type for the specified domain, this command is executed on the federated repository of the admin domain. However, configuration changes that are performed on the domain are applied to the security domain-specific configuration.

Syntax

getMembersOfGroup { -uniqueName uniqueName [-clearCache clearCacheMode] [-securityDomainName domainName] } 

Parameters

-uniqueName uniqueName
Specifies the unique name value for the group whose members you want to view. This parameter maps to the uniqueName property in virtual member manager.
-clearCache clearCacheMode
Specifies whether the repository adapter cache should be cleared before retrieving the specified group information.
Valid values are:
  • clearEntity: Clears the cache for the specified group, if the group exists in the cache.
  • clearAll: Clears the cached information for all of the entities in the adapter of the repository where the specified group exists.
The values are not case-sensitive. There is no default value for this parameter. If you do not specify a value, or specify a value other than clearEntity or clearAll, an error message appears.
Avoid trouble: Frequent use of this parameter to clear the cache may result in performance degradation. When the cache is cleared, the subsequent operation has to get the details from the repository and update the cache with this newly retrieved data. The impact on performance is more pronounced if you use the clearAll mode, as this invalidates the entire cache, and the subsequent operation takes longer to complete.
-securityDomainName domainName
Specifies the name that uniquely identifies the security domain. If you do not specify this parameter, the command uses the global federated repository.

Sample

To find all the members of the operators group, issue this command:
$AdminTask getMembersOfGroup {-uniqueName cn=operators,cn=users,dc=yourco,dc=com}

Icon that indicates the type of topic Reference topic



Timestamp icon Last updated: March 6, 2017 0:20
File name: getmembersofgroupcommand.html