doc/man-pages/pod/bos_delete.pod

   1 =head1 NAME
   2
   3 bos delete - Deletes a server process from the B</usr/afs/local/BosConfig> file
   4
   5 =head1 SYNOPSIS
   6
   7 bos delete B<-server> I<machine name>  B<-instance> I<server process name> [I<server process name> ...]
   8 [B<-cell> I<cell name>]  [B<-noauth>]  [B<-localauth>]  [B<-help>]
   9
  10 bos d B<-s> I<machine name>  B<-i> I<server process name> [I<server process name> ...]  [B<-c> I<cell name>]
  11 [B<-n>]  [B<-l>]  [B<-h>]
  12
  13 =head1 DESCRIPTION
  14
  15 The C<bos delete> command removes the B</usr/afs/local/BosConfig> entry for
  16 each process indicated by the B<-instance> argument, on the server
  17 machine named by the B<-server> argument.
  18
  19 Before issuing this command, issue the C<bos stop> command to stop the
  20 process and set its status flag in the B<BosConfig> file to C<NotRun>. The
  21 C<bos delete> command fails with an error message if a process's status
  22 flag is C<Run>.
  23
  24 =head1 OPTIONS
  25
  26 =over 4
  27
  28 =item B<-server> I<machine name>
  29
  30 Indicates the server machine on which to delete the server
  31 process entry from the B</usr/afs/local/BosConfig> file. Identify
  32 the machine by IP address or its host name (either
  33 fully-qualified or abbreviated unambiguously). For details, see
  34 the introductory reference page for the C<bos> command suite.
  35
  36 =item B<-instance> I<server process name> [I<server process name> ...]
  37
  38 Names each process to delete. Use the name assigned with the
  39 B<-instance> argument to the C<bos create> command; process names
  40 appear in the output of the C<bos status> command.
  41
  42 =item B<-cell> I<cell name>
  43
  44 Names the cell in which to run the command. Do not combine this
  45 argument with the B<-localauth> flag. For more details, see the
  46 introductory L<bos(1)> reference page.
  47
  48 =item B<-noauth>
  49
  50 Assigns the unprivileged identity B<anonymous> to the issuer. Do
  51 not combine this flag with the B<-localauth> flag. For more
  52 details, see the introductory L<bos(1)> reference page.
  53
  54 =item B<-localauth>
  55
  56 Constructs a server ticket using a key from the local
  57 B</usr/afs/etc/KeyFile> file. The C<bos> command interpreter presents
  58 the ticket to the BOS Server during mutual authentication. Do
  59 not combine this flag with the B<-cell> or B<-noauth> options. For
  60 more details, see the introductory L<bos(1)> reference page.
  61
  62 =item B<-help>
  63
  64 Prints the online help for this command. All other valid
  65 options are ignored.
  66
  67 =back
  68
  69 =head1 EXAMPLES
  70
  71 The following command removes the B<buserver>, B<kaserver>, B<ptserver>, and
  72 B<vlserver> entries from the B<BosConfig> file on B<db3.abc.com>, a database
  73 server machine being decommissioned.
  74
  75   bos delete -server db3.abc.com -instance buserver kaserver ptserver vlserver
  76
  77 =head1 PRIVILEGE REQUIRED
  78
  79 The issuer must be listed in the B</usr/afs/etc/UserList> file on the
  80 machine named by the B<-server> argument, or must be logged onto a server
  81 machine as the local superuser B<root> if the B<-localauth> flag is
  82 included.
  83
  84 =head1 COPYRIGHT
  85
  86 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
  87
  88 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
  89 and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
  90 Stanford Linear Accelerator Center, a department of Stanford University.
  91
  92 =head1 SEE ALSO
  93
  94 L<BosConfig(1)>,
  95 L<KeyFile(1)>,
  96 L<UserList(1)>,
  97 L<bos(1)>,
  98 L<bos_create(1)>,
  99 L<bos_status(1)>
 100
 101 =cut