eTrust Directory Administrator Guide - CA Technologies

DXserver Script Language
Command Syntax
Typically, commands have one of the following formats:
■
■
■
set item = value;
get item;
action parameters;
Some commands are hyphenated (for example, add-entry-req). You can spread
each command over many lines. You must terminate each command with a
semicolon.
You do not need to quote simple (one-word) strings. You must quote more
complex (many-word) strings. Within a quoted string, you can use a backslash
(\) as an escape mechanism for the following cases:
Case Example String
Quote my “favorite” car "my \"favorite\" car"
Backslash c:\myfile "c:\\myfile"
Hex number touché "Touch\xC2e"
There is often a need to specify attribute values in character sets other than
ASCII. For example, you can perform the following modification:
mod-entry-req entry= add-attr { description "a description" };
But how is this done in other languages?
LDAPv3 has standardized on UTF-8 for internationalization. An example, using
UTF-8, is now:
mod-entry-req entry= add-attr { description utf8 "touch\xC3\xA9" };
The Latin-1 character e-acute (E9) in UTF-8 (C3A9) has been encoded. The
following example would search for all entries with common names beginning
with e-acute.
search-req base-object= whole-subtree filter = { attr = commonName substrings [
initial utf8 "\xC3\xA9" };
Commands can continue over multiple lines. If you enter an incomplete
command at the management console, a continuation prompt, as shown below,
displays until you enter a semicolon:
--->
Tip: You can interrupt the execution of a script file from the management
console using the telnet commands Ctrl-c or Ctrl-x. (See DXconsole in this
chapter.)
2–12 eTrust Directory Administrator Guide