NAME

AFS::Cell - Module to administer AFS Cells

SYNOPSIS

  use AFS::Cell qw (configdir expandcell
                    getcellinfo localcell
                    whichcell wscell
                   );

  my $conf_dir = configdir;

  my $cell = expandcell('mpa');
  $cell = localcell;
  $cell = whichcell('./');
  $cell = wscell;

  ($cell, my @hosts) = getcellinfo;
  print "Cell: $cell\n";
  foreach my $host (@hosts) {
      print(" $host\n");
  }

DESCRIPTION

This module provides several functions to configure and to maintain an AFS cell. It is used to maintain the configuration directory. Any function required must by explicitly listed by the use statement to be exported into the calling package.

Some of these functions have the optional argument FOLLOW. FOLLOW determines which file should be used should PATH be a symbolic link. If FOLLOW be set to 1, then the symbolic link is followed to its target. If FOLLOW is set to 0, then the function applies to the symbolic link itself. If not specified FOLLOW defaults to 1.

COMPATIBILITY

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

EXPORTS

Standard Exports

none

Optional Exports

The following functions will be exported into your namespace if you specifically ask that they be imported.

$dir = configdir;

$ok = configdir(DIR);

Gets or sets the configuration directory for an AFS server/client machine. Default is /usr/vice/etc.

$cellname = expandcell(CELL);

Expands CELL to the fully qualified cellname. Returns undef on error.

($cell @servers) = getcellinfo([CELL [,IP]]);

Gets information on CELL (default NULL) using CellServDB. If IP (default 0) is set to 1 then IP addresses will be returned instead of hostnames.

$cellname = localcell;

Returns the cellname of the local cell. Returns undef on error.

$cellname = whichcell(PATH [,FOLLOW]);

Returns the name of the cell in which the volume that houses PATH resides. Returns undef and sets CODE on error.

$cellname = wscell;

Returns the name of the local machine's home cell.

CURRENT AUTHOR

Norbert E. Gruener <nog@MPA-Garching.MPG.de>

AUTHOR EMERITUS

Roland Schemers <schemers@slapshot.stanford.edu>

COPYRIGHT AND DISCLAIMER

 Copyright (c) 2001-2010 Norbert E. Gruener <nog@MPA-Garching.MPG.de>.
 All rights reserved.

 Copyright (c) 1994 Board of Trustees, Leland Stanford Jr. University.
 All rights reserved.

Most of the explanations in this document are taken from the original AFS documentation.

 AFS-3 Programmer's Reference:
 File Server/Cache Manager Interface
 Edward R. Zayas
 Copyright (c) 1991 Transarc Corporation.
 All rights reserved.

 IBM AFS Administration Reference
 Copyright (c) IBM Corporation 2000.
 All rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The original module is covered by the following copyright:

Copyright (c) 1994 Board of Trustees, Leland Stanford Jr. University

Redistribution and use in source and binary forms are permitted provided that the above copyright notice and this paragraph are duplicated in all such forms and that any documentation, advertising materials, and other materials related to such distribution and use acknowledge that the software was developed by Stanford University. The name of the University may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

DOCUMENT VERSION

Revision $Rev: 1059 $