c45fbe62e271e894d9ba9cec9cc8adebc796c0f7
[openafs.git] / doc / man-pages / pod8 / bos_startup.pod
1 =head1 NAME
2
3 bos_startup - Starts a process without changing its status flag
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<bos startup> S<<< B<-server> <I<machine name>> >>> S<<< [B<-instance> <I<instances>>+] >>>
11     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-help>]
12
13 B<bos startu> S<<< B<-s> <I<machine name>> >>> S<<< [B<-i> <I<instances>>+] >>>
14     S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-h>]
15
16 =for html
17 </div>
18
19 =head1 DESCRIPTION
20
21 The B<bos startup> command starts, on the server machine named by the
22 B<-server> argument, either:
23
24 =over 4
25
26 =item *
27
28 All AFS server processes not currently running but marked with the C<Run>
29 status flag in the F</usr/afs/local/BosConfig> file.
30
31 =item *
32
33 Each process specified by B<-instance> argument, even if its status flag
34 in the B<BosConfig> file is C<NotRun>.
35
36 =back
37
38 To start a process and set its F<BosConfig> status flag to C<Run>, use the
39 B<bos start> command instead.
40
41 =head1 OPTIONS
42
43 =over 4
44
45 =item B<-server> <I<machine name>>
46
47 Indicates the server machine on which to start processes. Identify the
48 machine by IP address or its host name (either fully-qualified or
49 abbreviated unambiguously). For details, see L<bos(8)>.
50
51 =item B<-instance> <I<instances>>+
52
53 Names each process to start. Use the process name assigned with the
54 B<-instance> argument to the B<bos create> command. The output from the
55 B<bos status> command lists the names.
56
57 =item B<-cell> <I<cell name>>
58
59 Names the cell in which to run the command. Do not combine this argument
60 with the B<-localauth> flag. For more details, see L<bos(8)>.
61
62 =item B<-noauth>
63
64 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
65 combine this flag with the B<-localauth> flag. For more details, see
66 L<bos(8)>.
67
68 =item B<-localauth>
69
70 Constructs a server ticket using a key from the local
71 F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
72 ticket to the BOS Server during mutual authentication. Do not combine this
73 flag with the B<-cell> or B<-noauth> options. For more details, see
74 L<bos(8)>.
75
76 =item B<-help>
77
78 Prints the online help for this command. All other valid options are
79 ignored.
80
81 =back
82
83 =head1 EXAMPLES
84
85 The following command starts all processes marked with status flag C<Run>
86 in the F<BosConfig> file on the machine C<fs3.example.com> that are not
87 currently running.
88
89    % bos startup fs3.example.com
90
91 The following command starts the B<buserver>, B<kaserver>, B<ptserver>,
92 and B<vlserver> processes running on the machine C<db2.example.com>, even if
93 their status flags in the F<BosConfig> file are C<NotRun>.
94
95    % bos startup -server db2.example.com \
96        -instance buserver kaserver ptserver vlserver
97
98 =head1 PRIVILEGE REQUIRED
99
100 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
101 machine named by the B<-server> argument, or must be logged onto a server
102 machine as the local superuser C<root> if the B<-localauth> flag is
103 included.
104
105 =head1 SEE ALSO
106
107 L<BosConfig(5)>,
108 L<KeyFile(5)>,
109 L<UserList(5)>,
110 L<bos(8)>,
111 L<bos_create(8)>,
112 L<bos_start(8)>,
113 L<bos_status(8)>
114
115 =head1 COPYRIGHT
116
117 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
118
119 This documentation is covered by the IBM Public License Version 1.0.  It was
120 converted from HTML to POD by software written by Chas Williams and Russ
121 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.