dts(1m)dts(1m)NAMEdts - A dcecp object that manages a dtsd process
SYNOPSISdts activate [dts_server] [-abruptly]
dts catalog [cell_name] [-simplename] [-global]
dts configure [dts_server] {-global | -notglobal}
dts deactivate [dts_server]
dts help [operation | -verbose]
dts modify [dts_server] {-change attribute_list | -attribute value}
dts operations
dts show [dts_server] [-all | [-attributes] [-counters]]
dts stop [dts_server]
dts synchronize [dts_server] [-abruptly]
ARGUMENTS
The name of a single cell. This name allows access to DTS servers reg‐
istered in a foreign cell. The name must be a fully qualified cell
name as in either of the following: /.:
/.../cellname
Identifies the dtsd server to act on. Supply the name in one of the
following forms: As a fully qualified name, for example: /.../cell‐
name/hosts/hostname/dts-entity As a string binding for the remote host
on which dtsd is running in standard string-binding syntax or in Tcl
syntax, for example: ncacn_ip_tcp:130.105.1.227
{ncacn_ip_tcp 130.105.1.227} The name of the dts operation for which to
display help information.
DESCRIPTION
The dts object represents the dtsd (DTS daemon) process running on a
host. The DTS process does not maintain stored data as some other
objects do. Consequently, the dts object represents the information in
and about a process rather than stored data.
These commands all affect the local dtsd entity by default. Use the
dts_server argument to operate on a remote DCE dtsd. This argument is
a single server entry or string binding representing a dtsd that will
be contacted for the operation. If the _s(dts) convenience variable is
set, it is treated as the name of a dtsd to contact for subsequent
operations. If either method is used, the specified server is the only
server contacted in an attempt to complete the operation. The argument
on the command line takes precedence over the value of the _s(dts) con‐
venience variable. These commands do not set the value of this vari‐
able after completion.
A number of attributes are associated with the dts object. All can be
viewed with the show operation, and many can be changed with the modify
operation. Attribute arguments can contain a maximum of 80 characters
and are recalculated to a normalized date format. For example, if the
input value is 0-0025:10:99.99999999, the result is 1-01:11:39.990.
Timestamps are specified in DTS and ISO formats. They can be specified
in both absolute and relative time formats. See the OSF DCE Adminis‐
tration Guide for more information.
ATTRIBUTES
The dts object supports attributes and counters. Most attributes and
counters pertain to dtsd processes in general. A subset of attributes
and counters pertains only to dtsd processes that are enabled as DTS
server entities. The format of all attributes of type relative_time is
in DTS-style ([-]DD-HH:MM:SS).
General Attributes
Specifies whether automatic changes to the time differential factor are
enabled or disabled. The value is either yes or no. The value is
determined by the operating system (that is, it cannot be changed with
the modify operation). Specifies the rate at which the DTS server or
clerk entity adjusts the node's clock during a synchronization. This
attribute may not be set by a user, but is built in to dtsd. Specifies
the amount of time between system clock ticks. The value is determined
by the operating system (that is, it cannot be changed with the modify
operation). Specifies the set of global servers known by the node.
The information returned for each server is as follows: the DCE name
of the host followed by /self, the last time polled, the last observed
time, the last observed skew, a binary value of whether the server was
used in the last last synchronization, and the transport time. These
subattributes are called respectively name, timelastpolled, lastob‐
stime, lastobsskew, inlastsync, and transport. Specifies the amount of
time the node waits for a response to a wide area network synchroniza‐
tion request before sending another request or declaring a global
server to be unavailable. The number of attempts made to reach the
server is controlled by the queryattempts attribute. The default value
is 0-00:00:15.000, and the range of possible values is 0-00:00:00.000
to 0-00:10:00.000. Specifies the set of local servers known by the
node. The information returned for each server is as follows: the
principal name that the server is running as, the last time polled, the
last observed time, the last observed skew, a binary value indicating
whether the server was used in the last synchronization, and the trans‐
port time. These subattributes are called respectively name, timelast‐
polled, lastobstime, lastobsskew, inlastsync, and transport. Specifies
the amount of time the node waits for a response to a synchronization
request before sending another request or declaring a server to be
unavailable. The number of attempts made to reach the server is con‐
trolled by the queryattempts attribute. The default is 0-00:00:05.000,
and the range of possible values is 0-00:00:00.000 to 0-00:01:00.000.
Note that this attribute controls only the initial contact with a time
provider. During this initial contact, the time-provider itself deter‐
mines the timeout value for actually reporting back times, allowing
time providers attached to a slow source, like a modem, to request that
dtsd wait for a longer interval. Specifies the worst-case drift rate
of the node's clock, in nanoseconds per second, as determined by the
manufacturer's specifications (that is, it cannot be changed with the
modify operation). Specifies the inaccuracy limit for the node. When
the node exceeds the maximum inaccuracy setting, it attempts to syn‐
chronize. The default is 0-00:00:00.100, and the range of possible
values is 0-00:00:00.0 to 10675199-02:48:05.478. The maximum number of
hours is 24. A practical value is less than 60 seconds. Specifies the
minimum number of servers required for a synchronization. Settings of
1 or 2 for a DTS server may cause unreliable computed times. The
default is 3 for a DTS server and 1 for a DTS clerk. The range of pos‐
sible values is 1 to 10. Specifies the future time at which the time
differential factor is automatically changed. The value is determined
by the operating system (that is, it cannot be changed with the modify
operation). Specifies the number of attempts a node makes to contact a
server before the node considers the server unavailable. The default
is 3, and the range of possible values is 1 to 10. Specifies the state
of the DTS entity. This is a read-only attribute and its possible val‐
ues are as follows: The DTS entity is disabled. The DTS entity is
enabled. The DTS entity is synchronizing. The DTS entity is updating
the time. Specifies the interval a node must wait to synchronize.
Also specifies synchronization frequency when a node reaches the value
specified by the maxinaccuracy attribute. For clerks the default is
0-00:10:00.0, and the range of possible values is 0-00:00:30.0 to
01-00:00:00.00. For servers the default is 0-00:02.00.0, and the range
of possible values is 0-00:00:30.0 to 01-00:00:00.00. Specifies the
time differential factor (TDF), which is the amount of time the server
varies from Greenwich mean time (GMT) or Universal Time Coordinated
(UTC). The default is based on time zone information, with the range
of possible values being -13-00:00:00 to 13-00:00:00. This may not be
set by a user, but rather is obtained from various time zone informa‐
tion repositories (such as the TZ environment variable, kernel struc‐
tures, and so on). Specifies the internal timestamp format used by the
node. This format is not related to the format used to display the
current time to the user (see the clock show command). Currently DTS
uses V1.0.0 timestamps only. This attribute cannot be set by a user,
but is built in to a dtsd. Specifies the maximum separation allowed
between the local clock and the computed time before synchronizations
become abrupt rather than gradual (monotonic). The default is
0-00:05:00.000, and the range of possible values is 0-00:00:00.500 to
10675199-02:48:05.478. Specifies whether the node is a DTS server or
clerk. Specifies the DTS software version installed on the node. This
attribute cannot be changed with the modify operation.
DTS Server Attributes
Specifies a server's acting interaction with the set of global servers.
The values are the same as for the courierrole attribute below. The
difference between actcourierrole and courierrole is that even when the
value of courierrole is backup there is no guarantee that the courier
is acting as a courier unless actcourierrole also specifies backup. The
actcourierrole attribute indicates the actual role of the server. The
default is courier. Specifies the amount of time between checks for
faulty servers. Applicable only to servers that have external time-
providers. The default is 0-01:30:00.00, and the range of the possible
values is 0-00:00:30.000 to 10675199-02:48:05.478. Specifies a
server's interaction with the set of global servers. Possible values
are as follows: The local server becomes a courier if none are avail‐
able on the local area network (LAN). This is the default. The local
server synchronizes with the global set of servers. The local server
does not synchronize with the global set of servers. Specifies the
server's epoch number. The default is 0, and the range of possible
values is 0 to 255. This value may not be changed with the modify com‐
mand; use the clock set command with the -epoch option to change its
value. Specifies whether the entity used an external time-provider at
the last successful synchronization. This attribute applies to servers
only and may not be set by a user. The value is either yes or no.
Specifies a server's access control list (ACL) entry name. The default
setting is the following recommended value: hosts/hostname/dts-entity.
Specifies the security group name for the time servers within the cell.
The default is subsys/dce/dts-servers. Specifies a server's principal
name for authentication purposes. The default setting is the following
recommended value: hosts/hostname/self. Specifies the entity's unique
identifier, which is generated when the entity is created.
General Counters
Specifies the number of times the node clock has been set non-monotoni‐
cally (abruptly). Specifies the number of times a local server was
contacted, but was not in the DTS security group. Specifies the number
of times the local node failed to process a received message containing
an incompatible protocol version. Specifies the number of times the
local node failed to process a received message containing an incompat‐
ible timestamp format. Specifies the time at which the DTS entity was
created and the counters were initialized. Specifies the number of
times the DTS has been disabled. Specifies the number of times the DTS
has been enabled. Specifies the number of times the node's time inter‐
val failed to intersect with the computed interval of the servers.
Specifies the number of times the node has been unable to allocate vir‐
tual memory. Specifies the number of times a dtsd server process ini‐
tiated contact with a time-provider and did not receive the initial
response within the interval specified by the localtimeout attribute.
Specifies the number of times the node synchronized successfully.
Specifies the number of times a DTS process detected a system error.
Specifies the number of times a node failed to synchronize because it
could not contact the required minimum number of servers.
DTS Server Counters
Specifies the number of times a non-local server was contacted, but was
not in the DTS security group. Specifies the number of times the node
received time response messages from servers or clerks that had epoch
numbers different from its own. Specifies the number of times the
server's epoch has changed. Specifies the number of times the courier
server could not contact any global servers. Specifies the number of
times the courier server could not contact a specific global server.
Specifies the number of times a server has detected faulty servers
(other than itself). Specifies the number of times the external time-
provider signaled a failure, or the node was unable to access the time-
provider. Specifies the number of times a server has attempted to syn‐
chronize its clock.
See the OSF DCE Administration Guide for more information about DTS
attributes.
OPERATIONSdts activate
Changes a DTS entity from an inactive state to an active state. The
syntax is as follows: dts activate [dts_server] [-abruptly]
Options Sets the clock abruptly rather than gradually adjust it to the
computed time.
The activate operation changes a DTS entity from an inactive state to
an active state. The status attribute is changed to enabled. This
attribute tells the DTS entity to begin synchronizing. This operation
takes an -abruptly option to determine whether the first clock adjust‐
ment due to synchronization is an abrupt or gradual one, and returns an
empty string on success.
Privileges Required
You must have w (write) permission on the DTS entity to execute the
command.
Examples
The following example activates a dtsd on the local host: dcecp> dts
activate dcecp>
The following example activates a dtsd on a remote host named cyclops:
dcecp> dts activate /.:/hosts/cyclops/dts-entity dcecp>
dts catalog
Returns a list of the names of all DTS servers registered in the local
cell. The syntax is as follows: dts catalog [cell_name] [-simplename]
[-global]
Options Returns a list of registered DTS servers without prepending the
cell name. Returns a list of registered global DTS servers.
The catalog operation returns a list of the names of all DTS servers
registered in the default LAN profile (/.:/lan-profile). Any DTS
servers registered in the cell profile (/.:/cell-profile) or in an
additional LAN profile will also be returned. The additional LAN pro‐
file must exist at the root (/.:) level of the CDS namespace. The
operation takes an optional cell_name argument that can return the
names of DTS servers registered in a foreign cell. By default, fully
qualified names are returned in the following form:
/.../cell_name/hosts/hostname/dts-entity If the -simplename option is
given, the cell name is not prepended to the DTS server names. The
-global option returns only DTS servers that are operating as global
servers. Names are returned in lexical order.
Privileges Required
You must have r (read) permission to the cell root directory (/.:) and
to the LAN profile.
Examples
dcecp> dts catalog /.../my_cell.goodcompany.com/hosts/frick/dts-entity
/.../my_cell.goodcompany.com/hosts/ice/dts-entity /.../my_cell.goodcom‐
pany.com/hosts/ninja/dts-entity dcecp>
dcecp> dts catalog -simplename hosts/frick/dts-entity hosts/ice/dts-
entity hosts/ninja/dts-entity dcecp>
dts configure
Configure the local dtsd as a local or global server. The syntax is as
follows: dts configure [dts_server] {-global | -notglobal}
Options
Configures the system as a global server by adding the server's entry
to the cell profile Configures the system as a local server by removing
the server's entry from the cell profile
The configure operation sets the local dtsd to be a local or global
server. You must specify either the -global or -notglobal option to
indicate whether to configure the local dtsd as a global server. The
difference is whether the server is listed in the /.:/cell-profile.
This command returns the string global or notglobal to indicate the
current (new) state of the dtsd.
Privileges Required
You must have w (write) permission on the DTS entity in order to exe‐
cute the command.
Examples
The following example sets the local dtsd to be a global DTS server:
dcecp> dts configure -global global dcecp>
dts deactivate
Changes a DTS entity from an active state to an inactive state. The
syntax is as follows: dts deactivate [dts_server]
The deactivate operation changes a DTS entity from an active state to
an inactive state. The status attribute is changed to disabled, which
tells the DTS entity to stop synchronizing. This operation returns an
empty string on success.
Privileges Required
You must have w (write) permission on the DTS entity to execute the
command.
Examples
dcecp> dts deactivate dcecp>
dts help
Returns help information about the dts object and its operations. The
syntax is as follows: dts help [operation | -verbose]
Options Displays information about the dts object.
Used without an argument or option, the dts help command returns brief
information about each dts 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 infor‐
mation about the dts object itself.
Privileges Required
No special privileges are needed to use the dts help command.
Examples
dcecp> dts help activate Activates a DTS entity. catalog
Returns a list of DTS servers in the cell. configure Config‐
ures current dtsd as 'global' or 'notglobal'. deactivate
Deactivates a DTS entity. modify Modifies attributes of
the DTS entity. show Displays attributes or counter
info of the named dtsd. stop Stops the current dtsd
process. synchronize Synchronizes the local dtsd with DTS
servers. help Prints a summary of command-line options.
operations Returns a list of the valid operations for this
command. dcecp>
dts modify
Changes attributes of dtsd processes. The syntax is as follows: dts
modify [dts_server] {-change attribute_list | -attribute value}
Options As an alternative to using the -change option with an attribute
list, you can specify individual attribute options by prepending a
hyphen (-) to any attributes listed in the ATTRIBUTES section of this
reference page. Allows you to modify attributes by using an attribute
list rather than individual attribute options. The format of an
attribute list is as follows: {{attribute value}...{attribute value}}
The modify operation changes attributes of dtsd processes. It allows
attributes to be changed with the -change option. Attribute options
are also supported for all modifiable attributes. This operation
returns an empty string on success.
Privileges Required
You must have w (write) permission on the DTS entity to execute the
command.
Examples
The following examples set the minimum number of servers needed for DTS
operation to 5 for a remote dtsd: dcecp> dts modify
ncacn_ip_tcp:130.105.1.227 -minservers 5 dcecp>
dcecp> dts modify ncacn_ip_tcp:130.105.1.227 -change {minservers 5}
dcecp>
dts operations
Returns a list of the operations supported by the dts object. The syn‐
tax is as follows: dts 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 dts operations command.
Examples
dcecp> dts operations activate catalog configure deactivate modify show
stop synchronize help operations dcecp>
dts show
Returns attribute information for the specified dtsd processes. The
syntax is as follows: dts show [dts_server] [-all | [-attributes]
[-counters]]
Options Returns only the attributes for the local dtsd process.
Returns only the counters for the local dtsd process. Return the
attributes and counters for the local dtsd process.
The show operation shows attribute information for the specified dtsd
processes. When called with the -attributes option, dts show returns
an attribute list giving the values of the attributes listed above. If
called with the -counters option counter information is returned. If
called with the -all or with both the -attributes and -counters
options, both attribute and counter information is returned. The
default behavior (invoked by using no options) is the same as if the
-attributes option was used. Attributes and counters are listed in the
order they are returned by the server.
Privileges Required
You must have r (read) permission on the DTS entity to execute the com‐
mand.
Examples
dcecp> dts show {checkinterval +0-01:30:00.000I-----} {epoch 0} {toler‐
ance +0-00:10:00.000I-----} {tdf -0-05:00:00.000I-----} {maxinaccuracy
+0-00:00:00.100I-----} {minservers 2} {queryattempts 3} {localtimeout
+0-00:00:05.000I-----} {globaltimeout +0-00:00:15.000I-----} {syncin‐
terval +0-00:02:00.000I-----} {type server} {courierrole backup} {act‐
courierrole courier} {clockadjrate 10000000 nsec/sec} {maxdriftrate
1000000 nsec/sec} {clockresolution 10000000 nsec} {version V1.0.1}
{timerep V1.0.0} {provider no} {autotdfchange no} {nexttdfchange
1994-10-30-01:00:00.000-05:00I0.000} {serverprincipal
hosts/medusa/self} {serverentry hosts/medusa/dts-entity} {servergroup
subsys/dce/dts-servers} {status enabled} {uuid
000013ed-000b-0000-b8ef-03a4fcdf00a4} dcecp>
dts stop
Stops the dtsd process. The syntax is as follows: dts stop
[dts_server]
The stop operation stops the dtsd process. This operation returns an
empty string on success.
Privileges Required
You must have w (write) permission on the DTS entity to execute the
command.
Examples
The following example stops the dtsd process on remote host named
cyclops: dcecp> dts stop /.:/hosts/cyclops/dts-entity dcecp>
dts synchronize
Causes dtsd to synchronize with DTS servers. The syntax is as follows:
dts synchronize [dts_server] [-abruptly]
Options Synchronize DTS abruptly rather than gradually adjust it to the
computed time.
The synchronize operation causes dtsd to synchronize with DTS servers.
The machine's clock is adjusted accordingly. By default, the clock is
adjusted gradually. Takes the -abruptly option to set the clock
abruptly. This operation returns an empty string on success.
Privileges Required
You must have w (write) permission on the DTS entity to execute the
command.
Examples
The following example causes the local dtsd process to synchronize with
other DTS servers in the cell: dcecp> dts synchronize dcecp>
The following example causes the dtsd process on a remote host named
cyclops to synchronize immediately with other DTS servers in the cell:
dcecp> dts synchronize /.:/hosts/cyclops/dts-entity -abruptly dcecp>
RELATED INFORMATION
Commands: dcecp(1m), dcecp_clock(1m), dcecp_utc(1m), dtsd(1m).
dts(1m)