1c4d96131a4cf8f514b4fb18b689725280e2fe63
[openafs.git] / doc / man-pages / pod1 / vos_addsite.pod
1 =head1 NAME
2
3 vos_addsite - Adds a read-only site definition to a volume's VLDB entry
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos addsite> S<<< B<-server> <I<machine name for new site>> >>>
11     S<<< B<-partition> <I<partition name for new site>> >>>
12     S<<< B<-id> <I<volume name or ID>> >>> S<<< [B<-cell> <I<cell name>>] >>>
13     [B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-help>]
14
15 B<vos ad> S<<< B<-s> <I<machine name for new site>> >>>
16     S<<< B<-p> <I<partition name for new site>> >>>
17     S<<< B<-i> <I<volume name or ID>> >>> S<<< [B<-c> <I<cell name>>] >>>
18     [B<-n>] [B<-l>] [B<-v>] [B<-h>]
19
20 =for html
21 </div>
22
23 =head1 DESCRIPTION
24
25 The B<vos addsite> command defines a new read-only site (partition on a
26 file server machine, specified by the B<-server> and B<-partition>
27 arguments) in the Volume Location Database (VLDB) entry of the read/write
28 volume named by the B<-id> argument. When the B<vos release> command is
29 next issued against the read/write volume, a read-only copy of it is
30 distributed to all of the read-only sites, including the newly defined
31 one.
32
33 =head1 CAUTIONS
34
35 A volume's VLDB entry accommodates a maximum number of site definitions,
36 as defined in the I<IBM AFS Release Notes>. The site housing the
37 read/write and backup versions of the volume counts as one site, and each
38 read-only site counts as an additional site (even the read-only site
39 defined on the same file server machine and partition as the read/write
40 site counts as a separate site). The limit in the VLDB entry effectively
41 determines the maximum number of copies of the volume that are available
42 to AFS clients.
43
44 Attempts to create additional sites by using this command fail with an
45 error.
46
47 =head1 OPTIONS
48
49 =over 4
50
51 =item B<-server> <I<machine name>>
52
53 Identifies the file server machine where the read-only volume is to
54 reside. Provide the machine's IP address or its host name (either fully
55 qualified or using an unambiguous abbreviation). For details, see
56 L<vos(1)>.
57
58 =item B<-partition> <I<partition name>>
59
60 Identifies the partition where the read-only volume is to reside, on the
61 file server machine named by the B<-server> argument. Provide the
62 partition's complete name with preceding slash (for example, C</vicepa>)
63 or use one of the three acceptable abbreviated forms. For details, see
64 L<vos(1)>.
65
66 =item B<-id> <I<volume name or ID>>
67
68 Specifies either the complete name or volume ID number of the read/write
69 source volume.
70
71 =item B<-cell> <I<cell name>>
72
73 Names the cell in which to run the command. Do not combine this argument
74 with the B<-localauth> flag. For more details, see L<vos(1)>.
75
76 =item B<-noauth>
77
78 Assigns the unprivileged identity anonymous to the issuer. Do not combine
79 this flag with the B<-localauth> flag. For more details, see L<vos(1)>.
80
81 =item -localauth
82
83 Constructs a server ticket using a key from the local
84 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
85 to the Volume Server and Volume Location Server during mutual
86 authentication. Do not combine this flag with the B<-cell> argument or
87 B<-noauth> flag. For more details, see L<vos(1)>.
88
89 =item B<-verbose>
90
91 Produces on the standard output stream a detailed trace of the command's
92 execution. If this argument is omitted, only warnings and error messages
93 appear.
94
95 =item B<-help>
96
97 Prints the online help for this command. All other valid options are
98 ignored.
99
100 =back
101
102 =head1 EXAMPLES
103
104 The following example, appropriate in the State University cell, defines a
105 read-only site for the cell's C<root.afs> volume.
106
107    % vos addsite -server sv7.stateu.edu -partition /vicepb -id root.afs
108
109 =head1 PRIVILEGE REQUIRED
110
111 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
112 machine specified with the B<-server> argument and on each database server
113 machine. If the B<-localauth> flag is included, the issuer must instead be
114 logged on to a server machine as the local superuser C<root>.
115
116 =head1 SEE ALSO
117
118 L<vos(1)>,
119 L<vos_examine(1)>,
120 L<vos_release(1)>
121
122 =head1 COPYRIGHT
123
124 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
125
126 This documentation is covered by the IBM Public License Version 1.0.  It was
127 converted from HTML to POD by software written by Chas Williams and Russ
128 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.