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