Managing an object class over LDAP
Manage an object class schema element over LDAP by adding a new attribute element to an existing object class. You can create your own schema file or type the schema from the command line. In either case, you must pay special attention to text spacing and ASN.1 formatting.
Before you begin
Define the attribute you want to add to the custom schema file.
About this task
The following example procedure adds a predefined attribute, contractorAddress
, to the custom schema file, then adds it to the contractor
object class.
Steps
-
Create and save an LDIF file with the content in the following example.
Example:
In this example, the file is named
contractorAddress-attr.ldif
.dn: cn=schema changetype: modify add: attributeTypes attributeTypes: ( contractor-OID NAME 'contractorAddress' SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 SINGLE-VALUE USAGE userApplications X-ORIGIN 'user defined' X-SCHEMA-FILE ’98-custom-schema.ldif’ ) X-ORIGINS ’user defined’ X-SCHEMA-FILE ’98-custom-schema.ldif’ )
-
To add the attribute you defined, run
ldapmodify
.Example:
In this example, the
contractorAddress
attribute is being added.$ bin/ldapmodify --filename contractorAddress-attr.ldif
-
To modify the contractor object class to allow this attribute, create an LDIF file.
When doing this, you are re-adding the updated
objectClass
. The PingDirectory server handles the proper replacement of the existing object class with the new one.Ensure that the lines are not wrapped, the
objectClasses
line should be one continuous line.Example:
In this example, the file is named
contractor-oc.ldif
.dn:cn=schema changetype: modify add: objectClasses objectClasses: ( contractor-OID NAME ’contractor’ DESC ’Contractor status information SUP top AUXILIARY MAY ( contractorStatus $ contractorAgency $ contractorAddress ) X-ORIGIN ’Directory Server Example’ X-SCHEMA-FILE ’98-custom-schema.ldif’ )
-
To update the
objectClass
, runldapmodify
.Example:
$ bin/ldapmodify --filename contractor-oc.ldif
Result:
These schema changes are replicated to all servers in the replication topology.
-
To verify the change, view the
config/schema/98-custom-schema.ldif
file on the other servers in the replication topology to ensure that the changes are present. -
Optional: To add an index for this attribute, run
dsconfig
with thecreate-local-db-index
option.You must do this on each server in your topology unless you have server configuration groups set up.
For more information, see Configuring server groups.
Example:
$ bin/dsconfig create-local-db-index --backend-name userRoot \ --index-name contractorAddress --set index-type:equality
-
Rebuild the index online.
This doesn’t affect other indexes or entries because there is no existing data for this attribute on any entry.
Example:
$ bin/rebuild-index --baseDN dc=example,dc=com --index contractorAddress