IdMgrRealmConfig

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 the realm configuration.

The IdMgrRealmConfig includes the following commands:

• addIdMgrRealmBaseEntry
• createIdMgrRealm
• deleteIdMgrRealm
• deleteIdMgrRealmBaseEntry
• getIdMgrDefaultRealm
• getIdMgrRepositoriesForRealm
• getIdMgrRealm
• listIdMgrRealms
• listIdMgrRealmBaseEntries
• renameIdMgrRealm
• setIdMgrDefaultRealm
• updateIdMgrRealm

 

addIdMgrRealmBaseEntry

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

Target ObjectNone.

Required parameters

-name

Name of the realm. (String, required)

-baseEntry

Name of the base entry. (String, optional)

Optional parameters None

Examples

Batch mode example usage:

• Jacl...

  $AdminTask addIdMgrRealmBaseEntry {-name defaultWIMFileBasedRealm -baseEntry o=sampleFileRepository}
  

• Use Jython string:

  AdminTask.addIdMgrRealmBaseEntry ('[-name defaultWIMFileBasedRealm -baseEntry o=sampleFileRepository]')
  

• Use Jython list:

  AdminTask.addIdMgrRealmBaseEntry (['-name', 'defaultWIMFileBasedRealm', '-baseEntry', 'o=sampleFileRepository'])
  

Interactive mode example usage:

• Jacl...

  $AdminTask addIdMgrRealmBaseEntry {-interactive}
  

• Use Jython string:

  AdminTask.addIdMgrRealmBaseEntry ('[-interactive]')
  

 

createIdMgrRealm

The createIdMgrRealm command creates a realm configuration.

Target ObjectNone.

Required parameters

-name

Name of the realm. (String, required)

Optional parameters

-securityUse

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

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)

Examples

Batch mode example usage:

• Jacl...

  $AdminTask createIdMgrRealm {-name realm1 -allowOperationIfReposDown true}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Jacl...

  $AdminTask createIdMgrRealm {-interactive}
  

• Use Jython string:

  AdminTask.createIdMgrRealm ('[-interactive]')
  

 

deleteIdMgrRealm

The deleteIdMgrRealm command deletes the realm configuration specified.

Target ObjectNone.

Required parameters

-name

The realm name. (String, required)

Optional parametersNone.

Examples

Batch mode example usage:

• Jacl...

  $AdminTask deleteIdMgrRealm {-name realm1}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• 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 we cannot remove every entry.

Target ObjectNone.

Required parameters

-name

Name of the realm. (String, required)

-baseEntry

Name of a base entry. (String, required)

Optional parametersNone.

Examples

Batch mode example usage:

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

• Jacl...

  $AdminTask deleteIdMgrRealmBaseEntry {-interactive}
  

• Use Jython string:

  AdminTask.deleteIdMgrRealmBaseEntry ('[-interactive]')
  

 

getIdMgrDefaultRealm

The getIdMgrDefaultRealm command returns the default realm name.

Target ObjectNone.

Required parameters: None.

Optional parametersNone.

Examples

Batch mode example usage:

• Jacl...

  $AdminTask getIdMgrDefaultRealm
  

• Use Jython string:

  AdminTask.getIdMgrDefaultRealm()
  

• Use Jython list:

  AdminTask.getIdMgrDefaultRealm()
  

Interactive mode example usage:

• Jacl...

  $AdminTask getIdMgrDefaultRealm {-interactive}
  

• Use Jython string:

  AdminTask.getIdMgrDefaultRealm ('[-interactive]')
  

 

getIdMgrRepositoriesForRealm

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

Target ObjectNone.

Required parameters

-name

Name of the realm. (String, required)

Optional parametersNone.

Examples

Batch mode example usage:

• Jacl...

  $AdminTask getIdMgrRepositoriesForRealm {-name realm1}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Jacl...

  $AdminTask getIdMgrRepositoriesForRealm {-interactive}
  

• Use Jython string:

  AdminTask.getIdMgrRepositoriesForRealm ('[-interactive]')
  

 

getIdMgrRealm

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

Target ObjectNone.

Required parameters

-name

Name of the realm. (String, required)

Optional parametersNone.

Examples

Batch mode example usage:

• Jacl...

  $AdminTask getIdMgrRealm {-name realm1}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Jacl...

  $AdminTask getIdMgrRealm {-interactive}
  

• Use Jython string:

  AdminTask.getIdMgrRealm ('[-interactive]')
  

 

listIdMgrRealms

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

Target ObjectNone.

Required parameters

None.

Optional parametersNone.

Examples

Batch mode example usage:

• Jacl...

  $AdminTask listIdMgrRealms
  

• Use Jython string:

  AdminTask.listIdMgrRealms()
  

• Use Jython list:

  AdminTask.listIdMgrRealms()
  

Interactive mode example usage:

• Jacl...

  $AdminTask listIdMgrRealms {-interactive}
  

• Use Jython string:

  AdminTask.listIdMgrRealms ('[-interactive]')
  

 

listIdMgrRealmBaseEntries

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

Target ObjectNone.

Required parameters

-name

Name of the realm. (String, required)

Examples

Batch mode example usage:

• Jacl...

  $AdminTask listIdMgrRealmBaseEntries {-name realm1}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Jacl...

  $AdminTask listIdMgrRealmBaseEntries {-interactive}
  

• Use Jython string:

  AdminTask.listIdMgrRealmBaseEntries ('[-interactive]')
  

 

renameIdMgrRealm

The renameIdMgrRealm command renames the name of the realm specified.

Target ObjectNone.

Required parameters

-name

Name of the realm. (String, required)

Optional parametersNone.

Examples

Batch mode example usage:

• Jacl...

  $AdminTask renameIdMgrRealm {-name realm1}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• 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

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

Examples

Batch mode example usage:

• Jacl...

  $AdminTask setIdMgrDefaultRealm {-name realm1}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Jacl...

  $AdminTask setIdMgrDefaultRealm {-interactive}
  

• Use Jython string:

  AdminTask.setIdMgrDefaultRealm ('[-interactive]')
  

 

updateIdMgrRealm

The updateIdMgrRealm command updates the configuration for a realm specified.

Target ObjectNone.

Required parameters

-name

Name of the realm. (String, required)

Optional parameters

-securityUse

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)

Examples

Batch mode example usage:

• Jacl...

  $AdminTask updateIdMgrRealm {-name realm1}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Jacl...

  $AdminTask updateIdMgrRealm {-interactive}
  

• Use Jython string:

  AdminTask.updateIdMgrRealm ('[-interactive]')
  

• Use Jython list:

  AdminTask.updateIdMgrRealm (['-interactive'])
  

---

 

Related tasks

Use AdminTask for scripted administration

 

Related

Commands for AdminTask
IdMgrRepositoryConfig
IdMgrConfig