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:

• createIdMgrRealm

• deleteIdMgrRealm

• deleteIdMgrRealmBaseEntry

• getIdMgrDefaultRealm

• getIdMgrRepositoriesForRealm

• getIdMgrRealm

• listIdMgrRealms

• listIdMgrRealmBaseEntries

• renameIdMgrRealm

• setIdMgrDefaultRealm

• updateIdMgrRealm

 

createIdMgrRealm

The createIdMgrRealm command creates a realm configuration.

Parameters and return values

-name

The realm name. (String, required)

-securityUse

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

The delimiter used for this realm. The default value is @. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask createIdMgrRealm {-name realm1}
  

• Use Jython string:

  AdminTask.createIdMgrRealm ('[-name realm1]')
  

• Use Jython list:

  AdminTask.createIdMgrRealm (['-name', 'realm1'])
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask createIdMgrRealm {-interactive}
  

• Use Jython string:

  AdminTask.createIdMgrRealm ('[-interactive]')
  

• Use Jython list:

  AdminTask.createIdMgrRealm (['-interactive'])
  

 

deleteIdMgrRealm

The deleteIdMgrRealm command deletes the realm configuration specified.

Parameters and return values

-name

The realm name. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrRealm {-name realm1}
  

• Use Jython string:

  AdminTask.deleteIdMgrRealm ('[-name realm1]')
  

• Use Jython list:

  AdminTask.deleteIdMgrRealm (['-name', 'realm1'])
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrRealm {-interactive}
  

• Use Jython string:

  AdminTask.deleteIdMgrRealm ('[-interactive]')
  

• Use Jython list:

  AdminTask.deleteIdMgrRealm (['-interactive'])
  

 

deleteIdMgrRealmBaseEntry

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

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

Parameters and return values

-name

The realm name. (String, required)

-baseEntry

The name of a base entry. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrRealmBaseEntry {-name realm1 -baseEntry entry1}
  

• Use Jython string:

  AdminTask.deleteIdMgrRealmBaseEntry ('[-name realm1 -baseEntry entry1]')
  

• Use Jython list:

  AdminTask.deleteIdMgrRealmBaseEntry (['-name', 'realm1', '-baseEntry', 'entry1'])
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrRealmBaseEntry {-interactive}
  

• Use Jython string:

  AdminTask.deleteIdMgrRealmBaseEntry ('[-interactive]')
  

• Use Jython list:

  AdminTask.deleteIdMgrRealmBaseEntry (['-interactive'])
  

 

getIdMgrDefaultRealm

The getIdMgrDefaultRealm command returns the default realm name.

Parameters and return values

• Parameters: None

• Returns: The name of the default realm.

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask getIdMgrDefaultRealm
  

• Use Jython string:

  AdminTask.getIdMgrDefaultRealm()
  

• Use Jython list:

  AdminTask.getIdMgrDefaultRealm()
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask getIdMgrDefaultRealm {-interactive}
  

• Use Jython string:

  AdminTask.getIdMgrDefaultRealm ('[-interactive]')
  

• Use Jython list:

  AdminTask.getIdMgrDefaultRealm (['-interactive'])
  

 

getIdMgrRepositoriesForRealm

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

Parameters and return values

-name

The realm name. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask getIdMgrRepositoriesForRealm {-name realm1}
  

• Use Jython string:

  AdminTask.getIdMgrRepositoriesForRealm ('[-name realm1]')
  

• Use Jython list:

  AdminTask.getIdMgrRepositoriesForRealm (['-name', 'realm1'])
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask getIdMgrRepositoriesForRealm {-interactive}
  

• Use Jython string:

  AdminTask.getIdMgrRepositoriesForRealm ('[-interactive]')
  

• Use Jython list:

  AdminTask.getIdMgrRepositoriesForRealm (['-interactive'])
  

 

getIdMgrRealm

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

Parameters and return values

-name

The realm name. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask getIdMgrRealm {-name realm1}
  

• Use Jython string:

  AdminTask.getIdMgrRealm ('[-name realm1]')
  

• Use Jython list:

  AdminTask.getIdMgrRealm (['-name', 'realm1'])
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask getIdMgrRealm {-interactive}
  

• Use Jython string:

  AdminTask.getIdMgrRealm ('[-interactive]')
  

• Use Jython list:

  AdminTask.getIdMgrRealm (['-interactive'])
  

 

listIdMgrRealms

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

Parameters and return values

• Parameters: None

• Returns: A list that contains the name of the configured realms.

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask listIdMgrRealms
  

• Use Jython string:

  AdminTask.listIdMgrRealms()
  

• Use Jython list:

  AdminTask.listIdMgrRealms()
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask listIdMgrRealms {-interactive}
  

• Use Jython string:

  AdminTask.listIdMgrRealms ('[-interactive]')
  

• Use Jython list:

  AdminTask.listIdMgrRealms (['-interactive'])
  

 

listIdMgrRealmBaseEntries

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

Parameters and return values

-name

The realm name. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask listIdMgrRealmBaseEntries {-name realm1}
  

• Use Jython string:

  AdminTask.listIdMgrRealmBaseEntries ('[-name realm1]')
  

• Use Jython list:

  AdminTask.listIdMgrRealmBaseEntries (['-name', 'realm1'])
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask listIdMgrRealmBaseEntries {-interactive}
  

• Use Jython string:

  AdminTask.listIdMgrRealmBaseEntries ('[-interactive]')
  

• Use Jython list:

  AdminTask.listIdMgrRealmBaseEntries (['-interactive'])
  

 

renameIdMgrRealm

The renameIdMgrRealm command renames the name of the realm specified.

Parameters and return values

-name

The realm name. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask renameIdMgrRealm {-name realm1}
  

• Use Jython string:

  AdminTask.renameIdMgrRealm ('[-name realm1]')
  

• Use Jython list:

  AdminTask.renameIdMgrRealm (['-name', 'realm1'])
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask renameIdMgrRealm {-interactive}
  

• Use Jython string:

  AdminTask.renameIdMgrRealm ('[-interactive]')
  

• Use Jython list:

  AdminTask.renameIdMgrRealm (['-interactive'])
  

 

setIdMgrDefaultRealm

The setIdMgrDefaultRealm command sets up the default realm configuration.

Parameters and return values

-name

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:

• Use Jacl:

  $AdminTask setIdMgrDefaultRealm {-name realm1}
  

• Use Jython string:

  AdminTask.setIdMgrDefaultRealm ('[-name realm1]')
  

• Use Jython list:

  AdminTask.setIdMgrDefaultRealm (['-name', 'realm1'])
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask setIdMgrDefaultRealm {-interactive}
  

• Use Jython string:

  AdminTask.setIdMgrDefaultRealm ('[-interactive]')
  

• Use Jython list:

  AdminTask.setIdMgrDefaultRealm (['-interactive'])
  

 

updateIdMgrRealm

The updateIdMgrRealm command updates the configuration for a realm specified.

Parameters and return values

-name

The realm name. (String, required)

-securityUse

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

The delimiter used for this realm. The default value is @. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrRealm {-name realm1}
  

• Use Jython string:

  AdminTask.updateIdMgrRealm ('[-name realm1]')
  

• Use Jython list:

  AdminTask.updateIdMgrRealm (['-name', 'realm1'])
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrRealm {-interactive}
  

• Use Jython string:

  AdminTask.updateIdMgrRealm ('[-interactive]')
  

• Use Jython list:

  AdminTask.updateIdMgrRealm (['-interactive'])
  

---

 

Related tasks

Use 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