IdMgrRealmConfig command group for the AdminTask object

You can use the Jython or Jacl scripting languages to configure federated repositories realms. The commands and parameters in the IdMgrRealmConfig group can be used to create and manage your realm configuration.

The IdMgrRealmConfig command group for the AdminTask object includes the following commands:

addIdMgrRealmBaseEntry

The addIdMgrRealmBaseEntry command adds a base entry to a specific realm configuration and links the realm with the repository.

Target Object

None.

Required parameters

-name
Specifies the name of the realm. (String, required)
-baseEntry
Specifies the name of the base entry. (String, optional)

Optional parameters

None

Examples

Batch mode example usage:

Interactive mode example usage:

createIdMgrRealm

The createIdMgrRealm command creates a realm configuration.

Target Object

None.

Required parameters

-name
Specifies the name of the realm. (String, required)

Optional parameters

-securityUse
Specifies a string that indicates if this virtual realm will be used in security now, later, or never. The default value is active. Additional values includes: inactive and nonSelectable. (String, optional)
-delimiter
Specifies the delimiter used for this realm. The default value is /. (String, optional)
-allowOperationIfReposDown
Specifies whether the system allows a repository operation such as get or search to complete successfully, even if repositories in the realm are down. The default value is false. (Boolean, optional)
Avoid trouble: [aug2010] Even if this parameter is specified, all repositories must be available when you start the server, or the virtual member manager might not function properly. [aug2010]
aug2010
gotcha

Examples

Batch mode example usage:

Interactive mode example usage:

deleteIdMgrRealm

The deleteIdMgrRealm command deletes the realm configuration that you specified.

Target Object

None.

Required parameters

-name
The realm name. (String, required)

Optional parameters

None.

Examples

Batch mode example usage:

Interactive mode example usage:

deleteIdMgrRealmBaseEntry

The deleteIdMgrRealmBaseEntry command deletes a base entry from a realm configuration that you specified.

The realm must always contain at least one base entry, thus you cannot remove every entry.

Target Object

None.

Required parameters

-name
Specifies the name of the realm. (String, required)
-baseEntry
Specifies the name of a base entry. (String, required)

Optional parameters

None.

Examples

Batch mode example usage:

Interactive mode example usage:

getIdMgrDefaultRealm

The getIdMgrDefaultRealm command returns the default realm name.

Target Object

None.

Required parameters

None.

Optional parameters

None.

Examples

Batch mode example usage:

Interactive mode example usage:

getIdMgrRepositoriesForRealm

The getIdMgrRepositoriesForRealm command returns repository specific details for the repositories configured for a specified realm.

Target Object

None.

Required parameters

-name
Specifies the name of the realm. (String, required)

Optional parameters

None.

Examples

Batch mode example usage:

Interactive mode example usage:

getIdMgrRealm

The getIdMgrRealm command returns the configuration parameters for the realm that you specified.

Target Object

None.

Required parameters

-name
Specifies the name of the realm. (String, required)

Optional parameters

None.

Examples

Batch mode example usage:

Interactive mode example usage:

listIdMgrRealms

The listIdMgrRealms command returns all of the names of the configured realms.

Target Object

None.

Required parameters

None.

Optional parameters

None.

Examples

Batch mode example usage:

Interactive mode example usage:

listIdMgrRealmBaseEntries

The listIdMgrRealmBaseEntries command returns all of the names of the configured realms.

Target Object

None.

Required parameters

-name
Specifies the name of the realm. (String, required)

Examples

Batch mode example usage:

Interactive mode example usage:

listIdMgrRealmURAttrMappings [Fix Pack 11 or later]

Use the listIdMgrRealmURAttrMappings command to list the mappings between the user or group attributes for a user registry and the federated repository properties of a specified realm.

Target object

None.

Optional parameters

-name
Use this parameter to specify a valid realm name for which you want to list the mapping.

If you do not specify the -name parameter, the listIdMgrRealmURAttrMappings command returns the mapping of the default realm in the federated repository configuration.

(String, optional)

Return values

The listIdMgrRealmURAttrMappings command returns a HashMap that contains the following structure:
  • The key is the user registry attribute name (URAttrName parameter).
  • The value is another HashMap that contains the propertyForInput and propertyForOutput as keys and the corresponding mapping as the values.
The following example shows a sample output. The example is broken into multiple lines for illustration purposes only.
{userDisplayName={propertyForInput=principalName, propertyForOutput=principalName},
userSecurityName={propertyForInput=principalName, propertyForOutput=principalName},
uniqueUserId={propertyForInput=uniqueName, propertyForOutput=uniqueName},
uniqueGroupId={propertyForInput=uniqueName, propertyForOutput=uniqueName},
groupSecurityName={propertyForInput=cn, propertyForOutput=cn},
groupDisplayName={propertyForInput=cn, propertyForOutput=cn}}

Examples

Batch mode example usage:

Interactive mode example usage:

renameIdMgrRealm

The renameIdMgrRealm command renames the name of the realm that you specified.

Target Object

None.

Required parameters

-name
Specifies the name of the realm. (String, required)

Optional parameters

None.

Examples

Batch mode example usage:

Interactive mode example usage:

setIdMgrDefaultRealm

The setIdMgrDefaultRealm command sets up the default realm configuration.

Required parameters

-name
specifies the name of the realm that is used as a default realm when the caller does not specify any in context. (String, required)

Examples

Batch mode example usage:

Interactive mode example usage:

setIdMgrRealmURAttrMapping [Fix Pack 11 or later]

Use the setIdMgrRealmURAttrMapping command to set or modify the mapping of the user or group attribute for a user registry to a federated repository property of a specified realm.

The setIdMgrRealmURAttrMapping command is available in both connected and local modes. If you run the setIdMgrRealmURAttrMapping command in connected mode, the realm attribute mapping changes take effect after you restart the server.

Target object

None.

Required parameters

-URAttrName
Use this parameter to specify the name of the user or group attribute in a user registry that you want to map. The following case-sensitive values are valid for the URAttrName parameter:
  • uniqueUserId
  • userSecurityName
  • userDisplayName
  • uniqueGroupId
  • groupSecurityName
  • groupDisplayName
Avoid trouble: If you run the setIdMgrRealmURAttrMapping command multiple times for the same user registry attribute name, it overwrites the previous value.gotcha

(String, required)

-propertyForInput
Use this parameter to specify the name of the federated repository property that maps to the specified user registry attribute (URAttrName parameter) when it is an input parameter for the user registry interface. (String, required)
-propertyForOutput
Use this parameter to specify the name of the federated repository property that maps to the specified user registry attribute (URAttrName parameter) when it is an output parameter (return value) for the user registry interface. (String, required)
Attention: In most cases, the propertyForInput and propertyForInput would be the same.

Optional parameters

-name
Use this parameter to specify a valid realm name for which you want to set or modify the mapping. If you do not specify the name parameter, the setIdMgrRealmURAttrMapping command uses the default realm in the federated repository configuration. (String, optional)

Examples

Batch mode example usage:

Interactive mode example usage:

updateIdMgrRealm

The updateIdMgrRealm command updates the configuration for a realm that you specify.

Target Object

None.

Required parameters

-name
Specifies the name of the realm. (String, required)

Optional parameters

-securityUse
Specifies a string that indicates if this realm will be used in security now, later, or never. The default value is active. Additional values includes: inactive and nonSelectable. (String, optional)
-delimiter
specifies the delimiter used for this realm. The default value is /. (String, optional)
-allowOperationIfReposDown
Specifies whether the system allows a repository operation such as get or search to complete successfully, even if repositories in the realm are down. (Boolean, optional)
Avoid trouble: [aug2010] Even if this parameter is specified, all repositories must be available when you start the server, or the federated repositories will not function properly. [aug2010]
aug2010
gotcha

Examples

Batch mode example usage:

Interactive mode example usage:




Related tasks
Using the wsadmin scripting AdminTask object for scripted administration
Related reference
Commands for the AdminTask object using wsadmin scripting
IdMgrRepositoryConfig command group for the AdminTask object
IdMgrConfig command group for the AdminTask object
Reference topic    

Terms of Use | Feedback

Last updated: Oct 20, 2010 7:53:43 PM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=compass&product=was-nd-dist&topic=rxml_atidmgrrealmconfig
File name: rxml_atidmgrrealmconfig.html