Provided by: openafs-client_1.8.13.2-1ubuntu1_amd64 bug

NAME

       vos_addsite - Adds a read-only site definition to a volume's VLDB entry

SYNOPSIS

       vos addsite -server <machine name for new site>
           -partition <partition name for new site>
           -id <volume name or ID>
           [-roid <readonly volume name or ID>]
           [-valid] [-cell <cell name>]
           [-noauth] [-localauth]
           [-verbose] [-encrypt] [-noresolve]
           [-config <config directory>]
           [-help]

       vos ad -s <machine name for new site>
           -p <partition name for new site>
           -i <volume name or ID>
           [-r <readonly volume name or ID>]
           [-va] [-c <cell name>] >>> [-noa] [-l]
           [-ve] [-e] [-nor]
           [-co <config directory>]
           [-h]

DESCRIPTION

       The vos addsite command defines a new read-only site (partition on a file server machine, specified by
       the -server and -partition arguments) in the Volume Location Database (VLDB) entry of the read/write
       volume named by the -id argument. When the vos release command is next issued against the read/write
       volume, a read-only copy of it is distributed to all of the read-only sites, including the newly defined
       one.

CAUTIONS

       A volume's VLDB entry accommodates a maximum number of 16 site definitions. The site housing the
       read/write and backup versions of the volume counts as one site, the backup snapshot counts as one site,
       and one site should be reserved for a transient clone for volume moves and similar operations. Each read-
       only site counts as an additional site (even the read-only site defined on the same file server machine
       and partition as the read/write site counts as a separate site). The limit in the VLDB entry effectively
       determines the maximum number of copies of the volume that are available to AFS clients.

       Attempts to create additional sites by using this command fail with an error.

OPTIONS

       -server <machine name>
           Identifies  the file server machine where the read-only volume is to reside. Provide the machine's IP
           address or its host name (either fully qualified or using an unambiguous abbreviation). For  details,
           see vos(1).

       -partition <partition name>
           Identifies the partition where the read-only volume is to reside, on the file server machine named by
           the  -server  argument.  Provide  the  partition's  complete  name with preceding slash (for example,
           "/vicepa") or use one of the three acceptable abbreviated forms. For details, see vos(1).

       -id <volume name or ID>
           Specifies either the complete name or volume ID number of the read/write source volume.

       -roid <readonly volume name or ID>
           Specifies either the complete name or volume ID number of the readonly  volume.  This  will  only  be
           honored  if  the  source read/write volume does not already have a readonly volume ID associated with
           it. If the source read/write volume already has a readonly  volume  ID,  the  specified  ID  will  be
           ignored, and a warning will be printed.

           If this is not specified and the source read/write volume does not already have a readonly volume ID,
           a volume ID for the readonly volume will be allocated for it when the vos release command is run.

           The  automatically  allocated  readonly volume IDs should be fine for almost all cases, so you should
           almost never need to specify them explicitly.  This option is available in OpenAFS versions 1.5.61 or
           later.

       -valid
           Marks the site as up-to-date in the VLDB. You should only do this if  the  new  site  already  has  a
           current  readonly replica of the volume, but for some reason it is not in the VLDB as a replica site.
           This is useful when an existing read-only volume is dumped and restored with the  -readonly  flag  at
           the  new  site.  This option is available in OpenAFS clients 1.4.7 or later and 1.5.31 or later. This
           option can be used with OpenAFS server versions later than 1.4.1 or 1.5.0.

       -cell <cell name>
           Names the cell in which to run the command. Do not combine this argument with  the  -localauth  flag.
           For more details, see vos(1).

       -noauth
           Assigns  the  unprivileged  identity  "anonymous"  to  the  issuer. Do not combine this flag with the
           -localauth flag. For more details, see vos(1).

       -localauth
           Constructs a server ticket using a key from  the  local  /etc/openafs/server/KeyFile  file.  The  vos
           command  interpreter  presents  it  to  the  Volume  Server  and Volume Location Server during mutual
           authentication. Do not combine this flag with the -cell argument or -noauth flag. For  more  details,
           see vos(1).

       -verbose
           Produces  on the standard output stream a detailed trace of the command's execution. If this argument
           is omitted, only warnings and error messages appear.

       -encrypt
           Encrypts the command so that the operation's results are not transmitted across the network in  clear
           text. This option is available in OpenAFS versions 1.4.11 or later and 1.5.60 or later.

       -noresolve
           Shows  all  servers  as  IP  addresses  instead  of the DNS name. This is very useful when the server
           address is registered as 127.0.0.1 or when dealing with multi-homed servers. This option is available
           in OpenAFS versions 1.4.8 or later and 1.5.35 or later.

       -config <configuration directory>
           Set the location of the configuration directory to be used. This defaults to /etc/openafs, except  if
           -localauth is specified, in which case the default is /etc/openafs/server. This option allows the use
           of alternative configuration locations for testing purposes.

       -help
           Prints the online help for this command. All other valid options are ignored.

EXAMPLES

       The  following  example,  appropriate  in the Example Organization cell, defines a read-only site for the
       cell's "root.afs" volume.

          % vos addsite -server sv7.example.org -partition /vicepb -id root.afs

PRIVILEGE REQUIRED

       The issuer must be listed in the /etc/openafs/server/UserList file on  the  machine  specified  with  the
       -server argument and on each database server machine. If the -localauth flag is included, the issuer must
       instead be logged on to a server machine as the local superuser "root".

SEE ALSO

       vos(1), vos_examine(1), vos_release(1)

COPYRIGHT

       IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.

       This  documentation  is covered by the IBM Public License Version 1.0.  It was converted from HTML to POD
       by software written by Chas Williams and Russ Allbery, based on  work  by  Alf  Wachsmann  and  Elizabeth
       Cassell.

OpenAFS                                            2025-03-21                                     VOS_ADDSITE(1)