IdMgrRealmConfig command group for the AdminTask object

Operating Systems: i5/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:

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:

Using Jacl:

$AdminTask createIdMgrRealm {-name realm1}

Using Jython string:

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

Using Jython list:

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

Interactive mode example usage:

Using Jacl:

$AdminTask createIdMgrRealm {-interactive}

Using Jython string:

AdminTask.createIdMgrRealm ('[-interactive]')

Using Jython list:

AdminTask.createIdMgrRealm (['-interactive'])

deleteIdMgrRealm

The deleteIdMgrRealm command deletes the realm configuration that you specified.

Parameters and return values

-name: The realm name. (String, required)

Examples

Batch mode example usage:

Using Jacl:

$AdminTask deleteIdMgrRealm {-name realm1}

Using Jython string:

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

Using Jython list:

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

Interactive mode example usage:

Using Jacl:

$AdminTask deleteIdMgrRealm {-interactive}

Using Jython string:

AdminTask.deleteIdMgrRealm ('[-interactive]')

Using Jython list:

AdminTask.deleteIdMgrRealm (['-interactive'])

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.

Parameters and return values

-name: The realm name. (String, required)
-baseEntry: The name of a base entry. (String, required)

Examples

Batch mode example usage:

Using Jacl:

$AdminTask deleteIdMgrRealmBaseEntry {-name realm1 -baseEntry entry1}

Using Jython string:

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

Using Jython list:

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

Interactive mode example usage:

Using Jacl:

$AdminTask deleteIdMgrRealmBaseEntry {-interactive}

Using Jython string:

AdminTask.deleteIdMgrRealmBaseEntry ('[-interactive]')

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

Using Jacl:
```
$AdminTask getIdMgrDefaultRealm
```
Using Jython string:
```
AdminTask.getIdMgrDefaultRealm()
```
Using Jython list:
```
AdminTask.getIdMgrDefaultRealm()
```

Interactive mode example usage:

Using Jacl:

$AdminTask getIdMgrDefaultRealm {-interactive}

Using Jython string:

AdminTask.getIdMgrDefaultRealm ('[-interactive]')

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

Using Jacl:

$AdminTask getIdMgrRepositoriesForRealm {-name realm1}

Using Jython string:

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

Using Jython list:

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

Interactive mode example usage:

Using Jacl:

$AdminTask getIdMgrRepositoriesForRealm {-interactive}

Using Jython string:

AdminTask.getIdMgrRepositoriesForRealm ('[-interactive]')

Using Jython list:

AdminTask.getIdMgrRepositoriesForRealm (['-interactive'])

getIdMgrRealm

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

Parameters and return values

-name: The realm name. (String, required)

Examples

Batch mode example usage:

Using Jacl:
```
$AdminTask getIdMgrRealm {-name realm1}
```

Using Jython string:

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

Using Jython list:

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

Interactive mode example usage:

Using Jacl:
```
$AdminTask getIdMgrRealm {-interactive}
```

Using Jython string:

AdminTask.getIdMgrRealm ('[-interactive]')

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

Using Jacl:
```
$AdminTask listIdMgrRealms
```
Using Jython string:
```
AdminTask.listIdMgrRealms()
```
Using Jython list:
```
AdminTask.listIdMgrRealms()
```

Interactive mode example usage:

Using Jacl:

$AdminTask listIdMgrRealms {-interactive}

Using Jython string:

AdminTask.listIdMgrRealms ('[-interactive]')

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

Using Jacl:

$AdminTask listIdMgrRealmBaseEntries {-name realm1}

Using Jython string:

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

Using Jython list:

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

Interactive mode example usage:

Using Jacl:

$AdminTask listIdMgrRealmBaseEntries {-interactive}

Using Jython string:

AdminTask.listIdMgrRealmBaseEntries ('[-interactive]')

Using Jython list:

AdminTask.listIdMgrRealmBaseEntries (['-interactive'])

renameIdMgrRealm

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

Parameters and return values

-name: The realm name. (String, required)

Examples

Batch mode example usage:

Using Jacl:

$AdminTask renameIdMgrRealm {-name realm1}

Using Jython string:

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

Using Jython list:

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

Interactive mode example usage:

Using Jacl:

$AdminTask renameIdMgrRealm {-interactive}

Using Jython string:

AdminTask.renameIdMgrRealm ('[-interactive]')

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

Using Jacl:

$AdminTask setIdMgrDefaultRealm {-name realm1}

Using Jython string:

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

Using Jython list:

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

Interactive mode example usage:

Using Jacl:

$AdminTask setIdMgrDefaultRealm {-interactive}

Using Jython string:

AdminTask.setIdMgrDefaultRealm ('[-interactive]')

Using Jython list:

AdminTask.setIdMgrDefaultRealm (['-interactive'])

updateIdMgrRealm

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

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:

Using Jacl:

$AdminTask updateIdMgrRealm {-name realm1}

Using Jython string:

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

Using Jython list:

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

Interactive mode example usage:

Using Jacl:

$AdminTask updateIdMgrRealm {-interactive}

Using Jython string:

AdminTask.updateIdMgrRealm ('[-interactive]')

Using Jython list:

AdminTask.updateIdMgrRealm (['-interactive'])

Related Reference

Commands for the AdminTask object
IdMgrRepositoryConfig command group for the AdminTask object
IdMgrConfig command group for the AdminTask object