| 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>> >>> |
| 13 | S<<< [B<-roid> <I<readonly volume name or ID>>] >>> |
| 14 | [B<-valid>] S<<< [B<-cell> <I<cell name>>] >>> |
| 15 | [B<-noauth>] [B<-localauth>] |
| 16 | [B<-verbose>] [B<-encrypt>] [B<-noresolve>] |
| 17 | S<<< [B<-config> <I<config directory>>] >>> |
| 18 | [B<-help>] |
| 19 | |
| 20 | B<vos ad> S<<< B<-s> <I<machine name for new site>> >>> |
| 21 | S<<< B<-p> <I<partition name for new site>> >>> |
| 22 | S<<< B<-i> <I<volume name or ID>> >>> |
| 23 | S<<< [B<-r> <I<readonly volume name or ID>>] >>> |
| 24 | [B<-va>] [B<-c> <I<cell name>>] >>> [B<-noa>] [B<-l>] |
| 25 | [B<-ve>] [B<-e>] [B<-nor>] |
| 26 | S<<< [B<-co> <I<config directory>>] >>> |
| 27 | [B<-h>] |
| 28 | |
| 29 | =for html |
| 30 | </div> |
| 31 | |
| 32 | =head1 DESCRIPTION |
| 33 | |
| 34 | The B<vos addsite> command defines a new read-only site (partition on a |
| 35 | file server machine, specified by the B<-server> and B<-partition> |
| 36 | arguments) in the Volume Location Database (VLDB) entry of the read/write |
| 37 | volume named by the B<-id> argument. When the B<vos release> command is |
| 38 | next issued against the read/write volume, a read-only copy of it is |
| 39 | distributed to all of the read-only sites, including the newly defined |
| 40 | one. |
| 41 | |
| 42 | =head1 CAUTIONS |
| 43 | |
| 44 | A volume's VLDB entry accommodates a maximum number of 16 site |
| 45 | definitions. The site housing the read/write and backup versions of the |
| 46 | volume counts as one site, the backup snapshot counts as one site, and one |
| 47 | site should be reserved for a transient clone for volume moves and similar |
| 48 | operations. Each read-only site counts as an additional site (even the |
| 49 | read-only site defined on the same file server machine and partition as |
| 50 | the read/write site counts as a separate site). The limit in the VLDB |
| 51 | entry effectively determines the maximum number of copies of the volume |
| 52 | that are available to AFS clients. |
| 53 | |
| 54 | Attempts to create additional sites by using this command fail with an |
| 55 | error. |
| 56 | |
| 57 | =head1 OPTIONS |
| 58 | |
| 59 | =over 4 |
| 60 | |
| 61 | =item B<-server> <I<machine name>> |
| 62 | |
| 63 | Identifies the file server machine where the read-only volume is to |
| 64 | reside. Provide the machine's IP address or its host name (either fully |
| 65 | qualified or using an unambiguous abbreviation). For details, see |
| 66 | L<vos(1)>. |
| 67 | |
| 68 | =item B<-partition> <I<partition name>> |
| 69 | |
| 70 | Identifies the partition where the read-only volume is to reside, on the |
| 71 | file server machine named by the B<-server> argument. Provide the |
| 72 | partition's complete name with preceding slash (for example, C</vicepa>) |
| 73 | or use one of the three acceptable abbreviated forms. For details, see |
| 74 | L<vos(1)>. |
| 75 | |
| 76 | =item B<-id> <I<volume name or ID>> |
| 77 | |
| 78 | Specifies either the complete name or volume ID number of the read/write |
| 79 | source volume. |
| 80 | |
| 81 | =item B<-roid> <I<readonly volume name or ID>> |
| 82 | |
| 83 | Specifies either the complete name or volume ID number of the readonly |
| 84 | volume. This will only be honored if the source read/write volume does not |
| 85 | already have a readonly volume ID associated with it. If the source |
| 86 | read/write volume already has a readonly volume ID, the specified ID will |
| 87 | be ignored, and a warning will be printed. |
| 88 | |
| 89 | If this is not specified and the source read/write volume does not already |
| 90 | have a readonly volume ID, a volume ID for the readonly volume will be |
| 91 | allocated for it when the B<vos release> command is run. |
| 92 | |
| 93 | The automatically allocated readonly volume IDs should be fine for almost |
| 94 | all cases, so you should almost never need to specify them explicitly. |
| 95 | This option is available in OpenAFS versions 1.5.61 or later. |
| 96 | |
| 97 | =item B<-valid> |
| 98 | |
| 99 | Marks the site as up-to-date in the VLDB. You should only do this if the |
| 100 | new site already has a current readonly replica of the volume, but for |
| 101 | some reason it is not in the VLDB as a replica site. This is useful when |
| 102 | an existing read-only volume is dumped and restored with the B<-readonly> |
| 103 | flag at the new site. This option is available in OpenAFS clients 1.4.7 or |
| 104 | later and 1.5.31 or later. This option can be used with OpenAFS server |
| 105 | versions later than 1.4.1 or 1.5.0. |
| 106 | |
| 107 | =include fragments/vos-common.pod |
| 108 | |
| 109 | =back |
| 110 | |
| 111 | =head1 EXAMPLES |
| 112 | |
| 113 | The following example, appropriate in the Example Organization cell, defines a |
| 114 | read-only site for the cell's C<root.afs> volume. |
| 115 | |
| 116 | % vos addsite -server sv7.example.org -partition /vicepb -id root.afs |
| 117 | |
| 118 | =head1 PRIVILEGE REQUIRED |
| 119 | |
| 120 | The issuer must be listed in the F</usr/afs/etc/UserList> file on the |
| 121 | machine specified with the B<-server> argument and on each database server |
| 122 | machine. If the B<-localauth> flag is included, the issuer must instead be |
| 123 | logged on to a server machine as the local superuser C<root>. |
| 124 | |
| 125 | =head1 SEE ALSO |
| 126 | |
| 127 | L<vos(1)>, |
| 128 | L<vos_examine(1)>, |
| 129 | L<vos_release(1)> |
| 130 | |
| 131 | =head1 COPYRIGHT |
| 132 | |
| 133 | IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved. |
| 134 | |
| 135 | This documentation is covered by the IBM Public License Version 1.0. It was |
| 136 | converted from HTML to POD by software written by Chas Williams and Russ |
| 137 | Allbery, based on work by Alf Wachsmann and Elizabeth Cassell. |