5 — Command Reference Pages

[Previous] [Contents]

This chapter provides revised reference pages necessary for using Gradient DCE for Tru64 UNIX.

cdscache( 8dce)

Name

cdscache -A dcecp object for managing a local CDS cache

Synopsis

cdscache create server_name -binding server_binding
cdscache delete server_name
cdscache discard [-entry entry_name] [-replica replica_name]
cdscache dump
cdscache help [operation | -verbose]
cdscache operations
cdscache show server_name {-server | -clearinghouse}

Arguments

operation

The name of the cdscache operation that displays help information.

server_name

The single simple name of the cached server machine. A "simple name' is not a cell-relative name (such as /.:/hosts/pelican). Some examples of simple names are pelican and hosts/pelican.

option

A specification to clarify the target of the operation (-entry, -replica).

Description

The cdscache object represents the Cell Directory Service (CDS) cache on the local node. The CDS cache contains information about servers and clearinghouses known to the local machine, and also contains user data about CDS entries that have been read. The create and delete operations apply only to the server information. The show and dump operations can display additional information. The discard operation can selectively eliminate cache entries on any client (given the appropriate permissions).

Errors

A representative list of errors that might be returned is not shown here. Refer to the DCE Problem Determination Guide for complete descriptions of all error messages.

Operations

cdscache create

Creates knowledge of a server in the local client's cache. The syntax is:

cdscache create server_name -binding server_binding

Options

-binding server_binding

The required -binding option lets you specify the binding information for a CDS server. This option takes a server_binding argument, which is the protocol sequence and network address of the server node. The string format is as follows:

protocol-sequence:network-address

The dcecp format is as follows:

{protocol-sequence network-address}

A protocol-sequence is a character string identifying the network protocols used to establish a relationship between a client and server. Protocol sequences have a specific format that depends on the network address that is supplied in the binding; for example ncacn_ip_tcp (for connection-based protocol) or ncadg_ip_udp (for datagram protocol) The network-address is a string representing the network address of the server node.

The create operation creates knowledge of a server in the local client's cache. The server_name argument is the simple name of a cached server. (An example of a simple name would be pelican, as opposed to a cell-relative name like /.:/hosts/pelican.) This command is typically used to provide configuration information manually to a client that cannot configure itself automatically. Providing configuration information manually may be necessary, for instance, to provide the client with addressing information about a server across a WAN. Once the client knows about one server, it can find other servers through referrals. This operation returns an empty string on success.

Privileges Required

You must have w (write) permission to the client system, /.:/hosts/hostname/cds-clerk.

Examples

The following command creates knowledge of the server pelican in the localclient's cache: 

dcecp> cdscache create pelican -binding ncacn_ip_tcp:16.20.15.25 
dcecp>

cdscache delete

Removes knowledge of a server that you had specifically created from the local client's cache. The syntax is:

cdscache delete server_name

The delete operation removes knowledge of a server that was specifically created from the local client's cache. The required server_name argument is the simple name of a cached server. (An example of a simple name would be pelican,as opposed to a cell-relative name like /.:/hosts/pelican.) You can delete only servers that you have specifically created with the cdscache create command. This operation returns an empty string on success.

Privileges Required

You must have w (write) permission to the client system, /.:/hosts/hostname/cds-clerk.

Examples

The following command removes knowledge of the server gumby from the client cache: 

dcecp> cdscache delete gumby 
dcecp>

cdscache discard

Discards the contents of the client cache. The syntax is:

cdscache discard [-entry entry_name] [-replica replica_name]

Options

-entry entry_name

Specifies the name of an entry in the clerk cache.

-replica replica_name

Specifies the clearinghouse name of a replica pointer.

Description

The cdscache discard operation eliminates data structures, frees memory, and shrinks the size of the client cache on the host specified by host_name. If host_name is not specified, the operation defaults to the cache that resides on the local host. Only a single host name can be specified. If both -entry and -replica options are specified, the command removes the specified replica pointer from a cached directory entry.

If a clearinghouse becomes unreachable, attempting to contact it to look up a replica pointer can result in a very time-consuming failure. If you use the option -replica, all replicas referencing the clearinghouse are removed from all cache directory entries. In this way, all references to an unreachable clearinghouse can be removed. If successful, this operation returns a null string.

The operation, cdscache discard with the options -entry or -replica, does the following:

Privileges Required

If it is a local operation you must have superuser (root) privileges on the client system. No DCE permissions are required.

If it is a remote operation you must have permissions on the srvrconf directory of the selected host:

Examples

The following command discards the entry, job_300 at the clearinghouse named gloria_ch from the client cache on the local host: 

dcecp> cdscache discard -entry /.:/ job_300 -replica /.:/gloria_ch
dcecp>

cdscache dump

Displays the entire contents of the client cache. The syntax is:

cdscache dump

The cdscache dump operation displays the contents of the client cache on the screen. Use this command when solving CDS problems.

Privileges Required

You must have superuser (root) privileges on the client system. No DCE permissions are required.

Examples

The following command displays the contents of the client cache on the screen (the output is not shown in the example): 

dcecp> > cdscache dump
dcecp> >

cdscache help

Returns help information about the cdscache object and its operations. The syntax is:

cdscache help [operation | -verbose]

Options

-verbose

Displays information about the cdscache object.

Description

Used without an argument or option, the cdscache help command returns brief information about each cdscache operation. The optional operation argument is the name of an operation about which you want detailed information. Alternatively, you can use the -verbose option for more detailed information about the cdscache object itself.

Privileges Required

No special privileges are needed to use the cdscache help command.

Examples 

dcecp> cdscache help 
create     Adds information about named server in local cds cache. 
delete     Removes information about named server in local cds cache. 
discard    Discards all cdsadv (CDS advertiser) cache information on the specified host. 
dump       Dumps all information from local cds cache. 
show       Shows information stored in cds cache. 
help       Prints a summary of command-line options. 
operations Returns a list of valid operations for this command. 
dcecp>

cdscache operations

Returns a list of the operations supported by the cdscache object. The syntax is as follows:

cdscache 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 cdscache operations command.

Examples 

dcecp> cdscache operations 
create delete discard dump show help operations 
dcecp>

cdscache show

Returns information about clearinghouses or servers stored in the cache. The syntax is as follows:

cdscache show server_name {-server | -clearinghouse}

Options

-clearinghouse

This option displays all the names and values of the attributes in the specified cached clearinghouse. The following are valid attributes:

-server

This option displays address information of a server in the local client's cache. The following attributes are valid:

The show operation displays information about clearinghouses or servers stored in the cache. The required server_name argument is the simple name of a server or a CDS name of a clearinghouse for which you want to display information. You must use one of the -clearinghouse or -server options to select the information you want to display.

Privileges Required

You must have r (read) permission to the CDS client.

Examples

The following command displays all attributes of the cached clearinghouse /.:/claire_ch: 

dcecp> cdscache show /.:/claire_ch -clearinghouse 
{CH_Name /.../blue.cell.osf.org/claire_ch} 
{Created 1994-10-07-11:41:23.131} 
{Others 458} 
{Reads 150221} 
{Tower {ncacn_ip_tcp 130.105.4.158}} 
{Tower {ncadg_ip_udp 130.105.4.158}} 
{Writes 162} 
dcecp>

The following command displays all attributes of the cached server mysystem: 

dcecp> cdscache show mysystem -server 
{CH_Name /.../terrapin_cell.osf.org/mysystem_ch} 
{Tower {ncacn_ip_tcp 130.105.5.16}} 
{Tower {ncadg_ip_udp 130.105.5.16}}

Related Information

Commands: clearinghouse(8dce), dcecp(8dce), directory(8dce), link(8dce),
object(8dce). define_cached-server(8cds). dump-clerk_cache(8cds).
show_cached-clearinghouse(8cds). show_cached-server(8cds).

clearinghouse( 8dce)

Name

clearinghouse -A dcecp object that manages a clearinghouse in CDS

Synopsis

clearinghouse catalog [cell_name] [-simplename]

clearinghouse create clearinghouse_name_list

clearinghouse delete clearinghouse_name_list

clearinghouse disable clearinghouse_name_list

clearinghouse initiate clearinghouse_name_list -checkpoint

clearinghouse help [operation | -verbose]

clearinghouse modify object_name_list {[-add attribute_list [-single]] [-remove attribute_list [-types]] -change attribute_list}

clearinghouse operations

clearinghouse repair clearinghouse_name_list -timestamps

clearinghouse show clearinghouse_name_list [-counters | -attributes | -all] [-schema]

clearinghouse verify clearinghouse_name_list

Arguments

cell_name

This optional argument is the name of a single cell. The name must be a fully qualified cell name as shown in the following:

/.../their_cell.goodco.com

clearinghouse_name_list

A list of one or more names of clearinghouses on which to operate.

operation

The name of one specific clearinghouse operation (subcommand) about which you want to see help information.

Description

The clearinghouse object represents Cell Directory Service (CDS) clearinghouses. Clearinghouses are databases located on CDS server machines that store data (directories, objects, and links) in CDS. On the server machines are files that contain the actual clearinghouse data. Clearinghouses are also represented in the CDS namespace by an entry that contains information about the clearinghouse.

You must run the create command on the host where you want to create the new clearinghouse and the delete, disable, initiate, repair, and verify commands on the host where the clearinghouse to be operated on resides.

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.

Attributes

The following are the CDS-defined attributes that may be present in CDS clearinghouse objects:

CDS_AllUpTo

Indicates the date and time the clearinghouse object has been updated to reflect the CDS_CHDirectories attribute.

CDS_CHDirectories

Specifies the full name and Universal Unique Identifier (UUID) of every directory that has a replica in this clearinghouse.

CDS_CHLastAddress

Specifies the current reported network address of the clearinghouse.

CDS_CHName

Specifies the full name of the clearinghouse.

CDS_CHState

Specifies the state of the clearinghouse. The state on indicates the clearinghouse is running and available.

CDS_CTS

Specifies the creation timestamp (CTS) of the clearinghouse.

CDS_DirectoryVersion

Specifies the current version of the directory in the clearinghouse in which the directory was created.

CDS_NSCellname

Specifies the name of the cell in which the clearinghouse resides.

CDS_ObjectUUID

Specifies the UUID of the clearinghouse. This read-only attribute is set by the system when the clearinghouse object is created.

CDS_ReplicaVersion

Specifies the current version of the replica in which the directory was created.

CDS_UpgradeTo

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.

CDS_UTS

Specifies the timestamp of the most recent update to an attribute of the clearinghouse.

Counters

The clearinghouse counters are as follows:

badchs

Specifies the number of times the clearinghouse entry missing event was generated.

baddata

Specifies the number of times that the data corruption event was generated.

badskulks

Specifies the number of times that a skulk of a directory, initiated from this clearinghouse, failed to complete—usually because one of the replicas in the replica set was unreachable.

badupgrades

Specifies the number of times that upgrades failed.

disables

Specifies the number of times that the clearinghouse was disabled since it was last started.

enables

Specifies the number of times that the clearinghouse was enabled since it was last started.

partials

Specifies the number of requests directed to this clearinghouse that resulted in the return of a partial answer instead of satisfying the client's request.

reads

Specifies the number of read operations directed to this clearinghouse.

rootlosts

Specifies the number of times the root lost event was generated.

writes

Specifies the number of write operations directed to this clearinghouse.

See the OSF DCE Administration Guide for more information about attributes and counters.

Operations

clearinghouse catalog

Returns a list of the names of all clearinghouses in a cell. The syntax is as follows:

clearinghouse catalog [cell_name] [-simplename]

The clearinghouse catalog command returns a list of the names of all clearinghouses in a cell. If you do not specify the optional argument, the cell name defaults to /.:.

Privileges Required

No special privileges are needed to use the clearinghouse catalog command.

Examples 

dcecp> clearinghouse catalog 
/.../dcecp.cell.osf.org/frick_ch
dcecp> clearinghouse catalog -simplename 
frick_ch

clearinghouse create

Creates a new clearinghouse on the local machine. The syntax is as follows:

clearinghouse create clearinghouse_name_list

The clearinghouse create operation creates a new clearinghouse on the local machine. The clearinghouse_name argument is a list of one or more names of the clearinghouses you want to create. Clearinghouses should only be named in the root directory—that is, /.:. This operation also stores a read-only replica of the root directory in the new clearinghouse. The process that creates the new clearinghouse initiates a skulk of the root directory, so all replicas of the root should be reachable when you enter the clearinghouse create command. To ensure this, perform an immediate skulk of /.: prior to invoking the command, using the directory synchronize /.: command. The operation returns an empty string on success.

Privileges Required

You need w (write) permission to the server on which you intend to create the clearinghouse and A (Admin) permission to the cell root directory. The server principal needs r (read), w (write), and A (Admin) permission to the cell root directory.

Examples

The following command creates a clearinghouse named /.:/Boston_CH on the local server system: 

dcecp > clearinghouse create /.:/Boston_CH

clearinghouse delete

Deletes the specified clearinghouse from the local machine. The syntax is as follows:

clearinghouse delete clearinghouse_name_list

The clearinghouse delete operation deletes the specified clearinghouse from the local server system. The clearinghouse_name_list argument is a list of one or more names of the clearinghouses you want to delete. Clearinghouses that contain master replicas of directories are not deleted (and also return errors). This command also automatically deletes all read-only replicas from the clearinghouse; however, you should delete all read-only replicas by hand (see directory delete -replica) before invoking this command since invoking many skulks will cause the command to execute more slowly. The command returns an empty string on success.

CDS does not permit you to delete a disabled (cleared) clearinghouse. Before you can delete a disabled (cleared) clearinghouse, you must recreate it using the clearinghouse create command.

Privileges Required

You must have w (write) and d (delete) permission to the clearinghouse and A (Admin) permission to all directories that store replicas in the clearinghouse. The server principal must have d (delete) permission to the associated clearinghouse object entry and A (Admin) permission to all directories that store replicas in the clearinghouse.

Examples

The following command deletes a clearinghouse named /.:/Orion_CH from the local server system: 

dcecp > clearinghouse delete /.:/Orion_CH

clearinghouse disable

Removes knowledge of the specified clearinghouse from the local server's memory. The syntax is as follows:

clearinghouse disable clearinghouse_name_list

The clearinghouse disable operation removes knowledge of the specified clearinghouse from the local server's memory. The clearinghouse_name_list argument is a list of names of one or more clearinghouses you want to disable. Use this command when relocating a clearinghouse. This command removes the name of the prefix of the clearinghouse files from the /opt/dcelocal/var/directory/cds/cds_files file and notifies the local CDS server that the clearinghouse is disabled. The clearinghouse entry is not removed from the namespace, nor are the datafiles associated with the clearinghouse removed. The operation returns an empty string on success.

Privileges Required

You must have w (write) permission to the CDS server on which the clearinghouse resides.

Examples

The following command disables the clearinghouse /.:/Paris2_CH so that it can be moved to another server: 

dcecp > clearinghouse disable /.:/Paris2_CH

clearinghouse help

Returns help information about the clearinghouse object and its operations. The syntax is as follows:

clearinghouse help [operation | -verbose]

Options

-verbose

Displays information about the clearinghouse object.

Used without an argument or option, the clearinghouse help command returns brief information about each clearinghouse operation.

The optional operation argument is the name of an operation about which you want detailed information.

Alternatively, you can use the -verbose option for more detailed information about the clearinghouse object itself.

Privileges Required

No special privileges are needed to use the clearinghouse help command.

Examples 

dcecp>clearinghouse help 
catalog             Returns the names of all clearinghouses in a cell.
create              Creates the named clearinghouse.
delete              Deletes the named clearinghouse.
disable             Disables the named clearinghouse.
initiate            Initiates an action on the named CDS clearinghouse.
modify              Add, remove or change an attribute in the named 
                      clearinghouse.
repair              Repairs an aspect of the named CDS clearinghouse.
show                Returns the attributes of a clearinghouse.
verify              Verifies the consistency of the clearinghouse.
help                Prints a summary of command-line options.
operations          Returns a list of the valid operations for this command.

clearinghouse initiate

Initiates a defined action on the specified clearinghouse on the local machine. The syntax is

clearinghouse initiate clearinghouse_name_list -checkpoint

Options

-checkpoint

Forces the clearinghouse to checkpoint to disk.

The clearinghouse initiate operation initiates a defined action on the specified clearinghouse. The required clearinghouse_name_list argument is a list of one or more names of clearinghouses you want to initiate actions on. Currently, only a checkpoint action is available. This operation returns an empty string on success.

Privileges Required

You need write permission on the clearinghouse server and administer permission on the cell root directory. The server principal needs read, write, and administer permission on the cell root directory.

Examples

The following command initiates a checkpoint operation on the clearinghouse named /.:/oddball_ch on the local system. 

dcecp > clearinghouse initiate /.:/oddball_ch -checkpoint

clearinghouse modify

Adds or removes attributes or changes attribute values for clearinghouse entries in the Cell Directory Service. This task is usually done through a client application.

The syntax is as follows:

clearinghouse modify object_name_list {[-add attribute_list [-single]]
[-remove attribute_list [-types]] -change attribute_list}
Options

-add

Adds one or more new attributes to an clearinghouse entry.

-single

Optionally used with the -add option to specify that the attribute is single-valued.

-remove

Removes one or more attribute values from an attribute type of a clearinghouse entry. For instance, removing a value from an attri-bute with three values leaves the attribute with two values.

{{attribute_name attribute_value}... \\ {attribute_name attribute_value}}

To remove an attribute type as well as its values, use the -types option with the -remove option. For example:

clearinghouse modify /.:/foo \
-remove {RPC_CLASS RPC_CLASS_VERSION} \
-types

If an attribute is not present, an error is returned. Fixed CDS attribute types, such as the CDS creation Timestamp (CDS_CTS), cannot be removed.

-types

Can be used with the -remove option to remove the attribute type as well as its values. This option is invalid without the -remove option.

-change

Changes one attribute value to another for a clearinghouse entry. The value of this option is an attribute list. The existing value of each attribute named in the list is replaced by the new value given for each attribute attribute in the list. For multivalued attributes, all existing values are replaced by all the values listed for the attribute in the attribute list. If an attribute or value is not present, an error is returned.

The clearinghouse modify operation adds or removes attributes or changes attribute values for clearinghouse entries in the Cell Directory Service. This task is usually done through a client application. The required clearinghouse_name argument is the full CDS name of the clearinghouse entry to be modified.

Privilege Required

You must have w (write) permission to the clearinghouse entry.

Examples

To change the value of the sales_record attribute to region2 of an clearinghouse entry named /.:/Q1_records, follow these steps:

  1. Read the cds_attributes file to check that the attribute sales_record is listed, as shown in the following display:

    OID LABEL SYNTAX
    1.3.22.1.3.66

    		sales_record

    		char

  2. Enter the following command to assign the value region2 to the attributesales_record of an clearinghouse entry named /.:/Q1_records.

    dcecp > clearinghouse modify /.:/Q1_records -add {sales_record region2} dcecp >

clearinghouse operations

Returns a list of the operations supported by the clearinghouse object. The syntax is as follows:

clearinghouse operations

The clearinghouse operations command takes no arguments and returns a list of the available operations for the clearinghouse object. The order of the elements is alphabetical with the exception that help and operations are listed last.

Privileges Required

No special privileges are needed to use the clearinghouse operations command.

Examples 

dcecp> clearinghouse operations 
catalog create delete disable initiate modify repair show verify help operations

clearinghouse repair

Repairs a specific problem on a specified clearinghouse on the local machine. The syntax is:

clearinghouse repair clearinghouse_name_list -timestamps

Options

-timestamps

Analyzes and repairs invalid timestamps found in a clearinghouse.

Use the clearinghouse repair operation to fix various problems that can occur in a clearinghouse. The required clearinghouse_name_list argument is a list of one or more names of clearinghouses you want to initiate repair actions on. Currently, only invalid timestamps can be repaired. This operation returns an empty string on success.

Privileges Required

You need write permission on the clearinghouse server and administer permission

on the cell root directory. The server principal needs read, write, and administer

permission on the cell root directory.

Examples

The following command repairs invalid timestamps in a clearinghouse named /.:/blech_ch on the local system. 

dcecp > clearinghouse repair /.:/blech_ch -timestamps

clearinghouse show

Displays attribute and counter information associated with specified clearinghouses on local or remote machines. The syntax is as follows:

clearinghouse show clearinghouse_name_list [-counters | -attributes | -all][-schema]

Options

-attributes

Returns the attributes for the clearinghouse (default).

-counters

Returns the counters for the clearinghouse.

-schema

Indicates whether attributes are singlevalued or multivalued.

The clearinghouse show operation displays attribute and counter information associated with the clearinghouses specified by clearinghouse_name_list, which is a list of one or more names of the clearinghouses. If more than one clearinghouse is specified, the attributes of all the clearinghouses are concatenated into one list. The order of the returned attributes is the lexical order of the object identifiers (OIDs) of each attribute for each clearinghouse.

If you supply no options, clearinghouse show returns the attributes associated with the specified clearinghouse.

Privileges Required

You must have r (read) permission to the clearinghouse. If you specify a wildcard clearinghouse name, you also need r (read) permission to the cell root directory.

Examples

The following command displays the attributes of the clearinghouse /.:/drkstr_ch. 

dcecp> clearinghouse show /.:/drkstr_ch 
{CDS_CTS 1994-06-18-20:16:22.150-05:00I0.000/00-00-c0-f7-de-56}
{CDS_UTS 1994-06-19-17:17:43.911-05:00I0.000/00-00-c0-f7-de-56}
{CDS_ObjectUUID 0066ccea-d978-1db3-8259-0000c0f7de56}
{CDS_AllUpTo 1994-07-01-21:30:18.948-05:00I0.000/00-00-c0-f7-de-56}
{CDS_DirectoryVersion 3.0}
{CDS_CHName /.../terrapin/drkstr_ch}
{CDS_CHLastAddress 
 {Tower ncacn_ip_tcp 130.105.5.16}
 {Tower ncadg_ip_udp 130.105.5.16}}
{CDS_CHState on}
{CDS_CHDirectories 
 {{Dir_UUID 00146037-d97b-1db3-8259-0000c0f7de56}
  {Dir_Name /.../terrapin}}
 {{Dir_UUID 0043797a-d991-1db3-8259-0000c0f7de56}
  {Dir_Name /.../terrapin/subsys}}
 {{Dir_UUID 004faa42-d992-1db3-8259-0000c0f7de56}
  {Dir_Name /.../terrapin/subsys/HP}}
 {{Dir_UUID 004fa65a-d993-1db3-8259-0000c0f7de56}
  {Dir_Name /.../terrapin/subsys/HP/sample-apps}}
 {{Dir_UUID 004b1130-d994-1db3-8259-0000c0f7de56}
  {Dir_Name /.../terrapin/subsys/dce}}
 {{Dir_UUID 00498a0e-d995-1db3-8259-0000c0f7de56}
  {Dir_Name /.../terrapin/subsys/dce/sec}}
 {{Dir_UUID 003ed80c-d996-1db3-8259-0000c0f7de56}
  {Dir_Name /.../terrapin/subsys/dce/dfs}}
 {{Dir_UUID 003d4d8e-d997-1db3-8259-0000c0f7de56}
  {Dir_Name /.../terrapin/hosts}}
 {{Dir_UUID 003bc522-d998-1db3-8259-0000c0f7de56}
  {Dir_Name /.../terrapin/hosts/drkstr}}
 {{Dir_UUID 0089ee8c-44e0-1dbe-929b-0000c0f7de56}
  {Dir_Name /.../terrapin/help}}
 {{Dir_UUID 001c6cea-00fb-1dc5-929b-0000c0f7de56}
  {Dir_Name /.../terrapin/test_1}}
 {{Dir_UUID 00440fe8-02a1-1dc5-929b-0000c0f7de56}
  {Dir_Name /.../terrapin/dirmod}}}
{CDS_ReplicaVersion 3.0}
{CDS_NSCellname /.../terrapin}

The following command displays the current values of the counters associated with the /.:/Chicago1_CH clearinghouse: 

dcecp> clearinghouse show /.:/Chicago1_CH -counters 
{corruptions 0}
{disables 0}
{enables 1}
{failedupgrades 0}
{missingentries 0}
{reads 2336}
{returnedrefs 2}
{rootunreachables 0}
{skulkfailures 0}
{writes 68}

clearinghouse verify

Verifies the consistency of the specified clearinghouse on the local machine. The syntax is:

clearinghouse verify clearinghouse_name_list

The clearinghouse verify operation verifies the consistency of the specified clearinghouse by checking internal attributes. The required clearinghouse_name_list argument is a list of one or more names of clearinghouses you want to verify. This operation returns an empty string on success.

Privileges Required

You need write permission on the clearinghouse server and administer permission on the cell root directory. The server principal needs read, write, and administer permission on the cell root directory.

Examples

The following command verifies the consistency of clearinghouses named /.:/gumby_ch and /.:/pokey_ch. 

dcecp > clearinghouse verify {/.:/gumby_ch /.:/pokey_ch}

Related Information

Commands: cdscache(8dce), directory(8dce), link(8dce), object(8dce), clear_clearinghouse(8cds), create_clearinghouse(8cds), delete_clearinghouse(8cds), show_clearinghouse(8cds).

directory( 8dce)

Name

directory -A dcecp object that manages a name service 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]|
[-clearinghouse clearinghouse_name]]

directory delete directory_name_list [[-tree]| [-replica -clearinghouse clearinghouse_name]]

directory help [operation | -verbose]

directory list directory_name_list [-directories][-objects][-links] [-simplename | -fullname]

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]
[-propagate [-force]] [-upgrade [-tree]]}

directory operations

directory remove directory_name_list -member child_pointer_list

directory show directory_name_list
[-member child_pointer_list | -replica -clearinghouse clearinghouse_name]
[-schema]

directory synchronize directory_name_list

Arguments

directory_name_list

A list of one or more specific directory names to be operated on. The last simple name can contain wildcard characters.

child_pointer_list

A list of one or more specific child pointers to be operated on.

clearinghouse_name

The name of a single clearinghouse to use during directory operations.

clearinghouse_name_list

A list of one or more clearinghouses to use during the directory modify operations.

source_directory_name

The name of one specific directory whose contents are to be copied into a destination directory using a directory merge operation.

destination_directory_name

The name of one specific directory that will contain the results of a successful directory merge operation.

operation

The name of one specific directory operation about which you want to see help information.

attribute_list

A list of one or more legal attributes to use during directory operations.

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 a -clearinghouse option is used (as described in some commands below), then it overrides the value of _s(cds) but the command will not change the setting of _s(cds).

Attributes

The following are the CDS defined attributes that may be present in directories and replicas in CDS:

CDS_AllUpTo

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.

CDS_Convergence value

Specifies the degree of consistency among replicas. This attribute's value is defined as one of the following:

CDS_CTS

Specifies the creation timestamp (CTS) of the CDS directory.

CDS_DirectoryVersion

Specifies the current version of the directory (derived from the CDS_DirectoryVersion attribute of the clearinghouse in which the directory was created). Multiple directory versions are supported in a cell.

CDS_Epoch

A Universal Unique Identifier (UUID) that identifies a particular incarnation of the directory.

CDS_GDAPointers

A set-valued attribute that is only present 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.

CDS_InCHName

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.

CDS_LastSkulk

Records the timestamp of the last skulk performed on this directory.

CDS_LastUpdate

Records the timestamp of the most recent change to any attribute of a directory replica, or any change to an entry in the replica.

CDS_ObjectUUID

Specifies the unique identifier of the directory. This is read-only to the user and is set by the system at creation time.

CDS_ParentPointer

Contains a pointer to this directory's parent in the namespace.

CDS_Replicas

Specifies the address, UUID, and name of every clearinghouse where 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.

CDS_ReplicaState

Specifies whether a directory replica can be accessed.

CDS_ReplicaType

Indicates whether a directory replica is a master or read-only replica.

CDS_ReplicaVersion

Specifies the version of a replica of the directory.

CDS_RingPointer

Specifies the UUID of a clearinghouse containing another replica of this directory.

CDS_UpgradeTo

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.

CDS_UTS

Specifies the timestamp of the most recent update to an attribute of the directory.

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

-member child_pointer_list

This required option names the child pointers to be added to parent directories in the clearinghouse named by the required -clearinghouse option.

-clearinghouse clearinghouse_name

This required option names the clearinghouse where the child pointers are to be added.

The directory add operation creates a child pointer in the parent directory. The directory_name_list argument is a list of one or more names of parent 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 of the directories 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 of the values of the -member option. The 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 /.:/darkstr_ch

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]|
[-clearinghouse clearinghouse_name]]
Options

-attribute attribute_list

Allows you to specify the CDS_Convergence attribute or the CDS_UpgradeTo attribute in an attribute list. The format is as follows:

-attribute {{attr value}{attr value}}

See the ATTRIBUTES section of this reference page for descriptions of the CDS_Convergence attribute and the CDS_UpgradeTo attribute.

-single

Valid only with the -attribute option, this specifies that attribute values are single-valued. Otherwise, attributes are multivalued.

-replica

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.

-clearinghouse clearinghouse_name

Required with the -replica option and optional when -replica option is not present, the -clearinghouse option names the clearinghouse to which the child pointers are to be added.

The directory 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 multivalued 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 directories 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. The operation returns an empty string on success.

Privileges Required

You must have the following permissions in order 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 must have r (read) and i (insert) permission to the parent directory.

Examples

The following command creates a directory named /.:/sales. 

dcecp > directory create /.:/sales

directory delete

Deletes a directory. The syntax is as follows:

directory delete directory_name_list
[[-tree]| [-replica -clearinghouse clearinghouse_name]]
Options

-tree

Removes the directory and everything (all directories, objects, links, and clearinghouses) beneath it.

-replica

Specifies that the directory to delete is a replica of an existing directory. If you use the -replica option, you must specify a clearinghouse using the -clearinghouse option.

-clearinghouse

Required with the -replica option, the -clearinghouse option names one clearinghouse (not a list of clearinghouses) from which the replica is to be deleted.

The directory 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 -replica and -clearinghouse options (they must be used together) let you delete a replica instead of a directory. The -clearinghouse option specifies the clearinghouse that contains the replica; only one value can be specified, not a list. The operation returns an empty string on sucess. 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 (delete) permission to the directory and w (write) permission to the clearinghouse that stores the master replica of the directory. The server principal 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

The following command deletes the directory /.:/eng from the namespace: 

dcecp> directory delete /.:/eng

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> dir delete /.:/depts/phrenology -tree

directory help

Returns help information about the directory object and operations. The syntax is as follows:

directory help [operation | -verbose]

Options

-verbose

Displays information about the directory object.

The optional operations argument returns information about the operation and its options. Used without an argument or option, the help command returns brief information about each directory operation.

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 directory.
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 or replica.
synchronize         Skulks the named directory.
help                Prints a summary of command-line options.
operations          Returns a list of the valid operations for this command.

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 [-directories][-objects][-links]
[-simplename] | -fullname]
Options

-directories

This option lists the names of all descendent directories.

-objects

This option lists the names of all descendent objects.

-links

This option lists the names of all descendent softlinks.

-simplename

Returns just the RDN of the name.

-fullname

Returns the entire name.

The directory list operation returns a list of the names of all the descendents of a directory. Descendents can include all directories, objects, links, and clearinghouses of the directory. 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, most 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 or if the -fullname option is specified, 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

The following example lists a softlink in the /.:/depts/administration directory that points to a server entry in the /.:/depts/phrenology/applications directory: 

dcecp> dir list /.:/depts/administration -links
/.../ward_cell.osf.org/depts/administration/bump_server1

directory merge

Copies the contents of one directory into another directory. The syntax is as follows:

directory merge source_directory_name -into destination_directory_name
[-clearinghouse clearinghouse_name][-tree][-nocheck]
Options

-tree

Copies the contents of child directories (as well as the child directories themselves) into the destination directory.

-into destination_directory_name

The argument to this required option specifies the name of the destination directory. The destination directory must exist.

-clearinghouse clearinghouse_name

Places the new objects (the resulting merged directory) in a clearinghouse other than that of the destination directory.

-nocheck

Lets the directory merge operation proceed without checking first for object name collisions or access control list (ACL) problems. Use this option to save time when you're sure problems don't exist.

The directory 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 following objects: /.:/x/b and /.:/x/c.

Normally only the immediate contents of the directory are merged. This means 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 descendant directories in another clearinghouse, use the -clearinghouse option with a value. There can only be one clearinghouse specified for all directories involved in the merge operation. To specify more than one, either change this after the merge has happened, or use separate commands.

This command first checks for any collisions or ACL problems before beginning to merge any objects. If there are any problems encountered, an error is generated (not immediately; all objects are checked first), and the names of all problem objects, links or directories are returned in a list. The administrator 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. Changing ACLs can be done to ensure this. If an error does occur during the actual merging process, it is generated and the operation aborts immediately.

The merge command actually recreates the objects with the same writable attributes of the source objects. This means that 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.

Privileges Required

You must have r (read) 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 directory: 

dcecp> dir list /.:/depts/phrenology -simple 
applications services staff users 
dcecp> directory merge /.:/depts/phrenology -into /.:/depts/radiology 
dcecp > dir list /.:/depts/radiology -simple 
applications services staff users

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]
[-propagate [-force]] [-upgrade [-tree]]}
Options

-add

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 in length. You can only enter pairs of hexadecimal values for user-defined attributes.

-single

Used with the -add option to specify that the attributes to be added are to be single-valued. Normally all user-defined attributes are defined to be multivalued, even if only one value is specified. This option is not legal without the -add option.

-remove

Removes a value from a set-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.

-types

Used with the -remove option to specify that the value of the -remove option is a list of attribute types. The entire attribute is to be removed, not just a value. (This option is not legal without the -remove option.)

-change

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}

Specify one of the following for value:

-propagate

Changes the replica set of the child directories to match that of the parent directory. This recursive call modifies the replica set of all child directories found beneath the parent directory. Refer to the Gradient DCE for Tru64 UNIX Product Guide for information about cell migration.

-force

Used with the -propagate option to specify that the child's replica set be synchronized with the parent's replica set even if the current replica set of the child directories contains a different master replica and does not contain the same number of replica sets.

-upgrade

Upgrades the directories to CDS directory version 4.0. This option is provided as part of a migration tool for upgrading from a Digital DCE V1.3 (OSF DCE R1.0.3+) to Digital DCE V2.0 (OSF DCE R1.1+) base. Refer to the Gradient DCE for Tru64 UNIX Installation and Configuration Guide for information about cell migration.

-tree

Used with the -upgrade option to specify recursive upgrading of all directories and child directories found beneath the directories named in the operation argument.

The directory 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 multivalued. For instance, the CDS_Replicas attribute can specify the locations and names of several clearinghouses that maintain copies of a directory. The -add operation needs to be instructed whether to operate on single-valued or multivalued attributes. Omit the -single option to operate on multivalued attributes. Include the -single option to operate on single-valued attributes.

The -upgrade and -tree, options support cell migration to Digital DCE Version 2.0 (based on OSF DCE Release 1.1). For information about cell migration, refer to the Gradient DCE for Tru64 UNIX Installation and Configuration Guide.

The -propogate and -force options support synchronization and creation of child directory replica sets. For information about synchronizing replica sets, refer to the Gradient DCE for Tru64 UNIX Product Guide.

Most attributes are usually managed by the client application. See the OSF DCE Administration Guide for more information about attributes. All modifications are made to each directory listed in the argument. An error in any one causes the command to abort immediately and generate an error. The 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}

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}

To remove the value 1 from the user-defined, set-valued attribute dirregion of a directory named /.:/sales, follow these steps:

  1. Read the cds_attributes file to check that the attribute dirregion is listed, as shown in the following display:

    OID LABEL SYNTAX
    1.3.22.1.3.66

    		dirregion

    		small

  2. Enter the following command to remove the value 1 from the attribute dirregion: 

    dcecp> directory modify /.:/sales -remove {dirregion 1}

directory operations

Returns a list of the operations supported by the directory object. The syntax is as follows:

directory operations

The directory operations command takes no arguments, and returns a list of the available operations for the directory object. The order of the elements is alphabetical with the exception that help and operations 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

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

-member child_pointer_list

This required option names the child pointers to be removed from each directory in the operation argument.

The directory 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 operation returns an empty string on success.

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 accidentally remains after the child directory is deleted. Normally child pointers are removed internally by CDS when deleting directories with the directory delete command.

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

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
[-member child_pointer_list | -replica -clearinghouse clearinghouse_name]
[-schema]
Options

-member child_pointer_list

The optional -member option takes one required value which is the last RDN of the child pointer in the directory specified by the operation argument. The returned list describes the child pointer information for the specified member stored in the specified directories. This option may not be combined with the -replica or -clearinghouse option.

-replica

This 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.

-clearinghouse clearinghouse_name

Required with the -replica option, the -clearinghouse option names the clearinghouse where the named replica exists.

-schema

This option returns whether an attribute is single or multivalued. This is specific to a directory, meaning that the same attribute can be single-valued on one directory and multivalued on another directory. This option may not be used with other options.

The directory show operation returns a list of attributes for the specified directories and optionally, their specified contents. The directory_name_list argument is a list of one or more 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 indentifiers (OIDs) of each attribute for each directory.

You can request attributes of specific replicas in specific clearinghouses by using the -replica and -clearinghouse options. Alternatively, 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

The following example shows the attributes for the /.:/depts/radiology directory: 

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_LastSkulk 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}

The following example uses the -schema option to show whether the attributes for the /.:/depts/radiology directory are single-valued or multivalued: 

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_ReplicaState single}
{CDS_ReplicaType single}
{CDS_LastSkulk single}
{CDS_LastUpdate single}
{CDS_RingPointer single}
{CDS_Epoch single}
{CDS_ReplicaVersion single}

directory synchronize

Initiates an immediate skulk of the directories specified. The syntax is as follows:

directory synchronize directory_name_list

The directory 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 complete. The operation returns an empty string on success.

Privileges Required

You must have A (Admin), w (write), i (insert), or d (delete) permission to the directory. The server principal 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

Related Information

Commands: dcecp(8dce), clearinghouse(8dce), link(8dce), object(8dce), add directory(8cds), create directory(8cds), delete directory(8cds), list directory(8cds), remove directory(8cds), set directory(8cds), show directory(8cds).

ldap_addcell( 8dce)

Name

ldap_addcell - Registers DCE cell information in a server that supports LDAP.

Synopsis

ldap_addcell -h ldap_server -a authentication_DN -p password
[-o object_class, object_class...] | [-d]

Options

-h ldap_server

The name of the LDAP server targeted to hold the binding.

-a authentication_DN

The distinguished name (DN), specified in LDAP name syntax, that is to be authenticated for successive operations to use.

-p password

The password that is used to authenticate the distinguished name (DN).

-o object_class, object_class...

Value or values of the attribute object_class for the entry being created or modified. If you are listing more than one object_class value, you must separate them with commas. If no object_class value is specified, it is assumed that the object exists and an attempt is made to modify its attributes, CDS_CELL and CDS_REPLICAS.

If this attempt fails, another attempt is made with the addition of the object_class value of dceCellInfoO. "dceCellInfoO" is the recommended auxilliary object class for the CDS_CELL and CDS_REPLICAS attributes

-d

Deletes the DCE cell information attributes from the entry in the directory. It does not remove the directory entry.

Description

The ldap_addcell command registers DCE cell information in a server that supports LDAP. It returns a zero (0) on success and a one (1) on error.

Privileges Required

You must log in as superuser (root) to run the ldap_addcell command.

Examples

The following ldap_addcell examples assume the following:

Example 1 shows the normal creation of the cell bindings in the ldap server. 

ldap addcell -h mymachine.mycity.mycompany.com -a \
"cn=gdatest, ou=mycity, o=mycompany, c=mycountry" \
-p "gdatest" -o organizationalUnit, dceCellInfo

Example 2 shows the deletion of the CDSCELL and CDSREPLICAS attributes. 

ldap addcell -h mycountry.mycity.mycompany.com -a \
"cn=gdatest, ou=mycity, o=mycompany, c=mycountry" \
-p "gdatest" | -d

Example 3 shows the changing of the CDSCELL and CDSREPLICAS attributes in an object that exists. 

ldap addcell -h mycountry.mycity.mycompany.com -a \
"cn=gdatest, ou=mycity, o=mycompany, c=mycountry" \
-p "gdatest"

Environment Variables Used

Each parameter of the ldap_addcell command has a corresponding environment variable, which is used when the corresponding parameter is not present on the ldap_addcell command invocation. The ldap_addcell parameters and the corresponding environment variables are as follows:

-h

LDAP_SERVER

-a

LDAP_AUTH_DN

-p

LDAP_AUTH_DN_PW

-o

LDAP_OPJECT_CLASS

If the cell entry is already registered, the CDSCELL and CDSREPLICAS attributes are replaced with new values for this cell.

Related Information

None

gdad( 8cds)

Name

gdad - Starts the global directory agent (GDA) daemon.

Synopsis

gdad [-b][-d routing][-D][-r resolve.conf file][-u][-w route]\
[-x][-l]| [-h addr_LDAP_server [port] -a authentication_DN \
-p password_for authentication_DN]| [-h addr_LDAP_server [port]]

Options

-b

Disables the use of DNS as the global directory service.

-d routing

Sets the debug routing. This option is for debugging use only.

-D

Sets up a debugging condition that refuses to let the gdad process fork.

-r resolve.conf file

Specifies the file name of the resolve configuration file. The default is /etc/ resolv.conf.

-s named.ca file

Indicates the file name of the bind server namec data file. The default is / etc/named.data.

-u

Prevents gdad from updating the GDA parent pointer on /.:. This option is for debugging use only.

-w route

Routes serviceability messages.

-l

Disables the use of LDAP as global directory service.

-h addr_LDAP_server port

Specifies the address of the LDAP server in which DCE cell information is registered. The value addr_LDAP_server and port is the port on which the LDAP server is listening. This is needed if the default port [389] is not used. Alternatively, the host can be specified as an IP address in dotted decimal format. The -h option is required when -l is not present.

-a authentication_DN

Authenticates a distinguished name (DN).

-p password_for authentication_DN

Specifies the password used to authenticate the distinguished name (DN).

-x

Disables X.500 name resolution.

Description

The gdad command starts the Global Directory Agent (GDA) daemon. The GDA enables intercell communication, serving as a connection to other cells through the global environment.

Privileges Required

You must log in as superuser (root).

Notes

This command is ordinarily executed by a DCE configuration or startup script. Use this command interactively only when a gdad process fails to start automatically after a reboot, or if you want to restart the GDA daemon after disabling it to perform a backup or do diagnostic work on the host system.

Examples

To start the gdad process, follow these steps:

  1. Log in to the system as superuser (root).

  2. Verify that the dced and gdad processes are running.

  3. 3. Enter the following command to restart the gdad process:

    gdad

To stop the GDA, enter the following command:

kill pid

where pid is the process identifier of the gdad process.

Related Information

Books: DCE Administration Guide - Core Components

dtsd( 8dts)

Name

dtsd - Restarts the DTS daemon

Synopsis

dtsd -s [server options][common options]
dtsd -c [common options]

Server Options

-k courier

Runs dtsd as a courier.

-k noncourier

Runs dtsd as a noncourier.

-o

When enabling as a server, set the clock immediately. Equivalent to the command enable set clock true in dtscp or to the command dcecp dts activate -abruptly.

-g

Runs dtsd as a global server.

-s

Runs dtsd as a server. The default is backup courier and local server. -s or -c must be on the command line to specify server type.

-c

Runs dtsd as a clerk. -s or -c must be on the command line to specify server type.

Common Options

-d

Debug mode. The command runs in the foreground.

-w serviceability

See the svcroute(5dce) reference page for the full description of the appropriate format for this entry. Only the three-field format, severity:how:where is used. An example is:

FATAL:TEXTFILE:/dev/console

-m

Accept timing messages in DLI. (Default is RPC only.)

Description

The dtsd command invokes the DTS daemon (server or clerk process). This command is usually executed as part of the overall DCE startup script, dcesetup.

You can enter the command manually under the following conditions:

In normal rebooting, the rc.dce script automatically provides arguments appropriate to the choice of configuration options.

The command line options shown here can also be provided to dced as part of the fixed configuration strings, if dced is configured to automatically start dtsd.

If dtsd is started with no arguments (other than -d and -w), then the server must be started with dcecp. The following example configures a local server: 

dcecp> dts configure -notglobal
dcecp> dts activate

Privileges Required

DTS runs as the host machine principal, which is usually root. See the security reference section for information about principals.

Notes

Use dtsd interactively only when troubleshooting; otherwise use the /sbin/rc3.d/S66dce script to start the DTS daemon. On some systems the superuser is associated with the machine principal.

Examples

To restart the daemon, follow these steps:

  1. Log into the system as superuser (root).

  2. Use the ps command to make sure that dced and cdsadv are running. (The DCE daemon provides the endpoint mapping and security services, and cdsadv provides CDS.)

  3. Use the following command to restart the dts daemon as a clerk:

    dtsd -c

    To restart the dts daemon as a server use the following command:

    dtsd -s

    To restart the dts daemon as a global server, setting the clock on startup, use the following command:

    dtsd -s -g -o

Related Information

Commands: dtscp (8dts), dtsdate (8dts), dcecp (8dce).

Files: svcroute(5dce).

Books: DCE Administration Guide - Core Components

randd( 8sec)

Name

randd - Stops and restarts the RAND daemon

Synopsis

randd

Description

The randd command is executed as part of the overall DCE startup script, dcesetup. Super (root) users can stop and restart the RAND daemon. The daemon, which has a low priority, takes over idle central processing unit (cpu) resources, which it uses to produce random numbers. The random numbers are stored in memory until requested by processes, often security processes. If the daemon is not present, security daemons calculate the random numbers as they did in the past.

Privileges Required

Superuser (root) priviledge is required.

Examples

To restart the daemon, follow these steps:

  1. Log into the system as superuser (root).

  2. Use the ps command to check whether the randd is running.

    ps auxw | grep randd

Related Information

None

[Previous] [Next] [Contents]

To make comments or ask for help, contact support@entegrity.com.

Copyright © 2001 Entegrity Solutions Corporation & its subsidiaries.

Copyright © 1998-2001 Compaq Computer Corporation.

All rights reserved.