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