updateGroup command
Use this command to modify the properties of a group.
Purpose
Use the updateGroup command to modify the following properties of a group:- cn
- descripton
If successful, the updateGroup command returns the unique name of the updated group.
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
updateGroup { -uniqueName uniqueName [-cn commonname]
[-description description] [-securityDomainName domainName] }
Parameters
- -uniqueName uniqueName
- Specifies the unique name value for the group that you want to modify the properties for. This parameter maps to the uniqueName property in virtual member manager.
- -cn commonname
- Specifies the new common name used for the group. This parameter maps to the cn property in virtual member manager.
- -description description
- Specifies the new information about the group. This parameter maps to the description entity in a virtual member manager object.
- -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 change the common name of the group called operators to groupA and to change the description of the group to graphicArtists, issue this command:$AdminTask updateGroup {-uniqueName cn=operators,cn=groups,dc=yourco,dc=com -cn groupA –description graphicArtists}