doc/man-pages/pod8/backup_delvolentry.pod

   1 =head1 NAME
   2
   3 backup delvolentry - Deletes a volume entry from a volume set
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<backup delvolentry> S<<< B<-name> <I<volume set name>> >>>
  11     S<<< B<-entry> <I<volume set index>> >>> [B<-localauth>]
  12     S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
  13
  14 B<backup delvole> S<<< B<-n> <I<volume set name>> >>> S<<< B<-e> <I<volume set index>> >>>
  15     [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
  16
  17 =for html
  18 </div>
  19
  20 =head1 DESCRIPTION
  21
  22 The B<backup delvolentry> command deletes the indicated volume entry from
  23 the volume set specified with the B<-name> argument.  Use the B<-entry>
  24 argument to identify the volume entry by its index number. To display the
  25 index numbers, use the B<backup listvolsets> command.
  26
  27 If there are any remaining volume entries with index numbers higher than
  28 the deleted entry, their indexes are automatically decremented to
  29 eliminate any gaps in the indexing sequence.
  30
  31 =head1 CAUTIONS
  32
  33 Deleting volume entries from a temporary volume set is possible only
  34 within the interactive session in which the volume set was created.
  35
  36 =head1 OPTIONS
  37
  38 =over 4
  39
  40 =item B<-name> <I<volume set name>>
  41
  42 Names the volume set from which to delete a volume entry.
  43
  44 =item B<-entry> <I<volume set index>>
  45
  46 Specifies the index number of the volume entry to delete. Use the B<backup
  47 listvolsets> command to display the index numbers for a volume set's
  48 volume entries.
  49
  50 =item B<-localauth>
  51
  52 Constructs a server ticket using a key from the local
  53 F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
  54 it to the Backup Server, Volume Server and VL Server during mutual
  55 authentication. Do not combine this flag with the B<-cell> argument. For
  56 more details, see L<backup(8)>.
  57
  58 =item B<-cell> <I<cell name>>
  59
  60 Names the cell in which to run the command. Do not combine this argument
  61 with the B<-localauth> flag. For more details, see L<backup(8)>.
  62
  63 =item B<-help>
  64
  65 Prints the online help for this command. All other valid options are
  66 ignored.
  67
  68 =back
  69
  70 =head1 EXAMPLES
  71
  72 The following command deletes the fourth volume entry from the volume set
  73 called C<sys>:
  74
  75    % backup delvolentry -name sys -entry 4
  76
  77 =head1 PRIVILEGE REQUIRED
  78
  79 The issuer must be listed in the F</usr/afs/etc/UserList> file on every
  80 machine where the Backup Server is running, or must be logged onto a
  81 server machine as the local superuser C<root> if the B<-localauth> flag is
  82 included.
  83
  84 =head1 SEE ALSO
  85
  86 L<backup(8)>,
  87 L<backup_addvolentry(8)>,
  88 L<backup_addvolset(8)>,
  89 L<backup_delvolset(8)>,
  90 L<backup_listvolsets(8)>
  91
  92 =head1 COPYRIGHT
  93
  94 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
  95
  96 This documentation is covered by the IBM Public License Version 1.0.  It was
  97 converted from HTML to POD by software written by Chas Williams and Russ
  98 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.