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