AFS-Command

 view release on metacpan or  search on metacpan

lib/AFS/Command/BOS.pod  view on Meta::CPAN

=over

=item Arguments

The bos help string is:

    bos getdate: get dates for programs
    Usage: bos getdate -server <machine name> -file <files to check>+ [-dir <destination dir>]
		       [-cell <cell name>] [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->getdate
      (
       # Required arguments
       server			=> $server,
       file			=> $file, # OR [ $file1, $file2, ... ]
       # Optional arguments
       dir			=> $dir,
       cell			=> $cell,
       noauth			=> 1,

lib/AFS/Command/BOS.pod  view on Meta::CPAN

=over

=item Arguments

The bos help string is:

    bos getlog: examine log file
    Usage: bos getlog -server <machine name> -file <log file to examine>
		      [-cell <cell name>] [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->getlog
      (
       # Required arguments
       server			=> $server,
       file			=> $file,
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       localauth		=> 1,

lib/AFS/Command/BOS.pod  view on Meta::CPAN

=over

=item Arguments

The bos help string is:

    bos getrestart: get restart times
    Usage: bos getrestart -server <machine name> [-cell <cell name>]
			  [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->getrestart
      (
       # Required arguments
       server			=> $server,
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       localauth		=> 1,
      );

lib/AFS/Command/BOS.pod  view on Meta::CPAN

=over

=item Arguments

The bos help string is:

    bos listhosts: get cell host list
    Usage: bos listhosts -server <machine name> [-cell <cell name>]
			 [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->listhosts
      (
       # Required arguments
       server			=> $server,
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       localauth		=> 1,
      );

lib/AFS/Command/BOS.pod  view on Meta::CPAN


=item Arguments

The bos help string is:

    bos listkeys: list keys
    Usage: bos listkeys -server <machine name> [-showkey]
			[-cell <cell name>] [-noauth] [-localauth]
    Where: -showkey    show the actual key rather than the checksum

The corresponding method invocation looks like:

    my $result = $bos->listkeys
      (
       # Required arguments
       server			=> $server,
       # Optional arguments
       showkey			=> 1,
       cell			=> $cell,
       noauth			=> 1,
       localauth		=> 1,

lib/AFS/Command/BOS.pod  view on Meta::CPAN

=over

=item Arguments

The bos help string is:

    bos listusers: list super-users
    Usage: bos listusers -server <machine name> [-cell <cell name>]
			 [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->listusers
      (
       # Required arguments
       server			=> $server,
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       localauth		=> 1,
      );

lib/AFS/Command/BOS.pod  view on Meta::CPAN


=item Arguments

The bos help string is:

    bos status: show server instance status
    Usage: bos status -server <machine name> [-instance <server process name>+]
		      [-long] [-cell <cell name>] [-noauth] [-localauth]
    Where: -long       long status

The corresponding method invocation looks like:

    my $result = $bos->status
      (
       # Required arguments
       server			=> $server,
       # Optional arguments
       instance			=> $instance, # OR [ $inst1, $inst2, ... ],
       cell			=> $cell,
       long			=> 1,
       noauth			=> 1,

lib/AFS/Command/BOS.pod  view on Meta::CPAN


=head2 addhost

The bos help string is:

    bos addhost: add host to cell dbase
    Usage: bos addhost -server <machine name> -host <host name>+
		       [-clone] [-cell <cell name>] [-noauth] [-localauth]
    Where: -clone      vote doesn't count

The corresponding method invocation looks like:

    my $result = $bos->addhost
      (
       # Required arguments
       server			=> $server,
       host			=> $host, # OR [ $host1, $host2, ... ]
       # Optional arguments
       clone			=> 1,
       cell			=> $cell,
       noauth			=> 1,

lib/AFS/Command/BOS.pod  view on Meta::CPAN

      );

=head2 addkey

The bos help string is:

    bos addkey: add keys to key dbase (kvno 999 is bcrypt)
    Usage: bos addkey -server <machine name> [-key <key>] -kvno <key version number>
		      [-cell <cell name>] [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->addkey
      (
       # Required arguments
       server			=> $server,
       kvno			=> $kvno,
       # Optional arguments
       key			=> $key,
       cell			=> $cell,
       noauth			=> 1,

lib/AFS/Command/BOS.pod  view on Meta::CPAN

      );

=head2 adduser

The bos help string is:

    bos adduser: add users to super-user list
    Usage: bos adduser -server <machine name> -user <user names>+
		       [-cell <cell name>] [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->adduser
      (
       # Required arguments
       server			=> $server,
       user			=> $user, # OR [ $user1, $user2, ... ]
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       localauth		=> 1,
      );

=head2 blockscanner

The bos help string is:

    bos blockscanner: block scanner daemon from making migration requests
    Usage: bos blockscanner -server <machine name> [-cell <cell name>]
			    [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->blockscanner
      (
       # Required arguments
       server			=> $server,
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       localauth		=> 1,
      );

=head2 create

The bos help string is:

    bos create: create a new server instance
    Usage: bos create -server <machine name> -instance <server process name>
		      -type <server type> -cmd <command lines>+ [-notifier <Notifier program>]
		      [-cell <cell name>] [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->create
      (
       # Required arguments
       server			=> $server,
       instance			=> $instance,
       type			=> $type,
       cmd			=> $cmd, # OR [ $cmd1, $cmd2, ... ]
       # Optional arguments
       notifier			=> $notifier,

lib/AFS/Command/BOS.pod  view on Meta::CPAN

      );

=head2 delete

The bos help string is:

    bos delete: delete a server instance
    Usage: bos delete -server <machine name> -instance <server process name>+
		      [-cell <cell name>] [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->delete
      (
       # Required arguments
       server			=> $server,
       instance			=> $instance, # OR [ $inst1, $inst2, ... ]
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       localauth		=> 1,
      );

=head2 exec

The bos help string is:

    bos exec: execute shell command on server
    Usage: bos exec -server <machine name> -cmd <command to execute>
		    [-cell <cell name>] [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->exec
      (
       # Required arguments
       server			=> $server,
       cmd			=> $cmd,
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       localauth		=> 1,
      );

=head2 install

The bos help string is:

    bos install: install program
    Usage: bos install -server <machine name> -file <files to install>+
		       [-dir <destination dir>] [-cell <cell name>] [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->install
      (
       # Required arguments
       server			=> $server,
       file			=> $file, # OR [ $file1, $file2, ... ]
       # Optional arguments
       dir			=> $dir,
       cell			=> $cell,
       noauth			=> 1,

lib/AFS/Command/BOS.pod  view on Meta::CPAN

The bos help string is:

    bos prune: prune server files
    Usage: bos prune -server <machine name> [-bak] [-old] [-core] [-all]
		     [-cell <cell name>] [-noauth] [-localauth]
    Where: -bak        delete .BAK files
	   -old        delete .OLD files
	   -core       delete core files
	   -all        delete all junk files

The corresponding method invocation looks like:

    my $result = $bos->prune
      (
       # Required arguments
       server			=> $server,
       # Optional arguments
       bak			=> 1,
       old			=> 1,
       core			=> 1,
       all			=> 1,

lib/AFS/Command/BOS.pod  view on Meta::CPAN

      );

=head2 removehost

The bos help string is:

    bos removehost: remove host from cell dbase
    Usage: bos removehost -server <machine name> -host <host name>+
			  [-cell <cell name>] [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->removehost
      (
       # Required arguments
       server			=> $server,
       host			=> $host, # OR [ $host1, $host2, ... ]
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       localauth		=> 1,
      );

=head2 removekey

The bos help string is:

    bos removekey: remove keys from key dbase
    Usage: bos removekey -server <machine name> -kvno <key version number>+
			 [-cell <cell name>] [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->removekey
      (
       # Required arguments
       server			=> $server,
       kvno			=> $kvno, # OR [ $kvno1, $kvno2, ... ]
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       localauth		=> 1,
      );

=head2 removeuser

The bos help string is:

    bos removeuser: remove users from super-user list
    Usage: bos removeuser -server <machine name> -user <user names>+
			  [-cell <cell name>] [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->removeuser
      (
       # Required arguments
       server			=> $server,
       user			=> $user, # OR [ $user1, $user2, ... ]
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       localauth		=> 1,

lib/AFS/Command/BOS.pod  view on Meta::CPAN

=head2 restart

The bos help string is:

    bos restart: restart processes
    Usage: bos restart -server <machine name> [-instance <instances>+] [-bosserver]
		       [-all] [-cell <cell name>] [-noauth] [-localauth]
    Where: -bosserver  restart bosserver
	   -all        restart all processes

The corresponding method invocation looks like:

    my $result = $bos->restart
      (
       # Required arguments
       server			=> $server,
       # Optional arguments
       instance			=> $instance, # OR [ $inst1, $inst2, ... ]
       bosserver		=> 1,
       all			=> 1,
       cell			=> $cell,

lib/AFS/Command/BOS.pod  view on Meta::CPAN

	   -SalvageRemote       (MR-AFS) Salvage storage systems that are not directly attached
	   -SalvageArchival     (MR-AFS) Salvage HSM storage systems
	   -IgnoreCheck         (MR-AFS) Don't perform VLDB safety check when deleting unreferenced files.
					 Only a good idea in single server cell.
	   -ForceOnLine         (MR-AFS) Force the volume to come online, even if it hasn't salvaged cleanly.
	   -UseRootDirACL       (MR-AFS) Use the root directory ACL for lost+found directory if it is created.
	   -TraceBadLinkCounts  (MR-AFS) Print out lines about volume reference count changes.
	   -DontAskFS           (MR-AFS) Don't ask fileserver to take volume offline.  THIS IS VERY DANGEROUS.
	   -rxdebug             (MR-AFS) Write out rx debug information.

The corresponding method invocation looks like:

    my $result = $bos->salvage
      (
       # Required arguments
       server			=> $server,
       # Optional arguments
       partition		=> $partition,
       volume			=> $volume,
       file			=> $file,
       all			=> 1,

lib/AFS/Command/BOS.pod  view on Meta::CPAN


=head2 setauth

The bos help string is:

    bos setauth: set authentication required flag
    Usage: bos setauth -server <machine name>
		       -authrequired <on or off: authentication required for admin requests>
		       [-cell <cell name>] [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->setauth
      (
       # Required arguments
       server			=> $server,
       authrequired		=> $authrequired,
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       localauth		=> 1,
      );

=head2 setcellname

The bos help string is:

    bos setcellname: set cell name
    Usage: bos setcellname -server <machine name> -name <cell name>
			   [-cell <cell name>] [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->setcellname
      (
       # Required arguments
       server			=> $server,
       name			=> $name,
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       localauth		=> 1,

lib/AFS/Command/BOS.pod  view on Meta::CPAN


The bos help string is:

    bos setrestart: set restart times
    Usage: bos setrestart -server <machine name> -time <time to restart server>
			  [-general] [-newbinary] [-cell <cell name>]
			  [-noauth] [-localauth]
    Where: -general    set general restart time
	   -newbinary  set new binary restart time

The corresponding method invocation looks like:

    my $result = $bos->setrestart
      (
       # Required arguments
       server			=> $server,
       time			=> $time,
       # Optional arguments
       general			=> 1,
       newbinary		=> 1,
       cell			=> $cell,

lib/AFS/Command/BOS.pod  view on Meta::CPAN


=head2 shutdown

The bos help string is:

    bos shutdown: shutdown all processes
    Usage: bos shutdown -server <machine name> [-instance <instances>+]
			[-wait] [-cell <cell name>] [-noauth] [-localauth]
    Where: -wait       wait for process to stop

The corresponding method invocation looks like:

    my $result = $bos->shutdown
      (
       # Required arguments
       server			=> $server,
       # Optional arguments
       instance			=> $instance, # OR [ $inst1, $inst2, ... ]
       wait			=> 1,
       cell			=> $cell,
       noauth			=> 1,

lib/AFS/Command/BOS.pod  view on Meta::CPAN

      );

=head2 start

The bos help string is:

    bos start: start running a server
    Usage: bos start -server <machine name> -instance <server process name>+
		     [-cell <cell name>] [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->start
      (
       # Required arguments
       server			=> $server,
       # Optional arguments
       instance			=> $instance, # OR [ $inst1, $inst2, ... ]
       cell			=> $cell,
       noauth			=> 1,
       localauth		=> 1,
      );

=head2 startup

The bos help string is:

    bos startup: start all processes
    Usage: bos startup -server <machine name> [-instance <instances>+]
		       [-cell <cell name>] [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->startup
      (
       # Required arguments
       server			=> $server,
       # Optional arguments
       instance			=> $instance, # OR [ $inst1, $inst2, ... ]
       cell			=> $cell,
       noauth			=> 1,
       localauth		=> 1,

lib/AFS/Command/BOS.pod  view on Meta::CPAN


=head2 stop

The bos help string is:

    bos stop: halt a server instance
    Usage: bos stop -server <machine name> -instance <server process name>+
		    [-wait] [-cell <cell name>] [-noauth] [-localauth]
    Where: -wait       wait for process to stop

The corresponding method invocation looks like:

    my $result = $bos->stop
      (
       # Required arguments
       server			=> $server,
       instance			=> $instance, # OR [ $inst1, $inst2, ... ]
       # Optional arguments
       wait			=> 1,
       cell			=> $cell,
       noauth			=> 1,

lib/AFS/Command/BOS.pod  view on Meta::CPAN

      );

=head2 unblockscanner

The bos help string is:

    bos unblockscanner: allow scanner daemon to make migration requests again
    Usage: bos unblockscanner -server <machine name>
			      [-cell <cell name>] [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->unblockscanner
      (
       # Required arguments
       server			=> $server,
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       localauth		=> 1,
      );

=head2 uninstall

The bos help string is:

bos uninstall: uninstall program
Usage: bos uninstall -server <machine name> -file <files to uninstall>+
                     [-dir <destination dir>] [-cell <cell name>] [-noauth] [-localauth]

The corresponding method invocation looks like:

    my $result = $bos->uninstall
      (
       # Required arguments
       server			=> $server,
       file			=> $file, # OR [ $file1, $file2, ... ]
       # Optional arguments
       dir			=> $dir,
       cell			=> $cell,
       noauth			=> 1,

lib/AFS/Command/FS.pod  view on Meta::CPAN

=item Arguments

The fs help string is:

    fs checkservers: check local cell's servers
    Usage: fs checkservers [-cell <cell to check>] [-all] [-fast]
			   [-interval <seconds between probes>]
    Where: -all   check all cells
	   -fast  just list, don't check

The corresponding method invocation looks like:

    my $result = $fs->checkservers
      (
       # Optional arguments
       cell			=> $cell,
       interval			=> $interval,
       all			=> 1,
       fast			=> 1,
      );

lib/AFS/Command/FS.pod  view on Meta::CPAN


=over

=item Arguments

The fs help string is:

    fs diskfree: show server disk space usage
    Usage: fs diskfree [-path <dir/file path>+]

The corresponding method invocation looks like:

    my $result = $fs->diskfree
      (
       # Optional arguments
       path			=> $path, # OR [ $path1, $path2, ... ]
      );

=item Return Values

This method returns an AFS::Object::CacheManager object, which

lib/AFS/Command/FS.pod  view on Meta::CPAN


=over

=item Arguments

The fs help string is:

    fs examine: display volume status
    Usage: fs examine [-path <dir/file path>+]

The corresponding method invocation looks like:

    my $result = $fs->examine
      (
       # Optional arguments
       path			=> $path, # OR [ $path1, $path2, ... ]
      );

=item Return Values

This method returns an AFS::Object::CacheManager object, which

lib/AFS/Command/FS.pod  view on Meta::CPAN

=item Arguments

The fs help string is:

    fs exportafs: enable/disable translators to AFS
    Usage: fs exportafs -type <exporter name> [-start <start/stop translator (on | off)>]
		       [-convert <convert from afs to unix mode (on | off)>]
		       [-uidcheck <run on strict 'uid check' mode (on | off)>]
		       [-submounts <allow nfs mounts to subdirs of /afs/.. (on  | off)>]

The corresponding method invocation looks like:

    my $result = $fs->exportafs
      (
       # Required arguments
       type			=> $type,	# 'nfs' is the only supported value
       # Optional arguments
       start			=> $start,	# 'on' or 'off'
       convert			=> $convert,	# 'on' or 'off'
       uidcheck			=> $uidcheck,	# 'on' or 'off'
       submounts		=> $submounts,	# 'on' or 'off'

lib/AFS/Command/FS.pod  view on Meta::CPAN


=over

=item Arguments

The fs help string is:

    fs getcacheparms: get cache usage info
    Usage: fs getcacheparms

The corresponding method invocation looks like:

    my $result = $fs->getcacheparms();

=item Return Values

This method returns an AFS::Object::CacheManager object with one or
more attributes.

    my $result = $fs->getcacheparms() || die $fs->errors();
    my $used = $result->used();

lib/AFS/Command/FS.pod  view on Meta::CPAN


=over

=item Arguments

The fs help string is:

    fs getcellstatus: get cell status
    Usage: fs getcellstatus -cell <cell name>+

The corresponding method invocation looks like:

    my $result = $fs->getcellstatus
      (
       # Required arguments
       cell			-> $cell, # OR [ $cell1, $cell2, ... ]
      );

=item Return Values

This method returns an AFS::Object::CacheManager object which contains

lib/AFS/Command/FS.pod  view on Meta::CPAN


=over

=item Arguments

The fs help string is:

    fs getclientaddrs: get client network interface addresses
    Usage: fs getclientaddrs

The corresponding method invocation looks like:

    my $result = $fs->getclientaddrs();

=item Return Values

This method returns an AFS::Object::CacheManager object with one attribute.

    my $result = $fs->getclientaddrs() || die $fs->errors();
    print "This client has the following addressed configured for AFS:\n";
    foreach my $address ( @{$result->addresses()} ) {

lib/AFS/Command/FS.pod  view on Meta::CPAN


=over

=item Arguments

The fs help string is:

    fs getcrypt: set cache manager encryption flag
    Usage: fs getcrypt

The corresponding method invocation looks like:

    my $result = $fs->getcrypt();

=item Return Values

This method returns an AFS::Object::CacheManager object with one attribute.

    my $result = $fs->getcrypt() || die $fs->errors();
    print "This client has encryption turned " . ( $result->crypt() ? "on" : "off" ) . "\n";

lib/AFS/Command/FS.pod  view on Meta::CPAN


=item Arguments

The fs help string is:

    fs getserverprefs: get server ranks
    Usage: fs getserverprefs [-file <output to named file>] [-numeric] [-vlservers]
    Where: -numeric    addresses only
	   -vlservers  VL servers

The corresponding method invocation looks like:

    my $result = $fs->getserverprefs
      (
       # Optional arguments
       file			=> $file,
       numeric			=> 1,
       vlservers		=> 1,
      );

=item Return Values

lib/AFS/Command/FS.pod  view on Meta::CPAN


=item Arguments

The fs help string is:

    fs listacl: list access control list
    Usage: fs listacl [-path <dir/file path>+] [-id] [-if]
    Where: -id  initial directory acl
	   -if  initial file acl

The corresponding method invocation looks like:

    my $result = $fs->listacl
      (
       # Required arguments
       path			=> $path, # OR [ $path1, $path2, ... ]
       # Optional arguments
       id			=> 1,
       if			=> 1,
      );

lib/AFS/Command/FS.pod  view on Meta::CPAN


=over

=item Arguments

The fs help string is:

    fs listaliases: list configured cell aliases
    Usage: fs listaliases

The corresponding method invocation looks like:

    my $result = $fs->listaliases();

=item Return Values

This method returns an AFS::Object::CacheManager object, which
contains one or more AFS::Object::Cell objects.

    my $result = $fs->listaliases() || die $fs->errors();
    foreach my $cellobj ( $result->getCells() ) {

lib/AFS/Command/FS.pod  view on Meta::CPAN

=over

=item Arguments

The fs help string is:

    fs listcells: list configured cells
    Usage: fs listcells [-numeric]
    Where: -numeric  addresses only

The corresponding method invocation looks like:

    my $result = $fs->listcells
      (
       # Optional arguments
       numeric			=> 1,
      );

=item Return Values

This method returns an AFS::Object::CacheManager object, which

lib/AFS/Command/FS.pod  view on Meta::CPAN


=over

=item Arguments

The fs help string is:

    fs listquota: list volume quota
    Usage: fs listquota [-path <dir/file path>+]

The corresponding method invocation looks like:

    my $result = $fs->listquota
      (
       # Optional arguments
       path			=> $path, # OR [ $path1, $path2, ... ]
      );

=item Return Values

=back

lib/AFS/Command/FS.pod  view on Meta::CPAN


=over

=item Arguments

The fs help string is:

    fs lsmount: list mount point
    Usage: fs lsmount -dir <directory>+

The corresponding method invocation looks like:

    my $result = $fs->lsmount
      (
       # Required arguments
       dir			=> $dir, # OR [ $dir1, $dir2, ... ]
      );

=item Return Values

This method returns an AFS::Object::CacheManager object, which

lib/AFS/Command/FS.pod  view on Meta::CPAN


=over

=item Arguments

The fs help string is:

    fs quota: show volume quota usage
    Usage: fs quota [-path <dir/file path>+]

The corresponding method invocation looks like:

    my $result = $fs->quota
      (
       # Optional arguments
       path			=> $path, # OR [ $path1, $path2, ... ]
      );

=item Return Values

This method returns an AFS::Object::CacheManager object, which

lib/AFS/Command/FS.pod  view on Meta::CPAN

=item Arguments

The fs help string is:

    fs storebehind: store to server after file close
    Usage: fs storebehind [-kbytes <asynchrony for specified names>]
			  [-files <specific pathnames>+] [-allfiles <new default (KB)>]
			  [-verbose]
    Where: -verbose  show status

The corresponding method invocation looks like:

    my $result = $fs->storebehind
      (
       # Optional arguments
       kbytes			=> $kbytes,
       files			=> $file, # OR [ $file1, $file2, ... ]
       allfiles			=> $default,
       verbose			=> 1,
      );

lib/AFS/Command/FS.pod  view on Meta::CPAN


=over

=item Arguments

The fs help string is:

    fs sysname: get/set sysname (i.e. @sys) value
    Usage: fs sysname [-newsys <new sysname>+]

The corresponding method invocation looks like:

    my $result = $fs->sysname
      (
       # Optional arguments
       newsys			=> $sysname, # OR [ $sysname1, $sysname2, ... ]
      );

=item Return Values

This method returns an AFS::Object::CacheManager object which has one

lib/AFS/Command/FS.pod  view on Meta::CPAN


=over

=item Arguments

The fs help string is:

    fs whereis: list file's location
    Usage: fs whereis [-path <dir/file path>+]

The corresponding method invocation looks like:

    my $result = $fs->whereis
      (
       # Optional arguments
       path			=> $path, # OR [ $path1, $path2, ... ]
      );

=item Return Values

This method returns an AFS::Object::CacheManager object, which

lib/AFS/Command/FS.pod  view on Meta::CPAN


=over

=item Arguments

The fs help string is:

    fs whichcell: list file's cell
    Usage: fs whichcell [-path <dir/file path>+]

The corresponding method invocation looks like:

    my $result = $fs->whichcell
      (
       # Optional arguments
       path			=> $path, # OR [ $path1, $path2, ... ]
      );

=item Return Values

This method returns an AFS::Object::CacheManager object, which

lib/AFS/Command/FS.pod  view on Meta::CPAN


=over

=item Arguments

The fs help string is:

    fs wscell: list workstation's cell
    Usage: fs wscell

The corresponding method invocation looks like:

    my $result = $fs->wscell();

=item Return Values

This method returns an AFS::Object::CacheManager object which has one
attribute.

    my $result = $fs->wscell() || die $fs->errors();
    print "This client lives in cell '" . $result->cell() . "'\n";

lib/AFS/Command/FS.pod  view on Meta::CPAN


=head1 METHODS (with simple return values)

=head2 checkvolumes

The fs help string is:

    fs checkvolumes: check volumeID/name mappings
    Usage: fs checkvolumes

The corresponding method invocation looks like:

    my $result = $fs->checkvolumes();

=head2 cleanacl

The fs help string is:

    fs cleanacl: clean up access control list
    Usage: fs cleanacl [-path <dir/file path>+]

The corresponding method invocation looks like:

    my $result = $fs->cleanacl
      (
       # Optional arguments
       path			=> $path, # OR [ $path1, $path2, ... ]
      );

=head2 copyacl

The fs help string is:

    fs copyacl: copy access control list
    Usage: fs copyacl -fromdir <source directory (or DFS file)>
		      -todir <destination directory (or DFS file)>+
		      [-clear] [-id] [-if]
    Where: -clear  first clear dest access list
	   -id     initial directory acl
	   -if     initial file acl

The corresponding method invocation looks like:

    my $result = $fs->copyacl
      (
       # Required arguments
       fromdir			=> $fromdir,
       todir			=> $todir, # OR [ $todir1, $todir2, ... ]
       # Optional arguments
       clear			=> 1,
       id			=> 1,
       if			=> 1,
      );

=head2 flush

The fs help string is:

    fs flush: flush file from cache
    Usage: fs flush [-path <dir/file path>+]

The corresponding method invocation looks like:

    my $result = $fs->flush
      (
       # Optional arguments
       path			=> $path, # OR [ $path1, $path2, ... ]
      );

=head2 flushmount

The fs help string is:

    fs flushmount: flush mount symlink from cache
    Usage: fs flushmount [-path <dir/file path>+]

The corresponding method invocation looks like:

    my $result = $fs->flushmount
      (
       # Optional arguments
       path			=> $path, # OR [ $path1, $path2, ... ]
      );

=head2 flushvolume

The fs help string is:

    fs flushvolume: flush all data in volume
    Usage: fs flushvolume [-path <dir/file path>+]

The corresponding method invocation looks like:

    my $result = $fs->flushvolume
      (
       # Optional arguments
       path			=> $path, # OR [ $path1, $path2, ... ]
      );

=head2 messages

The fs help string is:

    fs messages: control Cache Manager messages
    Usage: fs messages [-show <[user|console|all|none]>]

The corresponding method invocation looks like:

    my $result = $fs->messages
      (
       # Optional arguments
       show			=> $show,
      );

=head2 mkmount

The fs help string is:

    fs mkmount: make mount point
    Usage: fs mkmount -dir <directory> -vol <volume name> [-cell <cell name>] [-rw] [-fast]
    Where: -rw    force r/w volume
	   -fast  don't check name with VLDB

The corresponding method invocation looks like:

    my $result = $fs->mkmount
      (
       # Required arguments
       dir			=> $dir,
       vol			=> $vol,
       # Optional arguments
       cell			=> $cell,
       rw			=> 1,
       fast			=> 1,
      );

=head2 newalias

The fs help string is:

    fs newalias: configure new cell alias
    Usage: fs newalias -alias <alias name> -name <real name of cell>

The corresponding method invocation looks like:

    my $result = $fs->newalias
      (
       # Required arguments
       alias			=> $alias,
       name			=> $name,
      );

=head2 newcell

The fs help string is:

    fs newcell: configure new cell
    Usage: fs newcell -name <cell name> -servers <primary servers>+
		      [-linkedcell <linked cell name>]

The corresponding method invocation looks like:

    my $result = $fs->newcell
      (
       # Required arguments
       name			=> $name,
       servers			=> $server, # OR [ $server1, $server2, ... ]
       # Optional arguments
       linkedcell		=> $linkedcell,
      );

=head2 rmmount

The fs help string is:

    fs rmmount: remove mount point
    Usage: fs rmmount -dir <directory>+

The corresponding method invocation looks like:

    my $result = $fs->rmmount
      (
       # Required arguments
       dir			=> $dir, # OR [ $dir1, $dir2, ... ]
      );

=head2 rxstatpeer

The fs help string is:

    fs rxstatpeer: Manage per peer RX statistics
    Usage: fs rxstatpeer [-enable] [-disable] [-clear]
    Where: -enable   Enable RX stats
	   -disable  Disable RX stats
	   -clear    Clear RX stats

The corresponding method invocation looks like:

    my $result = $fs->rxstatpeer
      (
       # Optional arguments
       enable			=> 1,
       disable			=> 1,
       clear			=> 1,
      );

=head2 rxstatproc

The fs help string is:

    fs rxstatproc: Manage per process RX statistics
    Usage: fs rxstatproc [-enable] [-disable] [-clear]
    Where: -enable   Enable RX stats
	   -disable  Disable RX stats
	   -clear    Clear RX stats

The corresponding method invocation looks like:

    my $result = $fs->rxstatproc
      (
       # Optional arguments
       enable			=> 1,
       disable			=> 1,
       clear			=> 1,
      );

=head2 setacl

lib/AFS/Command/FS.pod  view on Meta::CPAN

The fs help string is:

    fs setacl: set access control list
    Usage: fs setacl -dir <directory>+ -acl <access list entries>+
		     [-clear] [-negative] [-id] [-if]
    Where: -clear     clear access list
	   -negative  apply to negative rights
	   -id        initial directory acl (DFS only)
	   -if        initial file acl (DFS only)

The corresponding method invocation looks like:

    my $result = $fs->setacl
      (
       # Required arguments
       dir			=> $dir, # OR [ $dir1, $dir2, ... ]
       acl			=> [ <<see below>> ],
       # Optional arguments
       clear			=> 1,
       negative			=> 1,
       id			=> 1,

lib/AFS/Command/FS.pod  view on Meta::CPAN

calls, but not yet...

=head2 setcachesize

The fs help string is:

    fs setcachesize: set cache size
    Usage: fs setcachesize [-blocks <size in 1K byte blocks (0 => reset)>] [-reset]
    Where: -reset  reset size back to boot value

The corresponding method invocation looks like:

    my $result = $fs->setcachesize
      (
       # Optional arguments
       blocks			=> $blocks,
       reset			=> 1,
      );

=head2 setcell

The fs help string is:

    fs setcell: set cell status
    Usage: fs setcell -cell <cell name>+ [-suid] [-nosuid]
    Where: -suid    allow setuid programs
	   -nosuid  disallow setuid programs

The corresponding method invocation looks like:

    my $result = $fs->setcell
      (
       # Required arguments
       cell			=> $cell, # OR [ $cell1, $cell2, ... ]
       # Optional arguments
       suid			=> 1,
       nosuid			=> 1,
      );

=head2 setclientaddrs

The fs help string is:

    fs setclientaddrs: set client network interface addresses
    Usage: fs setclientaddrs [-address <client network interfaces>+]

The corresponding method invocation looks like:

    my $result = $fs->setclientaddrs
      (
       # Required arguments
       address			=> $address, # OR [ $address1, $address2, ... ]
      );

=head2 setcrypt

The fs help string is:

    fs setcrypt: set cache manager encryption flag
    Usage: fs setcrypt -crypt <on or off>

The corresponding method invocation looks like:

    my $result = $fs->setcrypt
      (
       # Required arguments
       crypt			=> 1,
      );

=head2 setquota

The fs help string is:

    fs setquota: set volume quota
    Usage: fs setquota [-path <dir/file path>] -max <max quota in kbytes>

The corresponding method invocation looks like:

    my $result = $fs->setquota
      (
       # Required arguments
       max			=> $max,
       # Optional arguments
       path			=> $path, # OR [ $path1, $path2, ... ]
      );

=head2 setserverprefs

The fs help string is:

    fs setserverprefs: set server ranks
    Usage: fs setserverprefs [-servers <fileserver names and ranks>+]
			     [-vlservers <VL server names and ranks>+]
			     [-file <input from named file>] [-stdin]
    Where: -stdin  input from stdin

The corresponding method invocation looks like:

    my $result = $fs->setserverprefs
      (
       # Optional arguments
       servers			=> $server, # OR [ $server1, $server2, ... ]
       vlservers		=> $vlserver, # OR [ $vlserver1, $vlserver2, ... ]
       file			=> $file,
       stdin			=> 1,
      );

=head2 setvol

The fs help string is:

    fs setvol: set volume status
    Usage: fs setvol [-path <dir/file path>+] [-max <disk space quota in 1K units>]
		     [-offlinemsg <offline message>]

The corresponding method invocation looks like:

    my $result = $fs->setvol
      (
       # Optional arguments
       path			=> $path, # OR [ $path1, $path2, ... ]
       max			=> $max,
       offlinemsg   		=> $offlinemsg,
      );

=head1 SEE ALSO

lib/AFS/Command/PTS.pod  view on Meta::CPAN


=item Arguments

The pts help string is:

    pts creategroup: create a new group
    Usage: pts creategroup -name <group name>+ [-owner <owner of the group>]
			   [-id <id (negated) for the group>+]
			   [-cell <cell name>] [-noauth] [-force]

The corresponding method invocation looks like:

    my $result = $pts->creategroup
      (
       # Required arguments
       name			=> $name, # OR [ $name1, $name2, ... ]
       # Optional arguments
       owner			=> $owner,
       id			=> $id, # OR [ $id1, $id2, ... ]
       cell			=> $cell,
       noauth			=> 1,

lib/AFS/Command/PTS.pod  view on Meta::CPAN

=over

=item Arguments

The pts help string is:

    pts createuser: create a new user
    Usage: pts createuser -name <user name>+ [-id <user id>+]
			  [-cell <cell name>] [-noauth] [-force]

The corresponding method invocation looks like:

    my $result = $pts->createuser
      (
       # Required arguments
       name			=> $name, # OR [ $name1, $name2, ... ]
       # Optional arguments
       owner			=> $owner,
       id			=> $id, # OR [ $id1, $id2, ... ]
       cell			=> $cell,
       noauth			=> 1,

lib/AFS/Command/PTS.pod  view on Meta::CPAN

=over

=item Arguments

The pts help string is:

    pts examine: examine an entry
    Usage: pts examine -nameorid <user or group name or id>+
		       [-cell <cell name>] [-noauth] [-force]

The corresponding method invocation looks like:

    my $result = $pts->examine
      (
       # Required arguments
       nameorid			=> $nameorid, # OR [ $nameorid1, $nameorid2, ... ]
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       force			=> 1,
      );

lib/AFS/Command/PTS.pod  view on Meta::CPAN

=item Arguments

The pts help string is:

    pts listentries: list users/groups in the protection database
    Usage: pts listentries [-users] [-groups] [-cell <cell name>]
			   [-noauth] [-force]
    Where: -users   list user entries
	   -groups  list group entries

The corresponding method invocation looks like:

    my $result = $pts->listentries
      (
       # Optional arguments
       users			=> 1,
       groups			=> 1,
       cell			=> $cell,
       noauth			=> 1,
       force			=> 1,
      );

lib/AFS/Command/PTS.pod  view on Meta::CPAN


=over

=item Arguments

The pts help string is:

    pts listmax: list max id
    Usage: pts listmax [-cell <cell name>] [-noauth] [-force]

The corresponding method invocation looks like:

    my $result = $pts->listmax
      (
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       force			=> 1,
      );

=item Return Values

lib/AFS/Command/PTS.pod  view on Meta::CPAN

=over

=item Arguments

The pts help string is:

    pts listowned: list groups owned by an entry or zero id gets orphaned groups
    Usage: pts listowned -nameorid <user or group name or id>+
			 [-cell <cell name>] [-noauth] [-force]

The corresponding method invocation looks like:

    my $result = $pts->listowned
      (
       # Required arguments
       nameorid			=> $nameorid, # OR [ $nameorid1, $nameorid2, ... ]
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       force			=> 1,
      );

lib/AFS/Command/PTS.pod  view on Meta::CPAN

=over

=item Arguments

The pts help string is:

    pts membership: list membership of a user or group
    Usage: pts membership -nameorid <user or group name or id>+
			  [-cell <cell name>] [-noauth] [-force]

The corresponding method invocation looks like:

    my $result = $pts->membership
      (
       # Required arguments
       nameorid			=> $nameorid, # OR [ $nameorid1, $nameorid2, ... ]
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       force			=> 1,
      );

lib/AFS/Command/PTS.pod  view on Meta::CPAN

value, if they succeed or fail.

=head2 adduser

The pts help string is:

    pts adduser: add a user to a group
    Usage: pts adduser -user <user name>+ -group <group name>+
		       [-cell <cell name>] [-noauth] [-force]

The corresponding method invocation looks like:

    my $result = $pts->adduser
      (
       # Required arguments
       user			=> $user, # OR [ $user1, $user2, ... ]
       group			=> $group, # OR [ $group1, $group2, ... ]
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       force			=> 1,
      );

=head2 chown

The pts help string is:

    pts chown: change ownership of a group
    Usage: pts chown -name <group name> -owner <new owner>
		     [-cell <cell name>] [-noauth] [-force]

The corresponding method invocation looks like:

    my $result = $pts->chown
      (
       # Required arguments
       name			=> $name,
       owner			=> $owner,
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       force			=> 1,
      );

=head2 delete

The pts help string is:

    pts delete: delete a user or group from database
    Usage: pts delete -nameorid <user or group name or id>+
		      [-cell <cell name>] [-noauth] [-force]

The corresponding method invocation looks like:

    my $result = $pts->delete
      (
       # Required arguments
       nameorid			=> $nameorid, # OR [ $nameorid1, $nameorid2, ... ]
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       force			=> 1,
      );

=head2 removeuser

The pts help string is:

    pts removeuser: remove a user from a group
    Usage: pts removeuser -user <user name>+ -group <group name>+
			  [-cell <cell name>] [-noauth] [-force]

The corresponding method invocation looks like:

    my $result = $pts->removeuser
      (
       # Required arguments
       user			=> $user, # OR [ $user1, $user2, ... ]
       group			=> $group, # OR [ $group1, $group2, ... ]
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       force			=> 1,
      );

=head2 rename

The pts help string is:

    pts rename: rename user or group
    Usage: pts rename -oldname <old name> -newname <new name>
		      [-cell <cell name>] [-noauth] [-force]

The corresponding method invocation looks like:

    my $result = $pts->rename
      (
       # Required arguments
       oldname			=> $oldname,
       newname			=> $newname,
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       force			=> 1,

lib/AFS/Command/PTS.pod  view on Meta::CPAN


=head2 setfields

The pts help string is:

pts setfields: set fields for an entry
Usage: pts setfields -nameorid <user or group name or id>+ [-access <set privacy flags>]
                     [-groupquota <set limit on group creation>]
                     [-cell <cell name>] [-noauth] [-force]

The corresponding method invocation looks like:

    my $result = $pts->setfields
      (
       # Required arguments
       nameorid			=> $nameorid, # OR [ $nameorid1, $nameorid2, ... ]
       # Optional arguments
       access			=> $access,
       groupquota		=> $groupquota,
       cell			=> $cell,
       noauth			=> 1,

lib/AFS/Command/PTS.pod  view on Meta::CPAN

      );

=head2 setmax

The pts help string is:

    pts setmax: set max id
    Usage: pts setmax [-group <group max>] [-user <user max>]
		      [-cell <cell name>] [-noauth] [-force]

The corresponding method invocation looks like:

    my $result = $pts->setmax
      (
       # Optional arguments
       user			=> $user,
       group			=> $group,
       cell			=> $cell,
       noauth			=> 1,
       force			=> 1,
      );

lib/AFS/Command/VOS.pod  view on Meta::CPAN


=head2 dump

The vos help string is:

    vos dump: dump a volume
    Usage: vos dump -id <volume name or ID> [-time <dump from time>] [-file <dump file>]
		    [-server <server>] [-partition <partition>] [-cell <cell name>]
		    [-noauth] [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->dump
      (
       # Required arguments
       id			=> $id,
       file			=> $file, # SPECIAL CASE!!! (see below)
       # Optional arguments
       time			=> $time,
       server			=> $server,
       partition		=> $partition,

lib/AFS/Command/VOS.pod  view on Meta::CPAN

    Usage: vos restore -server <machine name> -partition <partition name>
		       -name <name of volume to be restored> [-file <dump file>]
		       [-id <volume ID>] [-overwrite <abort | full | incremental>]
		       [-offline] [-readonly]
                       [-creation <dump | keep | new>] [-lastupdate <dump | keep | new>]
                       [-cell <cell name>] [-noauth]
		       [-localauth] [-verbose] [-encrypt]
    Where: -offline    leave restored volume offline
	   -readonly   make restored volume read-only

The corresponding method invocation looks like:

    my $result = $vos->restore
      (
       # Required arguments
       server			=> $server,
       partition		=> $partition,
       name			=> $name,
       file			=> $file, # SPECIAL CASE!!! (see below)
       # Optional arguments
       id			=> $id,

lib/AFS/Command/VOS.pod  view on Meta::CPAN


=item Arguments

The vos help string is:

    vos examine: everything about the volume
    Usage: vos examine -id <volume name or ID> [-extended] [-cell <cell name>]
                       [-noauth] [-localauth] [-verbose] [-encrypt]
    Where: -extended   list extended volume fields

The corresponding method invocation looks like:

    my $result = $vos->examine
      (
       # Required arguments
       id			=> $id,
       # Optional arguments
       cell			=> $cell,
       extended			=> 1,
       noauth			=> 1,
       localauth		=> 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN


The vos help string is:

    vos listaddrs: list the IP address of all file servers registered in the VLDB
    Usage: vos listaddrs [-uuid <uuid of server>] [-host <address of host>]
			 [-noresolve] [-printuuid] [-cell <cell name>] [-noauth]
			 [-localauth] [-verbose] [-encrypt] 
    Where: -noresolve  don't resolve addresses
	   -printuuid  print uuid of hosts

The corresponding method invocation looks like:

    my $result = $vos->listaddrs
      (
       # Optional arguments
       uuid			=> $uuid,
       host			=> $host,
       noresolve		=> 1,
       printuuid		=> 1,
       cell			=> $cell,
       noauth			=> 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN

=over

=item Arguments

The vos help string is:

    vos listpart: list partitions
    Usage: vos listpart -server <machine name> [-cell <cell name>] [-noauth]
			[-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->listpart
      (
       # Required arguments
       server			=> $server,
       # Optional arguments
       cell			=> $cell,
       noauth			=> 1,
       localauth		=> 1,
       verbose			=> 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN

The vos help string is:

    vos listvldb: list volumes in the VLDB
    Usage: vos listvldb [-name <volume name or ID>] [-server <machine name>]
			[-partition <partition name>] [-locked] [-quiet] [-nosort]
			[-cell <cell name>] [-noauth] [-localauth] [-verbose] [-encrypt] 
    Where: -locked     locked volumes only
	   -quiet      generate minimal information
	   -nosort     do not alphabetically sort the volume names

The corresponding method invocation looks like:

    my $result = $vos->listvldb
      (
       # Optional arguments
       name			=> $name,
       server			=> $server,
       partition		=> $partition,
       locked			=> 1,
       quiet			=> 1,
       nosort			=> 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN


    vos listvol: list volumes on server (bypass VLDB)
    Usage: vos listvol -server <machine name> [-partition <partition name>]
		       [-fast] [-long] [-quiet] [-extended] [-cell <cell name>]
		       [-noauth] [-localauth] [-verbose] [-encrypt] 
    Where: -fast       minimal listing
	   -long       list all normal volume fields
	   -quiet      generate minimal information
	   -extended   list extended volume fields

The corresponding method invocation looks like:

    my $result = $vos->listvol
      (
       # Required arguments
       server			=> $server,
       # Optional arguments
       partition		=> $partition,
       fast			=> 1,
       long			=> 1,
       quiet			=> 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN


=item Arguments

The vos help string is:

    vos partinfo: list partition information
    Usage: vos partinfo -server <machine name> [-partition <partition name>]
			[-cell <cell name>] [-noauth] [-localauth]
			[-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->partinfo
      (
       # Required arguments
       server			=> $server,
       # Optional arguments
       partition		=> $partition,
       cell                     => $cell,
       noauth                   => 1,
       localauth                => 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN

=over

=item Arguments

The vos help string is:

    vos status: report on volser status
    Usage: vos status -server <machine name> [-cell <cell name>] [-noauth]
		      [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->status
      (
       # Required arguments
       server			=> $server,
       # Optional arguments
       cell                     => $cell,
       noauth                   => 1,
       localauth                => 1,
       verbose                  => 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN


=head2 addsite

The vos help string is:

    vos addsite: add a replication site
    Usage: vos addsite -server <machine name for new site> -partition <partition name for new site>
		       -id <volume name or ID> [-cell <cell name>]
		       [-noauth] [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->addsite
      (
       # Required arguments
       server			=> $server,
       partition		=> $partition,
       id			=> $id,
       # Optional arguments
       cell                     => $cell,
       noauth                   => 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN

      );

=head2 backup

The vos help string is:

    vos backup: make backup of a volume
    Usage: vos backup -id <volume name or ID> [-cell <cell name>]
		      [-noauth] [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->backup
      (
       # Required arguments
       id			=> $id,
       # Optional arguments
       cell                     => $cell,
       noauth                   => 1,
       localauth                => 1,
       verbose                  => 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN

The vos help string is:

    vos backupsys: en masse backups
    Usage: vos backupsys [-prefix <common prefix on volume(s)>+] [-server <machine name>]
			 [-partition <partition name>] [-exclude]
			 [-xprefix <negative prefix on volume(s)>+] [-dryrun]
			 [-cell <cell name>] [-noauth] [-localauth] [-verbose] [-encrypt]
    Where: -exclude    exclude common prefix volumes
	   -dryrun     no action

The corresponding method invocation looks like:

    my $result = $vos->backupsys
      (
       # Optional arguments
       prefix			=> $prefix, # OR [ $prefix1, $prefix2, ... ]
       server			=> $server,
       partition		=> $partition,
       exclude			=> 1,
       prefix			=> $xprefix, # OR [ $xprefix1, $xprefix2, ... ]
       dryrun			=> 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN

=head2 changeaddr

The vos help string is:

    vos changeaddr: change the IP address of a file server
    Usage: vos changeaddr -oldaddr <original IP address> [-newaddr <new IP address>]
			  [-remove] [-cell <cell name>] [-noauth]
			  [-localauth] [-verbose] [-encrypt]
    Where: -remove     remove the IP address from the VLDB

The corresponding method invocation looks like:

    my $result = $vos->changeaddr
      (
       # Required arguments
       oldaddr			=> $oldaddr,
       # Optional arguments
       newaddr			=> $newaddr,
       remove			=> 1,
       cell                     => $cell,
       noauth                   => 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN

=head2 changeloc

The vos help string is:

    vos changeloc: change an RW volume's location in the VLDB
    Usage: vos changeloc -server <machine name for new location>
			 -partition <partition name for new location>
			 -id <volume name or ID> [-cell <cell name>] [-noauth]
			 [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->changeloc
      (
       # Required arguments
       server			=> $server,
       partition		=> $partition,
       id			=> $id,
       # Optional arguments
       cell                     => $cell,
       noauth                   => 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN


The vos help string is:

    vos clone: make clone of a volume
    Usage: vos clone -id <volume name or ID> 
      [-server <server>] [-partition <partition>] 
      [-toname <volume name on destination>] [-toid <volume ID on destination>] 
      [-offline] [-readonly] [-cell <cell name>] [-noauth] 
      [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->clone
      (
       # Required arguments
       id           => $id,
       # Optional arguments
       server       => $server,
       partition    => $partition,
       toname       => $newname,
       toid         => $newid,

lib/AFS/Command/VOS.pod  view on Meta::CPAN


=head2 convertROtoRW

The vos help string is:

    vos convertROtoRW: convert a RO volume into a RW volume (after loss of old RW volume)
    Usage: vos convertROtoRW -server <machine name> -partition <partition name> 
       -id <volume name or ID> [-force] [-cell <cell name>] [-noauth]
       [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->convertROtoRW
      (
       # Required arguments
       server     => $server,
       partition  => $partition,
       id             => $id,
       # Optional arguments
       cell                     => $cell,
       noauth                   => 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN


The vos help string is:

    vos copy: copy a volume
    Usage: vos copy -id <volume name or ID on source> -fromserver <machine name on source> 
       -frompartition <partition name on source> -toname <volume name on destination> 
       -toserver <machine name on destination> -topartition <partition name on destination> 
       [-offline] [-readonly] [-live] [-cell <cell name>] [-noauth] 
       [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->copy
      (
       # Required arguments
       id             => $id,
       fromserver     => $server,
       frompartition  => $partition,
       toname         => $name
       toserver       => $newserver,
       topartition    => $newpartition,

lib/AFS/Command/VOS.pod  view on Meta::CPAN


=head2 create

The vos help string is:

    vos create: create a new volume
    Usage: vos create -server <machine name> -partition <partition name>
		      -name <volume name> [-maxquota <initial quota (KB)>]
		      [-cell <cell name>] [-noauth] [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->create
      (
       # Required arguments
       server			=> $server,
       partition		=> $partition,
       name			=> $name,
       # Optional arguments
       maxquota			=> $maxquota,
       cell                     => $cell,

lib/AFS/Command/VOS.pod  view on Meta::CPAN

=head2 delentry

The vos help string is:

    vos delentry: delete VLDB entry for a volume
    Usage: vos delentry [-id <volume name or ID>+]
			[-prefix <prefix of the volume whose VLDB entry is to be deleted>]
			[-server <machine name>] [-partition <partition name>]
			[-cell <cell name>] [-noauth] [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->delentry
      (
       # Optional arguments
       id			=> $id, # OR [ $id1, $id2, ... ]
       prefix			=> $prefix,
       server			=> $server,
       partition		=> $partition,
       cell                     => $cell,
       noauth                   => 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN

      );

=head2 lock

The vos help string is:

    vos lock: lock VLDB entry for a volume
    Usage: vos lock -id <volume name or ID> [-cell <cell name>]
		    [-noauth] [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->lock
      (
       # Required arguments
       id			=> $id,
       # Optional arguments
       cell                     => $cell,
       noauth                   => 1,
       localauth                => 1,
       verbose                  => 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN


The vos help string is:

    vos move: move a volume
    Usage: vos move -id <volume name or ID> -fromserver <machine name on source>
		    -frompartition <partition name on source>
		    -toserver <machine name on destination>
		    -topartition <partition name on destination> [-cell <cell name>]
		    [-noauth] [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->move
      (
       # Required arguments
       id			=> $id,
       fromserver		=> $fromserver,
       frompartition		=> $frompartition,
       toserver			=> $toserver,
       topartition		=> $topartition,
       # Optional arguments

lib/AFS/Command/VOS.pod  view on Meta::CPAN


=head2 offline

The vos help string is:

    Usage: vos offline -server <server name> -partition <partition name>
 		       -id <volume name or ID> [-sleep <seconds to sleep>]
                       [-busy] [-cell <cell name>]
 		       [-noauth] [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->offline
      (
       # Required arguments
       id			=> $id,
       server			=> $server,
       partition		=> $partition,
       # Optional arguments
       sleep			=> $sleep,
       busy			=> 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN

      );

=head2 online

The vos help string is:

    Usage: vos online -server <server name> -partition <partition name>
		      -id <volume name or ID> [-cell <cell name>]
		      [-noauth] [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->online
      (
       # Required arguments
       id			=> $id,
       server			=> $server,
       partition		=> $partition,
       # Optional arguments
       cell                     => $cell,
       noauth                   => 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN


=head2 release

The vos help string is:

    vos release: release a volume
    Usage: vos release -id <volume name or ID> [-force] [-cell <cell name>]
		       [-noauth] [-localauth] [-verbose] [-encrypt]
    Where: -force      force a complete release

The corresponding method invocation looks like:

    my $result = $vos->release
      (
       # Required arguments
       id			=> $id,
       # Optional arguments
       force			=> 1,
       cell                     => $cell,
       noauth                   => 1,
       localauth                => 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN


=head2 remove

The vos help string is:

    vos remove: delete a volume
    Usage: vos remove [-server <machine name>] [-partition <partition name>]
		      -id <volume name or ID> [-cell <cell name>] [-noauth]
		      [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->remove
      (
       # Required arguments
       id			=> $id,
       # Optional arguments
       server			=> $server,
       partition		=> $partition,
       cell                     => $cell,
       noauth                   => 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN


=head2 remsite

The vos help string is:

    vos remsite: remove a replication site
    Usage: vos remsite -server <machine name> -partition <partition name>
		       -id <volume name or ID> [-cell <cell name>] [-noauth]
		       [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->remsite
      (
       # Required arguments
       id			=> $id,
       server			=> $server,
       partition		=> $partition,
       # Optional arguments
       cell                     => $cell,
       noauth                   => 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN

      );

=head2 rename

The vos help string is:

    vos rename: rename a volume
    Usage: vos rename -oldname <old volume name > -newname <new volume name >
		      [-cell <cell name>] [-noauth] [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->rename
      (
       # Required arguments
       oldname			=> $oldname,
       newname			=> $newname,
       # Optional arguments
       cell                     => $cell,
       noauth                   => 1,
       localauth                => 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN

=head2 setfields

The vos help string is:

    vos setfields: change volume info fields
    Usage: vos setfields -id <volume name or ID> [-maxquota <quota (KB)>]
			 [-clearuse] [-cell <cell name>] [-noauth]
			 [-localauth] [-verbose] [-encrypt]
    Where: -clearuse   clear dayUse

The corresponding method invocation looks like:

    my $result = $vos->setfields
      (
       # Required arguments
       id			=> $id,
       # Optional arguments
       maxquota			=> $maxquota,
       clearuse			=> 1,
       cell                     => $cell,
       noauth                   => 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN


The vos help string is:

    vos shadow: make or update a shadow volume
    Usage: vos shadow -id <volume name or ID on source> -fromserver <machine name on source> 
       -frompartition <partition name on source> -toserver <machine name on destination> 
       -topartition <partition name on destination> [-toname <volume name on destination>] 
       [-toid <volume ID on destination>] [-offline] [-readonly] [-live] [-incremental] 
       [-cell <cell name>] [-noauth] [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->shadow
      (
       # Required arguments
       id             => $id,
       fromserver     => $server,
       frompartition  => $partition,
       toserver       => $newserver,
       topartition    => $newpartition,
       # Optional arguments

lib/AFS/Command/VOS.pod  view on Meta::CPAN



=head2 syncserv

The vos help string is:

    vos syncserv: synchronize server with VLDB
    Usage: vos syncserv -server <machine name> [-partition <partition name>]
			[-cell <cell name>] [-noauth] [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->syncserv
      (
       # Required arguments
       server			=> $server,
       # Optional arguments
       partition		=> $partition,
       cell                     => $cell,
       noauth                   => 1,
       localauth                => 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN


=head2 syncvldb

The vos help string is:

    vos syncvldb: synchronize VLDB with server
    Usage: vos syncvldb [-server <machine name>] [-partition <partition name>]
			[-volume <volume name or ID>] [-cell <cell name>]
			[-noauth] [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->syncvldb
      (
       # Optional arguments
       server			=> $server,
       partition		=> $partition,
       volume			=> $volume,
       cell                     => $cell,
       noauth                   => 1,
       localauth                => 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN

      );

=head2 unlock

The vos help string is:

    vos unlock: release lock on VLDB entry for a volume
    Usage: vos unlock -id <volume name or ID> [-cell <cell name>] [-noauth]
		      [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->unlock
      (
       # Required arguments
       id			=> $id,
       # Optional arguments
       cell                     => $cell,
       noauth                   => 1,
       localauth                => 1,
       verbose                  => 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN

      );

=head2 unlockvldb

The vos help string is:

    vos unlockvldb: unlock all the locked entries in the VLDB
    Usage: vos unlockvldb [-server <machine name>] [-partition <partition name>]
			  [-cell <cell name>] [-noauth] [-localauth] [-verbose] [-encrypt]

The corresponding method invocation looks like:

    my $result = $vos->unlockvldb
      (
       # Optional arguments
       server			=> $server,
       partition		=> $partition,
       cell                     => $cell,
       noauth                   => 1,
       localauth                => 1,
       verbose                  => 1,

lib/AFS/Command/VOS.pod  view on Meta::CPAN


The vos help string is:

    vos zap: delete the volume, don't bother with VLDB
    Usage: vos zap -server <machine name> -partition <partition name> -id <volume ID>
		   [-force] [-backup] [-cell <cell name>] [-noauth]
		   [-localauth] [-verbose] [-encrypt]
    Where: -force      force deletion of bad volumes
	   -backup     also delete backup volume if one is found

The corresponding method invocation looks like:

    my $result = $vos->zap
      (
       # Required arguments
       server			=> $server,
       partition		=> $partition,
       id			=> $id,
       # Optional arguments
       force			=> 1,
       backup			=> 1,



( run in 0.344 second using v1.01-cache-2.11-cpan-d7a12ab2c7f )