VOS_ADDSITE(1)

📦
version 1.8.16.1 · 10 versions
, in ubuntu stonking

💖 VOS_ADDSITE(1) — it's giving AFS Command Reference ✨

okay bestie, gather round 🫶 this is the vos addsite page from the AFS Command Reference, and we're gonna make it make sense, no cap.

🌸 NAME 🌸

vos_addsite — literally adds a read-only site definition to a volume's VLDB entry 💅

So like… you're telling the Volume Location Database "hey, this volume also lives here"? Yes ma'am, that's the whole vibe.

✨ 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]

yeah the short forms are all just the long forms with the middle vowels yeeted, it's giving efficiency 💀

🦋 DESCRIPTION 🦋

The vos addsite command defines a new read-only site in the Volume Location Database (VLDB) entry of the read/write volume you name with -id. And what even is a site, you ask? It's a partition on a file server machine, and you point at it with the -server and -partition arguments. That's the duo. Those two. 👑

Then, next time you run vos release against that read/write volume, a read-only copy gets distributed to all of the read-only sites — including the shiny new one you just defined. So like, adding the site doesn't copy anything by itself, it just makes the site exist in the VLDB. The release does the heavy lifting. Remember that, it's important. 📌

⚠️ CAUTIONS ⚠️

okay this is the part where we all sit down and pay attention 🫠

A volume's VLDB entry accommodates a maximum number of 16 site definitions. That's the ceiling. Sixteen. Not seventeen. Do not test it, bestie.

Here's how the counting actually goes down:

  • The site housing the read/write and backup versions of the volume counts as one site
  • The backup snapshot counts as one site
  • One site should be reserved for a transient clone for volume moves and similar operations
  • Each read-only site counts as an additional site — and yes, even the read-only site defined on the same file server machine and partition as the read/write site counts as a separate site 😭

And tbh the limit in the VLDB entry is effectively what determines the maximum number of copies of the volume that are available to AFS clients. So it's not just a bookkeeping thing.

Attempts to create additional sites by using this command fail with an error. That's it. That's the consequence. No sneaking a 17th one in. 🚫

💅 OPTIONS 💅

  • -server <machine name> — Identifies the file server machine where the read-only volume is to reside. Give it the machine's IP address or its host name — fully qualified, or 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 the preceding slash (for example, "/vicepa"), or use one of the three acceptable abbreviated forms. For details, see vos(1). don't forget that slash she's important 🎀
  • -id <volume name or ID> — Specifies either the complete name or volume ID number of the read/write source volume. This is your main character volume. 👑
  • -roid <readonly volume name or ID> — Specifies either the complete name or volume ID number of the readonly volume. Here's the tea though: 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, your 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). you're just some anonymous girlie, respect 🫡
  • -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. so like, silence unless something's wrong. iconic behavior honestly 💅
  • -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. like she said what she said 💀

🌈 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

look at her go. one line. site defined. slay. ✨

👑 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". 👑

fr fr, check your UserList before you come crying to me about permissions. it's giving "did you read the requirements" energy. 😭

🔗 SEE ALSO 🔗

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

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.

and that's the whole page bestie 🫶 this one's from OpenAFS, dated 2026-07-27 — go add those sites, but remember: sixteen max, and mind your -localauth combos. mwah 💋💖

📦 where this page comes from