directory(1m) directory(1m)
NAME
directory - A dcecp object that manages a CDS directory
SYNOPSIS
directory add directory_name_list -member child_pointer_list -clearinghouse clearinghouse_name
directory create directory_name_list [-attribute attribute_list [-single]] [[-replica] -clearinghouse clearinghouse_name]
directory delete directory_name_list [[-tree] [-force] | -replica -clearinghouse clearinghouse_name]
directory help [operation | -verbose]
directory list directory_name_list [-directories] [-objects] [-links] [-simplename]
directory merge source_directory_name
-into destination_directory_name [-clearinghouse clearinghouse_name] [-tree] [-nocheck]
directory modify directory_name_list {-add attribute_list [-single] | -remove attribute_list [-types] | -change attribute_list | -master
clearinghouse_name [-readonly clearinghouse_name_list] [-exclude clearinghouse_name_list]}
directory operations
directory remove directory_name_list -member child_pointer_list
directory show directory_name_list [-schema] [-member child_pointer_list | [-replica] -clearinghouse clearinghouse_name]
directory synchronize directory_name_list
ARGUMENTS
A list of one or more directory names to be operated on. The name of the directory operation for which to display help information. The
name of a single directory whose contents are to be copied into a destination directory using the merge operation.
DESCRIPTION
The directory object represents Cell Directory Service (CDS) directories. CDS directories are containers for other objects, links, and
other directories (as well as clearinghouses). Any of these items that reside in a directory are called children of that directory.
Directories also contain attributes that may be viewed or modified.
This object also represents CDS replicas. Replicas are read-only copies of directories stored in other clearinghouses. Several of the
supported operations take options to indicate that the command is to operate on a specific replica.
If the _s(cds) convenience variable is set, it is treated as the name of a clearinghouse to contact for this operation. This is the only
clearinghouse that will be contacted in an attempt to complete the operation. These commands do not set the value of this variable after
completion. If the -clearinghouse option is used (as described in some commands below), it overrides the value of _s(cds), but the command
does not change the setting of _s(cds).
ATTRIBUTES
The following are the CDS-defined attributes for CDS directory objects: Indicates the date and time of the last successful skulk on the
directory. All replicas of the directory are guaranteed to receive all updates whose timestamps are less than the value of this attribute.
The value of this attribute is a read-only DTS-style timestamp that is set by the system. Specifies the degree of consistency among repli-
cas. This attribute's value is defined as one of the following: CDS does not immediately propagate an update. The next skulk distributes
all updates that occurred since the previous skulk. Skulks occur at least once every 24 hours. CDS attempts to immediately propagate an
update to all replicas. If the attempt fails, the next scheduled skulk makes the replicas consistent. Skulks occur at least once every 12
hours. CDS attempts to immediately propagate an update to all replicas. If the attempt fails (for example, if one of the replicas is
unavailable), a skulk is scheduled for within one hour. Skulks usually occur at least once every 12 hours. Use this setting temporarily
and briefly, because it uses extensive system resources. By default, every directory inherits the convergence setting of its parent at
creation time. The default setting on the root directory is medium. Specifies the creation timestamp (CTS) of the directory. The value
of this attribute is a read-only DTS-style timestamp that is set by the system. Specifies the current version of the directory. The ver-
sion is derived from the CDS_DirectoryVersion attribute of the clearinghouse in which the directory was created. Multiple directory ver-
sions are supported in a cell. This read-only attribute is set by the system. A Universal Unique Identifier (UUID) that identifies a par-
ticular instance of the directory. This read-only attribute is set by the system. A set-valued attribute that is present only in the root
directory of a cell. This attribute contains location information about registered Global Directory Agents (GDAs) for that cell, similar
to the CDS_Replicas attribute. It is created and only used by a GDA. Indicates whether a directory or any of its descendants can store
clearinghouse names. If this value is true, the directory can store clearinghouse names. If it is false, the directory cannot store
clearinghouse names. This read-only attribute is set by the system. As of DCE Release 1.1 and later, CDS creates this attribute on the
cell root directory and gives it a value of true. The attribute will not appear in any other directory. Records the timestamp of the last
skulk performed on this directory. This read-only attribute is set by the system. Records the timestamp of the most recent change to any
attribute of a directory replica, or any change to an entry in the replica. This read-only attribute is set by the system. Specifies the
unique identifier of the directory. This read-only attribute is set by the system when the directory is created. Contains a pointer to
this directory's parent in the namespace. This read-only attribute is set by the system. Specifies the address, UUID, and name of every
clearinghouse i which a copy of this directory is located. This attribute also specifies whether the replica in a particular clearinghouse
is a master or read-only replica. This read-only attribute is set by the system. Specifies whether a directory replica can be accessed.
The state on indicates that the directory replica can be accessed. This read-only attribute is set by the system. Indicates whether a
directory replica is a master or read-only replica. Possible values are Master and ReadOnly. This read-only attribute is set by the sys-
tem. Specifies the version of a replica of the directory. The default is 3.0. This read-only attribute is set by the system. Specifies
the UUID of a clearinghouse containing another replica of this directory. The CDS_RingPointer attribute appears on older directories, but
not on DCE Release 1.1 and later directories. This read-only attribute is set by the system. A single-valued attribute used to control
the upgrading of a directory from one version of CDS to another. By modifying this attribute, the process of upgrading a directory to a
newer version of CDS may be initiated. After this attribute is set, the background process in CDS notices it and tries to contact each
replica. If CDS can contact the replica, the CDS_DirectoryVersion attribute is changed to the value of this attribute. Specifies the
timestamp of the most recent update to an attribute of the directory. The value of this attribute is a read-only DTS-style timestamp that
is set by the system.
See the OSF DCE Administration Guide for more information about directory attributes.
OPERATIONS
directory add
Creates a child pointer in the parent directory. The syntax is as follows: directory add directory_name_list -member child_pointer_list
-clearinghouse clearinghouse_name
Options
This required option names the child pointers to be added to parent directories in the clearinghouse named by the required -clearinghouse
option. This required option names the clearinghouse to which the child pointers are to be added.
The add operation creates a child pointer in the parent directory. The directory_name_list argument is a list of one or more names of par-
ent directories to have child pointers added to them. The value of the required -member option is a list of names of child pointers to be
added to each directory listed in the argument. Each child pointer name entered should contain only the last relative distinguished name
(RDN) of the name. The child object must exist or the command returns an error. The full name of a clearinghouse that holds a replica of
the child directory is given as the value to the required -clearinghouse option. This option may only have one value and is used for each
value of the -member option. This operation returns an empty string on success. If a child pointer of the same name already exists, an
error is returned.
This command is needed only to recreate a child pointer that was accidentally deleted, such as in a troubleshooting situation. Normally
child pointers are created internally by CDS when creating directories with the directory create command.
Privileges Required
You must have i (insert) permission to the parent directory.
Examples
dcecp> directory add /.: -member foo -clearinghouse /.:/oddball_ch dcecp>
directory create
Creates a new directory of the specified name. The syntax is as follows: directory create directory_name_list
[-attribute attribute_list [-single]] [[-replica] -clearinghouse clearinghouse_name]
Options
Allows you to specify the CDS_Convergence attribute or the CDS_UpgradeTo attribute in an attribute list. The format is as follows:
{{attribute value}...{attribute value}} See ATTRIBUTES for descriptions of the CDS_Convergence and the CDS_UpgradeTo attributes. Valid
only with the -attribute option, this option specifies that attribute values are single-valued. Otherwise, attributes are multi-valued.
This option specifies that the directory created is a replica of an existing directory. If you use the -replica option, you must specify a
clearinghouse by using the -clearinghouse option. Required with the -replica option; optional when the -replica option is not present. The
-clearinghouse option names the clearinghouse to which the child pointers are to be created.
The create operation creates a new directory of the specified name. The directory_name_list argument is a list of names of directories to
be created.
An optional -attribute option specifies a list of attributes to be included in each created directory. The attribute values are multi-val-
ued unless the -single option is specified, in which case all attributes are single-valued. The -single option is valid only if the
-attribute option is specified.
The -clearinghouse option specifies one clearinghouse to create all the directories in. If this option is not specified, the new directo-
ries are created in the master clearinghouse as the parent directory. The directory create command also takes a -replica option, which
indicates that a directory replica is created; when this option is used, the -clearinghouse option is required. When using the -replica
option to replicate directories, all directories that are children of the directory being replicated are not themselves replicated also.
You must use separate commands to replicate these child directories.
This operation returns an empty string on success.
Privileges Required
You must have the following permissions to create a directory: r (read) and i (insert) permission to the parent directory, and w (write)
permission to the clearinghouse in which the master replica of the new directory is to be stored.
In addition, the server principal (hosts/hostname/cds-server) must have r (read) and i (insert) permission to the parent directory.
Examples
dcecp> directory create /.:/sales dcecp>
directory delete
Deletes a directory. The syntax is as follows: directory delete directory_name_list [[-tree] [-force] | -replica -clearinghouse clearing-
house_name]
Options
Removes the directory and everything (all directories, objects, links, and clearinghouses) beneath it. Specifies that the directory to
delete is a replica of an existing directory. The -clearinghouse option is required if you use this option. Allows the delete operation to
proceed by deleting existing replicas. Required with the -replica option, the -clearinghouse option names the single clearinghouse from
which the replica is to be deleted.
The delete operation deletes a directory from the CDS name service. The directory_name_list argument is a list of names of directories to
be deleted. If the directory is not empty, the command returns an error unless the -tree option is used. The -tree option, which takes no
value, removes the directory and everything (all directories, objects, links, and clearinghouses) beneath it. The -force option also
deletes replicas.
Used together, the -replica and -clearinghouse options let you delete a replica instead of a directory. The -clearinghouse option speci-
fies the clearinghouse that contains the replica; only one value can be specified, not a list. This operation returns an empty string on
success. If a specified directory does not exist, an error is generated.
The -replica and -clearinghouse options cannot be used with the -tree option.
Privileges Required
You must have d (delete) permission to the directory and w (write) permission to the clearinghouse that stores the master replica of the
directory. The server principal (hosts/hostname/cds-server) needs A (Admin) permission to the parent directory or d (delete) permission to
the child pointer that points to the directory you intend to delete.
Examples
dcecp> directory delete /.:/eng dcecp>
The following command tries to delete a nonempty directory /.:/depts/phrenology and gets an error. The second attempt uses the -tree
option to delete the directory and all the directories and objects beneath it. dcecp> dir delete /.:/depts/phrenology Error: Directory
must be empty to be deleted dcecp>
dcecp> dir delete /.:/depts/phrenology -tree dcecp>
directory help
Returns help information about the directory object and its operations. The syntax is as follows: directory help [operation | -verbose]
Options Displays information about the directory object.
Used without an argument or option, the directory help command returns brief information about each directory operation. The optional
operation argument is the name of an operation about which you want detailed information. Alternatively, you can use the -verbose option
to display detailed information about the directory object itself.
Privileges Required
No special privileges are needed to use the directory help command.
Examples
dcecp> directory help add Creates a child pointer in the specified directory. create Creates the named direc-
tory. delete Deletes the named directory. list Lists the descendants of a directory. merge
Merges the contents of one directory into another. modify Adds, removes or changes attributes in the named directory. remove
Removes a child pointer in the specified directory. show Returns the attributes of a directory. synchronize Skulks
the named directory. help Prints a summary of command-line options. operations Returns a list of the valid opera-
tions for this command. dcecp>
directory list
Returns a list of the names of all the descendants of a directory. The syntax is as follows: directory list directory_name_list [-directo-
ries] [-objects] [-links] [-simplename]
Options
Lists the names of all descendent directories. Lists the names of all descendent objects. Lists the names of all descendent softlinks.
Returns just the RDN of the name.
The list operation returns a list of the names of all the descendents of a directory. Descendants can include all directories, objects,
links, and clearinghouses. The directory_name_list argument is a list of names of directories to be operated on. This command returns
only the names of descendents, so there is no way to tell the class of each name unless by convention (for instance, clearinghouses end
with _ch). Use the following options to specify the types of descendents to return: -directories, -objects, -links. The options take no
values and can be used in combination. By default, fullnames are returned. Use the -simplename option to return merely the last RDN of
the name.
Privileges Required
You must have r (read) permission to the directory named in the argument.
Examples
dcecp> dir list /.:/depts/administration -links /.../ward_cell.osf.org/depts/administration/bump_server1 dcecp>
directory merge
Copies the contents of one directory into another directory. The syntax is as follows: directory merge source_directory_name -into desti-
nation_directory_name [-clearinghouse clearinghouse_name] [-tree] [-nocheck]
Options
Copies the contents of child directories (as well as the child directories themselves) into the destination directory. The argument to
this required option specifies the name of the destination directory. The destination directory must exist. Places the new objects (the
resulting merged directory) in a clearinghouse other than that of the newly created destination directory. Lets the merge operation pro-
ceed without first checking for object name collisions or access control list (ACL) problems. Use this option to save time when you are
sure problems do not exist.
The merge operation copies the contents of one directory into another. The argument is the name of the source directory. This command
takes a required -into option to specify the destination directory, which must exist. For example, if /.:/a has two child objects /.:/a/b
and /.:/a/c, then directory merge /.:/a -into /.:/x would result (assuming no errors) in the creation of the following objects: /.:/x/b and
/.:/x/c.
Normally only the immediate contents of the directory are merged. These contents include all objects, links, and directories, but not the
contents of child directories. To merge these as well, use the -tree option.
By default, the new objects are placed in the destination directory's master clearinghouse, and all children (no matter how many levels
down) are placed in the same clearinghouse. To place any newly created descendent directories in another clearinghouse, use the
-clearinghouse option with a value. Only one clearinghouse can be specified for all directories involved in the merge operation.
This command first checks for any collisions or ACL problems before beginning to merge any objects. If problems are encountered, an error
is generated after all objects are checked, and the names of all problem objects, links, or directories are returned in a list. The admin-
istrator should then address these problems and rerun the merge command. If the -nocheck option is specified, the check is not performed.
This way time can be saved when trying a known nonproblematic merge. This is not an atomic operation and other changes to the involved
objects can cause problems. This command should be issued when others are not modifying the involved directories. ACLs can be changed to
ensure that no other principal has the modify permissions to the directories. If an error occurs during the actual merging process, it is
generated and the operation ceases immediately.
The merge command actually re-creates the objects with the same writable attributes of the source objects. As a result, some read-only
attributes will change between the source and destination. For example, the creation timestamp attribute (CDS_CTS) changes.
The resulting merged directory inherits its ACLs from the destination directory's Initial Container or Initial Object ACLs. Consequently,
the ACLs of the destination objects are likely to differ from the ACLs of the source objects. This operation returns an empty string on
success.
Privileges Required
You must have r (read) to the source and destination directories and i (insert) permission to the destination directory.
Examples
The following command merges the directories but not the contents of the /.:/depts/phrenology directory into the /.:/depts/radiology direc-
tory: dcecp> dir list /.:/depts/phrenology -simple applications services staff users dcecp>
dcecp> directory merge /.:/depts/phrenology -into /.:/depts/radiology dcecp>
dcecp> dir list /.:/depts/radiology -simple applications services staff users dcecp>
directory modify
Adds, removes, or changes a directory's attributes and their values. The syntax is as follows: directory modify directory_name_list {-add
attribute_list [-single] | -remove attribute_list [-types] | -change attribute_list | -master clearinghouse_name [-readonly clearing-
house_name_list] [-exclude clearinghouse_name_list]}
Options
This option adds a value to a modifiable, set-valued attribute (including application-defined attributes) of a directory. If you enter a
byte data type, you must enter an even number of digits. You can only enter pairs of hexadecimal values for user-defined attributes. Used
with the -add option, this option specifies that the attributes to be added are to be single-valued. By default, all user defined
attributes are defined to be multi-valued, even if only one value is specified. This option is not legal without the -add option. This
option removes a value from a multi-valued or single-valued attribute (including application-defined attributes) of a directory. If you do
not specify a value, the command removes the entire attribute. This command can delete attributes created with the -add and -change
options. Used with the -remove option, this option specifies that the value of the -remove option is a list of attribute types. Use this
option to remove the entire attribute, not just a value. This option is not legal without the -remove option. This option changes the
value of a modifiable, single-valued attribute of a directory. You can specify an application-defined attribute or the following
attribute, which specifies the degree of consistency among replicas: {CDS_Convergence value} See ATTRIBUTES for the format of CDS_Conver-
gence. When changing the epoch of a directory, use the -master option to specify a new master clearinghouse for the directory. When
changing the epoch of a directory, this option specifies which clearinghouses will hold a replica of the directory. When changing the
epoch of a directory, the option specifies which clearinghouses will no longer be used as replicas for the directory.
The modify operation adds, removes, or changes a directory's attributes and their values. The argument is a list of one or more names of
directories to be operated on. Attribute options are not supported; use one or more of the -add, -remove, or -change options, each of
which takes an attribute list as an argument.
Use the -remove option to remove a value from an attribute. You can use the -types option along with the -remove option to remove an
entire attribute or list of attributes.
Some attributes in CDS are multi-valued. For instance, the CDS_Replicas attribute can specify the locations and names of several clearing-
houses that maintain copies of a directory. The -add operation requires an indication of whether it will operate on single-valued or
multi-valued attributes. Multi-valued attributes are the default case and are indicated by using no qualifying options. However, you can
indicate the use of single-valued attributes by using the -single option.
To change the epoch of a directory, you must specify each clearinghouse that has a master or replica copy of the directory as either the
new master (with the -master option), a readonly copy (with the -readonly option), or an excluded copy (with the -exclude option). Addi-
tional extra clearinghouses can also be specified.
Most attributes are usually managed by the client application. All modifications are made to each directory listed in the argument. An
error in any one causes the command to cease immediately and generate an error. This operation returns an empty string on success.
Privileges Required
You must have w (write) permission to the directory to add, remove, or change attributes.
Examples
The following command sets the CDS_Convergence attribute on the /.:/depts/radiology directory to a value of low: dcecp> directory modify
/.:/depts/radiology -change {CDS_Convergence low} dcecp>
To add the value ontario to the attribute myname of a directory named /.:/sales, read the cds_attributes file to verify that the attribute
shown in the following display exists:
OID LABEL SYNTAX 1.3.22.1.3.91 myname char
Enter the following command to assign the value ontario to the attribute myname: dcecp> directory modify /.:/sales -add {myname ontario}
dcecp>
To remove the value 1 from the user-defined, set-valued attribute dirregion of a directory named /.:/sales, follow these steps: Read the
cds_attributes file to verify that the attribute dirregion is listed, as shown in the following display:
OID LABEL SYNTAX 1.3.22.1.3.66 dirregion small Enter the following command to remove the value 1 from the
attribute dirregion: dcecp> directory modify /.:/sales -remove {dirregion 1} dcecp>
To change the epoch of a directory with one master and two replicas, enter the following command: dcecp> directory modify /.:/oddball -mas-
ter /.:/gumby_ch > -readonly /.:/pokey_ch -exclude /.:/goober_ch dcecp>
directory operations
Returns a list of the operations supported by the directory object. The syntax is as follows: directory operations
The list of available operations is in alphabetical order except for help and operations, which are listed last.
Privileges Required
No special privileges are needed to use the directory operations command.
Examples
dcecp> directory operations add create delete list merge modify remove show synchronize help operations dcecp>
directory remove
Deletes a child pointer from the directories specified. The syntax is as follows: directory remove directory_name_list -member
child_pointer_list
Options
This required option names the child pointers to be removed from each directory in the operation argument.
The remove operation deletes a child pointer from the directories specified. The directory_name_list argument is a list of names of one or
more directories to be operated on. The required -member option allows you to list the child pointers to be removed from each specified
directory.
The child_pointer_list argument value of the required -member option is a list of one or more child pointers (specified as only one RDN
each) to be removed from each directory in the argument.
This command is needed only to delete a child pointer that remains after the child directory is deleted. Normally child pointers are
removed internally by CDS when deleting directories with the directory delete command. This operation returns an empty string on success.
Privileges Required
You must have d (delete) permission to the child pointer or A (Admin) permission to the parent directory.
Examples
The following command deletes the child pointer that accidentally remains after the /.:/sales/east directory is deleted: dcecp> directory
remove /.:/sales -member east dcecp>
directory show
Returns a list of attributes for the specified directories and, optionally, their specified contents. The syntax is as follows: directory
show directory_name_list [-schema] [-member child_pointer_list | [-replica] -clearinghouse clearinghouse_name]
Options
The -member option takes one required value which is the last RDN of the child pointer in the directory specified by the argument. The
returned list describes the child pointer information for the specified member stored in the specified directories. This option cannot be
combined with the -replica or -clearinghouse option. Specifies that the directory shown is a replica of an existing directory. If you use
the -replica option, you must specify a clearinghouse with the -clearinghouse option. Required with the -replica option, the
-clearinghouse option names the clearinghouse in which the named replica exists. This option returns whether an attribute is single-valued
or multi-valued. This attribute is specific to a directory, meaning that the same attribute can be single-valued on one directory and
multi-valued on another. This option may not be used with other options.
The show operation returns a list of attributes for the specified directories and, optionally, their specified contents. The direc-
tory_name_list argument is a list of names of directories to be operated on. When used without any options, this command returns the
attributes associated with the named directories. If more than one directory is specified, then all the arguments are grouped together in
one list. The order of the returned arguments is the lexical order of the object identifiers (OIDs) of each attribute for each directory.
You can request attributes of specific replicas in specific clearinghouses by using the -replica and -clearinghouse options. Alterna-
tively, you can request attributes of child pointers by using the -member option.
Privileges Required
You must have r (read) permission to the directories named in the argument list.
Examples
dcecp> directory show /.:/depts/radiology {RPC_ClassVersion
{01 00}} {CDS_CTS 1994-07-08-17:01:03.115+00:00I0.000/00-00-c0-8a-df-56} {CDS_UTS 1994-07-08-19:36:31.719+00:00I0.000/00-00-c0-8a-df-56}
{CDS_ObjectUUID 2df03af4-9a76-11cd-8f2b-0000c08adf56} {CDS_Replicas
{{CH_UUID b32648c6-928d-11cd-b4b5-0000c08adf56}
{CH_Name /.../ward_cell.osf.org/pmin17_ch}
{Replica_Type Master}
{Tower ncacn_ip_tcp:130.105.1.227[]}
{Tower ncadg_ip_udp:130.105.1.227[]}}} {CDS_AllUpTo 1994-07-08-17:01:05.945+00:00I0.000/00-00-c0-8a-df-56} {CDS_Convergence medium}
{CDS_ParentPointer
{{Parent_UUID 8eeb369a-9a4b-11cd-8f2b-0000c08adf56}
{Timeout
{expiration 1994-07-09-17:13:31.959}
{extension +1-00:00:00.000I0.000}}
{myname /.../ward_cell.osf.org/depts/radiology}}} {CDS_DirectoryVersion 3.0} {CDS_ReplicaState on} {CDS_ReplicaType Master} {CDS_Last-
Skulk 1994-07-08-17:01:05.945+00:00I0.000/00-00-c0-8a-df-56} {CDS_LastUpdate 1994-07-08-19:36:31.719+00:00I0.000/00-00-c0-8a-df-56}
{CDS_RingPointer b32648c6-928d-11cd-b4b5-0000c08adf56} {CDS_Epoch 2f617aa6-9a76-11cd-8f2b-0000c08adf56} {CDS_ReplicaVersion 3.0} dcecp>
dcecp> directory show /.:/depts/radiology -schema {RPC_ClassVersion multi} {CDS_CTS single} {CDS_UTS single} {CDS_ObjectUUID single}
{CDS_Replicas multi} {CDS_AllUpTo single} {CDS_Convergence single} {CDS_ParentPointer multi} {CDS_DirectoryVersion single} {CDS_ReplicaS-
tate single} {CDS_ReplicaType single} {CDS_LastSkulk single} {CDS_LastUpdate single} {CDS_RingPointer single} {CDS_Epoch single}
{CDS_ReplicaVersion single} dcecp>
directory synchronize
Initiates an immediate skulk of the directories specified. The syntax is as follows: directory synchronize directory_name_list
The synchronize operation initiates an immediate skulk of the directories specified. The directory_name_list argument is a list of names
of one or more directories to be operated on. Skulks begin immediately in sequence. The command does not return until all skulks com-
plete. This operation returns an empty string on success.
Privileges Required
You must have A (Admin), w (write), i (insert), and d (delete) permission to the directory. The server principal (hosts/hostname/cds-
server) needs A (Admin), r (read), and w (write) permission to the directory.
Examples
The following command begins a skulk on the /.:/admin directory: dcecp> directory synchronize /.:/admin dcecp>
RELATED INFORMATION
Commands: dcecp(1m), dcecp_clearinghouse(1m), dcecp_link(1m), dcecp_object(1m).
directory(1m)