view release on metacpan or  search on metacpan

pod/v2/afsperl.pod  view on Meta::CPAN

#------------------------------------------------------------------------------
# RCS-Id: "@(#)$RCS-Id: pod/v2/afsperl.pod 2e2ca60 Tue Apr 15 13:04:20 2014 +0200 Norbert E Gruener$"
#
# © 2001-2014 Norbert E. Gruener <nog@MPA-Garching.MPG.de>
#
# This is free software; you can redistribute it and/or modify it under
# the same terms as the Perl 5 programming language system itself.
#------------------------------------------------------------------------------

=head1 NAME

B<AFS> - Perl interface to AFS programming APIs

=head1 VERSION

This document describes the AFS module bundle (Version 2.6.4)


=head1 COMPATIBILITY

B<This release does NOT support any features and interfaces from
version 1.>

=head1 DESCRIPTION

The AFS module bundle is a dynamically loadable (where available)
extension to Perl.  It gives the AFS user and administrator access to
most of the AFS programming APIs, allowing you to make these calls
directly from Perl, rather than processing the output of a command.

The AFS module bundle is a thin layer above the low-level AFS APIs. When
possible, function names are similar to the actual API names, or to the
AFS command suite names. The ordering of function parameters is not
always the same though.

The AFS module bundle includes the following features:

=over 4

=item * Access to Basic Overseer Server routines

Methods that deal with the Basic Overseer Server (i.e, the I<bos>
command suite).  See L<AFS::BOS>.

=item * Access to Volume Server routines

Methods that deal with the Volume Server (i.e, part of the I<vos>
command suite).  See L<AFS::VOS>.

=item * Access to Volume Location Server routines

Methods that deal with the Volume Location Server (i.e, part of the
I<vos> command suite).  See L<AFS::VLDB>.

=item * Access to File Server routines

Functions that deal with the File Server (i.e, part of the I<fs>
command suite).  See L<AFS::FS>.

=item * Access to Cache Manager routines

Functions that deal with the Cache Manager (i.e, part of the I<fs>
command suite).  See L<AFS::CM>.

=item * Managing Access Control Lists

Methods to control access to directories and all of their files. (i.e,
part of the I<fs> command suite). See L<AFS::ACL>.

=item * Manipulations of the Cell Configuration

Functions that deal with Cell Configurations (i.e, part of the I<fs>
command suite).  See L<AFS::CELL>.

=item * Access to Protection Server routines

Methods that deal with the Protection Server (i.e, the I<pts> command
suite).  See L<AFS::PTS>.

=item * Access to the Authentication Server routines

Methods that deal with the Authentication Server (i.e, the I<kas>
command suite).  See L<AFS::KAS>.

=item * Access to the AFS structure ktc_token

Methods that deal with token management in the I<Kernel Token Cache>
(KTC) (i.e, the tokens command).  See L<AFS::KTC_TOKEN>.

=item * Access to the AFS structure ktc_principal

Methods that deal with principals related to tokens.  See L<AFS::KTC_PRINCIPAL>.

=item * Access to the AFS structure ktc_encryptionkey

Methods that deal with encryption keys related to tokens.  See