Preface Dirxmetahub Document Set
Total Page:16
File Type:pdf, Size:1020Kb
Preface DirXmetahub Document Set Preface This manual is reference for the DirXmetahub meta controller and its associated programs and files. It consists of the following chapters: S Chapter 1 provides reference pages for the meta controller command-line program metacp and for the binary trace log file analyzers dirxdumplog and dxmdumplog. S Chapter 2 describes the meta controller attribute configuration file format. S Chapter 3 describes the data file formats supported by the meta controller. S Chapter 4 describes the use of change log information. S Chapter 5 describes the extensions to the meta directory store schema that are required to support the integrated DirXmetahub meta agents and the DirXmetahub synchronization jobs. S Chapter 6 describes the string representations and use of attribute syntaxes for LDAP binds by the meta controller to the meta directory store. It also contains a reference page for simple syntaxes and reference pages for each of the structured syntaxes. S Chapter 7 describes the files used by the metacp, dirxdumplog and dxmdumplog programs. S Chapter 8 describes the environment variables used by the metacp, dirxdumplog and dxmdumplog programs. S Chapter 9 describes the synchronization templates supplied with DirXmetahub. S Chapter 10 describes procedures for use of data file formats like XML and change log. S Appendix A provides a list of country codes. S Appendix B provides detailed information on code conversion. DirXmetahub Document Set The DirXmetahub document set consists of the following manuals: S DirXmetahub Administration Guide. Use this book to obtain a description of DirXmetahub architecture and components and to understand the basic tasks of DirXmetahub administration using DirXmetahub Manager. S DirXmetahub Controller Reference (this manual). Use this book to obtain reference information about the DirXmetahub meta controller and its associated command-line programs and files. DirXmetahub Meta Controller Reference 1 Notation Conventions Preface S DirXmetahub Meta Agent Reference. Use this book to obtain reference information about the DirXmetahub meta agent programs, scripts, and files. S DirXmetahubTroubleshooting Guide. Use this book to track down and solve problems in your DirXmetahub installation. S DirXmetahub Installation Guide. Use this book to install DirXmetahub. S DirXmetahub Release Notes. Use this book to understand the features and limitations of the current release. This document is shipped with the DirXmetahub installation as the file Readme.txt. Notation Conventions Boldface type In command syntax, bold words and characters represent commands or keywords that must be entered exactly as shown. In examples, bold words and characters represent user input. Italic type In command syntax, italic words and characters represent placeholders for information that you must supply. [ ] In command syntax, square braces enclose optional items. { } In command syntax, braces enclose a list from which you must choose one item. In Tcl syntax, you must actually type in the braces, which will appear in boldface type. | In command syntax, the vertical bar separates items in a list of choices. ... In command syntax, ellipses indicate that the previous item can be repeated. install_path The exact name of the root of the directory where DirXmetahub programs and files are installed. The default installation directory is userID_home_directory/DirXmetahub on UNIX systems and C:\Program Files\Siemens\DirXmetahub on Windows NT/Windows 2000 systems. During installation the installation directory can be specified. In this manual, the installation- specific portion of pathnames represented by the notation install_path. 2 DirXmetahub Meta Controller Reference DirXmetahub Commands Chapter 1 1 DirXmetahub Commands DirXmetahub provides the following commands: S metacp - Invokes the meta controller. The DirXmetahub meta controller is a Meta Directory client program that system administrators can use to synchronize directories and manage the entries in a meta directory store. This program supports the following objects: S ldapargs - Manages service controls associated with an LDAP directory operation S meta - Performs directory synchronization operations S obj - Manages meta directory store entries S util - Implements the metacp utilities. S dirxdumplog - Displays the contents of the binary trace log files generated by the meta controller (metacp). S dxmdumplog - Displays the contents of the binary trace log files generated by the DirXmetahub server (dxmmsssvr.exe and dxmsvr.exe). The remainder of this section describes the DirXmetahub commands and provides command syntax and examples. The metacp command is described first, followed by descriptions of all the objects it supports in alphabetical order. Next, the dirxdumplog and dxmdumplog commands are described. Note: DirXmetahub commands in scripts can use the backslash (\) as the line continuation character. In interactive mode, there is no continuation character. Instead, you must continue typing. The line automatically wraps if your characters extend beyond the line end. If you press the Enter/Return key, the information you have typed is sent to the system for processing. You should press the Enter/Return key only when you have typed all information required for the command to process. The majority of the sample commands in this chapter use continuation characters and appear as they would appear in a script. The commands are presented this way so that they can be formatted for readability. DirXmetahub Meta Controller Reference 3 1.1 metacp DirXmetahub Commands 1.1 metacp Synopsis metacp [script_name [arg1 [arg2 …]] | -c command | -V] Purpose Provides a set of operations for directory synchronization and manages entries in a meta directory store. The meta controller (metacp) supports the following objects: ldapargs Manages service controls associated with an LDAP directory operation meta Performs directory synchronization operations obj Manages meta directory store entries The meta controller also supports the utilities described in the util page. Arguments script_name Filename of a user-defined script containing metacp commands. The given TCL-Script will be loaded using the utf-8 encoding as default. If the TCL- script holds data in a different encoding, then the following additional arguments must be passed: -encoding encoding Note: -encoding encoding is part of arg[n]. It is passed along to the Tcl-Script as global TCL variables. In order to write compatible TCL scripts, it is recommended to pass these two arguments at the end of the argument list. arg[n] Argument to the user-defined script specified in script_name. Script arguments are stored in global Tcl variables and can be evaluated in Tcl scripts. See the Tcl Variables section in this chapter for more information. Options -c command Executes the metacp or Tcl commands specified by command. -V Displays the metacp build version, in the format: 4 DirXmetahub Meta Controller Reference DirXmetahub Commands 1.1 metacp 'metacp' build version: product_version build_id date time For example: 'metacp' build version: 5.0B 19 1999:05:05 13:14 The metacp initialize operation also writes the build version to the metacp trace file. Description The meta controller is a command-line tool that system administrators can use to perform directory synchronization. Use it to perform the following tasks: S Initialize and clean up the metacp workspace S Open connections to directories S Create and manage metacp handles S Read attribute configuration files S Perform entry management during directory synchronization S Create and manage directory search results lists S Perform string-handling operations S Create trace files that record directory synchronization progress S Create and manage index lists You can also use metacp as a command-line entry administration tool to communicate with a meta directory store and manage the entries contained within it. Tcl Command Language The meta controller is built on a portable command language called the tool command language (Tcl). Tcl permits the use of variables, if statements, list-processing functions, loop functions, and many other features commonly found in command languages. The program extends these features to provide a set of commands for directory synchronization and structured file I/O. The program also includes task scripts to help directory users and system administrators perform some routine management functions. The Meta Directory Client Configuration File The meta controller uses the Meta Directory client configuration file (dirxcl.cfg) to convert symbolic names of meta directory stores to network addresses and to determine network addresses of default servers. See the DirXmetahub Program Files chapter for details about this file. Bind Types and Bind IDs The meta controller supports multiple binds by using bind IDs and-for compatibility reasons-the concept of a default bind. A bind ID is a string associated with an LDAP bind DirXmetahub Meta Controller Reference 5 1.1 metacp DirXmetahub Commands (a connection to a meta directory store through the LDAP v2 or LDAP v3 protocol). Specify the string value of a bind ID in an obj bind operation. (See the obj bind operation for details.) Use the bind ID in other operations to refer to a particular bind. An obj bind command that does not specify a bind ID establishes a default bind. A command that does not specify a bind ID refers to the default bind. Only one default bind can exist at a time. Synchronization Profiles and