DXrename Tool—Change the Name of a Directory Entry

Reference Guide › DXtools › DXrename Tool—Change the Name of a Directory Entry

DXrename Tool—Change the Name of a Directory Entry

Use the DXrename tool to change the distinguished name of a directory entry. The utility can source the rename data for a single entry from the keyboard or for multiple entries from a file.

This command has the following format:

dxrename [options] [dn newdn]

options
Denotes one or more of the following options:
-c
Runs in continuous mode. Errors are reported, but the process is not stopped.
-d level [-d level...]
Sets the LDAP debug levels.
- level
  Defines the level of debugging as follows:
  
  -1 Enable all debugging
  
  0 No debugging
  
  1 Trace function
  
  2 Debug packet handling
  
  4 Heavy trace debugging
  
  8 Connection management
  
  16 Print out packages sent and received
  
  32 Search filter processing
  
  64 Configuration file processing
  
  128 Access control list processing
  
  256 Stats log connections/operations/results
  
  512 Stats log entries sent
  
  1024 Print communication with shell backends
  
  2048 Print entry parsing debugging
  
  You can add numbers together to specify multiple debug levels at the same time. For example, a debug level of 6 specifies the debugging levels of both 2 and 4.
-D bindDN
Specifies the distinguished name of the user performing the bind.
-f filename
Specifies a file to read from, rather than standard input.
-h dap-host
Specifies the address or host name of the directory host. If you do not specify this, the tool uses localhost instead.

You can include OSI addressing for transport, session, and presentation SAPs by fully expanding dap-host:
```
hostname:port/tsel/ssel/psel
```
You can include binary and ASCII characters in the tsel, ssel, and psel selectors, using the % followed by the two hexadecimal digits that represent the ASCII code for the character, for example:
- / is expressed as %2F
- % is expressed as %25
-l timelimit
Specifies the time limit in seconds for each DAP operation.
-n
Shows what would be done, but does not actually do it. Use with the -v option for debugging.
-p dap-port
Specifies the port on directory host computer. If you do not specify this, the tool uses port 102, the OSI port, buy default

You can combine the -h and -p arguments into a single argument, and express them as a dotted IP address or hostname. For example, you can replace the options on the first line with those on the second:
```
-h 192.168.19.202 -p 19389
```
```
-h 192.168.19.202:19389
```
-r
Removes the old RDN.
-v
Runs in verbose mode.
-w password
Specifies the bind password, which is used for simple authentication.
-Z [ssld_config_filename]
Specifies that the tool should start a TLS request.

Use -ZZ to require a successful response from the DSA.
- ssld_config_filename
  Specifies the name of the configuration file used by the -Z option. The default file is:
```
DXHOME/config/ssld/dxldap.conf
```
  This configuration file is a text file. It must contain a line starting TLS_CACERT, and can optionally contain a second line starting TLS_REQCERT. Its format is as follows:
```
TLS_CACERT trusted_pem_file
[TLS_REQCERT {allow|demand|hard|never|try}]
```
In the configuration file, the lines have the following meaning:
- TLS_CACERT trusted_pem_file
  Specifies the file that contains certificates for all of the Certificate Authorities the client will recognize.
  
  trusted_pem_file
  
  Species the trusted pem file.
  
  This must be an absolute reference to a full path, without environment variables.
  
  Do not enclose trusted_pem_file in quotes.
- [TLS_REQCERT {allow|demand|hard|never|try} ]
  Specifies what checks to perform on server certificates in a TLS session, if any.
  
  If this line is missing, the system uses TLS_REQCERT demand
  
  The keywords have the following meaning:
  - allow - The client will request a server certificate and if no certificate is provided, the session proceeds normally. If a bad certificate is provided, it will be ignored and the session proceeds normally.
  - demand - The client will request a server certificate and if no certificate is provided, or a bad certificate is provided, the session is immediately terminated. This is the default setting.
  - hard - This is a synonym for demand.
  - never - The client will not request or check any server certificate.
  - try - The client will request a server certificate and if no certificate is provided, the session proceeds normally. However, if a bad certificate is provided, the session immediately terminates.

Example: dxldap.conf file on a Windows System, Specifying the TLS_REQCERT Setting

TLS_CACERT  c:\program files\CA\Directory\dxserver\config\ssld\trusted.pem
TLS_REQCERT allow

Example: dxldap.conf file on a UNIX System, Using the Default TLS_REQECRT Setting

TLS_CACERT  /opt/CA/Directory/dxserver/config/ssld/trusted.pem

dn
Specifies the distinguished name of the entry that is to be renamed.
newrdn
Specifies the new RDN.

Example: Change Middle Initial

This example uses the Democorp sample directory supplied with CA Directory. You can repeat this example as a training exercise.

Consider an example entry Murray Horsfall

Change the RDN to insert a middle initial J.
The example uses the input file option. The example file name is filename.txt:
```
cn=Murray HORSFALL,ou=Repair,ou=Operations,o=Democorp,c=AU
cn=Murray J HORSFALL
```

Use the DXrename tool as follows:

dxrename -r -h hostname:1900 -f filename.txt

Use the DXsearch tool to check the results of the rename:

dxsearch -L -h hostname:19389 "(sn=horsfall)"

dn: cn=Murray J HORSFALL,ou=Repair,ou=Operations,o=Democorp,c=AU
oc: organizationalPerson
oc: newPilotPerson
oc: 0.9.2342.19200300.99.3.2
cn: Murray J HORSFALL
sn: HORSFALL
title: Chief Information Officer
telephone: 797 8877
telephone: 797 8888
mail: Murray.HORSFALL@Democorp.com
postalAddress: 173 Toorak Rd $ South Yarra
postalCode: 3066

Email CA about this topic