IdMgrRepositoryConfig command group for the AdminTask object

 

+

Search Tips   |   Advanced Search

 

You can use the Jython or Jacl scripting languages to configure security. The commands and parameters in the IdMgrRepositoryConfig group can be used to create and manage the virtual member manager and LDAP directory properties.

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

• addIdMgrLDAPEntityType
• addIdMgrLDAPEntityTypeRDNAttr
• addIdMgrLDAPGroupDynamicMemberAttr
• addIdMgrLDAPGroupMemberAttr
• addIdMgrLDAPServer
• addIdMgrRepositoryBaseEntry
• createIdMgrDBRepository
• createIdMgrFileRepository
• createIdMgrLDAPRepository
• deleteIdMgrLDAPEntityType
• deleteIdMgrLDAPEntityTypeRDNAttr
• deleteIdMgrLDAPGroupConfig
• deleteIdMgrLDAPGroupMemberAttr
• deleteIdMgrLDAPGroupDynamicMemberAttr
• deleteIdMgrLDAPServer
• deleteIdMgrRepository
• deleteIdMgrRepositoryBaseEntry
• getIdMgrLDAPAttrCache
• getIdMgrLDAPContextPool
• getIdMgrLDAPEntityType
• getIdMgrLDAPEntityTypeRDNAttr
• getIdMgrLDAPGroupConfig
• getIdMgrLDAPGroupDynamicMemberAttrs
• getIdMgrLDAPGroupMemberAttrs
• getIdMgrLDAPSearchResultCache
• getIdMgrLDAPServer
• getIdMgrRepository
• listIdMgrCustomProperties
• listIdMgrLDAPBackupServers
• listIdMgrLDAPEntityTypes
• listIdMgrLDAPServers
• listIdMgrRepositories
• listIdMgrRepositoryBaseEntries
• listIdMgrSupportedDBTypes
• listIdMgrSupportedMessageDigestAlgorithms
• listIdMgrSupportedLDAPServerTypes
• removeIdMgrLDAPBackupServer
• setIdMgrCustomProperty
• setIdMgrLDAPAttrCache
• setIdMgrLDAPContextPool
• setIdMgrLDAPGroupConfig
• setIdMgrLDAPSearchResultCache
• setIdMgrEntryMappingRepository
• setIdMgrPropertyExtensionRepository
• updateIdMgrDBRepository
• updateIdMgrFileRepository
• updateIdMgrLDAPAttrCache
• updateIdMgrLDAPContextPool
• updateIdMgrLDAPEntityType
• updateIdMgrLDAPGroupDynamicMemberAttr
• updateIdMgrLDAPGroupMemberAttr
• updateIdMgrLDAPRepository
• updateIdMgrLDAPSearchResultCache
• updateIdMgrLDAPServer
• updateIdMgrRepository
• updateIdMgrRepositoryBaseEntry

 

addIdMgrLDAPEntityType

The addIdMgrLDAPEntityType command adds an LDAP entity type definition.

Parameters and return values

-id

The ID of the repository. (String, required)

-name

The name of the entity type. (String, required)

-searchFilter

The search filter to use to search the entity type. (String, optional)

-objectClasses

One or more object classes for the entity type. (String, required)

-objectClassesForCreate

The object class to use when an entity type is created. If the value of this parameter is the same as the objectClass parameter, you do not need to specify this parameter. (String, optional)

-searchBases

The search base or bases to use while searching the entity type. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask addIdMgrLDAPEntityType {-id id1 -name name1 -objectClasses objectclass}

• Use Jython string:

  AdminTask.addIdMgrLDAPEntityType ('[-id id1 -name name1 -objectClasses objectclass]')

• Use Jython list:

  AdminTask.addIdMgrLDAPEntityType (['-id', 'id1', '-name', 'name1', '-objectClasses', 'objectclass'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask addIdMgrLDAPEntityType {-interactive}

• Use Jython string:

  AdminTask.addIdMgrLDAPEntityType ('[-interactive]')

• Use Jython list:

  AdminTask.addIdMgrLDAPEntityType (['-interactive'])

 

addIdMgrLDAPEntityTypeRDNAttr

The addIdMgrLDAPEntityTypeRDNAttr command adds RDN attribute configuration to an LDAP entity type definition.

Parameters and return values

-id

The ID of the repository. (String, required)

-entityTypeName

The name of the entity type. (String, required)

-name

The attribute name that is used to build the relative distinguished name (RDN) for the entity type. (String, required)

-objectClass

The object class to use for the entity type for the relative distinguished name (RDN) attribute name specified. Use this parameter to map one entity type to multiple structural object classes. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask addIdMgrLDAPEntityTypeRDNAttr {-id id1 -entityTypeName entitytype -name name1}

• Use Jython string:

  AdminTask.addIdMgrLDAPEntityTypeRDNAttr ('[-id id1 -entityTypeName entitytype -name name1]')

• Use Jython list:

  AdminTask.addIdMgrLDAPEntityTypeRDNAttr (['-id', 'id1', '-entityTypeName', 'entitytype', '-name', 'name1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask addIdMgrLDAPEntityTypeRDNAttr {-interactive}

• Use Jython string:

  AdminTask.addIdMgrLDAPEntityTypeRDNAttr ('[-interactive]')

• Use Jython list:

  AdminTask.addIdMgrLDAPEntityTypeRDNAttr (['-interactive'])

 

addIdMgrLDAPGroupDynamicMemberAttr

The addIdMgrLDAPGroupDynamicMemberAttr command adds a dynamic member attribute configuration to an LDAP group configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

-name

The name of the LDAP attribute that is used as the group member attribute. For example, member or uniqueMember. (String, required)

-objectClass

The group object class that contains the member attribute. For example, groupOfNames or groupOfUnqiueNames. If you do not define this parameter, the member attribute applies to all group object classes. (String, optional)

-scope

The scope of the member attribute. The valid values for this parameter include the following:

• direct - The member attribute only contains direct members, therefore, this value refers to the member directly contained by the group and not contained through the nested group. For example, if Group1 contains Group2 and Group2 contains User1, then Group2 is a direct member of Group1 but User1 is not a direct member of Group1. Both member and uniqueMember are direct member attributes.

• nested - The member attribute that contains the direct members and the nested members.

-dummyMember

Indicates that if you create a group without specifying a member, a dummy member will be filled in to avoid creating an exception about missing a mandatory attribute. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask addIdMgrLDAPGroupDynamicMemberAttr {-id id1 -name name1 -objectClass objectclass}

• Use Jython string:

  AdminTask.addIdMgrLDAPGroupDynamicMemberAttr ('[-id id1 -name name1 -objectClass objectclass]')

• Use Jython list:

  AdminTask.addIdMgrLDAPGroupDynamicMemberAttr (['-id', 'id1', '-name', 'name1', '-objectClass', 'objectclass'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask addIdMgrLDAPGroupDynamicMemberAttr {-interactive}

• Use Jython string:

  AdminTask.addIdMgrLDAPGroupDynamicMemberAttr ('[-interactive]')

• Use Jython list:

  AdminTask.addIdMgrLDAPGroupDynamicMemberAttr (['-interactive'])

 

addIdMgrLDAPGroupMemberAttr

The addIdMgrLDAPGroupMemberAttr command adds a member attribute configuration to an LDAP group configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

-name

The name of the LDAP attribute that is used as the group member attribute. For example, member or uniqueMember. (String, required)

-objectClass

The group object class that contains the member attribute. For example, groupOfNames or groupOfUnqiueNames. If you do not define this parameter, the member attribute applies to all group object classes. (String, optional)

-scope

The scope of the member attribute. The valid values for this parameter include the following:

• direct - The member attribute only contains direct members, therefore, this value refers to the member directly contained by the group and not contained through the nested group. For example, if Group1 contains Group2 and Group2 contains User1, then Group2 is a direct member of Group1 but User1 is not a direct member of Group1. Both member and uniqueMember are direct member attributes.

• nested - The member attribute that contains the direct members and the nested members.

-dummyMember

Indicates that if you create a group without specifying a member, a dummy member will be filled in to avoid creating an exception about missing a mandatory attribute. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask addIdMgrLDAPGroupMemberAttr {-id id1 -name name1}

• Use Jython string:

  AdminTask.addIdMgrLDAPGroupMemberAttr ('[-id id1 -name name1]')

• Use Jython list:

  AdminTask.addIdMgrLDAPGroupMemberAttr (['-id', 'id1', '-name', 'name1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask addIdMgrLDAPGroupMemberAttr {-interactive}

• Use Jython string:

  AdminTask.addIdMgrLDAPGroupMemberAttr ('[-interactive]')

• Use Jython list:

  AdminTask.addIdMgrLDAPGroupMemberAttr (['-interactive'])

 

addIdMgrLDAPServer

The addIdMgrLDAPServer command adds an LDAP server to the LDAP repository ID specified.

Parameters and return values

-id

The ID of the repository. (String, required)

-host

The host name for the primary LDAP server. (String, required)

-port

The port number for the LDAP server. (Integer, optional)

-bindDN

The binding distinguished name for the LDAP server. (String, optional)

-bindPassword

The binding password. (String, optional)

-authentication

Indicates the authentication method to use. The default value is simple. Valid values include: none or strong. (String, optional)

-referal

The LDAP referral. The default value is ignore. Valid values include: follow, throw, or false. (String, optional)

-derefAliases

Controls how aliases are dereferenced. The default value is always. Valid values include:

• never - never deference aliases

• finding - deferences aliases only during name resolution

• searching - deferences aliases only after name resolution

(String, optional)

-sslEnabled

Indicates to enable SSL or not. The default value is false. (Boolean, optional)

-connectionPool

The connection pool. The default value is false. (Boolean, optional)

-connectTimeout

The connection timeout in seconds. The default value is 0. (Integer, optional)

-ldapServerType

The type of LDAP server being used. The default value is IDS51. (String, optional)

-sslConfiguration

The SSL configuration. (String, optional)

-certificateMapMode

Specifies whether to map X.509 certificates into a LDAP directory by exact distinguished name or by certificate filter. The default value is exactdn. To use the certificate filter for the mapping, specify certificatefilter. (String, optional)

-certificateFilter

If certificateMapMode has the value certificatefilter, then this property specifies the LDAP filter which maps attributes in the client certificate to entries in LDAP. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask addIdMgrLDAPServer {-id id1 -host myhost.ibm.com}

• Use Jython string:

  AdminTask.addIdMgrLDAPServer ('[-id id1 -host myhost.ibm.com]')

• Use Jython list:

  AdminTask.addIdMgrLDAPServer (['-id', 'id1', '-host', 'myhost.ibm.com'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask addIdMgrLDAPServer {-interactive}

• Use Jython string:

  AdminTask.addIdMgrLDAPServer ('[-interactive]')

• Use Jython list:

  AdminTask.addIdMgrLDAPServer (['-interactive'])

 

addIdMgrRepositoryBaseEntry

The addIdMgrRepositoryBaseEntry command adds a base entry to the specified repository.

Parameters and return values

-id

The ID of the repository. (String, required)

-name

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

-nameInRepository

The distinguished name in the repository that uniquely identifies the base entry name. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask addIdMgrRepositoryBaseEntry {-id id1 -name name1}

• Use Jython string:

  AdminTask.addIdMgrRepositoryBaseEntry ('[-id id1 -name name1]')

• Use Jython list:

  AdminTask.addIdMgrRepositoryBaseEntry (['-id', 'id1', '-name', 'name1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask addIdMgrRepositoryBaseEntry {-interactive}

• Use Jython string:

  AdminTask.addIdMgrRepositoryBaseEntry ('[-interactive]')

• Use Jython list:

  AdminTask.addIdMgrRepositoryBaseEntry (['-interactive'])

 

createIdMgrDBRepository

The createIdMgrDBRepository command creates a database repository configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

-dataSourceName

The name of the data source. The default value is jdbc/wimDS. (String, required)

-databaseType

The type of the database. The default value is DB2. (String, required)

-dbURL

The URL of the database. (String, required)

-dbAdminId

The database administrator ID. (String, required if database type is not Cloudscape.)

-dbAdminPassword

The database administrator password. (String, required if database type is not Cloudscape.)

-adapterClassName

The default value is com.ibm.ws.wim.adapter.db.DBAdapter. (String, optional)

-JDBCDriverClass

The JDBC driver class name. (String, optional)

-supportSorting

Indicates if sorting is supported or not. The default value is false. (Boolean, optional)

-supportTransaction

Indicates if transactions are supported or not. The default value is false. (Boolean, optional)

-isExtIdUnique

Specifies if the external ID is unique. The default value is true. (Boolean, optional)

-supportExternalName

Indicates if external names are supported or not. The default value is false. (Boolean, optional)

-entityRetrievalLimit

Indicates the value of the retrieval limit on database entries. The default value is 200. (Integer, optional)

-saltLength

The salt length in bits. The default value is 12. (Integer, optional)

-encryptionKey

The default value is rZ15ws0ely9yHk3zCs3sTMv/ho8fY17s. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask createIdMgrDBRepository {-id id1 -dataSourceName datasourcename -databaseType DB2}

• Use Jython string:

  AdminTask.createIdMgrDBRepository ('[-id id1 -dataSourceName datasourcename -databaseType DB2]')

• Use Jython list:

  AdminTask.createIdMgrDBRepository (['-id', 'id1', '-dataSourceName', 'datasourcename', '-databaseType', 'DB2'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask createIdMgrDBRepository {-interactive}

• Use Jython string:

  AdminTask.createIdMgrDBRepository ('[-interactive]')

• Use Jython list:

  AdminTask.createIdMgrDBRepository (['-interactive'])

 

createIdMgrFileRepository

The createIdMgrFileRepository command creates a file repository configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

-messageDigest Algorithm

The message digest algorithm that will be used for hashing the password. The default value is SHA-1. Valid values include... SHA-245, SHA-384, or SHA-512.(String, required)

-adapterClassName

The default value is com.ibm.ws.wim.adapter.file.was.FileAdapter. (String, optional)

-supportPaging

Indicates if paging is supported or not. The default value is false. (Boolean, optional)

-supportSorting

Indicates if sorting is supported or not. The default value is false. (Boolean, optional)

-supportTransaction

Indicates if transaction is supported or not. The default value is false. (Boolean, optional)

-isExtIdUnique

Specifies if the external ID is unique or not. The default value is true. (Boolean, optional)

-supportExternalName

Indicates if external names are supported or not. The default value is false. (Boolean, optional)

-baseDirectory

The base directory where the fill will be created in order to store the data. The default is to be dynamically built during run time using user.install.root and cell name. (String, optional)

-fileName

The file name of the repository. The default value is fileRegistry.xml. (String, optional)

-saltLength

The salt length of the randomly generated salt for password hashing. The default value is 12. (Integer, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask createIdMgrFileRepository {-id id1 -messageDigestAlgorithm SHA-245}

• Use Jython string:

  AdminTask.createIdMgrFileRepository ('[-id id1 -messageDigestAlgorithm SHA-245]')

• Use Jython list:

  AdminTask.createIdMgrFileRepository (['-id', 'id1', '-messageDigestAlgorithm', 'SHA-245'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask createIdMgrFileRepository {-interactive}

• Use Jython string:

  AdminTask.createIdMgrFileRepository ('[-interactive]')

• Use Jython list:

  AdminTask.createIdMgrFileRepository (['-interactive'])

 

createIdMgrLDAPRepository

The createIdMgrLDAPRepository command creates an LDAP repository configuration.

Parameters and return values

-id

The unique identifier for the repository. (String, required)

-ldapServerType

The type of LDAP server that is being used. The default value is IDS51. (String, required)

-adapterClassName

The default value is com.ibm.ws.wim.adapter.db.DBAdapter. (String, optional)

-supportSorting

Indicates if sorting is supported or not. The default value is false. (Boolean, optional)

-supportPaging

Indicates if paging is supported or not. The default value is false. (Boolean, optional)

-supportTransaction

Indicates if transactions are supported or not. The default value is false. (Boolean, optional)

-isExtIdUnique

Specifies if the external ID is unique. The default value is true. (Boolean, optional)

-supportExternalName

Indicates if external names are supported or not. The default value is false. (Boolean, optional)

-authentication

Indicates the authentication method to use. The default value is simple. Valid values include: none or strong. (String, optional)

-referal

The LDAP referral. The default value is ignore. Valid values include: follow, throw, or false. (String, optional)

-sslEnabled

Indicates to enable SSL or not. The default value is false. (Boolean, optional)

-sslConfiguration

The SSL configuration. (String, optional)

-connectionPool

The connection pool. The default value is false. (Boolean, optional)

-translateRDN

Indicates to translate RDN or not. The default value is false. (Boolean, optional)

-searchTimeLimit

The value of search time limit. (Integer, optional)

-searchCountLimit

The value of search count limit. (Integer, optional)

-searchPageSize

The value of search page size. (Integer, optional)

-returnToPrimaryServer

(Integer, optional)

-primaryServerQueryTimeInterval

(Integer, optional)

-default

If you set this parameter to true, the default values will be set for the remaining configuration properties of the LDAP repository. (Boolean, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask createIdMgrLDAPRepository {-id id1 -ldapServerType IDS51}

• Use Jython string:

  AdminTask.createIdMgrLDAPRepository ('[-id id1 -ldapServerType IDS51]')

• Use Jython list:

  AdminTask.createIdMgrLDAPRepository (['-id', 'id1', '-ldapServerType', 'IDS51'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask createIdMgrLDAPRepository {-interactive}

• Use Jython string:

  AdminTask.createIdMgrLDAPRepository ('[-interactive]')

• Use Jython list:

  AdminTask.createIdMgrLDAPRepository (['-interactive'])

 

deleteIdMgrLDAPEntityType

The deleteIdMgrLDAPEntityType command deletes the LDAP entity type configuration data for a specified entity type for a specific LDAP repository.

Parameters and return values

-id

The ID of the repository. (String, required)

-name

The name of the entity type. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrLDAPEntityType {-id id1 -name name1}

• Use Jython string:

  AdminTask.deleteIdMgrLDAPEntityType ('[-id id1 -name name1]')

• Use Jython list:

  AdminTask.deleteIdMgrLDAPEntityType (['-id', 'id1', '-name', 'name1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrLDAPEntityType {-interactive}

• Use Jython string:

  AdminTask.deleteIdMgrLDAPEntityType ('[-interactive]')

• Use Jython list:

  AdminTask.deleteIdMgrLDAPEntityType (['-interactive'])

 

deleteIdMgrLDAPEntityTypeRDNAttr

The deleteIdMgrLDAPEntityTypeRDNAttr command deletes the relative distinguished name (RDN) attribute configuration from an LDAP entity type configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

-entityTypeName

The name of the entity type. (String, required)

-name

The attribute name that is used to build the relative distinguished name (RDN) for the entity type. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrLDAPEntityTypeRDNAttr {-id id1 -name name1 -entityTypeName entityType}

• Use Jython string:

  AdminTask.deleteIdMgrLDAPEntityTypeRDNAttr ('[-id id1 -name name1 -entityTypeName entityType]')

• Use Jython list:

  AdminTask.deleteIdMgrLDAPEntityTypeRDNAttr (['-id', 'id1', '-name', 'name1', '-entityTypeName', 'entityType'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrLDAPEntityTypeRDNAttr {-interactive}

• Use Jython string:

  AdminTask.deleteIdMgrLDAPEntityTypeRDNAttr ('[-interactive]')

• Use Jython list:

  AdminTask.deleteIdMgrLDAPEntityTypeRDNAttr (['-interactive'])

 

deleteIdMgrLDAPGroupConfig

The deleteIdMgrLDAPGroupConfig command deletes the LDAP group configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrLDAPGroupConfig {-id id1}

• Use Jython string:

  AdminTask.deleteIdMgrLDAPGroupConfig ('[-id id1]')

• Use Jython list:

  AdminTask.deleteIdMgrLDAPGroupConfig (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrLDAPGroupConfig {-interactive}

• Use Jython string:

  AdminTask.deleteIdMgrLDAPGroupConfig ('[-interactive]')

• Use Jython list:

  AdminTask.deleteIdMgrLDAPGroupConfig (['-interactive'])

 

deleteIdMgrLDAPGroupMemberAttr

The deleteIdMgrLDAPGroupMemberAttr command deletes a member attribute configuration from an LDAP group configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrLDAPGroupMemberAttr {-id id1}

• Use Jython string:

  AdminTask.deleteIdMgrLDAPGroupMemberAttr ('[-id id1]')

• Use Jython list:

  AdminTask.deleteIdMgrLDAPGroupMemberAttr (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrLDAPGroupMemberAttr {-interactive}

• Use Jython string:

  AdminTask.deleteIdMgrLDAPGroupMemberAttr ('[-interactive]')

• Use Jython list:

  AdminTask.deleteIdMgrLDAPGroupMemberAttr (['-interactive'])

 

deleteIdMgrLDAPGroupDynamicMemberAttr

The deleteIdMgrLDAPGroupDynamicMemberAttr command deletes a dynamic member attribute configuration from an LDAP group configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

-name

The name of the LDAP attribute that is used as the group member attribute. For example, memberURL. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrLDAPGroupDynamicMemberAttr {-id id1 -name name1}

• Use Jython string:

  AdminTask.deleteIdMgrLDAPGroupDynamicMemberAttr ('[-id id1 -name name1]')

• Use Jython list:

  AdminTask.deleteIdMgrLDAPGroupDynamicMemberAttr (['-id', 'id1', '-name', 'name1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrLDAPGroupDynamicMemberAttr {-interactive}

• Use Jython string:

  AdminTask.deleteIdMgrLDAPGroupDynamicMemberAttr ('[-interactive]')

• Use Jython list:

  AdminTask.deleteIdMgrLDAPGroupDynamicMemberAttr (['-interactive'])

 

deleteIdMgrLDAPServer

The deleteIdMgrLDAPServer command deletes the configuration for the LDAP server that you specify from the LDAP repository ID specified.

Parameters and return values

-id

The ID of the repository. (String, required)

-host

The host name for the primary LDAP server. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrLDAPServer {-id id1 -host myhost.ibm.com}

• Use Jython string:

  AdminTask.deleteIdMgrLDAPServer ('[-id id1 -host myhost.ibm.com]')

• Use Jython list:

  AdminTask.deleteIdMgrLDAPServer (['-id', 'id1', '-host', 'myhost.ibm.com'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrLDAPServer {-interactive}

• Use Jython string:

  AdminTask.deleteIdMgrLDAPServer ('[-interactive]')

• Use Jython list:

  AdminTask.deleteIdMgrLDAPServer (['-interactive'])

 

deleteIdMgrRepository

The deleteIdMgrRepository command deletes a repository specified.

Parameters and return values

-id

The ID of the repository. Valid values include existing repository IDs. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrRepository {-id id1}

• Use Jython string:

  AdminTask.deleteIdMgrRepository ('[-id id1]')

• Use Jython list:

  AdminTask.deleteIdMgrRepository (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrRepository {-interactive}

• Use Jython string:

  AdminTask.deleteIdMgrRepository ('[-interactive]')

• Use Jython list:

  AdminTask.deleteIdMgrRepository (['-interactive'])

 

deleteIdMgrRepositoryBaseEntry

The deleteIdMgrRepositoryBaseEntry command deletes a base entry from the specified repository.

Parameters and return values

-id

The ID of the repository. (String, required)

-name

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

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrRepositoryBaseEntry {-id id1 -name name1}

• Use Jython string:

  AdminTask.deleteIdMgrRepositoryBaseEntry ('[-id id1 -name name1]')

• Use Jython list:

  AdminTask.deleteIdMgrRepositoryBaseEntry (['-id', 'id1', '-name', 'name1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask deleteIdMgrRepositoryBaseEntry {-interactive}

• Use Jython string:

  AdminTask.deleteIdMgrRepositoryBaseEntry ('[-interactive]')

• Use Jython list:

  AdminTask.deleteIdMgrRepositoryBaseEntry (['-interactive'])

 

getIdMgrLDAPAttrCache

The getIdMgrLDAPAttrCache command returns the LDAP attribute cache configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask getIdMgrLDAPAttrCache {-id id1}

• Use Jython string:

  AdminTask.getIdMgrLDAPAttrCache ('[-id id1]')

• Use Jython list:

  AdminTask.getIdMgrLDAPAttrCache (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask getIdMgrLDAPAttrCache {-interactive}

• Use Jython string:

  AdminTask.getIdMgrLDAPAttrCache ('[-interactive]')

• Use Jython list:

  AdminTask.getIdMgrLDAPAttrCache (['-interactive'])

 

getIdMgrLDAPContextPool

The getIdMgrLDAPContextPool command returns the LDAP context pool configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask getIdMgrLDAPContextPool {-id id1}

• Use Jython string:

  AdminTask.getIdMgrLDAPContextPool ('[-id id1]')

• Use Jython list:

  AdminTask.getIdMgrLDAPContextPool (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask getIdMgrLDAPContextPool {-interactive}

• Use Jython string:

  AdminTask.getIdMgrLDAPContextPool ('[-interactive]')

• Use Jython list:

  AdminTask.getIdMgrLDAPContextPool (['-interactive'])

 

getIdMgrLDAPEntityType

The getIdMgrLDAPEntityType command returns the LDAP entity type configuration data.

Parameters and return values

-id

The ID of the repository. (String, required)

-name

The name of the entity type. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask getIdMgrLDAPEntityType {-id id1 -name name1}

• Use Jython string:

  AdminTask.getIdMgrLDAPEntityType ('[-id id1 -name name1]')

• Use Jython list:

  AdminTask.getIdMgrLDAPEntityType (['-id', 'id1', '-name', 'name1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask getIdMgrLDAPEntityType {-interactive}

• Use Jython string:

  AdminTask.getIdMgrLDAPEntityType ('[-interactive]')

• Use Jython list:

  AdminTask.getIdMgrLDAPEntityType (['-interactive'])

 

getIdMgrLDAPEntityTypeRDNAttr

The getIdMgrLDAPEntityTypeRDNAttr command returns the relative distinguished name (RDN) attribute configuration for an LDAP entity type definition.

Parameters and return values

-id

The ID of the repository. (String, required)

-entityTypeName

The name of the entity name. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask getIdMgrLDAPEntityTypeRDNAttr {-id id1 -entityTypeName name1}

• Use Jython string:

  AdminTask.getIdMgrLDAPEntityTypeRDNAttr ('[-id id1 -entityTypeName name1]')

• Use Jython list:

  AdminTask.getIdMgrLDAPEntityTypeRDNAttr (['-id', 'id1', '-entityTypeName', 'name1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask getIdMgrLDAPEntityTypeRDNAttr {-interactive}

• Use Jython string:

  AdminTask.getIdMgrLDAPEntityTypeRDNAttr ('[-interactive]')

• Use Jython list:

  AdminTask.getIdMgrLDAPEntityTypeRDNAttr (['-interactive'])

 

getIdMgrLDAPGroupConfig

The getIdMgrLDAPGroupConfig command returns the LDAP group configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask getIdMgrLDAPGroupConfig {-id id1}

• Use Jython string:

  AdminTask.getIdMgrLDAPGroupConfig ('[-id id1]')

• Use Jython list:

  AdminTask.getIdMgrLDAPGroupConfig (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask getIdMgrLDAPGroupConfig {-interactive}

• Use Jython string:

  AdminTask.getIdMgrLDAPGroupConfig ('[-interactive]')

• Use Jython list:

  AdminTask.getIdMgrLDAPGroupConfig (['-interactive'])

 

getIdMgrLDAPGroupDynamicMemberAttrs

The getIdMgrLDAPGroupDynamicMemberAttrs command returns the dynamic member attribute configuration from the LDAP group configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask getIdMgrLDAPGroupDynamicMemberAttrs {-id id1}

• Use Jython string:

  AdminTask.getIdMgrLDAPGroupDynamicMemberAttrs ('[-id id1]')

• Use Jython list:

  AdminTask.getIdMgrLDAPGroupDynamicMemberAttrs (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask getIdMgrLDAPGroupDynamicMemberAttrs {-interactive}

• Use Jython string:

  AdminTask.getIdMgrLDAPGroupDynamicMemberAttrs ('[-interactive]')

• Use Jython list:

  AdminTask.getIdMgrLDAPGroupDynamicMemberAttrs (['-interactive'])

 

getIdMgrLDAPGroupMemberAttrs

The getIdMgrLDAPGroupMemberAttrs command returns the member attribute configuration for the LDAP group configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask getIdMgrLDAPGroup MemberAttrs {-id id1}

• Use Jython string:

  AdminTask.getIdMgrLDAPGroup MemberAttrs ('[-id id1]')

• Use Jython list:

  AdminTask.getIdMgrLDAPGroup MemberAttrs (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask getIdMgrLDAPGroupMemberAttrs {-interactive}

• Use Jython string:

  AdminTask.getIdMgrLDAPGroupMemberAttrs ('[-interactive]')

• Use Jython list:

  AdminTask.getIdMgrLDAPGroupMemberAttrs (['-interactive'])

 

getIdMgrLDAPSearchResultCache

The getIdMgrLDAPSearchResultCache command returns the LDAP search result cache configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask getIdMgrLDAPSearchResultCache {-id id1}

• Use Jython string:

  AdminTask.getIdMgrLDAPSearchResultCache ('[-id id1]')

• Use Jython list:

  AdminTask.getIdMgrLDAPSearchResultCache (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask getIdMgrLDAPSearchResultCache {-interactive}

• Use Jython string:

  AdminTask.getIdMgrLDAPSearchResultCache ('[-interactive]')

• Use Jython list:

  AdminTask.getIdMgrLDAPSearchResultCache (['-interactive'])

 

getIdMgrLDAPServer

The getIdMgrLDAPServer command returns the configuration for the LDAP server specified for the LDAP repository ID specified.

Parameters and return values

-id

The ID of the repository. (String, required)

-host

The host name for the primary LDAP server. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask getIdMgrLDAPServer {-id id1 -host myhost.ibm.com}

• Use Jython string:

  AdminTask.getIdMgrLDAPServer ('[-id id1 -host myhost.ibm.com]')

• Use Jython list:

  AdminTask.getIdMgrLDAPServer (['-id', 'id1', '-host', 'myhost.ibm.com'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask getIdMgrLDAPServer {-interactive}

• Use Jython string:

  AdminTask.getIdMgrLDAPServer ('[-interactive]')

• Use Jython list:

  AdminTask.getIdMgrLDAPServer (['-interactive'])

 

getIdMgrRepository

The getIdMgrRepository command returns the configuration of the specified repository.

Parameters and return values

-id

The ID of the repository. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask getIdMgrRepository {-id id1}

• Use Jython string:

  AdminTask.getIdMgrRepository ('[-id id1]')

• Use Jython list:

  AdminTask.getIdMgrRepository (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask getIdMgrRepository {-interactive}

• Use Jython string:

  AdminTask.getIdMgrRepository ('[-interactive]')

• Use Jython list:

  AdminTask.getIdMgrRepository (['-interactive'])

 

listIdMgrCustomProperties

The listIdMgrCustomProperties command returns a list of custom properties for the repository specified.

Parameters and return values

-id

The ID of the repository. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask listIdMgrCustomProperties {-id id1}

• Use Jython string:

  AdminTask.listIdMgrCustomProperties ('[-id id1]')

• Use Jython list:

  AdminTask.listIdMgrCustomProperties (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask listIdMgrCustomProperties {-interactive}

• Use Jython string:

  AdminTask.listIdMgrCustomProperties ('[-interactive]')

• Use Jython list:

  AdminTask.listIdMgrCustomProperties (['-interactive'])

 

listIdMgrLDAPBackupServers

The listIdMgrLDAPBackupServers command returns a list of the backup LDAP server or servers.

Parameters and return values

-id

The ID of the repository. (String, required)

-primary_host

The host name for the primary LDAP server. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask listIdMgrLDAPBackupServer {-id id1 -primary_host hostname}

• Use Jython string:

  AdminTask.listIdMgrLDAPBackupServer ('[-id id1 -primary_host hostname]')

• Use Jython list:

  AdminTask.listIdMgrLDAPBackupServer (['-id', 'id1', '-primary_host', 'hostname'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask listIdMgrLDAPBackupServer {-interactive}

• Use Jython string:

  AdminTask.listIdMgrLDAPBackupServer ('[-interactive]')

• Use Jython list:

  AdminTask.listIdMgrLDAPBackupServer (['-interactive'])

 

listIdMgrLDAPEntityTypes

The listIdMgrLDAPEntityTypes command lists the name of all of the configured LDAP entity type definitions.

Parameters and return values

-id

The ID of the repository. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask listIdMgrLDAPEntityType {-id id1}

• Use Jython string:

  AdminTask.listIdMgrLDAPEntityType ('[-id id1]')

• Use Jython list:

  AdminTask.listIdMgrLDAPEntityType (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask listIdMgrLDAPEntityType {-interactive}

• Use Jython string:

  AdminTask.listIdMgrLDAPEntityType ('[-interactive]')

• Use Jython list:

  AdminTask.listIdMgrLDAPEntityType (['-interactive'])

 

listIdMgrLDAPServers

The listIdMgrLDAPServers command lists all of the configured primary LDAP servers.

Parameters and return values

-id

The ID of the repository. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask listIdMgrLDAPServers {-id id1}

• Use Jython string:

  AdminTask.listIdMgrLDAPServers ('[-id id1]')

• Use Jython list:

  AdminTask.listIdMgrLDAPServers (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask listIdMgrLDAPServers {-interactive}

• Use Jython string:

  AdminTask.listIdMgrLDAPServers ('[-interactive]')

• Use Jython list:

  AdminTask.listIdMgrLDAPServers (['-interactive'])

 

listIdMgrRepositories

The listIdMgrRepositories command lists names and types of all configured repositories.

Parameters and return values

• Parameters: None

• Returns: A hash map with key as the name of the repository and value as another hash map that includes the following keys:

  • repositoryType - The type of repository. For example, File, LDAP, DB, and so on.

  • specificRepositoryType - The specific type of repository. For example, LDAP, IDS51, NDS, and so on.

  • host - The host name where the repository resides. For File, it is LocalHost and for DB it is dataSourceName.

  This command will not return the Property Extension and Entry Mapping repository data.

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask listIdMgrRepositories

• Use Jython string:

  AdminTask.listIdMgrRepositories()

• Use Jython list:

  AdminTask.listIdMgrRepositories()

Interactive mode example usage:

• Use Jacl:

  $AdminTask listIdMgrRepositories {-interactive}

• Use Jython string:

  AdminTask.listIdMgrRepositories ('[-interactive]')

• Use Jython list:

  AdminTask.listIdMgrRepositories (['-interactive'])

 

listIdMgrRepositoryBaseEntries

The listIdMgrRepositoryBaseEntries command lists the base entries for a specified repository.

Parameters and return values

-id

The ID of the repository. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask listIdMgrRepositoryBaseEntries {-id id1}

• Use Jython string:

  AdminTask.listIdMgrRepositoryBaseEntries ('[-id id1]')

• Use Jython list:

  AdminTask.listIdMgrRepositoryBaseEntries (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask listIdMgrRepositoryBaseEntries {-interactive}

• Use Jython string:

  AdminTask.listIdMgrRepositoryBaseEntries ('[-interactive]')

• Use Jython list:

  AdminTask.listIdMgrRepositoryBaseEntries (['-interactive'])

 

listIdMgrSupportedDBTypes

The listIdMgrSupportedDBTypes command returns a list of supported database types.

Parameters and return values

• Parameters: None

• Returns: A list of supported database types.

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask listIdMgrSupportedDBTypes

• Use Jython string:

  AdminTask.listIdMgrSupportedDBTypes()

• Use Jython list:

  AdminTask.listIdMgrSupportedDBTypes()

Interactive mode example usage:

• Use Jacl:

  $AdminTask listIdMgrSupportedDBTypes {-interactive}

• Use Jython string:

  AdminTask.listIdMgrSupportedDBTypes ('[-interactive]')

• Use Jython list:

  AdminTask.listIdMgrSupportedDBTypes (['-interactive'])

 

listIdMgrSupportedMessageDigestAlgorithms

The listIdMgrSupportedMessageDigestAlgorithms command returns a list of supported message digest algorithms.

Parameters and return values

• Parameters: None

• Returns: A list of supported message digest algorithms.

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask listIdMgrSupportedMessageDigestAlgorithms

• Use Jython string:

  AdminTask.listIdMgrSupportedMessageDigestAlgorithms()

• Use Jython list:

  AdminTask.listIdMgrSupportedMessageDigestAlgorithms()

Interactive mode example usage:

• Use Jacl:

  $AdminTask listIdMgrSupportedMessageDigestAlgorithms {-interactive}

• Use Jython string:

  AdminTask.listIdMgrSupportedMessageDigestAlgorithms ('[-interactive]')

• Use Jython list:

  AdminTask.listIdMgrSupportedMessageDigestAlgorithms (['-interactive'])

 

listIdMgrSupportedLDAPServerTypes

The listIdMgrSupportedLDAPServerTypes command returns a list of supported LDAP server types.

Parameters and return values

• Parameters: None

• Returns: A list of supported LDAP server types.

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask listIdMgrSupportedLDAPServerTypes

• Use Jython string:

  AdminTask.listIdMgrSupportedLDAPServerTypes()

• Use Jython list:

  AdminTask.listIdMgrSupportedLDAPServerTypes()

Interactive mode example usage:

• Use Jacl:

  $AdminTask listIdMgrSupportedLDAPServerTypes {-interactive}

• Use Jython string:

  AdminTask.listIdMgrSupportedLDAPServerTypes ('[-interactive]')

• Use Jython list:

  AdminTask.listIdMgrSupportedLDAPServerTypes (['-interactive'])

 

removeIdMgrLDAPBackupServer

The removeIdMgrLDAPBackupServer command removes the backup LDAP server or servers.

Parameters and return values

-id

The ID of the repository. (String, required)

-primary_host

The host name for the primary LDAP server. (String, required)

-host

The name of the backup host name. Use a asterisk (*) if you want to remove all backup servers. (String, required)

-port

The port number of the LDAP server. (Integer, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask removeIdMgrLDAPBackupServer {-id id1 -primary_host myprimaryhost.ibm.com -host myhost.ibm.com}

• Use Jython string:

  AdminTask.removeIdMgrLDAPBackupServer ('[-id id1 -primary_host myprimaryhost.ibm.com -host myhost.ibm.com]')

• Use Jython list:

  AdminTask.removeIdMgrLDAPBackupServer (['-id', 'id1', '-primary_host', 'myprimaryhost.ibm.com', '-host', 'myhost.ibm.com'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask removeIdMgrLDAPBackupServer {-interactive}

• Use Jython string:

  AdminTask.removeIdMgrLDAPBackupServer ('[-interactive]')

• Use Jython list:

  AdminTask.removeIdMgrLDAPBackupServer (['-interactive'])

 

setIdMgrCustomProperty

The setIdMgrCustomProperty command adds the custom properties to a repository configuration.

Parameters and return values

-id

The ID of the repository. Valid values include the existing repository IDs. (String, required)

-name

The name of the additional property for the repository that are not defined OOTB.(String, required)

-value

If this parameter is an empty string, the property will be deleted from the repository configuration. If this parameter is not an empty string and name does not exist, it will be added. If name is an empty string, all the custom properties will be deleted. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask setIdMgrCustomProperty {-id id1 -name name1 -value value}

• Use Jython string:

  AdminTask.setIdMgrCustomProperty ('[-id id1 -name name1 -value value]')

• Use Jython list:

  AdminTask.setIdMgrCustomProperty (['-id', 'id1', '-name', 'name1', '-value', 'value'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask setIdMgrCustomProperty {-interactive}

• Use Jython string:

  AdminTask.setIdMgrCustomProperty ('[-interactive]')

• Use Jython list:

  AdminTask.setIdMgrCustomProperty (['-interactive'])

 

setIdMgrLDAPAttrCache

The setIdMgrLDAPAttrCache command configures the LDAP attribute cache configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

-cachesDiskOffLoad

(String, optional)

-enabled

Indicates if you want to enable attribute caching. The default value is true. (Boolean, optional)

-cacheSize

The maximum size of the attribute cache defined by the number of attribute objects that are permitted in the attribute cache. The minimum value of this parameter is 100. The default value is 4000. (Integer, optional)

-cacheTimeOut

The amount of time in seconds before the cached entries that are located in the attributes cache can be not valid. The minimum value of this parameter is 0. The attribute objects that are cached will remain in the attributes cache until the virtual member manager changes the attribute objects. The default value is 1200. (Integer, optional)

-attributeSizeLimit

An integer that represents the maximum number of attribute object values that can cache in the attributes cache.

Some attributes, for example, the member attribute, contain many values. The attributeSizeLimit parameter prevents the attributes cache to cache large attributes. The default value is 2000. (Integer, optional)

-serverTTLAttribute

The name of the ttl attribute that is supported by the LDAP server. The attributes cache uses the value of this attribute to determine when the cached entries in the attributes cache will time out.

The ttl attribute contains the time, in seconds, that any information from the entry should be kept by a client before it is considered stale and a new copy is fetched. A value of 0 implies that the object will not be cached. For more information about this attribute, go to: http://www.ietf.org/proceedings/98aug/I-D/draft-ietf-asid-ldap-cache-01.txt.

The ttl attribute is not supported by all LDAP servers. If this attribute is supported by an LDAP server, you can set the value of the serverTTLAttribute parameter to the name of the ttl attribute in order to allow the value of the ttyl attribute to determine when cached entries will time out. The time out value for different entries in attributes cache can be different.

For example, if the value of the serverTTLAttribute parameter is ttl and the attributes cache retrieves attributes of a user from an LDAP server, it will also retrieve the value of the ttl attribute of this user. If the value is 200, the WMM uses this value to set the time out for the attributes of the user in the attributes cache instead of using the value of cacheTimeout. You can set different ttl attribute values for different users. (String, optional)

• Returns: None

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask setIdMgrLDAPAttrCache {-id id1}

• Use Jython string:

  AdminTask.setIdMgrLDAPAttrCache ('[-id id1]')

• Use Jython list:

  AdminTask.setIdMgrLDAPAttrCache (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask setIdMgrLDAPAttrCache {-interactive}

• Use Jython string:

  AdminTask.setIdMgrLDAPAttrCache ('[-interactive]')

• Use Jython list:

  AdminTask.setIdMgrLDAPAttrCache (['-interactive'])

 

setIdMgrLDAPContextPool

The setIdMgrLDAPContextPool command sets up the LDAP context pool configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

-enabled

By default, the context pool is enabled. If you set this parameter to false, the context pool is disabled. When the context pool is disabled, new context instances will be created for each request. The default value is true. (Boolean, optional)

-initPoolSize

The number of context instances that the the virtual member manager LDAP adapter creates when it creates the pool. The valid range for this parameter is 1 to 50. The default value is 1. (Integer, optional)

-maxPoolSize

The maximum number of context instances that the context pool will maintain. Context instances that are in use and those that are idle contribute to this number. When the pool size reaches this number, new context instances cannot be created for new requests. The new request is blocked until a context instance is released by another request or is removed. The request checks periodically if there are context instances available in the pool according to the amount of time specified using the poolWaitTime parameter.

The minimum value for this parameter is 0. There is no maximum value. Setting the value of this parameter to 0 means that there is no maximum size and a request for a pooled context instance will use an existing pooled idle context instance or a newly created pooled context instance. The default value is 20. (Integer, optional)

-prefPoolSize

The preferred number of context instances that the context pool will maintain. Context instances that are in use and those that are idle contribute to this number. When there is a request for the use of a pooled context instance and the pool size is less than the preferred size, the context pool creates and uses a new pooled context instance regardless of whether an idle connection is available. When a request finishes with a pooled context instance and the pool size is greater than the preferred size, the context pool closes and removes the pooled context instance from the pool.

The valid range for this parameter is from 0 to 100. Setting the value of this parameter to 0 means that there is no preferred size and a request for a pooled context instance results in a newly created context instance only if no idle ones are available. The default value is 3. (Integer, optional)

-poolTimeOut

An integer that represents the number of milliseconds that an idle context instance may remain in the pool without being closed and removed from the pool. When a context instance is requested from the pool, if this context already exists in the pool for more than the time defined by poolTimeout, this connection will be closed no matter this context instance is stale or active. A new context instance will be created and put back to the pool after it has been released from the request.

The minimum value for this parameter is 0. There is no maximum value. Setting the value of this parameter to 0 means that the context instances in the pool will remain in the pool until they are staled. The context pool catches the communication exception and recreates a new context instance. The default value is 0. (Integer, optional)

-poolWaitTime

The time interval in milliseconds that the request waits until the context pool rechecks if there are idle context instances available in the pool when the number of context instances reaches the maximum pool size. If no idle context instance, the request will continue waiting for the same period of time until next checking.

The minimum value for the poolWaitout parameter is 0. There is no maximum value. A value of 0 for this parameter means that the context pool will not check if idle context exists. The request will be notified when a context instance releases from other requests. The default value is 3000. (Integer, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask setIdMgrLDAPContextPool {-id id1}

• Use Jython string:

  AdminTask.setIdMgrLDAPContextPool ('[-id id1]')

• Use Jython list:

  AdminTask.setIdMgrLDAPContextPool (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask setIdMgrLDAPContextPool {-interactive}

• Use Jython string:

  AdminTask.setIdMgrLDAPContextPool ('[-interactive]')

• Use Jython list:

  AdminTask.setIdMgrLDAPContextPool (['-interactive'])

 

setIdMgrLDAPGroupConfig

The setIdMgrLDAPGroupConfig command sets up the LDAP group configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

-updateGroup Membership

Updates the group membership if the member is deleted or renamed. Some LDAP servers, for example, Domino server, do not clean up the membership of the user when a user is deleted or renamed. If you choose these LDAP server types in the ldapServerType property, the value of this parameter is set to true. Use this parameter to change the value. The default value is false. (Boolean, optional)

-name

The name of the membership attribute. For example, memberOf in an active directory server and ibm-allGroups in IDS. (String, optional)

-scope

The scope of the membership attribute. The following are the possible values for this parameter:

• direct - The membership attribute only contains direct groups. Direct groups contain the member and are not contained through a nested group. For example, if group1 contains group2, group2 contains user1, then group2 is a direct group of user1, but group1 is not a direct group of user1.

• nested - The membership attribute contains both direct groups and nested groups.

• all - The membership attribute contains direct groups, nested groups, and dynamic members.

The default value is direct. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask setIdMgrLDAPGroupConfig {-id id1}

• Use Jython string:

  AdminTask.setIdMgrLDAPGroupConfig ('[-id id1]')

• Use Jython list:

  AdminTask.setIdMgrLDAPGroupConfig (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask setIdMgrLDAPGroupConfig {-interactive}

• Use Jython string:

  AdminTask.setIdMgrLDAPGroupConfig ('[-interactive]')

• Use Jython list:

  AdminTask.setIdMgrLDAPGroupConfig (['-interactive'])

 

setIdMgrLDAPSearchResultCache

The setIdMgrLDAPSearchResultCache command sets up the LDAP search result cache configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

-cachesDiskOffLoad

Loads the attributes caches and the search results onto hard disk. By default, when the number of cache entries reaches the maximum size of the cache, cache entries are evicted to allow new entries to enter the caches. If you enable this parameter, the evicted cache entries will be copied to disk for future access. The default value is false. (Boolean, optional)

-enabled

Enables the search results cache. The default value is true. (Boolean, optional)

-cacheSize

The maximum size of the search results cache. The number of naming enumeration objects that can be put into the search results cache. The minimum value of this parameter is 100. The default value is 2000. (Integer, optional)

-cacheTimeOut

The amount of time in seconds before the cached entries in the search results cache can be not valid. The minimum value for this parameter is 0. A value of 0 means that the cached naming enumeration objects will stay in the search results cache until there are configuration changes. The default value is 600. (Integer, optional)

-searchResultSizeLimit

The maximum number of entries contained in the naming enumeration object that can be cached in the search results cache.For example, if the results from a search contains 2000 users, the search results will not cache in the search results cache if the value of the of this property is set to 1000. The default value is 1000. (Integer, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask setIdMgrLDAPSearchResultCache {-id id1}

• Use Jython string:

  AdminTask.setIdMgrLDAPSearchResultCache ('[-id id1]')

• Use Jython list:

  AdminTask.setIdMgrLDAPSearchResultCache (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask setIdMgrLDAPSearchResultCache {-interactive}

• Use Jython string:

  AdminTask.setIdMgrLDAPSearchResultCache ('[-interactive]')

• Use Jython list:

  AdminTask.setIdMgrLDAPSearchResultCache (['-interactive'])

 

setIdMgrEntryMappingRepository

The setIdMgrEntryMappingRepository command sets or updates an entry mapping repository configuration.

Parameters and return values

-dataSourceName

The name of the data source. The default value is jdbc/wimDS. The parameter is required if the property extension is not set. The parameter is not required if the command is used to update the existing configuration. (String)

-databaseType

The type of the database. The default value is DB2. The parameter is required if the property extension is not set. The parameter is not required if the command is used to update the existing configuration. (String)

-dbURL

The URL of the database. The parameter is required if the property extension is not set. The parameter is not required if the command is used to update the existing configuration. (String)

-dbAdminId

The database administrator ID. (String, required if database type is not Cloudscape.)

-dbAdminPassword

The database administrator password. (String, required if database type is not Cloudscape.)

-JDBCDriverClass

The JDBC driver class name. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask setIdMgrEntryMappingRepository {-dbAdminId dbid1 -dbAdminPassword pw1}

• Use Jython string:

  AdminTask.setIdMgrEntryMappingRepository ('[-dbAdminId dbid1 -dbAdminPassword pw1]')

• Use Jython list:

  AdminTask.setIdMgrEntryMappingRepository (['-dbAdminId', 'dbid1', '-dbAdminPassword', 'pw1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask setIdMgrEntryMappingRepository {-interactive}

• Use Jython string:

  AdminTask.setIdMgrEntryMappingRepository ('[-interactive]')

• Use Jython list:

  AdminTask.setIdMgrEntryMappingRepository (['-interactive'])

 

setIdMgrPropertyExtensionRepository

The setIdMgrPropertyExtensionRepository command sets or updates the property extension repository configuration.

Parameters and return values

-dataSourceName

The name of the data source. The default value is jdbc/wimDS. The parameter is required if the property extension is not set. The parameter is not required if the command is used to update the existing configuration. (String)

-databaseType

The type of the database. The default value is DB2. The parameter is required if the property extension is not set. The parameter is not required if the command is used to update the existing configuration. (String)

-dbURL

The URL of the database. The parameter is required if the property extension is not set. The parameter is not required if the command is used to update the existing configuration. (String)

-dbAdminId

The database administrator ID. (String, required if database type is not Cloudscape.)

-dbAdminPassword

The database administrator password. (String, required if database type is not Cloudscape.)

-entityRetrievalLimit

The limit for the retrieval of entities. (Integer, required)

-JDBCDriverClass

The JDBC driver class name. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask setIdMgrPropertyExtensionRepository {-entityRetrievalLimit 10 -JDBCDriverClass classname}

• Use Jython string:

  AdminTask.setIdMgrPropertyExtensionRepository ('[-entityRetrievalLimit 10 -JDBCDriverClass classname]')

• Use Jython list:

  AdminTask.setIdMgrPropertyExtensionRepository (['-entityRetrievalLimit', '10', '-JDBCDriverClass', 'classname'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask setIdMgrPropertyExtensionRepository {-interactive}

• Use Jython string:

  AdminTask.setIdMgrPropertyExtensionRepository ('[-interactive]')

• Use Jython list:

  AdminTask.setIdMgrPropertyExtensionRepository (['-interactive'])

 

updateIdMgrDBRepository

The updateIdMgrDBRepository command updates the configuration for the database repository specified.

Parameters and return values

-id

The ID of the repository. (String, required)

-dataSourceName

The name of the data source. The default value is jdbc/wimDS. (String, optional)

-databaseType

The type of the database. The default value is DB2. (String, optional)

-dbURL

The URL of the database. (String, optional)

-dbAdminId

The database administrator ID. (String, optional)

-dbAdminPassword

The database administrator password. (String, optional)

-entityRetrievalLimit

Indicates the value of the retrieval limit on database entries. The default value is 200. (Integer, optional)

-JDBCDriverClass

The JDBC driver class name. (String, optional)

-saltLength

The salt length in bits. The default value is 12. (Integer, optional)

-encryptionKey

The default value is rZ15ws0ely9yHk3zCs3sTMv/ho8fY17s. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrDBRepository {-id id1}

• Use Jython string:

  AdminTask.updateIdMgrDBRepository ('[-id id1]')

• Use Jython list:

  AdminTask.updateIdMgrDBRepository (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrDBRepository {-interactive}

• Use Jython string:

  AdminTask.updateIdMgrDBRepository ('[-interactive]')

• Use Jython list:

  AdminTask.updateIdMgrDBRepository (['-interactive'])

 

updateIdMgrFileRepository

The updateIdMgrFileRepository command updates the configuration for the file repository specified. To update other properties of the file repository use the updateIdMgrRepository command.

Parameters and return values

-id

The ID of the repository. (String, required)

-messageDigest Algorithm

The message digest algorithm that will be used for hashing the password. The default value is SHA-1. Valid values include... SHA-245, SHA-384, or SHA-512.(String, optional)

-baseDirectory

The base directory where the fill will be created in order to store the data. The default is to be dynamically built during run time using user.install.root and cell name. (String, optional)

-fileName

The file name of the repository. The default value is fileRegistry.xml. (String, optional)

-saltLength

The salt length of the randomly generated salt for password hashing. The default value is 12. (Integer, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrFileRepository {-id id1}

• Use Jython string:

  AdminTask.updateIdMgrFileRepository ('[-id id1]')

• Use Jython list:

  AdminTask.updateIdMgrFileRepository (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrFileRepository {-interactive}

• Use Jython string:

  AdminTask.updateIdMgrFileRepository ('[-interactive]')

• Use Jython list:

  AdminTask.updateIdMgrFileRepository (['-interactive'])

 

updateIdMgrLDAPAttrCache

The updateIdMgrLDAPAttrCache command updates the LDAP attribute cache configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

-cachesDiskOffLoad

(String, optional)

-enabled

Indicates if you want to enable attribute caching. The default value is true. (Boolean, optional)

-cacheSize

The maximum size of the attribute cache defined by the number of attribute objects that are permitted in the attribute cache. The minimum value of this parameter is 100. The default value is 4000. (Integer, optional)

-cacheTimeOut

The amount of time in seconds before the cached entries that are located in the attributes cache can be not valid. The minimum value of this parameter is 0. The attribute objects that are cached will remain in the attributes cache until the virtual member manager changes the attribute objects. The default value is 1200. (Integer, optional)

-attributeSizeLimit

An integer that represents the maximum number of attribute object values that can cache in the attributes cache.

Some attributes, for example, the member attribute, contain many values. The attributeSizeLimit parameter prevents the attributes cache to cache large attributes. The default value is 2000. (Integer, optional)

-serverTTLAttribute

The name of the ttl attribute that is supported by the LDAP server. The attributes cache uses the value of this attribute to determine when the cached entries in the attributes cache will time out.

The ttl attribute contains the time, in seconds, that any information from the entry should be kept by a client before it is considered stale and a new copy is fetched. A value of 0 implies that the object will not be cached. For more information about this attribute, go to: http://www.ietf.org/proceedings/98aug/I-D/draft-ietf-asid-ldap-cache-01.txt.

The ttl attribute is not supported by all LDAP servers. If this attribute is supported by an LDAP server, you can set the value of the serverTTLAttribute parameter to the name of the ttl attribute in order to allow the value of the ttyl attribute to determine when cached entries will time out. The time out value for different entries in attributes cache can be different.

For example, if the value of the serverTTLAttribute parameter is ttl and the attributes cache retrieves attributes of a user from an LDAP server, it will also retrieve the value of the ttl attribute of this user. If the value is 200, the WMM uses this value to set the time out for the attributes of the user in the attributes cache instead of using the value of cacheTimeout. You can set different ttl attribute values for different users. (String, optional)

• Returns: None

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrLDAPAttrCache {-id id1}

• Use Jython string:

  AdminTask.updateIdMgrLDAPAttrCache ('[-id id1]')

• Use Jython list:

  AdminTask.updateIdMgrLDAPAttrCache (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrLDAPAttrCache {-interactive}

• Use Jython string:

  AdminTask.updateIdMgrLDAPAttrCache ('[-interactive]')

• Use Jython list:

  AdminTask.updateIdMgrLDAPAttrCache (['-interactive'])

 

updateIdMgrLDAPContextPool

The updateIdMgrLDAPContextPool command updates the LDAP context pool configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

-enabled

By default, the context pool is enabled. If you set the value of this parameter to false, the context pool is disabled which means that a new context instance will be created for each request. The default value is true. (Boolean, optional)

-initPoolSize

The number of context instances that the virtual member manager LDAP adapter creates when it creates the pool. The valid range for this parameter is 1 to 50. The default value is 1. (Integer, optional)

-maxPoolSize

The maximum number of context instances that can be maintained concurrently by the context pool. Both in-use and idle context instances contribute to this number. When the pool size reaches this number, new context instances cannot created for new request. The new request is blocked until a context instance is released by another request or is removed. The request checks periodically if there are context instances available in the pool according to the value defined for the poolWaitTime parameter. The minimum value of the maxPoolSize parameter is 0. There is no maximum value. A maximum pool size of 0 means that there is no maximum size and that a request for a pooled context instance will use an existing pooled idle context instance or a newly created pooled context instance. The default value is 20. (Integer, optional)

-prefPoolSize

The preferred number of context instances that the Context Pool should maintain. Both in-use and idle context instances contribute to this number. When there is a request for the use of a pooled context instance and the pool size is less than the preferred size, Context Pool will create and use a new pooled context instance regardless of whether an idle connection is available. When a request is finished with a pooled context instance and the pool size is greater than the preferred size, the Context Pool will close and remove the pooled context instance from the pool. The valid range of the prefPoolSize parameter is 0 to 100. A preferred pool size of 0 means that there is no preferred size: A request for a pooled context instance will result in a newly created context instance only if no idle ones are available. The default value is 3. (Integer, optional)

-poolTimeOut

An integer that represents the number of milliseconds that an idle context instance may remain in the pool without being closed and removed from the pool. When a context instance is requested from the pool, if this context already exists in the pool for more than the time defined by poolTimeout, this connection will be closed no matter this context instance is stale or active. A new context instance will be created and put back to the pool after it has been released from the request.The minimum value of poolTimeout is 0. There is no maximum value.A poolTimeout of 0 means that the context instances in the pool will remain in the pool until they are staled. In this case, Context Pool will catch the communication exception and recreate a new context instance. The default value is 0. (Integer, optional)

-poolWaitTime

The time interval (in milliseconds) that the request will wait until the Context Pool checks again if there are idle context instance available in the pool when the number of context instances reaches the maximum pool size. If there is still no idle context instance, the request will continue waiting for the same period of time until next checking. The minimum value of poolWaitout is 0. There is no maximum value. A poolWaitTime of 0 means the Context Pool will not check if there are idle context. Instead, the request will be notified when there is a context instance is released from other requests. The default value is 3000. (Integer, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrLDAPContextPool {-id id1}

• Use Jython string:

  AdminTask.updateIdMgrLDAPContextPool ('[-id id1]')

• Use Jython list:

  AdminTask.updateIdMgrLDAPContextPool (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrLDAPContextPool {-interactive}

• Use Jython string:

  AdminTask.updateIdMgrLDAPContextPool ('[-interactive]')

• Use Jython list:

  AdminTask.updateIdMgrLDAPContextPool (['-interactive'])

 

updateIdMgrLDAPEntityType

The updateIdMgrLDAPEntityType command updates an existing LDAP entity type definition to LDAP repository configuration. You can use this command to add more values to multi-valued parameters. If the property already exists, the value of the property will be replaced. If the property does not exist, it will be added.

Parameters and return values

-id

The ID of the repository. (String, required)

-name

The name of the entity type. (String, required)

-searchFilter

The search filter to use to search the entity type. (String, optional)

-objectClasses

One or more object classes for the entity type. (String, optional)

-objectClassesForCreate

The object class that will be when you create an entity type object. You do not have to specify the value of this parameter if it is the same as the value of the objectClasses parameter. (String, optional)

-searchBases

The search base or bases to use while searching the entity type. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrLDAPEntityType {-id id1 -name name1}

• Use Jython string:

  AdminTask.updateIdMgrLDAPEntityType ('[-id id1 -name name1]')

• Use Jython list:

  AdminTask.updateIdMgrLDAPEntityType (['-id', 'id1', '-name', 'name1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrLDAPEntityType {-interactive}

• Use Jython string:

  AdminTask.updateIdMgrLDAPEntityType ('[-interactive]')

• Use Jython list:

  AdminTask.updateIdMgrLDAPEntityType (['-interactive'])

 

updateIdMgrLDAPGroupDynamicMemberAttr

The updateIdMgrLDAPGroupDynamicMemberAttr command updates a dynamic member attribute configuration to an LDAP group configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

-name

The name of the LDAP attribute that is used as the group member attribute. For example, memberURL. (String, required)

-objectClass

The group object class that contains the dynamic member attribute. For example groupOfURLs. If you do not define this parameter, the dynamic member attribute will apply to all group object classes. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrLDAPGroupDynamicMemberAttr {-id id1 -name name1 -objectClass groupOfURLs}

• Use Jython string:

  AdminTask.updateIdMgrLDAPGroupDynamicMemberAttr ('[-id id1 -name name1 -objectClass groupOfURLs]')

• Use Jython list:

  AdminTask.updateIdMgrLDAPGroupDynamicMemberAttr (['-id', 'id1', '-name', 'name1', '-objectClass', 'groupOfURLs'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrLDAPGroupDynamicMemberAttr {-interactive}

• Use Jython string:

  AdminTask.updateIdMgrLDAPGroupDynamicMemberAttr ('[-interactive]')

• Use Jython list:

  AdminTask.updateIdMgrLDAPGroupDynamicMemberAttr (['-interactive'])

 

updateIdMgrLDAPGroupMemberAttr

The updateIdMgrLDAPGroupMemberAttr command updates a member attribute configuration of an LDAP group configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

-name

The name of the LDAP attribute that is used as the group member attribute. For example, member or uniqueMember. (String, required)

-objectClass

The group object class that contains the member attribute. For example, groupOfNames or groupOfUnqiueNames. If you do not define this parameter, the member attribute applies to all group object classes. (String, optional)

-scope

The scope of the member attribute. The following are the valid values:

• direct - The member attribute only contains direct members whereby the member is directly contained by the group and not contained in a nested group. For example, if group1 contains group2, group2 contains user1, then group2 is a direct member of group1 but user1 is not a direct member of group1. Both member and uniqueMember are direct member attributes.

• nested - The member attribute contains both direct members and nested members.

-dummyMember

When you create a group without specifying a member, a dummy member will be filled in automatically to avoid receiving an exception that indicates that there is a mandatory attribute missing. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrLDAPGroupMemberAttr {-id id1 -name name1}

• Use Jython string:

  AdminTask.updateIdMgrLDAPGroupMemberAttr ('[-id id1 -name name1]')

• Use Jython list:

  AdminTask.updateIdMgrLDAPGroupMemberAttr (['-id', 'id1', '-name', 'name1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrLDAPGroupMemberAttr {-interactive}

• Use Jython string:

  AdminTask.updateIdMgrLDAPGroupMemberAttr ('[-interactive]')

• Use Jython list:

  AdminTask.updateIdMgrLDAPGroupMemberAttr (['-interactive'])

 

updateIdMgrLDAPRepository

The updateIdMgrLDAPRepository command updates an LDAP repository configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

-ldapServerType

The type of LDAP server that is being used. The default value is IDS51. (String, optional)

-adapterClassName

The default value is com.ibm.ws.wim.adapter.ldap.LdapAdapter. (String, optional)

-certificateMapMode

Specifies whether to map X.509 certificates into a LDAP directory by exact distinguished name or by certificate filter. The default value is exactdn. To use the certificate filter for the mapping, specify certificatefilter. (String, optional)

-certificateFilter

If certificateMapMode has the value certificatefilter, then this property specifies the LDAP filter which maps attributes in the client certificate to entries in LDAP. (String, optional)

-isExtIdUnique

Specifies if the external ID is unique. The default value is true. (Boolean, optional)

-loginProperties

Indicates the property name used for login. (String , optional)

-primaryServerQueryTimeInterval

Indicates the polling interval for testing the primary server availability. The value of this parameter is specified in minutes. The default value is 15. (Integer, optional)

-returnToPrimaryServer

Indicates to return to the primary LDAP server when it is available. The default value is true. (Boolean, optional)

-supportAsyncMode

Indicates if the async mode is supported or not. The default value is false. (Boolean, optional)

-supportSorting

Indicates if sorting is supported or not. The default value is false. (Boolean, optional)

-supportPaging

Indicates if paging is supported or not. The default value is false. (Boolean, optional)

-supportTransaction

Indicates if transactions are supported or not. The default value is false. (Boolean, optional)

-supportExternalName

Indicates if external names are supported or not. The default value is false. (Boolean, optional)

-sslConfiguration

The SSL configuration. (String, optional)

-translateRDN

Indicates to translate RDN or not. The default value is false. (Boolean, optional)

-searchTimeLimit

The value of search time limit. (Integer, optional)

-searchCountLimit

The value of search count limit. (Integer, optional)

-searchPageSize

The value of search page size. (Integer, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrLDAPRepository {-id id1}

• Use Jython string:

  AdminTask.updateIdMgrLDAPRepository ('[-id id1]')

• Use Jython list:

  AdminTask.updateIdMgrLDAPRepository (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrLDAPRepository {-interactive}

• Use Jython string:

  AdminTask.updateIdMgrLDAPRepository ('[-interactive]')

• Use Jython list:

  AdminTask.updateIdMgrLDAPRepository (['-interactive'])

 

updateIdMgrLDAPSearchResultCache

The updateIdMgrLDAPSearchResultCache command updates the LDAP search result cache configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

-cachesDiskOffLoad

Loads the attributes caches and the search results onto hard disk. By default, when the number of cache entries reaches the maximum size of the cache, cache entries are evicted to allow new entries to enter the caches. If you enable this parameter, the evicted cache entries will be copied to disk for future access. The default value is false. (Boolean, optional)

-enabled

Enables the search results cache. The default value is true. (Boolean, optional)

-cacheSize

The maximum size of the search results cache. The number of naming enumeration objects that can be put into the search results cache. The minimum value of this parameter is 100. The default value is 2000. (Integer, optional)

-cacheTimeOut

The amount of time in seconds before the cached entries in the search results cache can be not valid. The minimum value for this parameter is 0. A value of 0 means that the cached naming enumeration objects will stay in the search results cache until there are configuration changes. The default value is 600. (Integer, optional)

-searchResultSizeLimit

The maximum number of entries contained in the naming enumeration object that can be cached in the search results cache.For example, if the results from a search contains 2000 users, the search results will not cache in the search results cache if the value of the of this property is set to 1000. The default value is 1000. (Integer, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrLDAPSearchResultCache {-id id1}

• Use Jython string:

  AdminTask.updateIdMgrLDAPSearchResultCache ('[-id id1]')

• Use Jython list:

  AdminTask.updateIdMgrLDAPSearchResultCache (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrLDAPSearchResultCache {-interactive}

• Use Jython string:

  AdminTask.updateIdMgrLDAPSearchResultCache ('[-interactive]')

• Use Jython list:

  AdminTask.updateIdMgrLDAPSearchResultCache (['-interactive'])

 

updateIdMgrLDAPServer

The updateIdMgrLDAPServer command updates an LDAP server configuration for the LDAP repository ID specified.

Parameters and return values

-id

The ID of the repository. (String, required)

-host

The host name for the LDAP server that contains the properties to modify. (String, required)

-port

The port number for the LDAP server. (Integer, optional)

-authentication

Indicates the authentication method to use. The default value is simple. Valid values include: none or strong. (String, optional)

-bindDN

The binding domain name for the LDAP server. (String, optional)

-bindPassword

The binding password. The password is encrypted before it is stored.(String, optional)

-certificateMapMode

Specifies whether to map X.509 certificates into a LDAP directory by exact distinguished name or by certificate filter. The default value is exactdn. To use the certificate filter for the mapping, specify certificatefilter. (String, optional)

-certificateFilter

If certificateMapMode has the value certificatefilter, then this property specifies the LDAP filter which maps attributes in the client certificate to entries in LDAP. (String, optional)

-connectTimeout

The connection timeout measured in seconds. The default value is 0. (Integer, optional)

-connectionPool

The connection pool. The default value is false. (Boolean, optional)

-derefAliases

Controls how aliases are dereferenced. The default value is always. Valid values include:

• never - never deference aliases

• finding - deferences aliases only during name resolution

• searching - deferences aliases only after name resolution

(String, optional)

-ldapServerType

The type of LDAP server being used. The default value is IDS51. (String, optional)

-primary_host

The host name for the primary LDAP server. (String, optional)

-referal

The LDAP referral. The default value is ignore. Valid values include: follow, throw, or false. (String, optional)

-sslConfiguration

The SSL configuration. (String, optional)

-sslEnabled

Indicates to enable SSL or not. The default value is false. (Boolean, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrLDAPServer {-id id1 -host myhost.ibm.com}

• Use Jython string:

  AdminTask.updateIdMgrLDAPServer ('[-id id1 -host myhost.ibm.com]')

• Use Jython list:

  AdminTask.updateIdMgrLDAPServer (['-id', 'id1', '-host', 'myhost.ibm.com'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrLDAPServer {-interactive}

• Use Jython string:

  AdminTask.updateIdMgrLDAPServer ('[-interactive]')

• Use Jython list:

  AdminTask.updateIdMgrLDAPServer (['-interactive'])

 

updateIdMgrRepository

The updateIdMgrRepository command updates the common repository configuration.

Parameters and return values

-id

The ID of the repository. (String, required)

-adapterClassName

The implementation class name for the repository adapter. (String, optional)

-EntityTypesNot AllowCreate

The name of the entity type that should not be created in this repository. (String, optional)

-EntityTypesNotAllowUpdate

The name of the entity type that should not be updated in this repository. (String, optional)

-EntityTypesNotAllowRead

The name of the entity type that should not be read from this repository. (String, optional)

-EntityTypesNotAllowDelete

The name of the entity type that should not be deleted from this repository. (String, optional)

-loginProperties

(String, optional)

-readOnly

Indicates if this is a read only repository. The default value is false. (Boolean, optional)

-repositoriesForGroups

The repository ID where group data is stored. (String, optional)

-supportPaging

Indicates if the repository supports paging or not. (Boolean, optional)

-supportSorting

Indicates if the repository supports sorting or not. (Boolean, optional)

-supportTransaction

Indicates if the repository supports transaction or not. (Boolean, optional)

-isExtIdUnique

Specifies if the external ID is unique or not. (Boolean, optional)

-supportedExternalName

Indicates if the repository supports external names or not. (Boolean, optional)

-supportAsyncMode

Indicates if the adapter supports async mode or not. The default value is false. (Boolean, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrRepository {-id id1}

• Use Jython string:

  AdminTask.updateIdMgrRepository ('[-id id1]')

• Use Jython list:

  AdminTask.updateIdMgrRepository (['-id', 'id1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrRepository {-interactive}

• Use Jython string:

  AdminTask.updateIdMgrRepository ('[-interactive]')

• Use Jython list:

  AdminTask.updateIdMgrRepository (['-interactive'])

 

updateIdMgrRepositoryBaseEntry

The updateIdMgrRepositoryBaseEntry command updates a base entry to the specified repository.

Parameters and return values

-id

The ID of the repository. (String, required)

-name

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

-nameInRepository

The distinguished name in the repository that uniquely identifies the base entry name. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrRepositoryBaseEntry {-id id1 name name1}

• Use Jython string:

  AdminTask.updateIdMgrRepositoryBaseEntry ('[-id id1 name name1]')

• Use Jython list:

  AdminTask.updateIdMgrRepositoryBaseEntry (['-id', 'id1', 'name', 'name1'])

Interactive mode example usage:

• Use Jacl:

  $AdminTask updateIdMgrRepositoryBaseEntry {-interactive}

• Use Jython string:

  AdminTask.updateIdMgrRepositoryBaseEntry ('[-interactive]')

• Use Jython list:

  AdminTask.updateIdMgrRepositoryBaseEntry (['-interactive'])

---

 

Related tasks

Use the AdminTask object for scripted administration

 

Related Reference

Commands for the AdminTask object

 

Reference topic