WebSphere Application Server Version 6.1 Feature Pack for Web Services
             Operating Systems: AIX, HP-UX, i5/OS, Linux, Solaris, Windows, z/OS

             Personalize the table of contents and search results

IdMgrRealmConfig command group for the AdminTask object

You can use the Jython or Jacl scripting languages to configure the member manager realm and 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)

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:

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.

Parameters and return values

-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:

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)

Examples

Batch mode example usage:

Interactive mode example usage:




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

Terms of Use | Feedback

Last updated: Nov 25, 2008 2:35:59 AM CST
http://publib.boulder.ibm.com/infocenter/wasinfo/v6r1/index.jsp?topic=/com.ibm.websphere.wsfep.multiplatform.doc/info/ae/ae/rxml_atidmgrrealmconfig.html