ptserver - Initializes the Protection Server


ptserver [-database | -db <db path>] [-afscompat [yes | no]] [-debug <debug level>] [-groupdepth | -depth <# of nested groups>] [-default_access <user access mask> <group access mask>] [-restricted] [-restrict_anonymous] [-enable_peer_stats] [-enable_process_stats] [-allow-dotted-principals] [-rxbind] [-auditlog [<file path> | yes | on]] [-audit-interface (file | syslog | sysvmq)] [-syslog[=<FACILITY>]] [-logfile <log file] [-config <configuration file] [-rxmaxmtu <bytes>] [-rxwindow <maximum window size in packets>] [-udpsize <size of socket buffer in bytes>] [-maxthreads <maximum number of worker threads>] [-threadidle <maximum idle lifetime for a worker thread in seconds>] [-help]


The ptserver command initializes the Protection Server, which must run on every database server machine. In the conventional configuration, its binary file is located in the /usr/local/libexec/yfs directory on a file server machine.

The ptserver command is not normally issued at the command shell prompt, but rather placed into a database server machine's /etc/yfs/server/BosConfig file with the bos create command. If it is ever issued at the command shell prompt, the issuer must be logged onto a file server machine as the local superuser root.

The Protection Server performs the following tasks:

When using Kerberos 5, cross-realm authentication is possible. If the special pts group system:authuser@FOREIGN.REALM exists and its group quota is greater than zero, aklog will automatically create an entry for the foreign user in the local PTS database and add the foreign user to the system:authuser@FOREIGN.REALM PTS group. Each time a foreign user is created in the local PTS database, the group quota for the system:authuser@FOREIGN.REALM PTS group is decremented by one.

This command does not use the syntax conventions of the AFS command suites. Provide the command name and all option names in full.


-afscompat [yes | no]

Ensures that no data or metadata will be accepted that prevents interoperability with AFS3-protocol clients such as OpenAFS. It does not disable the AuriStorFS protocol extensions or use of the yfs-rxgk security class.

For this service, this prevents use of the disabled, afsonly and not-authuser flags. See pts_setfields(1).

-debug <debug level>

Sets the detail level for the debugging trace written to the /var/log/yfs/PtLog file. Provide one of the following values, each of which produces an increasingly detailed trace: 0, 1, 5, 25, and 125.

-database | -db <db path>

Specifies the pathname of an alternate directory in which the Protection Database files reside. Provide the complete pathname, ending in the base filename to which the .DB0 and .DBSYS1 extensions are appended. For example, the appropriate value for the default database files is /etc/yfs/prdb.

-groupdepth | -depth <# of nested groups>

Specifies the group depth for nested groups. The default depth for nested groups is 5.

-default_access <user access> <group access>

Specifies the default user and group privacy flags to apply to each entry. Provide a string of five characters, one for each of the permissions. See pts_examine(1) or pts_setfields(1) for more information on the flags.


Run the PT Server in restricted mode. While in restricted mode, only members of the system:administrators PTS group may make any PTS changes.


Run the PT Server in restricted anonymous access mode. While in this mode, only authenticated users will be able to access the PTS database.


Activates the collection of Rx statistics and allocates memory for their storage. For each connection with a specific UDP port on another machine, a separate record is kept for each type of RPC (FetchFile, GetStatus, and so on) sent or received. To display or otherwise access the records, use the Rx Monitoring API.


Activates the collection of Rx statistics and allocates memory for their storage. A separate record is kept for each type of RPC (FetchFile, GetStatus, and so on) sent or received, aggregated over all connections to other machines. To display or otherwise access the records, use the Rx Monitoring API.


By default, the RXKAD security layer will disallow access by Kerberos principals with a dot in the first component of their name. This is to avoid the confusion where principals user/admin and user.admin are both mapped to the user.admin PTS entry. Sites whose Kerberos realms don't have these collisions between principal names may disable this check by starting the server with this option.


Bind the Rx socket to the primary interface only. (If not specified, the Rx socket will listen on all interfaces.)

-syslog[=<syslog facility>]

Specifies that logging output should go to syslog instead of the normal log file. -syslog=FACILITY can be used to specify to which facility the log message should be sent. Logging message sent to syslog are tagged with the string "ptserver".

-logfile <log file>

Sets the file to use for server logging. If logfile is not specified, and no other logging options are supplied, this will be /var/log/yfs/PTLog. Note that this option is intended for debugging and testing purposes. Changing the location of the log file from the command line may result in undesirable interactions with tools such as bos.

-config <configuration file>

Sets an alternate location for the configuration file that will be parsed for configuration options for this service. If this option is not specified, /etc/yfs/server/yfs-server.conf will be used.

-auditlog [<log path> | yes | on]

Turns on audit logging, and optionally sets the path for the audit log. The audit log records information about RPC calls, including the name of the RPC call, the host that submitted the call, the authenticated entity (user) that issued the call, the parameters for the call, and if the call succeeded or failed. If no path is specified, /var/log/yfs/PtAuditLog is used.

-audit-interface (file | syslog | sysvmq)

Specifies what audit interface to use. Defaults to file. See fileserver(8) for an explanation of each interface.

-rxmaxmtu <bytes>

Specify the maximum transmission unit (MTU) value. The value must be between the minimum (520) and maximum (16384) Rx packet sizes.

It artificially limits the maximum Rx data packet size that will be transmitted. It can be used when the maximum size that can be successfully transmitted is smaller than the reported network interface MTU.

-rxwindow <packets>

Specify the maximum sliding window size that RX may use on the wire. Larger windows improve performance on networks with a high latency, at the expense of higher memory usage. The value specified must be less than the maximum RX window size of 65535.

-udpsize <size of socket buffer in bytes>

Sets the size of the UDP buffer, which is 64 KB by default. Provide a positive integer, preferably larger than the default.

-maxthreads <maximum number of worker threads>

Specifies the maximum number of worker threads that can be started to service incoming remote procedure calls. The default is 256 for vlserver and ptserver; and 1024 for the fileserver.

-threadidle <maximum idle lifetime for a worker thread in seconds>

Specifies the maximum number of seconds that a worker thread can remain idle before it will be terminated. The default is 20 minutes (1200 seconds). This value should be increased if the server workload is known to experience a spike in the number of serviced remote procedure calls on a periodic cycle longer than the default. =item -help

Prints the online help for this command. All other valid options are ignored.


The following bos create command creates a ptserver process on the machine The command appears here on multiple lines only for legibility.

   % bos create -server -instance ptserver \
                -type simple -cmd /usr/local/libexec/yfs/ptserver


The issuer must be logged in as the superuser root on a file server machine to issue the command at a command shell prompt. It is conventional instead to create and start the process by issuing the bos create command.


BosConfig(5), prdb.DB0(5), bos_create(8), bos_getlog(8), pts(1)


IBM Corporation 2000. All Rights Reserved.

This documentation is covered by the IBM Public License Version 1.0. It was converted from HTML to POD by software written by Chas Williams and Russ Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.


"AFS" is a registered mark of International Business Machines Corporation, used under license. (USPTO Registration 1598389)

"OpenAFS" is a registered mark of International Business Machines Corporation. (USPTO Registration 4577045)

The "AuriStor" name, log 'S' brand mark, and icon are registered marks of AuriStor, Inc. (USPTO Registrations 4849419, 4849421, and 4928460) (EUIPO Registration 015539653).

"Your File System" is a registered mark of AuriStor, Inc. (USPTO Registrations 4801402 and 4849418).

"YFS" and "AuriStor File System" are trademarks of AuriStor, Inc.