NAME

cdscache - A dcecp object that manages a cdscache

SYNOPSIS

cdscache create server_name -binding server_binding

cdscache delete server_name

cdscache dump 

cdscache help [operation | -verbose] 

cdscache operations 

cdscache show server_name {-server | -clearinghouse}

DESCRIPTION

The cdscache object represents the 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 commands can display additional information.

ARGUMENTS

server_name
This is a simple name for the cached server machine. A simple name is like pelican. It is not a cell-relative name like /.:/hosts/pelican.

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

OPERATIONS

cdscache create

Creates knowledge of a server in the local clerk'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 protocol-sequence:network-address; the TCL format is {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 a connection-based protocol) or ncadg_ip_udp (for a datagram protocol). A complete list of the protocol sequences recognized can be found in dce/ep.idl. The network-address is a string representing the network address of the server node. For more information about this format, see the RPC introduction in the OSF DCE Application Development Reference.

The cdscache create operation creates knowledge of a server in the local clerk's cache. The server_name argument is a simple name for the cached server. A simple name is like pelican. It is not a cell-relative name like /.:/hosts/pelican. This command is typically used to manually provide configuration information to a clerk that cannot automatically configure itself. This is required, for instance, to give the clerk addressing information about a server. Once the clerk knows about one server, it can find other servers through referrals. The command returns an empty string on success.

Privilege Required

You must have w permission to the clerk system, /.../<cell>/hosts/<machine>/cds-clerk.

Examples

The following command creates knowledge of the server pelican in the local clerk'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 clerk's cache. The syntax is:

cdscache delete server_name

The cdscache delete operation removes knowledge of a server that you had specifically created from the local clerk's cache. The required server_name argument is a simple name given with the cdscache create command. You can only delete servers that you have specifically created with the cdscache create command.

Privilege Required

You must have w permission to the clerk system, /.../<cell>/hosts/<machine>/cds-clerk.

Examples

The following command removes knowledge of the server nrl from the clerk cache:

dcecp> cdscache delete nrl
dcecp>

cdscache dump

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

cdscache dump

The cdscache dump operation displays the contents of the clerk cache on the screen.

Privilege Required

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

Examples

The following command displays the contents of the clerk cache on the screen:

dcecp> cdscache dump

cdscache help

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

cdscache help [operation | -verbose]

Option

-verbose
Displays information about the cdscache object.

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 (create, delete, dump, or show) about which you want detailed information.

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

Privilege 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.
dump                Dump all information from local cds cache.
show                Returns information stored in cds cache.
help                Print summary of command-line options and abort.
operations          Returns the valid operations for command.
dcecp>

cdscache operations

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

cdscache operations

The cdscache operations command takes no arguments. The list of operations available to the cdscache object is ordered alphabetically except that help and operations are listed last.

Privilege Required

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

Examples

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

cdscache show

Displays information about clearinghouses or servers stored in the cache. The syntax is:

cdscache show server_name {-server | -clearinghouse}

Options

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

Creation Time
Specifies the time at which this clearinghouse was added to the cache

Miscellaneous Operations
Specifies the number of operations other than read and write (that is, skulks, new epochs, and so on) performed by this clerk on the cached clearinghouse

Read Operations
Specifies the number of lookup operations of any sort performed by the clerk on the cached clearinghouse

Towers
Specifies the protocol sequence and network address of the server that maintains the cached clearinghouse

Write Operations
Specifies the number of write operations performed by this clerk on the cached clearinghouse

-server
The -server option displays address information of a server in the local clerk's cache. The following list describes the valid attributes:

Name
The directory cell name

Towers
The protocol sequence and network address of the server node

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

Privilege Required

You must have r permission to the clerk system, /.../<cell>/hosts/<machine>/cds-clerk.

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

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

RELATED INFORMATION

Commands: directory(8dce), link(8dce), object(8dce), clearinghouse(8dce) clear_cached_server(8cds), define_cached_server(8cds), dump_clerk_cache(8cds), show_cached_clearinghouse(8cds), show_cached_server(8cds)


© 1990-1996, Transarc Corporation